Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

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

The ISeriesNetServer class represents the NetServer service on a server. This class allows the user to query and modify the state and configuration of the NetServer.

If the NetServer job on the iSeries server 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: Calling any of the attribute getters for the first time will result in an implicit call to refresh, if not yet explicitly refreshed. 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 server 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 servers running OS/400 V5R1 or later. 

 import com.ibm.as400.access.*;

 // Create a NetServer object for a specific server 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
static int ENCRYPTED_PASSWORDS
          Value of the NetServer "authentication method" attribute, indicating that the server authenticates with encrypted passwords only.
static int KERBEROS_OR_PASSWORDS
          Value of the NetServer "authentication method" attribute, indicating that the server authenticates with Kerberos v5 tokens when possible, but it allows clients to use encrypted passwords when needed.
static int KERBEROS_V5_TOKENS
          Value of the NetServer "authentication method" attribute, indicating that the server authenticates with Kerberos v5 tokens only.
static int NO_AUTO_DISCONNECT
          Value of the "idle timeout" attribute, indicating "no autodisconnect".
 
Constructor Summary
ISeriesNetServer(AS400 system)
          Constructs a NetServer object.
 
Method Summary
 void commitChanges()
          Commits all attribute value changes to the server.
 void commitChanges(ISeriesNetServerFileShare share)
          Commits attribute value changes to the server, for the specified share.
 void commitChanges(ISeriesNetServerPrintShare share)
          Commits attribute value changes to the server, for the specified share.
 void createFileShare(java.lang.String shareName, java.lang.String path)
          Creates a file share.
 void createFileShare(java.lang.String shareName, java.lang.String path, java.lang.String desc)
          Creates a file share.
 void createFileShare(java.lang.String shareName, java.lang.String path, java.lang.String desc, int permission)
          Creates a file share.
 void createFileShare(java.lang.String shareName, java.lang.String path, java.lang.String desc, int permission, int maxUsers)
          Creates a file share.
 void createPrintShare(java.lang.String shareName, java.lang.String outqLib, java.lang.String outqName)
          Creates a print share.
 void createPrintShare(java.lang.String shareName, java.lang.String outqLib, java.lang.String outqName, java.lang.String desc, int splfType)
          Creates a print share.
 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)
          Creates a print share.
 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)
          Creates a print share.
 void end()
          Ends the NetServer job on the iSeries server.
 void endSession(long sessionID)
          Ends a specific NetServer session.
 void endSessionsForWorkstation(java.lang.String workstationName)
          Ends all the sessions that were established from the specified workstation.
 int getAuthenticationMethod()
          Returns the value of the "authentication method" attribute.
 int getBrowsingInterval()
          Returns the value of the "browsing interval" attribute.
 int getCCSID()
          Returns the value of the "server CCSID" attribute.
 java.lang.String getDescription()
          Returns the value of the "description" attribute.
 java.lang.String getDomainName()
          Returns the value of the "domain name" attribute.
 java.lang.String getGuestUserProfile()
          Returns the value of the "guest user profile" attribute.
 int getIdleTimeout()
          Returns the value of the "idle timeout" attribute.
 java.lang.String getName()
          Returns the value of the "NetServer name" attribute.
 AS400 getSystem()
          Returns the system.
 java.lang.String getWINSPrimaryAddress()
          Returns the value of the "WINS primary address" attribute.
 java.lang.String getWINSScopeID()
          Returns the value of the "WINS scope ID" attribute.
 java.lang.String getWINSSecondaryAddress()
          Returns the value of the "WINS secondary address" attribute.
 boolean isAllowSystemName()
          Returns the value of the "allow system name" attribute.
 boolean isAutoStart()
          Returns the value of the "autostart" attribute.
 boolean isLogonServer()
          Returns the value of the "logon support" attribute.
 boolean isStarted()
          Indicates whether or not the NetServer job on the iSeries server is started.
 boolean isWINSServer()
          Returns the value of the "WINS enablement" attribute.
 ISeriesNetServerConnection[] listConnectionsForSession(long sessionID)
          Lists all connections for the specified NetServer session.
 ISeriesNetServerConnection[] listConnectionsForSession(java.lang.String workstationName)
          Lists all connections for the specified NetServer workstation.
 ISeriesNetServerConnection[] listConnectionsForShare(java.lang.String shareName)
          Returns the connections associated with a specific share.
 ISeriesNetServerFileShare[] listFileShares()
          Lists all file shares.
 ISeriesNetServerFileShare[] listFileShares(java.lang.String shareName)
          Lists the file shares.
 ISeriesNetServerPrintShare[] listPrintShares()
          Lists all print shares.
 ISeriesNetServerPrintShare[] listPrintShares(java.lang.String shareName)
          Lists the print shares.
 ISeriesNetServerSession[] listSessions()
          Lists all NetServer sessions.
 ISeriesNetServerSession[] listSessionsForWorkstation(java.lang.String name)
          Lists all NetServer sessions for the specified workstation.
 ISeriesNetServerShare[] listShares()
          Lists the shares (both file shares and print shares).
 void refresh()
          Refreshes the attribute values of this ISeriesNetServer object, from the current in-effect values on the server.
 void refresh(ISeriesNetServerConnection connection)
          Refreshes the attribute values of the connection object, from the current values on the server.
 void refresh(ISeriesNetServerSession session)
          Refreshes the attribute values of the session object, from the current values on the server.
 void refresh(ISeriesNetServerShare share)
          Refreshes the attribute values of the share object, from the currently in-effect values on the server.
 void removeShare(java.lang.String shareName)
          Removes the specified share.
 void setAllowSystemName(boolean value)
          Sets the value of the "allow system name" attribute.
 void setAuthenticationMethod(int value)
          Sets the value of the "authentication method" attribute.
 void setAutoStart(boolean value)
          Sets the value of the "autostart" attribute.
 void setBrowsingInterval(int value)
          Sets the value of the "browsing interval" attribute.
 void setCCSID(int value)
          Sets the value of the "server CCSID" attribute.
 void setDescription(java.lang.String value)
          Sets the value of the "description" attribute.
 void setDomainName(java.lang.String value)
          Sets the value of the "domain name" attribute.
 void setGuestUserProfile(java.lang.String value)
          Sets the value of the "guest user profile" attribute.
 void setIdleTimeout(int value)
          Sets the value of the "idle timeout" attribute.
 void setLogonServer(boolean value)
          Sets the value of the "logon support" attribute.
 void setName(java.lang.String value)
          Sets the value of the "NetServer name" attribute.
 void setWINSPrimaryAddress(java.lang.String value)
          Sets the value of the "WINS primary address" attribute.
 void setWINSScopeID(java.lang.String value)
          Sets the value of the "WINS scope ID" attribute.
 void setWINSSecondaryAddress(java.lang.String value)
          Sets the value of the "WINS secondary address" attribute.
 void setWINSServer(boolean value)
          Sets the value of the "WINS enablement" attribute.
 void start()
          Starts the NetServer job on the iSeries server.
 void start(boolean reset)
          Starts the NetServer job on the iSeries server, and (optionally) resets it.
 java.lang.String toString()
          Returns the String representation of this ISeriesNetServer object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ENCRYPTED_PASSWORDS

