public class ISeriesNetServer
extends java.lang.Object
implements java.io.Serializable
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(); }
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 and Description |
---|
ISeriesNetServer(AS400 system)
Constructs a NetServer object.
|
Modifier and Type | Method and Description |
---|---|
void |
commitChanges()
Commits all attribute value changes to the system.
|
void |
commitChanges(ISeriesNetServerFileShare share)
Commits attribute value changes to the system, for the specified share.
|
void |
commitChanges(ISeriesNetServerPrintShare share)
Commits attribute value changes to the system, 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 IBM i system.
|
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 |
getAuthenticationMethodPending()
Returns the pending value of the "authentication method" attribute.
|
int |
getBrowsingInterval()
Returns the value of the "browsing interval" attribute.
|
int |
getBrowsingIntervalPending()
Returns the pending value of the "browsing interval" attribute.
|
int |
getCCSID()
Returns the value of the "system CCSID" attribute.
|
int |
getCCSIDPending()
Returns the pending value of the "system CCSID" attribute.
|
java.lang.String |
getDescription()
Returns the value of the "description" attribute.
|
java.lang.String |
getDescriptionPending()
Returns the pending value of the "description" attribute.
|
java.lang.String |
getDomainName()
Returns the value of the "domain name" attribute.
|
java.lang.String |
getDomainNamePending()
Returns the pending value of the "domain name" attribute.
|
int |
getEncryptedConnectionEnforcement()
Returns the value of the "encrypted connection enforce" attribute.
|
int |
getEncryptedConnectionEnforcementPending()
Returns the pending value of the "Encrypted connection enforcement" attribute.
|
java.lang.String |
getGuestUserProfile()
Returns the value of the "guest user profile" attribute.
|
java.lang.String |
getGuestUserProfilePending()
Returns the pending value of the "guest user profile" attribute.
|
int |
getIdleTimeout()
Returns the value of the "idle timeout" attribute.
|
int |
getIdleTimeoutPending()
Returns the pending value of the "idle timeout" attribute.
|
int |
getLANManagerAuthentication()
Returns the value of the "LAN Manager authentication" attribute.
|
int |
getLANManagerAuthenticationPending()
Returns the pending value of the "LAN Manager authentication" attribute.
|
int |
getMessageAuthentication()
Returns the value of the "message authentication" attribute.
|
int |
getMessageAuthenticationPending()
Returns the pending value of the "message authentication" attribute.
|
int |
getMinimumMessageSeverity()
Returns the value of the "minimum message severity" attribute.
|
int |
getMinimumMessageSeverityPending()
Returns the pending value of the "minimum message severity" attribute.
|
java.lang.String |
getName()
Returns the value of the "NetServer name" attribute.
|
java.lang.String |
getNamePending()
Returns the pending value of the "NetServer name" attribute.
|
int |
getOpportunisticLockTimeout()
Returns the value of the "opportunistic lock timeout" attribute.
|
int |
getOpportunisticLockTimeoutPending()
Returns the pending value of the "opportunistic lock timeout" attribute.
|
java.lang.String |
getServerAuthorizationList()
Returns the value of the "Server Authorization List" attribute.
|
java.lang.String |
getServerAuthorizationListPending()
Returns the pending value of the "Server Authorization List" attribute.
|
AS400 |
getSystem()
Returns the system.
|
java.lang.String |
getWINSPrimaryAddress()
Returns the value of the "WINS primary address" attribute.
|
java.lang.String |
getWINSPrimaryAddressPending()
Returns the pending value of the "WINS primary address" attribute.
|
java.lang.String |
getWINSScopeID()
Returns the value of the "WINS scope ID" attribute.
|
java.lang.String |
getWINSScopeIDPending()
Returns the pending value of the "WINS scope ID" attribute.
|
java.lang.String |
getWINSSecondaryAddress()
Returns the value of the "WINS secondary address" attribute.
|
java.lang.String |
getWINSSecondaryAddressPending()
Returns the pending value of the "WINS secondary address" attribute.
|
boolean |
isAllowSystemName()
Returns the value of the "allow system name" attribute.
|
boolean |
isAllowSystemNamePending()
Returns the pending value of the "allow system name" attribute.
|
boolean |
isAutoStart()
Returns the value of the "autostart" attribute.
|
boolean |
isAutoStartPending()
Returns the pending value of the "autostart" attribute.
|
boolean |
isLogonServer()
Returns the value of the "logon support" attribute.
|
boolean |
isLogonServerPending()
Returns the pending value of the "logon support" attribute.
|
boolean |
isStarted()
Indicates whether or not the NetServer job on the system is started.
|
boolean |
isWINSServer()
Returns the value of the "WINS enablement" attribute.
|
boolean |
isWINSServerPending()
Returns the pending 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 system.
|
void |
refresh(ISeriesNetServerConnection connection)
Refreshes the attribute values of the connection object, from the current values on the system.
|
void |
refresh(ISeriesNetServerSession session)
Refreshes the attribute values of the session object, from the current values on the system.
|
void |
refresh(ISeriesNetServerShare share)
Refreshes the attribute values of the share object, from the currently in-effect values on the system.
|
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 "system 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 |
setEncryptedConnectionEnforcement(int value)
Sets the value of the "Encrypted connection enforcement" 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 |
setLANManagerAuthentication(int value)
Sets the value of the "LAN Manager authentication" attribute.
|
void |
setLogonServer(boolean value)
Sets the value of the "logon support" attribute.
|
void |
setMessageAuthentication(int value)
Sets the value of the "message authentication" attribute.
|
void |
setMinimumMessageSeverity(int value)
Sets the value of the "minimum message severity" attribute.
|
void |
setName(java.lang.String value)
Sets the value of the "NetServer name" attribute.
|
void |
setOpportunisticLockTimeout(int value)
Sets the value of the "opportunistic lock timeout" attribute.
|
void |
setServerAuthorizationList(java.lang.String value)
Sets the value of the "Server Authorization List" 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 system.
|
void |
start(boolean reset)
Starts the NetServer job on the system, and (optionally) resets it.
|
java.lang.String |
toString()
Returns the String representation of this ISeriesNetServer object.
|
public static final int ENCRYPTED_PASSWORDS
public static final int NETWORK_AUTHENTICATION
public static final int KERBEROS_V5_TOKENS
public static final int NETWORK_AUTHENTICATION_OR_PASSWORDS
public static final int KERBEROS_OR_PASSWORDS
public static final int NO_AUTO_DISCONNECT
public static final int OPP_LOCK_DISABLED
public static final int MSG_AUTH_NOT_SUPPORTED
public static final int MSG_AUTH_NEGOTIATED
public static final int MSG_AUTH_REQUIRED
public static final int NO_ADMIN_ALERTS
public static final int PASSWORD_STRONGER
public static final int PASSWORD_STRONGER_OR_MISMATCH
public ISeriesNetServer(AS400 system)
system
- The system with which the NetServer is associated.public void createFileShare(java.lang.String shareName, java.lang.String path) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException, ObjectDoesNotExistException
shareName
- The name of the share.path
- The path of the share.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.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
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:
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.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
shareName
- The name of the share.path
- The path of the share.desc
- The description of the share.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.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
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.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.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
ISeriesNetServerPrintShare.AUTO_DETECT
.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.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.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
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:
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.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
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.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.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
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.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.public AS400 getSystem()
public ISeriesNetServerFileShare[] listFileShares() throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException, ObjectDoesNotExistException
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.public ISeriesNetServerFileShare[] listFileShares(java.lang.String shareName) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException, ObjectDoesNotExistException
shareName
- The name of the share to list.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.public ISeriesNetServerPrintShare[] listPrintShares() throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException, ObjectDoesNotExistException
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.public ISeriesNetServerPrintShare[] listPrintShares(java.lang.String shareName) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException, ObjectDoesNotExistException
shareName
- The name of the share to list.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.public ISeriesNetServerShare[] listShares() throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException, ObjectDoesNotExistException
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.public ISeriesNetServerSession[] listSessions() throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException, ObjectDoesNotExistException
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.public ISeriesNetServerSession[] listSessionsForWorkstation(java.lang.String name) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException, ObjectDoesNotExistException
name
- The name of the workstation.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.public ISeriesNetServerConnection[] listConnectionsForSession(long sessionID) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException, ObjectDoesNotExistException
sessionID
- The session ID.
Note: The "session identifier" was added to the NetServer API's in V5R1.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.public ISeriesNetServerConnection[] listConnectionsForSession(java.lang.String workstationName) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException, ObjectDoesNotExistException
workstationName
- The name of the workstation.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.public ISeriesNetServerConnection[] listConnectionsForShare(java.lang.String shareName) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException, ObjectDoesNotExistException
shareName
- The name of the share.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.public void removeShare(java.lang.String shareName) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException, ObjectDoesNotExistException
shareName
- The name of the share.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.public boolean isAllowSystemName()
public boolean isAllowSystemNamePending()
isAllowSystemName()
public void setAllowSystemName(boolean value)
value
- The value of the "allow system name" attribute.public int getAuthenticationMethod()
ENCRYPTED_PASSWORDS
, NETWORK_AUTHENTICATION
, and NETWORK_AUTHENTICATION_OR_PASSWORDS
.public int getAuthenticationMethodPending()
getAuthenticationMethod()
public void setAuthenticationMethod(int value)
value
- The value of the "authentication method" attribute.
Valid values are ENCRYPTED_PASSWORDS
, NETWORK_AUTHENTICATION
, and NETWORK_AUTHENTICATION_OR_PASSWORDS
.public boolean isAutoStart() throws AS400SecurityException
AS400SecurityException
- If a security or authority error occurs.public boolean isAutoStartPending() throws AS400SecurityException
AS400SecurityException
- If a security or authority error occurs.isAutoStart()
public void setAutoStart(boolean value)
commitChanges
. That is, a NetServer restart is not necessary.value
- The pending value of the "autostart" attribute.public int getBrowsingInterval()
public int getBrowsingIntervalPending()
getBrowsingInterval()
public void setBrowsingInterval(int value)
value
- The value of the "browsing interval" attribute.public int getCCSID()
public int getCCSIDPending()
getCCSID()
public void setCCSID(int value)
value
- The value of the "system CCSID" attribute.public java.lang.String getDescription()
public java.lang.String getDescriptionPending()
getDescription()
public void setDescription(java.lang.String value)
value
- The value of the "description" attribute.
Maximum length is 50 characters.public java.lang.String getDomainName()
public java.lang.String getDomainNamePending()
getDomainName()
public void setDomainName(java.lang.String value)
value
- The value of the "domain name" attribute.public java.lang.String getGuestUserProfile()
public java.lang.String getGuestUserProfilePending()
getGuestUserProfile()
public void setGuestUserProfile(java.lang.String value)
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.
value
- The value of the "guest user profile" attribute.public int getIdleTimeout()
NO_AUTO_DISCONNECT
) indicates no autodisconnect.public int getIdleTimeoutPending()
getIdleTimeout()
public void setIdleTimeout(int value)
NO_AUTO_DISCONNECT
) indicates no autodisconnect.value
- The value of the "idle timeout" attribute.public int getLANManagerAuthentication()
PASSWORD_STRONGER
and PASSWORD_STRONGER_OR_MISMATCH
.
public int getLANManagerAuthenticationPending()
getLANManagerAuthentication()
public void setLANManagerAuthentication(int value)
PASSWORD_STRONGER
and PASSWORD_STRONGER_OR_MISMATCH
.
value
- The value of the "LAN Manager authentication" attribute.public boolean isLogonServer()
public boolean isLogonServerPending()
isLogonServer()
public void setLogonServer(boolean value)
value
- The value of the "logon support" attribute.public int getMessageAuthentication()
MSG_AUTH_NOT_SUPPORTED
, MSG_AUTH_NEGOTIATED
, and MSG_AUTH_REQUIRED
.
public int getMessageAuthenticationPending()
getMessageAuthentication()
public void setMessageAuthentication(int value)
MSG_AUTH_NOT_SUPPORTED
, MSG_AUTH_NEGOTIATED
, and MSG_AUTH_REQUIRED
.
value
- The value of the "message authentication" attribute.public int getMinimumMessageSeverity()
NO_ADMIN_ALERTS
) indicates that administrative alert messages are not sent.
public int getMinimumMessageSeverityPending()
getMinimumMessageSeverity()
public void setMinimumMessageSeverity(int value)
NO_ADMIN_ALERTS
) indicates that administrative alert messages are not sent.
value
- The value of the "minimum message severity" attribute.public java.lang.String getName()
public java.lang.String getNamePending()
getName()
public void setName(java.lang.String value)
value
- The value of the "NetServer name" attribute.public int getOpportunisticLockTimeout()
OPP_LOCK_DISABLED
) indicates that opportunistic locking is disabled.
The default value is 30 seconds.
public int getOpportunisticLockTimeoutPending()
getOpportunisticLockTimeout()
public void setOpportunisticLockTimeout(int value)
OPP_LOCK_DISABLED
) indicates that opportunistic locking is disabled.
The default value is 30 seconds.
value
- The value of the "opportunistic lock timeout" attribute.public boolean isWINSServer()
public boolean isWINSServerPending()
isWINSServer()
public void setWINSServer(boolean value)
value
- The value of the "WINS enablement" attribute.public java.lang.String getWINSPrimaryAddress()
public java.lang.String getWINSPrimaryAddressPending()
getWINSPrimaryAddress()
public void setWINSPrimaryAddress(java.lang.String value)
value
- The value of the "WINS primary address" attribute.public java.lang.String getWINSScopeID()
public java.lang.String getWINSScopeIDPending()
getWINSScopeID()
public void setWINSScopeID(java.lang.String value)
value
- The value of the "WINS scope ID" attribute.public java.lang.String getWINSSecondaryAddress()
public java.lang.String getWINSSecondaryAddressPending()
getWINSSecondaryAddress()
public void setWINSSecondaryAddress(java.lang.String value)
value
- The value of the "WINS secondary address" attribute.public void refresh() throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException, ObjectDoesNotExistException
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.public void commitChanges() throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException, ObjectDoesNotExistException
end
) and restarted (start
).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.public void end() throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException, ObjectDoesNotExistException
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.public void endSession(long sessionID) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException, ObjectDoesNotExistException
sessionID
- 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.public void endSessionsForWorkstation(java.lang.String workstationName) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException, ObjectDoesNotExistException
workstationName
- 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.public boolean isStarted() throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException, ObjectDoesNotExistException
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.public void start() throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException, ObjectDoesNotExistException
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.public void start(boolean reset) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException, ObjectDoesNotExistException
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.
reset
- Whether or not the system is to be reset when started. Default is no reset.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.public void refresh(ISeriesNetServerConnection connection) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException, ObjectDoesNotExistException
connection
- The connection.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.public void refresh(ISeriesNetServerSession session) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException, ObjectDoesNotExistException
session
- The session.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.public void refresh(ISeriesNetServerShare share) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException, ObjectDoesNotExistException
share
- The share.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.public java.lang.String toString()
toString
in class java.lang.Object
public void commitChanges(ISeriesNetServerFileShare share) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException, ObjectDoesNotExistException
share
- The share.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.public void commitChanges(ISeriesNetServerPrintShare share) throws AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException, ObjectDoesNotExistException
share
- The share.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.public int getEncryptedConnectionEnforcement()
public int getEncryptedConnectionEnforcementPending()
getEncryptedConnectionEnforcement()
public void setEncryptedConnectionEnforcement(int value)
value
- The value of the "Encrypted connection enforcement" attribute.public java.lang.String getServerAuthorizationList()
public java.lang.String getServerAuthorizationListPending()
getEncryptedConnectionEnforcement()
public void setServerAuthorizationList(java.lang.String value)
value
- The value of the "Encrypted connection enforcement" attribute.