com.ibm.as400.access

Class ISeriesNetServer

  • java.lang.Object
    • com.ibm.as400.access.ISeriesNetServer
  • All Implemented Interfaces:
    java.io.Serializable


    public class ISeriesNetServer
    extends java.lang.Object
    implements java.io.Serializable
    Represents the NetServer service on a system. This class allows the user to query and modify the state and configuration of the NetServer.

    If the NetServer job on the IBM i system is not started, the "list" methods may return incomplete results. To determine if the NetServer job is started, use the isStarted method. To start the NetServer, use the start method.

    Note: The first call to one of the attribute "getter" methods will cause an implicit call to refresh, if refresh() hasn't yet been explicitly called. If any exceptions are thrown by refresh() during the implicit call, they will be logged to Trace.ERROR and ignored. However, should an exception occur during an explicit call to refresh(), it will be thrown to the caller.

    Note: Typically, methods which change the state or attributes of the NetServer require that the system user profile have *IOSYSCFG special authority. For example, starting or ending the NetServer requires *IOSYSCFG authority.

    Note: This class uses some API fields that are available only when connecting to systems at release V5R1 or higher.

     import com.ibm.as400.access.*;
    
     // Create a NetServer object for a specific system.
     AS400 system = new AS400("MYSYSTEM", "MYUSERID", "MYPASSWORD");
     ISeriesNetServer ns = new ISeriesNetServer(system);
    
     try
     {
    
       // Get the name of the NetServer.
       System.out.println("Name: " + ns.getName());
    
       // Get the CCSID of the NetServer.
       System.out.println("CCSID: " + ns.getCCSID());
    
       // Get the "allow system name" value of the NetServer.
       System.out.println("'Allow system name': " +  ns.isAllowSystemName());
    
       // Set the description of the NetServer.
       // Note: Changes will take effect after next start of NetServer.
       ns.setDescription("The NetServer");
       ns.commitChanges();
    
       // Set the CCSID of the NetServer to 13488.
       ns.setCCSID(13488);
    
       // Set the "allow system name" value of the NetServer to true.
       ns.setAllowSystemName(true);
    
       // Commit the attribute changes (send them to the system).
       ns.commitChanges();
    
     }
     catch (AS400Exception e) {
       AS400Message[] messageList = e.getAS400MessageList();
       for (int i=0; i<messageList.length; i++) {
         System.out.println(messageList[i].getText());
       }
     }
     catch (Exception e) {
       e.printStackTrace();
     }
     finally {
       if (system != null) system.disconnectAllServices();
     }
    
    See Also:
    ISeriesNetServerFileShare, ISeriesNetServerPrintShare, ISeriesNetServerConnection, ISeriesNetServerSession, Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static int ENCRYPTED_PASSWORDS
      Value of the NetServer "authentication method" attribute, indicating that the system authenticates with encrypted passwords only.
      static int KERBEROS_OR_PASSWORDS
      Deprecated. 
      Renamed to NETWORK_AUTHENTICATION_OR_PASSWORDS
      static int KERBEROS_V5_TOKENS
      Deprecated. 
      Renamed to NETWORK_AUTHENTICATION
      static int MSG_AUTH_NEGOTIATED
      Value of the "message authentication" attribute, indicating that the system supports message authentication, and message authentication is negotiated between the client and the system.
      static int MSG_AUTH_NOT_SUPPORTED
      Value of the "message authentication" attribute, indicating that the system does not support message authentication.
      static int MSG_AUTH_REQUIRED
      Value of the "message authentication" attribute, indicating that the system requires message authentication for all connections.
      static int NETWORK_AUTHENTICATION
      Value of the NetServer "authentication method" attribute, indicating that the system authenticates with Network authentication only.
      static int NETWORK_AUTHENTICATION_OR_PASSWORDS
      Value of the NetServer "authentication method" attribute, indicating that the system authenticates with Network authentication when possible, but it allows clients to use encrypted passwords when needed.
      static int NO_ADMIN_ALERTS
      Value of the "minimum message severity" attribute, indicating that administrative alert messages are not sent.
      static int NO_AUTO_DISCONNECT
      Value of the "idle timeout" attribute, indicating "no autodisconnect".
      static int OPP_LOCK_DISABLED
      Value of the "opportunistic lock timeout" attribute, indicating that opportunistic locking is disabled.
      static int PASSWORD_STRONGER
      Value of the "LAN Manager authentication" attribute, indicating that the LANMAN password hash is ignored if a stronger password hash is provided by the client.
      static int PASSWORD_STRONGER_OR_MISMATCH
      Value of the "LAN Manager authentication" attribute, indicating that the LANMAN password hash is used only if a stronger password hash provided by the client does not match, or if a stronger password hash is not provided.
    • Constructor Summary

      Constructors 
      Constructor and Description
      ISeriesNetServer(AS400 system)
      Constructs a NetServer object.
    • Field Detail

      • ENCRYPTED_PASSWORDS

        public static final int ENCRYPTED_PASSWORDS
        Value of the NetServer "authentication method" attribute, indicating that the system authenticates with encrypted passwords only.
        See Also:
        Constant Field Values
      • NETWORK_AUTHENTICATION

        public static final int NETWORK_AUTHENTICATION
        Value of the NetServer "authentication method" attribute, indicating that the system authenticates with Network authentication only.
        See Also:
        Constant Field Values
      • KERBEROS_V5_TOKENS

        public static final int KERBEROS_V5_TOKENS
        Deprecated. Renamed to NETWORK_AUTHENTICATION
        Value of the NetServer "authentication method" attribute, indicating that the system authenticates with Network authentication only.
        See Also:
        Constant Field Values
      • NETWORK_AUTHENTICATION_OR_PASSWORDS

        public static final int NETWORK_AUTHENTICATION_OR_PASSWORDS
        Value of the NetServer "authentication method" attribute, indicating that the system authenticates with Network authentication when possible, but it allows clients to use encrypted passwords when needed.
        Note: This value is valid only for IBM i release V5R3 and higher.
        See Also:
        Constant Field Values
      • KERBEROS_OR_PASSWORDS

        public static final int KERBEROS_OR_PASSWORDS
        Deprecated. Renamed to NETWORK_AUTHENTICATION_OR_PASSWORDS
        Value of the NetServer "authentication method" attribute, indicating that the system authenticates with Network authentication when possible, but it allows clients to use encrypted passwords when needed.
        Note: This value is valid only for IBM i release V5R3 and higher.
        See Also:
        Constant Field Values
      • NO_AUTO_DISCONNECT

        public static final int NO_AUTO_DISCONNECT
        Value of the "idle timeout" attribute, indicating "no autodisconnect".
        See Also:
        Constant Field Values
      • OPP_LOCK_DISABLED

        public static final int OPP_LOCK_DISABLED
        Value of the "opportunistic lock timeout" attribute, indicating that opportunistic locking is disabled.
        See Also:
        Constant Field Values
      • MSG_AUTH_NOT_SUPPORTED

        public static final int MSG_AUTH_NOT_SUPPORTED
        Value of the "message authentication" attribute, indicating that the system does not support message authentication.
        See Also:
        Constant Field Values
      • MSG_AUTH_NEGOTIATED

        public static final int MSG_AUTH_NEGOTIATED
        Value of the "message authentication" attribute, indicating that the system supports message authentication, and message authentication is negotiated between the client and the system.
        See Also:
        Constant Field Values
      • MSG_AUTH_REQUIRED

        public static final int MSG_AUTH_REQUIRED
        Value of the "message authentication" attribute, indicating that the system requires message authentication for all connections.
        See Also:
        Constant Field Values
      • NO_ADMIN_ALERTS

        public static final int NO_ADMIN_ALERTS
        Value of the "minimum message severity" attribute, indicating that administrative alert messages are not sent.
        See Also:
        Constant Field Values
      • PASSWORD_STRONGER

        public static final int PASSWORD_STRONGER
        Value of the "LAN Manager authentication" attribute, indicating that the LANMAN password hash is ignored if a stronger password hash is provided by the client.
        See Also:
        Constant Field Values
      • PASSWORD_STRONGER_OR_MISMATCH

        public static final int PASSWORD_STRONGER_OR_MISMATCH
        Value of the "LAN Manager authentication" attribute, indicating that the LANMAN password hash is used only if a stronger password hash provided by the client does not match, or if a stronger password hash is not provided.
        See Also:
        Constant Field Values
    • Constructor Detail

      • ISeriesNetServer

        public ISeriesNetServer(AS400 system)
        Constructs a NetServer object.
        Parameters:
        system - The system with which the NetServer is associated.
    >
    • Method Detail

      • createPrintShare

        public void createPrintShare(java.lang.String shareName,
                            java.lang.String outqLib,
                            java.lang.String outqName,
                            java.lang.String desc,
                            int splfType,
                            java.lang.String prtDriver,
                            java.lang.String prtFileLib,
                            java.lang.String prtFileName,
                            boolean publish)
                              throws AS400SecurityException,
                                     ErrorCompletingRequestException,
                                     java.lang.InterruptedException,
                                     java.io.IOException,
                                     ObjectDoesNotExistException
        Creates a print share.
        Parameters:
        shareName - The name of the share.
        outqLib - The library that contains the output queue for the share.
        outqName - The name of the output queue for the share.
        desc - The description of the share.
        splfType - The type of spooled files that are created using this share. Valid values are:
        prtDriver - The print driver that is appropriate for this share.
        prtFileLib - The library that contains the printer file.
        prtFileName - The name of the printer file. This is a template containing attributes used to create spooled files.
        publish - Whether to publish this print share. Default is false.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the system object does not exist.
      • getSystem

        public AS400 getSystem()
        Returns the system.
        Returns:
        The system.
      • isAllowSystemName

        public boolean isAllowSystemName()
        Returns the value of the "allow system name" attribute. This attribute indicates whether access is allowed to the system using the system's TCP/IP system name.
        Returns:
        The value of the "allow system name" attribute.
      • isAllowSystemNamePending

        public boolean isAllowSystemNamePending()
        Returns the pending value of the "allow system name" attribute.
        Returns:
        The pending value of the "allow system name" attribute.
        See Also:
        isAllowSystemName()
      • setAllowSystemName

        public void setAllowSystemName(boolean value)
        Sets the value of the "allow system name" attribute. This attribute indicates whether access is allowed to the system using the system's TCP/IP system name.
        Parameters:
        value - The value of the "allow system name" attribute.
      • getAuthenticationMethod

        public int getAuthenticationMethod()
        Returns the value of the "authentication method" attribute. This attribute indicates the method used to authenticate users. Note: This attribute is available only if the system is at release V5R2 or higher.
        Returns:
        The value of the "authentication method" attribute. Valid values are ENCRYPTED_PASSWORDS, NETWORK_AUTHENTICATION, and NETWORK_AUTHENTICATION_OR_PASSWORDS.
      • getAuthenticationMethodPending

        public int getAuthenticationMethodPending()
        Returns the pending value of the "authentication method" attribute.
        Returns:
        The pending value of the "authentication method" attribute.
        See Also:
        getAuthenticationMethod()
      • setAuthenticationMethod

        public void setAuthenticationMethod(int value)
        Sets the value of the "authentication method" attribute. This attribute indicates the authentication method used to authenticate users. Note: This attribute is available only if the system is at release V5R2 or higher.
        Parameters:
        value - The value of the "authentication method" attribute. Valid values are ENCRYPTED_PASSWORDS, NETWORK_AUTHENTICATION, and NETWORK_AUTHENTICATION_OR_PASSWORDS.
      • isAutoStart

        public boolean isAutoStart()
                            throws AS400SecurityException
        Returns the value of the "autostart" attribute. This attribute indicates whether or not the NetServer is to be started automatically when TCP is started.
        Note: This method requires that the user have *IOSYSCFG authority on the system. If the user doesn't have that authority, this method throws AS400SecurityException.
        Returns:
        The value of the "autostart" attribute.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
      • isAutoStartPending

        public boolean isAutoStartPending()
                                   throws AS400SecurityException
        Returns the pending value of the "autostart" attribute.
        Returns:
        The pending value of the "autostart" attribute.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        See Also:
        isAutoStart()
      • setAutoStart

        public void setAutoStart(boolean value)
        Sets the value of the "autostart" attribute. This attribute indicates whether or not the NetServer is to be started automatically when TCP is started. Note: This is the only NetServer attribute for which changes take effect immediately upon commitChanges. That is, a NetServer restart is not necessary.
        Parameters:
        value - The pending value of the "autostart" attribute.
      • getBrowsingInterval

        public int getBrowsingInterval()
        Returns the value of the "browsing interval" attribute. This attribute represents the amount of time, in milliseconds, between each system announcement that is used for browsing. A value of zero indicates that there will be no system announcements.
        Returns:
        The value of the "browsing interval" attribute.
      • getBrowsingIntervalPending

        public int getBrowsingIntervalPending()
        Returns the pending value of the "browsing interval" attribute.
        Returns:
        The pending value of the "browsing interval" attribute.
        See Also:
        getBrowsingInterval()
      • setBrowsingInterval

        public void setBrowsingInterval(int value)
        Sets the value of the "browsing interval" attribute. This attribute represents the amount of time, in milliseconds, between each system announcement that is used for browsing. A value of zero indicates that there will be no system announcements.
        Parameters:
        value - The value of the "browsing interval" attribute.
      • getCCSID

        public int getCCSID()
        Returns the value of the "system CCSID" attribute. This attribute represents the coded character set identifier for the NetServer. This is the CCSID that is used for all clients connected to the system.
        A value of 0 indicates that the user would like to use the associated ASCII CCSID for the CCSID of the job used to start the system.
        Returns:
        The value of the "system CCSID" attribute.
      • getCCSIDPending

        public int getCCSIDPending()
        Returns the pending value of the "system CCSID" attribute.
        Returns:
        The pending value of the "system CCSID" attribute.
        See Also:
        getCCSID()
      • setCCSID

        public void setCCSID(int value)
        Sets the value of the "system CCSID" attribute. This attribute represents the coded character set identifier for the NetServer. This is the CCSID that is used for all clients connected to the system. The default value is the associated ASCII CCSID for the CCSID of the job used to start the system.
        A value of 0 indicates that the user would like to use the associated ASCII CCSID for the CCSID of the job used to start the system.
        Parameters:
        value - The value of the "system CCSID" attribute.
      • getDescription

        public java.lang.String getDescription()
        Returns the value of the "description" attribute. This attribute represents the text description of the NetServer.
        Returns:
        The value of the "description" attribute.
      • getDescriptionPending

        public java.lang.String getDescriptionPending()
        Returns the pending value of the "description" attribute.
        Returns:
        The pending value of the "description" attribute.
        See Also:
        getDescription()
      • setDescription

        public void setDescription(java.lang.String value)
        Sets the value of the "description" attribute. This attribute represents the text description of the NetServer
        Parameters:
        value - The value of the "description" attribute. Maximum length is 50 characters.
      • getDomainName

        public java.lang.String getDomainName()
        Returns the value of the "domain name" attribute. This attribute represents the domain name of the NetServer.
        Returns:
        The value of the "domain name" attribute.
      • getDomainNamePending

        public java.lang.String getDomainNamePending()
        Returns the pending value of the "domain name" attribute.
        Returns:
        The pending value of the "domain name" attribute.
        See Also:
        getDomainName()
      • setDomainName

        public void setDomainName(java.lang.String value)
        Sets the value of the "domain name" attribute. This attribute represents the domain name of the NetServer.
        Parameters:
        value - The value of the "domain name" attribute.
      • getGuestUserProfile

        public java.lang.String getGuestUserProfile()
        Returns the value of the "guest user profile" attribute. This attribute represents the guest user profile for the NetServer. If no guest user profile is currently configured on the system, the value of this attribute is "" (an empty String).
        Returns:
        The value of the "guest user profile" attribute.
      • getGuestUserProfilePending

        public java.lang.String getGuestUserProfilePending()
        Returns the pending value of the "guest user profile" attribute.
        Returns:
        The pending value of the "guest user profile" attribute.
        See Also:
        getGuestUserProfile()
      • setGuestUserProfile

        public void setGuestUserProfile(java.lang.String value)
        Sets the value of the "guest user profile" attribute. This attribute represents the guest user profile for the NetServer. If no guest user profile is currently configured on the system, the value of this attribute is "" (an empty String).

        Note: Guest support allows customers to have users accessing files and printers on the system, without the requirement of a user profile on the system. It limits access to data and allows customers to support a set of users who may only need print support but do not otherwise need system access.

        Parameters:
        value - The value of the "guest user profile" attribute.
      • getIdleTimeout

        public int getIdleTimeout()
        Returns the value of the "idle timeout" attribute. This attribute represents the amount of time, in seconds, that a connection to the NetServer will remain active once activity has ceased on that connection. An idle time-out value of (NO_AUTO_DISCONNECT) indicates no autodisconnect.
        Returns:
        The value of the "idle timeout" attribute.
      • getIdleTimeoutPending

        public int getIdleTimeoutPending()
        Returns the pending value of the "idle timeout" attribute.
        Returns:
        The pending value of the "idle timeout" attribute.
        See Also:
        getIdleTimeout()
      • setIdleTimeout

        public void setIdleTimeout(int value)
        Sets the value of the "idle timeout" attribute. This attribute represents the amount of time, in seconds, that a connection to the NetServer will remain active once activity has ceased on that connection. An idle time-out value of (NO_AUTO_DISCONNECT) indicates no autodisconnect.
        Parameters:
        value - The value of the "idle timeout" attribute.
      • getLANManagerAuthentication

        public int getLANManagerAuthentication()
        Returns the value of the "LAN Manager authentication" attribute. This attribute represents the level of restriction on the use of the LANMAN password hash for authentication. Possible values are PASSWORD_STRONGER and PASSWORD_STRONGER_OR_MISMATCH.
        Note: This attribute is not supported prior to IBM i release V5R4.
        Returns:
        The value of the "LAN Manager authentication" attribute.
      • getLANManagerAuthenticationPending

        public int getLANManagerAuthenticationPending()
        Returns the pending value of the "LAN Manager authentication" attribute.
        Note: This attribute is not supported prior to IBM i release V5R4.
        Returns:
        The pending value of the "LAN Manager authentication" attribute.
        See Also:
        getLANManagerAuthentication()
      • setLANManagerAuthentication

        public void setLANManagerAuthentication(int value)
        Sets the value of the "LAN Manager authentication" attribute. This attribute represents the level of restriction on the use of the LANMAN password hash for authentication. Possible values are PASSWORD_STRONGER and PASSWORD_STRONGER_OR_MISMATCH.
        Note: This attribute is not supported prior to IBM i release V5R4.
        Parameters:
        value - The value of the "LAN Manager authentication" attribute.
      • isLogonServer

        public boolean isLogonServer()
        Returns the value of the "logon support" attribute. This attribute indicates the logon system role for the system. If true, then the server is a logon server; if false, the server is not a logon server.
        Note: This attribute corresponds to the "server role" field specified in the NetServer API's.
        Returns:
        The value of the "logon support" attribute.
      • isLogonServerPending

        public boolean isLogonServerPending()
        Returns the pending value of the "logon support" attribute.
        Returns:
        The pending value of the "logon support" attribute.
        See Also:
        isLogonServer()
      • setLogonServer

        public void setLogonServer(boolean value)
        Sets the value of the "logon support" attribute. This attribute indicates the logon server role for the server. If true, then the server is a logon server; if false, the server is not a logon server.
        Note: This attribute corresponds to the "server role" field specified in the NetServer API's.
        Parameters:
        value - The value of the "logon support" attribute.
      • getMessageAuthentication

        public int getMessageAuthentication()
        Returns the value of the "message authentication" attribute. This attribute represents the status of message authentication. Possible values are MSG_AUTH_NOT_SUPPORTED, MSG_AUTH_NEGOTIATED, and MSG_AUTH_REQUIRED.
        Note: This attribute is not supported prior to IBM i release V5R4.
        Returns:
        The value of the "message authentication" attribute.
      • getMessageAuthenticationPending

        public int getMessageAuthenticationPending()
        Returns the pending value of the "message authentication" attribute.
        Note: This attribute is not supported prior to IBM i release V5R4.
        Returns:
        The pending value of the "message authentication" attribute.
        See Also:
        getMessageAuthentication()
      • setMessageAuthentication

        public void setMessageAuthentication(int value)
        Sets the value of the "message authentication" attribute. This attribute represents the status of message authentication. Possible values are MSG_AUTH_NOT_SUPPORTED, MSG_AUTH_NEGOTIATED, and MSG_AUTH_REQUIRED.
        Note: This attribute is not supported prior to IBM i release V5R4.
        Parameters:
        value - The value of the "message authentication" attribute.
      • getMinimumMessageSeverity

        public int getMinimumMessageSeverity()
        Returns the value of the "minimum message severity" attribute. This attribute represents the minimum message severity of administrative alerts to send to users of the system. A value of (NO_ADMIN_ALERTS) indicates that administrative alert messages are not sent.
        Note: This attribute is not supported prior to IBM i release V5R4.
        Returns:
        The value of the "minimum message severity" attribute.
      • getMinimumMessageSeverityPending

        public int getMinimumMessageSeverityPending()
        Returns the pending value of the "minimum message severity" attribute.
        Note: This attribute is not supported prior to IBM i release V5R4.
        Returns:
        The pending value of the "minimum message severity" attribute.
        See Also:
        getMinimumMessageSeverity()
      • setMinimumMessageSeverity

        public void setMinimumMessageSeverity(int value)
        Sets the value of the "minimum message severity" attribute. This attribute represents the minimum message severity of administrative alerts to send to users of the system. A value of (NO_ADMIN_ALERTS) indicates that administrative alert messages are not sent.
        Note: This attribute is not supported prior to IBM i release V5R4.
        Parameters:
        value - The value of the "minimum message severity" attribute.
      • getName

        public java.lang.String getName()
        Returns the value of the "NetServer name" attribute. This attribute represents the name of the NetServer.
        Note: The NetServer name is always uppercase on the system.
        Returns:
        The value of the "NetServer name" attribute.
      • getNamePending

        public java.lang.String getNamePending()
        Returns the pending value of the "NetServer name" attribute.
        Returns:
        The pending value of the "NetServer name" attribute.
        See Also:
        getName()
      • setName

        public void setName(java.lang.String value)
        Sets the value of the "NetServer name" attribute. This attribute represents the name of the NetServer.
        Note: The NetServer name is always uppercase on the system.
        Parameters:
        value - The value of the "NetServer name" attribute.
      • getOpportunisticLockTimeout

        public int getOpportunisticLockTimeout()
        Returns the value of the "opportunistic lock timeout" attribute. This attribute represents the amount of time, in seconds, that the system will wait for a response to a break lock request sent to a lock holder, before forcefully removing the lock. A value of (OPP_LOCK_DISABLED) indicates that opportunistic locking is disabled. The default value is 30 seconds.
        Note: This attribute is not supported prior to IBM i release V5R4.
        Returns:
        The value of the "opportunistic lock timeout" attribute.
      • getOpportunisticLockTimeoutPending

        public int getOpportunisticLockTimeoutPending()
        Returns the pending value of the "opportunistic lock timeout" attribute.
        Note: This attribute is not supported prior to IBM i release V5R4.
        Returns:
        The pending value of the "opportunistic lock timeout" attribute.
        See Also:
        getOpportunisticLockTimeout()
      • setOpportunisticLockTimeout

        public void setOpportunisticLockTimeout(int value)
        Sets the value of the "opportunistic lock timeout" attribute. This attribute represents the amount of time, in seconds, that the system will wait for a response to a break lock request sent to a lock holder, before forcefully removing the lock. A value of (OPP_LOCK_DISABLED) indicates that opportunistic locking is disabled. The default value is 30 seconds.
        Note: This attribute is not supported prior to IBM i release V5R4.
        Parameters:
        value - The value of the "opportunistic lock timeout" attribute.
      • isWINSServer

        public boolean isWINSServer()
        Returns the value of the "WINS enablement" attribute. This attribute indicates whether the system uses a WINS server. Note: This attribute is also referred to as the "server role".
        Returns:
        The value of the "WINS enablement" attribute.
      • isWINSServerPending

        public boolean isWINSServerPending()
        Returns the pending value of the "WINS enablement" attribute.
        Returns:
        The pending value of the "WINS enablement" attribute.
        See Also:
        isWINSServer()
      • setWINSServer

        public void setWINSServer(boolean value)
        Sets the value of the "WINS enablement" attribute. This attribute indicates whether the system uses a WINS server. Note: This attribute is also referred to as the "server role".
        Parameters:
        value - The value of the "WINS enablement" attribute.
      • getWINSPrimaryAddress

        public java.lang.String getWINSPrimaryAddress()
        Returns the value of the "WINS primary address" attribute. This attribute represents the IP address of the primary WINS server.
        Returns:
        The value of the "WINS primary address" attribute.
      • getWINSPrimaryAddressPending

        public java.lang.String getWINSPrimaryAddressPending()
        Returns the pending value of the "WINS primary address" attribute.
        Returns:
        The pending value of the "WINS primary address" attribute.
        See Also:
        getWINSPrimaryAddress()
      • setWINSPrimaryAddress

        public void setWINSPrimaryAddress(java.lang.String value)
        Sets the value of the "WINS primary address" attribute. This attribute represents the IP address of the primary WINS server.
        Parameters:
        value - The value of the "WINS primary address" attribute.
      • getWINSScopeID

        public java.lang.String getWINSScopeID()
        Returns the value of the "WINS scope ID" attribute. This attribute represents the network scope used by the WINS server. If no scope ID is currently configured on the system, the value of this attribute is "" (an empty String).
        Returns:
        The value of the "WINS scope ID" attribute.
      • getWINSScopeIDPending

        public java.lang.String getWINSScopeIDPending()
        Returns the pending value of the "WINS scope ID" attribute.
        Returns:
        The pending value of the "WINS scope ID" attribute.
        See Also:
        getWINSScopeID()
      • setWINSScopeID

        public void setWINSScopeID(java.lang.String value)
        Sets the value of the "WINS scope ID" attribute. This attribute represents the network scope used by the WINS server. If no scope ID is currently configured on the system, the value of this attribute is "" (an empty String).
        Parameters:
        value - The value of the "WINS scope ID" attribute.
      • getWINSSecondaryAddress

        public java.lang.String getWINSSecondaryAddress()
        Returns the value of the "WINS secondary address" attribute. This attribute represents the IP address of the secondary WINS server.
        Returns:
        The value of the "WINS secondary address" attribute.
      • getWINSSecondaryAddressPending

        public java.lang.String getWINSSecondaryAddressPending()
        Returns the pending value of the "WINS secondary address" attribute.
        Returns:
        The pending value of the "WINS secondary address" attribute.
        See Also:
        getWINSSecondaryAddress()
      • setWINSSecondaryAddress

        public void setWINSSecondaryAddress(java.lang.String value)
        Sets the value of the "WINS secondary address" attribute. This attribute represents the IP address of the secondary WINS server.
        Parameters:
        value - The value of the "WINS secondary address" attribute.
      • start

        public void start()
                   throws AS400SecurityException,
                          ErrorCompletingRequestException,
                          java.lang.InterruptedException,
                          java.io.IOException,
                          ObjectDoesNotExistException
        Starts the NetServer job on the system. If the NetServer is already started, this method does nothing. This method requires *IOSYSCFG special authority on the system. If the QSERVER subsystem is not running, this method will attempt to start the subsystem.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the system object does not exist.
      • start

        public void start(boolean reset)
                   throws AS400SecurityException,
                          ErrorCompletingRequestException,
                          java.lang.InterruptedException,
                          java.io.IOException,
                          ObjectDoesNotExistException
        Starts the NetServer job on the system, and (optionally) resets it. If the NetServer is already started, this method does nothing. This method requires *IOSYSCFG special authority on the system. If the QSERVER subsystem is not running, this method will attempt to start it.

        Note: Reset is used when the NetServer fails to start normally on the system. It is on the NetServer context menu so an administrator can use it. The reset does some under-the-covers cleanup, and is used infrequently. The times it would be used is if the system ended abnormally and there may be jobs or objects hanging around that need to be cleaned up before the system can start again. The reset does that.

        Parameters:
        reset - Whether or not the system is to be reset when started. Default is no reset.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ObjectDoesNotExistException - If the system object does not exist.
      • toString

        public java.lang.String toString()
        Returns the String representation of this ISeriesNetServer object.
        Overrides:
        toString in class java.lang.Object
        Returns:
        The String representation of this ISeriesNetServer object.