public static final int ENCRYPTED_PASSWORDS
Value of the NetServer "authentication method" attribute, indicating that the server authenticates with encrypted passwords only.

See Also:
Constant Field Values

KERBEROS_V5_TOKENS

public static final int KERBEROS_V5_TOKENS
Value of the NetServer "authentication method" attribute, indicating that the server authenticates with Kerberos v5 tokens only.

See Also:
Constant Field Values

KERBEROS_OR_PASSWORDS

public static final int KERBEROS_OR_PASSWORDS
Value of the NetServer "authentication method" attribute, indicating that the server authenticates with Kerberos v5 tokens when possible, but it allows clients to use encrypted passwords when needed.
Note: This value is valid only for OS/400 releases after (not including) V5R2.

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
Constructor Detail

ISeriesNetServer

public ISeriesNetServer(AS400 system)
Constructs a NetServer object.

Parameters:
system - The server with which the NetServer is associated.
Method Detail

createFileShare

public void createFileShare(java.lang.String shareName,
                            java.lang.String path)
                     throws AS400SecurityException,
                            ErrorCompletingRequestException,
                            java.lang.InterruptedException,
                            java.io.IOException,
                            ObjectDoesNotExistException
Creates a file share.

Parameters:
shareName - The name of the share.
path - The path of the share.
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 server.
ObjectDoesNotExistException - If the server object does not exist.

createFileShare

public void createFileShare(java.lang.String shareName,
                            java.lang.String path,
                            java.lang.String desc,
                            int permission)
                     throws AS400SecurityException,
                            ErrorCompletingRequestException,
                            java.lang.InterruptedException,
                            java.io.IOException,
                            ObjectDoesNotExistException
Creates a file share.

Parameters:
shareName - The name of the share.
path - The path of the share.
desc - The description of the share.
permission - The permission of the share. Valid values are:
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 server.
ObjectDoesNotExistException - If the server object does not exist.

createFileShare

public void createFileShare(java.lang.String shareName,
                            java.lang.String path,
                            java.lang.String desc)
                     throws AS400SecurityException,
                            ErrorCompletingRequestException,
                            java.lang.InterruptedException,
                            java.io.IOException,
                            ObjectDoesNotExistException
Creates a file share.

Parameters:
shareName - The name of the share.
path - The path of the share.
desc - The description of the share.
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 server.
ObjectDoesNotExistException - If the server object does not exist.

createFileShare

public void createFileShare(java.lang.String shareName,
                            java.lang.String path,
                            java.lang.String desc,
                            int permission,
                            int maxUsers)
                     throws AS400SecurityException,
                            ErrorCompletingRequestException,
                            java.lang.InterruptedException,
                            java.io.IOException,
                            ObjectDoesNotExistException
Creates a file share.

Parameters:
shareName - The name of the share.
path - The path of the share.
desc - The description of the share.
permission - The permission of the share. Valid values are: The default is READ_ONLY.
maxUsers - The maximum number of users of the share.
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 server.
ObjectDoesNotExistException - If the server object does not exist.

createPrintShare

public void createPrintShare(java.lang.String shareName,
                             java.lang.String outqLib,
                             java.lang.String outqName)
                      throws AS400SecurityException,
                             ErrorCompletingRequestException,
                             java.lang.InterruptedException,
                             java.io.IOException,
                             ObjectDoesNotExistException
Creates a print share. The spooled file type is set to ISeriesNetServerPrintShare.AUTO_DETECT.

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.
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 server.
ObjectDoesNotExistException - If the server object does not exist.

createPrintShare

public void createPrintShare(java.lang.String shareName,
                             java.lang.String outqLib,
                             java.lang.String outqName,
                             java.lang.String desc,
                             int splfType)
                      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:
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 server.
ObjectDoesNotExistException - If the server object does not exist.

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)
                      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.
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 server.
ObjectDoesNotExistException - If the server object does not exist.

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 server.
ObjectDoesNotExistException - If the server object does not exist.

getSystem

public AS400 getSystem()
Returns the system.

Returns:
The system.

listFileShares

public ISeriesNetServerFileShare[] listFileShares()
                                           throws AS400SecurityException,
                                                  ErrorCompletingRequestException,
                                                  java.lang.InterruptedException,
                                                  java.io.IOException,
                                                  ObjectDoesNotExistException
Lists all file shares.

Returns:
The file shares.
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 server.
ObjectDoesNotExistException - If the server object does not exist.

listFileShares

public ISeriesNetServerFileShare[] listFileShares(java.lang.String shareName)
                                           throws AS400SecurityException,
                                                  ErrorCompletingRequestException,
                                                  java.lang.InterruptedException,
                                                  java.io.IOException,
                                                  ObjectDoesNotExistException
Lists the file shares.

Parameters:
shareName - The name of the share to list.
Returns:
The file shares.
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 server.
ObjectDoesNotExistException - If the server object does not exist.

listPrintShares

public ISeriesNetServerPrintShare[] listPrintShares()
                                             throws AS400SecurityException,
                                                    ErrorCompletingRequestException,
                                                    java.lang.InterruptedException,
                                                    java.io.IOException,
                                                    ObjectDoesNotExistException
Lists all print shares.

Returns:
The print shares.
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 server.
ObjectDoesNotExistException - If the server object does not exist.

listPrintShares

public ISeriesNetServerPrintShare[] listPrintShares(java.lang.String shareName)
                                             throws AS400SecurityException,
                                                    ErrorCompletingRequestException,
                                                    java.lang.InterruptedException,
                                                    java.io.IOException,
                                                    ObjectDoesNotExistException
Lists the print shares.

Parameters:
shareName - The name of the share to list.
Returns:
The print shares.
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 server.
ObjectDoesNotExistException - If the server object does not exist.

listShares

public ISeriesNetServerShare[] listShares()
                                   throws AS400SecurityException,
                                          ErrorCompletingRequestException,
                                          java.lang.InterruptedException,
                                          java.io.IOException,
                                          ObjectDoesNotExistException
Lists the shares (both file shares and print shares).

Returns:
The shares.
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 server.
ObjectDoesNotExistException - If the server object does not exist.

listSessions

public ISeriesNetServerSession[] listSessions()
                                       throws AS400SecurityException,
                                              ErrorCompletingRequestException,
                                              java.lang.InterruptedException,
                                              java.io.IOException,
                                              ObjectDoesNotExistException
Lists all NetServer sessions.

Returns:
The current sessions.
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 server.
ObjectDoesNotExistException - If the server object does not exist.

listSessionsForWorkstation

public ISeriesNetServerSession[] listSessionsForWorkstation(java.lang.String name)
                                                     throws AS400SecurityException,
                                                            ErrorCompletingRequestException,
                                                            java.lang.InterruptedException,
                                                            java.io.IOException,
                                                            ObjectDoesNotExistException
Lists all NetServer sessions for the specified workstation.

Parameters:
name - The name of the workstation.
Returns:
The current sessions for the workstation.
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 server.
ObjectDoesNotExistException - If the server object does not exist.

listConnectionsForSession

public ISeriesNetServerConnection[] listConnectionsForSession(long sessionID)
                                                       throws AS400SecurityException,
                                                              ErrorCompletingRequestException,
                                                              java.lang.InterruptedException,
                                                              java.io.IOException,
                                                              ObjectDoesNotExistException
Lists all connections for the specified NetServer session.

Parameters:
sessionID - The session ID. Note: The "session identifier" was added to the NetServer API's in V5R1.
Returns:
The current connections for the specified session.
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 server.
ObjectDoesNotExistException - If the server object does not exist.

listConnectionsForSession

public ISeriesNetServerConnection[] listConnectionsForSession(java.lang.String workstationName)
                                                       throws AS400SecurityException,
                                                              ErrorCompletingRequestException,
                                                              java.lang.InterruptedException,
                                                              java.io.IOException,
                                                              ObjectDoesNotExistException
Lists all connections for the specified NetServer workstation.

Parameters:
workstationName - The name of the workstation.
Returns:
The current connections for the specified session.
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 server.
ObjectDoesNotExistException - If the server object does not exist.

listConnectionsForShare

public ISeriesNetServerConnection[] listConnectionsForShare(java.lang.String shareName)
                                                     throws AS400SecurityException,
                                                            ErrorCompletingRequestException,
                                                            java.lang.InterruptedException,
                                                            java.io.IOException,
                                                            ObjectDoesNotExistException
Returns the connections associated with a specific share.

Parameters:
shareName - The name of the share.
Returns:
The connections for the specified share.
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 server.
ObjectDoesNotExistException - If the server object does not exist.

removeShare

public void removeShare(java.lang.String shareName)
                 throws AS400SecurityException,
                        ErrorCompletingRequestException,
                        java.lang.InterruptedException,
                        java.io.IOException,
                        ObjectDoesNotExistException
Removes the specified share.

Parameters:
shareName - The name of the share.
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 server.
ObjectDoesNotExistException - If the server object does not exist.

isAllowSystemName

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

Returns:
The "allow system name" attribute

setAllowSystemName

public void setAllowSystemName(boolean value)
Sets the value of the "allow system name" attribute. This attribute indicates whether access is allowed to the server using the server'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 iSeries server has OS/400 release V5R2 or later.

Returns:
The value of the "authentication method" attribute. Valid values are ENCRYPTED_PASSWORDS, KERBEROS_V5_TOKENS, and KERBEROS_OR_PASSWORDS.

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 iSeries server has OS/400 release V5R2 or later.

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 server. 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.

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.

Returns:
The 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 server announcement that is used for browsing. A value of zero indicates that there will be no server announcements.

Returns:
The value of the "browsing interval" attribute.

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 server announcement that is used for browsing. A value of zero indicates that there will be no server announcements.

Parameters:
value - The value of the "browsing interval" attribute.

getCCSID

public int getCCSID()
Returns the value of the "server 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 server.
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 server.

Returns:
The value of the "server CCSID" attribute.

setCCSID

public void setCCSID(int value)
Sets the value of the "server 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 server. The default value for this field is the associated ASCII CCSID for the CCSID of the job used to start the server.
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 server.

Parameters:
value - The value of the "server 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.

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.

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 server, the value of this attribute is "" (an empty String).

Returns:
The value of the "guest user profile" attribute.

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 server, the value of this attribute is "" (an empty String).

Note: Guest support allows customers to have users accessing files and printers on the server, without the requirement of a user profile on the server. 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 server 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 -1 (NO_AUTO_DISCONNECT) indicates no autodisconnect.

Returns:
The value of the "guest user profile" attribute.

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 -1 (NO_AUTO_DISCONNECT) indicates no autodisconnect.

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

isLogonServer

public boolean isLogonServer()
Returns 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.

Returns:
The value of the "logon support" attribute.

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.

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 server.

Returns:
The value of the "NetServer name" attribute.

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 server.

Parameters:
value - The value of the "NetServer name" attribute.

isWINSServer

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

Returns:
The value of the "WINS enablement" attribute.

setWINSServer

public void setWINSServer(boolean value)
Sets the value of the "WINS enablement" attribute. This attribute indicates whether the server 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.

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 server, the value of this attribute is "" (an empty String).

Returns:
The value of the "WINS scope ID" attribute.

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 server, 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.

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.

refresh

public void refresh()
             throws AS400SecurityException,
                    ErrorCompletingRequestException,
                    java.lang.InterruptedException,
                    java.io.IOException,
                    ObjectDoesNotExistException
Refreshes the attribute values of this ISeriesNetServer object, from the current in-effect values on the server.

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 server.
ObjectDoesNotExistException - If the server object does not exist.

commitChanges

public void commitChanges()
                   throws AS400SecurityException,
                          ErrorCompletingRequestException,
                          java.lang.InterruptedException,
                          java.io.IOException,
                          ObjectDoesNotExistException
Commits all attribute value changes to the server. Note that for most attributes, changes do not take effect until the NetServer process on the server is stopped (end) and restarted (start).

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 server.
ObjectDoesNotExistException - If the server object does not exist.

end

public void end()
         throws AS400SecurityException,
                ErrorCompletingRequestException,
                java.lang.InterruptedException,
                java.io.IOException,
                ObjectDoesNotExistException
Ends the NetServer job on the iSeries server.
This method requires *IOSYSCFG special authority on the server.

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 server.
ObjectDoesNotExistException - If the server object does not exist.

endSession

public void endSession(long sessionID)
                throws AS400SecurityException,
                       ErrorCompletingRequestException,
                       java.lang.InterruptedException,
                       java.io.IOException,
                       ObjectDoesNotExistException
Ends a specific NetServer session.
This method requires *IOSYSCFG special authority on the server.

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 server.
ObjectDoesNotExistException - If the server object does not exist.

endSessionsForWorkstation

public void endSessionsForWorkstation(java.lang.String workstationName)
                               throws AS400SecurityException,
                                      ErrorCompletingRequestException,
                                      java.lang.InterruptedException,
                                      java.io.IOException,
                                      ObjectDoesNotExistException
Ends all the sessions that were established from the specified workstation.
This method requires *IOSYSCFG special authority on the server.

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 server.
ObjectDoesNotExistException - If the server object does not exist.

isStarted

public boolean isStarted()
                  throws AS400SecurityException,
                         ErrorCompletingRequestException,
                         java.lang.InterruptedException,
                         java.io.IOException,
                         ObjectDoesNotExistException
Indicates whether or not the NetServer job on the iSeries server is started.

Returns:
true if the NetServer job is started; false otherwise.
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 server.
ObjectDoesNotExistException - If the server object does not exist.

start

public void start()
           throws AS400SecurityException,
                  ErrorCompletingRequestException,
                  java.lang.InterruptedException,
                  java.io.IOException,
                  ObjectDoesNotExistException
Starts the NetServer job on the iSeries server. If the NetServer is already started, this method does nothing. This method requires *IOSYSCFG special authority on the server. 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 server.
ObjectDoesNotExistException - If the server 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 iSeries server, and (optionally) resets it. If the NetServer is already started, this method does nothing. This method requires *IOSYSCFG special authority on the server. 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 server. 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 server ended abnormally and there may be jobs or objects hanging around that need to be cleaned up before the server can start again. The reset does that.

Parameters:
reset - Whether or not the server 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 server.
ObjectDoesNotExistException - If the server object does not exist.

refresh

public void refresh(ISeriesNetServerConnection connection)
             throws AS400SecurityException,
                    ErrorCompletingRequestException,
                    java.lang.InterruptedException,
                    java.io.IOException,
                    ObjectDoesNotExistException
Refreshes the attribute values of the connection object, from the current values on the server.

Parameters:
connection - The connection.
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 server.
ObjectDoesNotExistException - If the server object does not exist.

refresh

public void refresh(ISeriesNetServerSession session)
             throws AS400SecurityException,
                    ErrorCompletingRequestException,
                    java.lang.InterruptedException,
                    java.io.IOException,
                    ObjectDoesNotExistException
Refreshes the attribute values of the session object, from the current values on the server.

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 server.
ObjectDoesNotExistException - If the server object does not exist.

refresh

public void refresh(ISeriesNetServerShare share)
             throws AS400SecurityException,
                    ErrorCompletingRequestException,
                    java.lang.InterruptedException,
                    java.io.IOException,
                    ObjectDoesNotExistException
Refreshes the attribute values of the share object, from the currently in-effect values on the server. Note: This overwrites any attribute changes that have been made but not yet committed.

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 server.
ObjectDoesNotExistException - If the server 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.

commitChanges

public void commitChanges(ISeriesNetServerFileShare share)
                   throws AS400SecurityException,
                          ErrorCompletingRequestException,
                          java.lang.InterruptedException,
                          java.io.IOException,
                          ObjectDoesNotExistException
Commits attribute value changes to the server, for the specified share.

Parameters:
share - The share.
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 server.
ObjectDoesNotExistException - If the server object does not exist.

commitChanges

public void commitChanges(ISeriesNetServerPrintShare share)
                   throws AS400SecurityException,
                          ErrorCompletingRequestException,
                          java.lang.InterruptedException,
                          java.io.IOException,
                          ObjectDoesNotExistException
Commits attribute value changes to the server, for the specified share.

Parameters:
share - The share.
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 server.
ObjectDoesNotExistException - If the server object does not exist.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD