AS400 (JTOpen 20.0.8 API)

java.lang.Object
- com.ibm.as400.access.AS400

All Implemented Interfaces:

Serializable, AutoCloseable

Direct Known Subclasses:

SecureAS400
```
public class AS400
extends Object
implements Serializable, AutoCloseable
```
Represents the authentication information and a set of connections to the IBM i host servers.
If running on IBM i or an older version of that operating system, the system name, user ID, and password do not need to be supplied. These values default to the local system. For the system name, the keyword localhost can be used to specify the local system. For the user ID and password, *CURRENT can be used.
If running on another operating system, the system name, user ID, and password need to be supplied. If not supplied, the first 'open' request associated with this object will trigger a prompt to the workstation user. Subsequent opens associated with the same object will not prompt the workstation user. Keywords localhost and *CURRENT will not work when running on another operating system.
For example:
```
      AS400 system = new AS400();
      system.connectService(AS400.DATAQUEUE);   // This causes a password prompt.
      ...
      system.connectService(AS400.FILE);        // This does not cause a prompt.
 
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`String`	`aspName`
`static int`	`AUTHENTICATION_SCHEME_DDM_EUSERIDPWD`	Constant representing the DDM_EUSERIDPWD scheme - only applicable to Record Access service.
`static int`	`AUTHENTICATION_SCHEME_GSS_TOKEN`	Constant indicating the authentication scheme is GSS token.
`static int`	`AUTHENTICATION_SCHEME_IDENTITY_TOKEN`	Constant indicating the authentication scheme is identity token.
`static int`	`AUTHENTICATION_SCHEME_PASSWORD`	Constant indicating the authentication scheme is password.
`static int`	`AUTHENTICATION_SCHEME_PROFILE_TOKEN`	Constant indicating the authentication scheme is profile token.
`boolean`	`bidiAS400Text`	Determines whether Bidi processing should occur in AS400Text.toBytes() method
`boolean`	`bidiAS400Varchar`	Determines whether Bidi processing should occur in AS400Varchar.toBytes() method
`static int`	`CENTRAL`	Constant indicating the Central service.
`static boolean`	`changeCipherSuites`	Indicate whether the cipher suites changed by the caller.
`static int`	`CLIENT_TO_PROXY_SERVER`	Constant indicating that encryption should only be done on the connection between the client and the proxy server.
`static int`	`CLIENT_TO_SERVER`	Constant indicating that encryption should be done in both the connection between the client and the proxy server and the connection between the proxy server and the system.
`static int`	`CLINT_TO_SERVER`	Deprecated. Use CLIENT_TO_SERVER instead.
`static int`	`COMMAND`	Constant indicating the Command service.
`String`	`currentLib_`
`static int`	`DATABASE`	Constant indicating the Database service.
`static int`	`DATAQUEUE`	Constant indicating the Dataqueue service.
`static int`	`FILE`	Constant indicating the File service.
`static int`	`GSS_OPTION_FALLBACK`	Constant indicating that the JGSS framework will be attempted when no password or authentication token is set.
`static int`	`GSS_OPTION_MANDATORY`	Constant indicating that the JGSS framework must be used when no password or authentication token is set.
`static int`	`GSS_OPTION_NONE`	Constant indicating that the JGSS framework will not be used when no password or authentication token is set.
`static int`	`HOSTCNN`	Constant indicating the Host connection service.
`String`	`librariesForThread_`
`static String[]`	`newCipherSuites`
`static int`	`PRINT`	Constant indicating the Print service.
`static int`	`PROXY_SERVER_TO_SERVER`	Constant indicating that encryption should only be done on the connection between the proxy server and the system.
`static int`	`RECORDACCESS`	Constant indicating the Record Access service.
`static int`	`SIGNON`	Constant indicating the Sign-on service.
`static int`	`USE_PORT_MAPPER`	Special value indicating the service port should be retrieved from the port mapper server.

Constructor Summary

Constructors
Constructor	Description
`AS400()`	Constructs an AS400 object.
`AS400(AS400 system)`	Constructs an AS400 object.
`AS400(String systemName)`	Constructs an AS400 object.
`AS400(String systemName, ProfileTokenCredential profileToken)`	Constructs an AS400 object.
`AS400(String systemName, ProfileTokenProvider tokenProvider)`	Constructs an AS400 object.
`AS400(String systemName, ProfileTokenProvider tokenProvider, int refreshThreshold)`	Constructs an AS400 object.
`AS400(String systemName, String userId)`	Constructs an AS400 object.
`AS400(String systemName, String userId, char[] password)`	Constructs an AS400 object.
`AS400(String systemName, String userId, char[] password, char[] additionalAuthFactor)`	Constructs an AS400 object.
`AS400(String systemName, String userId, char[] password, String proxyServer)`	Constructs an AS400 object.
`AS400(String systemName, String userId, String password)`	Deprecated. Use AS400(String systemName, String userId, char[] password) instead
`AS400(String systemName, String userId, String password, String proxyServer)`	Deprecated. Use AS400((String systemName, String userId, char[] password, String proxyServer) instead.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`addConnectionListener(ConnectionListener listener)`	Adds a listener to be notified when a connection event occurs.
`static void`	`addPasswordCacheEntry(String systemName, String userId, char[] password)`	Validates the user ID and password, and if successful, adds the information to the password cache.
`static void`	`addPasswordCacheEntry(String systemName, String userId, char[] password, boolean useSSL)`	Validates the user ID and password, and if successful, adds the information to the password cache.
`static void`	`addPasswordCacheEntry(String systemName, String userId, char[] password, String proxyServer)`	Validates the user ID and password, and if successful, adds the information to the password cache.
`static void`	`addPasswordCacheEntry(String systemName, String userId, char[] password, String proxyServer, boolean useSSL)`	Validates the user ID and password, and if successful, adds the information to the password cache.
`static void`	`addPasswordCacheEntry(String systemName, String userId, String password)`	Deprecated. Use addPasswordCacheEntry(String systemName, String userId, char[] password) instead
`static void`	`addPasswordCacheEntry(String systemName, String userId, String password, String proxyServer)`	Deprecated. Use addPasswordCacheEntry(String systemName, String userId, char[] password, String proxyServer) instead.
`void`	`addPropertyChangeListener(PropertyChangeListener listener)`	Adds a listener to be notified when the value of any property is changed.
`void`	`addVetoableChangeListener(VetoableChangeListener listener)`	Adds a listener to be notified when the value of any constrained property is changed.
`boolean`	`arePropertiesFrozen()`	Indicates if properties are frozen.
`boolean`	`authenticate()`	Authenticate the user ID and password on the system and adds to the signon-list.
`boolean`	`authenticate(String userId, char[] password)`	Authenticates the user profile name and user profile password.
`boolean`	`authenticate(String userId, String password)`	Deprecated. Using a String as a password is insecure.
`boolean`	`canUseNativeOptimizations()`	Indicates if this AS400 object is enabled to exploit Toolbox native optimizations.
`void`	`changePassword(char[] oldPassword, char[] newPassword)`	Changes the user profile password.
`void`	`changePassword(char[] oldPassword, char[] newPassword, char[] additionalAuthFactor)`	Changes the user profile password.
`void`	`changePassword(String oldPassword, String newPassword)`	Deprecated. Use changePassword(char[] oldPassword, char[] newPassword) instead
`static void`	`clearPasswordCache()`	Clears the password cache for all systems within this Java virtual machine.
`static void`	`clearPasswordCache(String systemName)`	Clears all the passwords that are cached for the given system name within this Java virtual machine.
`void`	`close()`	This method is functionally equivalent to the resetAllServices() method.
`void`	`connectService(int service)`	Connects to a service.
`void`	`connectService(int service, int overridePort)`	Connects to a service.
`void`	`disconnectAllServices()`	Disconnects all services.
`void`	`disconnectService(int service)`	Disconnects the service.
`protected void`	`finalize()`
`ProfileTokenCredential`	`generateProfileToken(String userIdentity, int tokenType, int timeoutInterval)`	Generates a profile token on behalf of the provided user identity.
`ProfileTokenCredential`	`generateProfileToken(String userIdentity, int tokenType, int timeoutInterval, String verificationID, String remoteIPAddress)`	Generates a profile token on behalf of the provided user identity.
`static int`	`generateVRM(int version, int release, int modification)`	Generates a VRM from a version, release, and modification.
`int`	`getAuthenticationScheme()`	Returns the authentication scheme for this object.
`int`	`getBidiStringType()`	Returns bidi string type of the connection.
`int`	`getCcsid()`	Returns the CCSID for this object.
`String`	`getDDMRDB()`	Returns the relational database name (RDB name) used for record-level access (DDM) connections.
`static SignonHandler`	`getDefaultSignonHandler()`	Returns the default sign-on handler.
`static TimeZone`	`getDefaultTimeZone(AS400 system)`	Returns the timezone of the IBM i, if available.
`static String`	`getDefaultUser(String systemName)`	Returns the default user ID for this system name.
`String`	`getGSSName()`	Returns the GSS name string.
`int`	`getGSSOption()`	Returns the option for how the JGSS framework will be used.
`com.ibm.as400.access.AS400Impl`	`getImpl()`	Get underlying AS400Impl object.
`String`	`getJobCCSIDEncoding()`	Returns the encoding that corresponds to the job CCSID.
`Job[]`	`getJobs(int service)`	Returns an array of Job objects representing the jobs to which this object is connected.
`String`	`getKeyRingName()`	Deprecated.
`Locale`	`getLocale()`	Returns the Locale associated with this system object.
`int`	`getModification()`	Returns the modification level of the IBM i system.
`String`	`getNLV()`	Returns the National Language Version (NLV) that will be sent to the system.
`GregorianCalendar`	`getPasswordExpirationDate()`	Returns the password expiration date for the signed-on user.
`int`	`getPasswordExpirationDays()`	Returns the number of days until the user profile's password expires.
`static int`	`getPasswordExpirationWarningDays()`	Returns the number of days before password expiration to start warning the user.
`GregorianCalendar`	`getPreviousSignonDate()`	Returns the date of the last successful sign-on.
`ProfileTokenCredential`	`getProfileToken()`	Deprecated. Use `getProfileToken(int,int)` instead.
`ProfileTokenCredential`	`getProfileToken(int tokenType, int timeoutInterval)`	Authenticates the assigned user profile and password and returns a corresponding ProfileTokenCredential if successful.
`ProfileTokenCredential`	`getProfileToken(int tokenType, int timeoutInterval, String verificationID, String remoteIPAddress)`	Authenticates the assigned user profile and password and returns a corresponding ProfileTokenCredential if successful.
`ProfileTokenCredential`	`getProfileToken(String userId, char[] password)`	Authenticates the given user profile and password and returns a corresponding ProfileTokenCredential if successful.
`ProfileTokenCredential`	`getProfileToken(String userId, char[] password, char[] additionalAuthFactor, int tokenType, int timeoutInterval, ProfileTokenEnhancedInfo enhancedInfo)`	Authenticates the given user profile and password and returns a corresponding ProfileTokenCredential if successful.
`ProfileTokenCredential`	`getProfileToken(String userId, char[] password, char[] additionalAuthFactor, int tokenType, int timeoutInterval, String verificationID, String remoteIPAddress)`	Authenticates the given user profile and password and returns a corresponding ProfileTokenCredential if successful.
`ProfileTokenCredential`	`getProfileToken(String userId, char[] password, int tokenType, int timeoutInterval)`	Authenticates the given user profile and password and returns a corresponding ProfileTokenCredential if successful.
`ProfileTokenCredential`	`getProfileToken(String userId, String password)`	Deprecated. Use `getProfileToken(String, char[])` instead.
`ProfileTokenCredential`	`getProfileToken(String userId, String password, int tokenType, int timeoutInterval)`	Deprecated. Use `getProfileToken(String, char[],int,int)` instead.
`int`	`getProxyEncryptionMode()`	Returns the proxy encryption mode.
`String`	`getProxyServer()`	Returns the name of the middle-tier machine where the proxy server is running.
`int`	`getRelease()`	Returns the release of the IBM i system.
`static String`	`getServerName(int service)`	Converts a service constant to the string representation of the service.
`int`	`getServicePort(int service)`	Returns the service port stored in the service port table for the specified service.
`GregorianCalendar`	`getSignonDate()`	Returns the date for the current sign-on.
`SignonHandler`	`getSignonHandler()`	Returns the sign-on handler that is used by this object.
`SocketProperties`	`getSocketProperties()`	Returns a copy of the socket options object.
`String`	`getSystemName()`	Returns the name of the IBM i system.
`int`	`getSystemPasswordExpirationWarningDays()`	Returns the number of days before password expiration to start warning the user based on the value of the QPWDEXPWRN system value.
`TimeZone`	`getSystemTimeZone()`	Deprecated. Use `getTimeZone()` instead.
`TimeZone`	`getTimeZone()`	Returns the time zone of the IBM i system.
`String`	`getUserId()`	Returns the user ID.
`String`	`getUserId(boolean forceRefresh)`	Returns the user ID.
`int`	`getvalidateSignonTimeOut()`	Returns the timeout value when attempting to validate the sign on information.
`int`	`getVersion()`	Returns the version of the IBM i system.
`int`	`getVRM()`	Returns the version, release, and modification level for the system.
`static int`	`getVRM(String systemName, boolean useSSL)`	Returns the version, release, and modification level a given system.
`void`	`initializeConverter(int ccsid)`	Initialize conversion table for the given CCSID.
`boolean`	`isAdditionalAuthenticationFactorAccepted()`	Checks whether an additional authentication factor is accepted for the given system.
`static boolean`	`isAdditionalAuthenticationFactorAccepted(String systemName)`	Deprecated. Use `isAdditionalAuthenticationFactorAccepted(String, boolean)`
`static boolean`	`isAdditionalAuthenticationFactorAccepted(String systemName, boolean useSSL)`	Checks whether an additional authentication factor is accepted for the given system
`boolean`	`isConnected()`	Indicates if any service is currently connected through this object.
`boolean`	`isConnected(int service)`	Indicates if a service is currently connected through this object.
`boolean`	`isConnectionAlive()`	Tests the connection to the system, to verify that it is still working.
`boolean`	`isConnectionAlive(int service)`	Tests the connection to a service on the system, to verify that it is still working.
`boolean`	`isGuiAvailable()`	Returns the sign-on prompting mode for this object.
`boolean`	`isInPasswordExpirationWarningDays()`	Determines if the password expiration date for the user profile is within the password expiration warning days for the system returned by `getPasswordExpirationDays()`.
`boolean`	`isLocal()`	Indicates if this object is representing the system you are currently running on.
`boolean`	`isMustAddLanguageLibrary()`	Indicates whether this object will attempt to add the appropriate secondary language library to the library list, when running on the system.
`boolean`	`isMustUseNetSockets()`	Indicates if Internet domain sockets only will be used.
`boolean`	`isMustUseSockets()`	When your Java program runs on the system, some Toolbox classes access data via a call to an API instead of making a socket call to the system.
`boolean`	`isMustUseSuppliedProfile()`	Indicates if only a supplied profile will be used.
`boolean`	`isSecure()`	Returns true if host server communications is performed over a secure channel.
`boolean`	`isShowCheckboxes()`	Indicates if checkboxes should be shown on the sign-on dialog.
`boolean`	`isThreadUsed()`	Indicates whether threads are used in communication with the host servers.
`static boolean`	`isTurkish()`	Return whether default locale is Turkish.
`boolean`	`isUseDefaultUser()`	Indicates if the default user should be used by this object.
`boolean`	`isUsePassphrase()`	Is the AS400 object configured to use a pass phrase
`boolean`	`isUsePasswordCache()`	Indicates if the password cache is being used by this object.
`static AS400`	`newInstance(boolean useSSL)`	Returns a new instance of an AS400 object.
`static AS400`	`newInstance(boolean useSSL, AS400 system)`	Returns a new instance of an AS400 object.
`static AS400`	`newInstance(boolean useSSL, String systemName)`	Returns a new instance of an AS400 object.
`static AS400`	`newInstance(boolean useSSL, String systemName, ProfileTokenCredential profileToken)`	Returns a new instance of an AS400 object.
`static AS400`	`newInstance(boolean useSSL, String systemName, String userId)`	Returns a new instance of an AS400 object.
`static AS400`	`newInstance(boolean useSSL, String systemName, String userId, char[] password, char[] additionalAuthFactor)`	Returns a new instance of an AS400 object.
`static AS400`	`newInstance(boolean useSSL, String systemName, String userId, char[] password, String proxyServer)`	Returns a new instance of an AS400 object.
`int`	`passwordLevel()`	Password level
`void`	`removeConnectionListener(ConnectionListener listener)`	Removes a listener from the connection event list.
`static void`	`removeDefaultUser(String systemName)`	Removes the default user for the given system name.
`static void`	`removePasswordCacheEntry(String systemName, String userId)`	Removes the password cache entry associated with this system name and user ID.
`void`	`removePropertyChangeListener(PropertyChangeListener listener)`	Removes a property changed listener from the listener list.
`void`	`removeVetoableChangeListener(VetoableChangeListener listener)`	Removes a listener from the veto list.
`void`	`resetAllServices()`	Disconnects all services, and clears the sign-on information.
`void`	`setAdditionalAuthenticationFactor(char[] additionalAuthFactor)`	Set the additional authentication factor for the AS400 object.
`void`	`setBidiStringType(int bidiStringType)`	Sets bidi string type of the connection.
`void`	`setCcsid(int ccsid)`	Sets the CCSID to be used for this object.
`void`	`setDDMRDB(String ddmRDB)`	Sets the relational database name (RDB name) used for record-level access (DDM) connections.
`static void`	`setDefaultSignonHandler(SignonHandler handler)`	Sets the default sign-on handler, globally across the JVM.
`static boolean`	`setDefaultUser(String systemName, String userId)`	Sets the default user for a given system name.
`void`	`setEnabledCipherSuites(String[] suites)`	Set list of cipher suites.
`void`	`setGSSCredential(GSSCredential gssCredential)`	Sets the GSS credential for this object.
`static void`	`setGSSManager(GSSManager gssMgr)`	Sets the GSS manager to be used for all GSS operations.
`void`	`setGSSName(String gssName)`	Sets the GSS name for this object.
`void`	`setGSSOption(int gssOption)`	Sets the option for how the JGSS framework will be used to retrieve a GSS token for authenticating to the system.
`void`	`setGuiAvailable(boolean guiAvailable)`	Sets the environment in which you are running.
`void`	`setIASPGroup(String IASPGroup)`	Set ASP group for the AS400 connection to the Remote Command Host server.
`void`	`setIASPGroup(String IASPGroup, String currentLib)`	Set ASP group for the AS400 connection to the Remote Command Host server.
`void`	`setIASPGroup(String IASPGroup, String currentLib, String librariesForThread)`	Set ASP group for the AS400 connection to the Remote Command Host server.
`void`	`setIASPGroup(String IASPGroup, String currentLib, String[] librariesForThread)`	Set ASP group for the AS400 connection to the Remote Command Host server.
`void`	`setIdentityToken(byte[] identityToken)`	Sets or resets the identity token for this object.
`void`	`setKeyRingName(String keyRingName)`	Sets the key ring class name used for SSL communications with the system.
`void`	`setKeyRingName(String keyRingName, String keyRingPassword)`	Sets the key ring class name used for SSL communications with the system.
`void`	`setKeyRingPassword(String keyRingPassword)`	Deprecated.
`void`	`setLocale(Locale locale)`	Sets the Locale used to set the National Language Version (NLV) on the system.
`void`	`setLocale(Locale locale, String nlv)`	Sets the Locale and a specific National Language Version (NLV) to send to the system.
`void`	`setMustAddLanguageLibrary(boolean mustAddLanguageLibrary)`	Sets this object to attempt to add the appropriate secondary language library to the library list, when running on the system.
`void`	`setMustUseNetSockets(boolean mustUseNetSockets)`	Sets this object to using Internet domain sockets only.
`void`	`setMustUseSockets(boolean mustUseSockets)`	Sets this object to using sockets.
`void`	`setMustUseSuppliedProfile(boolean mustUseSuppliedProfile)`	Sets this object to using a supplied profile only.
`void`	`setPassword(char[] password)`	Sets the password for this object using a char array.
`void`	`setPassword(String password)`	Deprecated.
`static void`	`setPasswordExpirationWarningDays(int days)`	Sets the number of days before password expiration to warn the user.
`void`	`setProfileToken(ProfileTokenCredential profileToken)`	Sets or resets the profile token for this object.
`void`	`setProxyEncryptionMode(int proxyEncryptionMode)`	Sets the proxy encryption mode.
`void`	`setProxyServer(String proxyServer)`	Sets the name and port of the middle-tier machine where the proxy server is running.
`void`	`setServicePort(int service, int port)`	Sets the service port in the service port table for the specified service for this system name.
`void`	`setServicePortsToDefault()`	Sets the ports in the service port table for all the services for this system name to their default values.
`void`	`setShowCheckboxes(boolean showCheckboxes)`	Indicates if checkboxes should be shown on the sign-on dialog.
`void`	`setSignonHandler(SignonHandler handler)`	Sets the sign-on handler for this AS400 object.
`void`	`setSocketProperties(SocketProperties socketProperties)`	Sets the socket options the IBM Toolbox for Java will set on its client side sockets.
`void`	`setStayAlive(long seconds)`	Set the stay-alve interval.
`void`	`setSystemName(String systemName)`	Sets the system name for this object.
`void`	`setThreadUsed(boolean useThreads)`	Sets whether the IBM Toolbox for Java uses threads in communication with the host servers.
`void`	`setUseDefaultUser(boolean useDefaultUser)`	Sets the indicator for whether the default user is used.
`void`	`setUsePasswordCache(boolean usePasswordCache)`	Sets the indicator for whether the password cache is used.
`void`	`setUserId(String userId)`	Sets the user ID for this object.
`void`	`setUseSystemPasswordExpirationWarningDays(boolean useSystem)`	Set a flag to indicate whether or not to use the password expiration warning days from the QPWDEXPWRN system value.
`void`	`setvalidateSignonTimeOut(int validateSignonTimeOut)`	Set the the timeout value when when attempting to validate the sign on information.
`protected void`	`setVRM(int v, int r, int m)`	Sets the VRM for the object, creating a signonInfo as needed
`String`	`toString()`	Returns the text representation of this AS400 object.
`boolean`	`validateSignon()`	Validates the user ID and password on the system but does not add to the signed-on list.
`boolean`	`validateSignon(char[] password)`	Validates the user ID and password on the system but does not add to the signed-on list.
`boolean`	`validateSignon(String password)`	Deprecated.
`boolean`	`validateSignon(String userId, char[] password)`	Validates the user ID and password on the system but does not add to the signed-on list.
`boolean`	`validateSignon(String userId, char[] password, char[] additionalAuthFactor)`	Validates the user ID and password on the system but does not add to the signed-on list.
`boolean`	`validateSignon(String userId, String password)`	Deprecated. Using a string as a password is insecure

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - FILE
```
public static final int FILE
```
    Constant indicating the File service.
    
    See Also:
    
    Constant Field Values
  - PRINT
```
public static final int PRINT
```
    Constant indicating the Print service.
    
    See Also:
    
    Constant Field Values
  - COMMAND
```
public static final int COMMAND
```
    Constant indicating the Command service.
    
    See Also:
    
    Constant Field Values
  - DATAQUEUE
```
public static final int DATAQUEUE
```
    Constant indicating the Dataqueue service.
    
    See Also:
    
    Constant Field Values
  - DATABASE
```
public static final int DATABASE
```
    Constant indicating the Database service.
    
    See Also:
    
    Constant Field Values
  - RECORDACCESS
```
public static final int RECORDACCESS
```
    Constant indicating the Record Access service.
    
    See Also:
    
    Constant Field Values
  - CENTRAL
```
public static final int CENTRAL
```
    Constant indicating the Central service.
    
    See Also:
    
    Constant Field Values
  - SIGNON
```
public static final int SIGNON
```
    Constant indicating the Sign-on service.
    
    See Also:
    
    Constant Field Values
  - HOSTCNN
```
public static final int HOSTCNN
```
    Constant indicating the Host connection service.
    
    See Also:
    
    Constant Field Values
  - USE_PORT_MAPPER
```
public static final int USE_PORT_MAPPER
```
    Special value indicating the service port should be retrieved from the port mapper server.
    
    See Also:
    
    Constant Field Values
  - AUTHENTICATION_SCHEME_PASSWORD
```
public static final int AUTHENTICATION_SCHEME_PASSWORD
```
    Constant indicating the authentication scheme is password.
    
    See Also:
    
    Constant Field Values
  - AUTHENTICATION_SCHEME_GSS_TOKEN
```
public static final int AUTHENTICATION_SCHEME_GSS_TOKEN
```
    Constant indicating the authentication scheme is GSS token.
    
    See Also:
    
    Constant Field Values
  - AUTHENTICATION_SCHEME_PROFILE_TOKEN
```
public static final int AUTHENTICATION_SCHEME_PROFILE_TOKEN
```
    Constant indicating the authentication scheme is profile token.
    
    See Also:
    
    Constant Field Values
  - AUTHENTICATION_SCHEME_IDENTITY_TOKEN
```
public static final int AUTHENTICATION_SCHEME_IDENTITY_TOKEN
```
    Constant indicating the authentication scheme is identity token.
    
    See Also:
    
    Constant Field Values
  - AUTHENTICATION_SCHEME_DDM_EUSERIDPWD
```
public static final int AUTHENTICATION_SCHEME_DDM_EUSERIDPWD
```
    Constant representing the DDM_EUSERIDPWD scheme - only applicable to Record Access service.
    
    See Also:
    
    Constant Field Values
  - GSS_OPTION_MANDATORY
```
public static final int GSS_OPTION_MANDATORY
```
    Constant indicating that the JGSS framework must be used when no password or authentication token is set. An object set to this option will not attempt to present a sign-on dialog or use the current user profile information. A failure to retrieve the GSS token will result in an exception returned to the user.
    
    See Also:
    
    Constant Field Values
  - GSS_OPTION_FALLBACK
```
public static final int GSS_OPTION_FALLBACK
```
    Constant indicating that the JGSS framework will be attempted when no password or authentication token is set. An object set to this option will attempt to retrieve a GSS token, if that attempt fails, the object will present a sign-on dialog or use the current user profile information. This option is the default.
    
    See Also:
    
    Constant Field Values
  - GSS_OPTION_NONE
```
public static final int GSS_OPTION_NONE
```
    Constant indicating that the JGSS framework will not be used when no password or authentication token is set. An object set to this option will only present a sign-on dialog or use the current user profile information.
    
    See Also:
    
    Constant Field Values
  - CLIENT_TO_PROXY_SERVER
```
public static final int CLIENT_TO_PROXY_SERVER
```
    Constant indicating that encryption should only be done on the connection between the client and the proxy server.
    
    See Also:
    
    Constant Field Values
  - PROXY_SERVER_TO_SERVER
```
public static final int PROXY_SERVER_TO_SERVER
```
    Constant indicating that encryption should only be done on the connection between the proxy server and the system.
    
    See Also:
    
    Constant Field Values
  - CLINT_TO_SERVER
```
public static final int CLINT_TO_SERVER
```
    Deprecated.
    Use CLIENT_TO_SERVER instead.
    
    See Also:
    
    Constant Field Values
  - CLIENT_TO_SERVER
```
public static final int CLIENT_TO_SERVER
```
    Constant indicating that encryption should be done in both the connection between the client and the proxy server and the connection between the proxy server and the system.
    
    See Also:
    
    Constant Field Values
  - changeCipherSuites
```
public static boolean changeCipherSuites
```
    Indicate whether the cipher suites changed by the caller. We add this for iNav.
  - newCipherSuites
```
public static String[] newCipherSuites
```
  - currentLib_
```
public String currentLib_
```
  - librariesForThread_
```
public String librariesForThread_
```
  - aspName
```
public String aspName
```
  - bidiAS400Text
```
public boolean bidiAS400Text
```
    Determines whether Bidi processing should occur in AS400Text.toBytes() method
  - bidiAS400Varchar
```
public boolean bidiAS400Varchar
```
    Determines whether Bidi processing should occur in AS400Varchar.toBytes() method
- Constructor Detail
  - AS400
```
public AS400()
```
    Constructs an AS400 object.
    If running on IBM i, the target is the local system. This has the same effect as using localhost for the system name, *CURRENT for the user ID, and *CURRENT for the password.
    If running on another operating system, a sign-on prompt may be displayed. The user is then able to specify the system name, user ID, and password.
  - AS400
```
public AS400(String systemName)
```
    Constructs an AS400 object. It uses the specified system name.
    If running on IBM i to another system or to itself, the user ID and password of the current job are used.
    If running on another operating system, the user may be prompted for the user ID and password if a default user has not been established for this system name.
    
    Parameters:
    
    systemName - The name of the IBM i system. Use localhost to access data locally.
  - AS400
```
public AS400(String systemName,
             String userId)
```
    Constructs an AS400 object. It uses the specified system name and user ID. If the sign-on prompt is displayed, the user is able to specify the password. Note that the user ID may be overridden.
    
    Parameters:
    
    systemName - The name of the IBM i system. Use localhost to access data locally.
    
    userId - The user profile name to use to authenticate to the system. If running on IBM i, *CURRENT may be used to specify the current user ID.
    
    Throws:
    
    ExtendedIllegalArgumentException - If userId length is not valid.
  - AS400
```
public AS400(String systemName,
             ProfileTokenCredential profileToken)
```
    Constructs an AS400 object. It uses the specified system name and profile token.
    
    Parameters:
    
    systemName - The name of the IBM i system. Use localhost to access data locally.
    
    profileToken - The profile token to use to authenticate to the system.
  - AS400
```
public AS400(String systemName,
             ProfileTokenProvider tokenProvider)
```
    Constructs an AS400 object. The specified ProfileTokenProvider is used. The token refresh threshold is determined by the ProfileTokenProvider.
    
    Parameters:
    
    systemName - The name of the IBM i system.
    
    tokenProvider - The provider to use when a new profile token needs to be generated.
    
    See Also:
    
    AS400(String,ProfileTokenProvider,int)
  - AS400
```
public AS400(String systemName,
             ProfileTokenProvider tokenProvider,
             int refreshThreshold)
```
    Constructs an AS400 object. The specified ProfileTokenProvider is used.
    
    Parameters:
    
    systemName - The name of the IBM i system.
    
    tokenProvider - The provider to use when a new profile token needs to be generated.
    
    refreshThreshold - The refresh threshold, in seconds, for the profile token. Used by the vault to manage the currency of the profile token to help ensure it remains current for an indefinite period of time.
    
    See Also:
    
    AS400(String,ProfileTokenProvider)
  - AS400
```
@Deprecated
public AS400(String systemName,
             String userId,
             String password)
```
    Deprecated.
    Use AS400(String systemName, String userId, char[] password) instead
    
    Constructs an AS400 object. It uses the specified system name, user ID, and password. No sign-on prompt is displayed unless the sign-on fails.
    
    Parameters:
    
    systemName - The name of the IBM i system. Use localhost to access data locally.
    
    userId - The user profile name to use to authenticate to the system. If running on IBM i, *CURRENT may be used to specify the current user ID.
    
    password - The user profile password to use to authenticate to the system. If running on IBM i, CURRENT may be used to specify the current user ID.
    
    Throws:
    
    ExtendedIllegalArgumentException - If userId length is not valid.
  - AS400
```
public AS400(String systemName,
             String userId,
             char[] password,
             char[] additionalAuthFactor)
      throws AS400SecurityException,
             IOException
```
    Constructs an AS400 object. It uses the specified system name, user ID, password, and additional authentication factor. No sign-on prompt is displayed unless the sign-on fails.
    
    Parameters:
    
    systemName - The name of the IBM i system. Use localhost to access data locally.
    
    userId - The user profile name to use to authenticate to the system. If running on IBM i, *CURRENT may be used to specify the current user ID.
    
    password - The user profile password to use to authenticate to the system.
    
    additionalAuthFactor - Additional authentication factor (or null if not providing one). The caller is responsible for clearing the password array to keep the password from residing in memory.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    IOException - If an error occurs while communicating with the system.
  - AS400
```
public AS400(String systemName,
             String userId,
             char[] password)
```
    Constructs an AS400 object. It uses the specified system name, user ID, and password. No sign-on prompt is displayed unless the sign-on fails.
    
    Parameters:
    
    systemName - The name of the IBM i system. Use localhost to access data locally.
    
    userId - The user profile name to use to authenticate to the system. If running on IBM i, *CURRENT may be used to specify the current user ID.
    
    password - The user profile password to use to authenticate to the system. The caller is responsible for clearing the password array to keep the password from residing in memory.
    
    Throws:
    
    ExtendedIllegalArgumentException - If userId length is not valid.
  - AS400
```
@Deprecated
public AS400(String systemName,
             String userId,
             String password,
             String proxyServer)
```
    Deprecated.
    Use AS400((String systemName, String userId, char[] password, String proxyServer) instead.
    
    Constructs an AS400 object. It uses the specified system name, user ID, and password. No sign-on prompt is displayed unless the sign-on fails.
    
    Parameters:
    
    systemName - The name of the IBM i system. Use localhost to access data locally.
    
    userId - The user profile name to use to authenticate to the system. If running on IBM i, *CURRENT may be used to specify the current user ID.
    
    password - The user profile password to use to authenticate to the system. If running on IBM i, *CURRENT may be used to specify the current user ID.
    
    proxyServer - The name and port of the proxy server in the format serverName[:port]. If no port is specified, a default will be used.
    
    Throws:
    
    ExtendedIllegalArgumentException - If userId length is not valid.
  - AS400
```
public AS400(String systemName,
             String userId,
             char[] password,
             String proxyServer)
```
    Constructs an AS400 object. It uses the specified system name, user ID, and password. No sign-on prompt is displayed unless the sign-on fails.
    
    Parameters:
    
    systemName - The name of the IBM i system. Use localhost to access data locally.
    
    userId - The user profile name to use to authenticate to the system. If running on IBM i, *CURRENT may be used to specify the current user ID.
    
    password - The user profile password to use to authenticate to the system. The caller is responsible fore clearing sensitive data from password after the constructor runs.
    
    proxyServer - The name and port of the proxy server in the format serverName[:port]. If no port is specified, a default will be used.
    
    Throws:
    
    ExtendedIllegalArgumentException - If userId length is not valid.
  - AS400
```
public AS400(AS400 system)
```
    Constructs an AS400 object. This does not create a clone. The new AS400 object will uses the same system name, user ID, and other properties of the passed-in AS400 object, enabling the new object to generally behave in a similar manner as the passed-in AS400 object.
    Notes:
    - Host server connections are not shared between the passed-in AS400 object and the new AS400 object, except for the HOSTCNN service connection, which is shared as long as the authentication credentials stay the same.
    - Properties that are not propagated to the new AS400 object include event listeners (connection, property change, vetoable property change.). In addition, you will need to call the setStayAlive(long) method on the new AS400 object if you want the feature enabled.
    Parameters:
    
    system - A previously instantiated AS400 object.
- Method Detail
  - setIASPGroup
```
public void setIASPGroup(String IASPGroup)
                  throws AS400SecurityException,
                         ErrorCompletingRequestException,
                         IOException,
                         InterruptedException,
                         PropertyVetoException
```
    Set ASP group for the AS400 connection to the Remote Command Host server. It calls SETASPGRP command to change the asp setting for corresponding CommandCall, ProgramCall and ServiceProgramCall in the same connection. Current library default is *CURUSR. Libraries for current thread default is *CURUSR. If an ASP group had already been set, it will remove the old ASP group and set the specified ASP group for the current thread. Once the specified ASP group has been set, all libraries in the independent ASPs in the ASP group are accessible and objects in those libraries can be referenced using regular library-qualified object name syntax.
    
    Parameters:
    
    IASPGroup - asp group name
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    
    IOException - If an error occurs while communicating with the system.
    
    InterruptedException - If this thread is interrupted.
    
    PropertyVetoException - If the recipient wishes the property change to be rolled back.
  - setIASPGroup
```
public void setIASPGroup(String IASPGroup,
                         String currentLib)
                  throws AS400SecurityException,
                         ErrorCompletingRequestException,
                         IOException,
                         InterruptedException,
                         PropertyVetoException
```
    Set ASP group for the AS400 connection to the Remote Command Host server. It calls SETASPGRP command to change the asp setting for corresponding CommandCall, ProgramCall and ServiceProgramCall in the same connection. Libraries for current thread default is *CURUSR. If an ASP group had already been set, it will remove the old ASP group and set the specified ASP group for the current thread. Once the specified ASP group has been set, all libraries in the independent ASPs in the ASP group are accessible and objects in those libraries can be referenced using regular library-qualified object name syntax.
    
    Parameters:
    
    IASPGroup - asp group name
    
    currentLib - Current library which can be *CURSYSBAS, *CURUSR, *CRTDFT, name. If null or "" is set, default value *CURUSR is used.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    
    ExtendedIllegalArgumentException - If currentLib length is not valid.
    
    IOException - If an error occurs while communicating with the system.
    
    InterruptedException - If this thread is interrupted.
    
    PropertyVetoException - If the recipient wishes the property change to be rolled back.
  - setIASPGroup
```
public void setIASPGroup(String IASPGroup,
                         String currentLib,
                         String librariesForThread)
                  throws AS400SecurityException,
                         ErrorCompletingRequestException,
                         IOException,
                         InterruptedException,
                         PropertyVetoException
```
    Set ASP group for the AS400 connection to the Remote Command Host server. It calls SETASPGRP command to change the asp setting for corresponding CommandCall, ProgramCall and ServiceProgramCall in the same connection. If an ASP group had already been set, it will remove the old ASP group and set the specified ASP group for the current thread. Once the specified ASP group has been set, all libraries in the independent ASPs in the ASP group are accessible and objects in those libraries can be referenced using regular library-qualified object name syntax.
    
    Parameters:
    
    IASPGroup - asp group name
    
    currentLib - Current library which can be *CURSYSBAS, *CURUSR, *CRTDFT, name. If null or "" is set, default value *CURUSR is used.
    
    librariesForThread - Libraries for current thread with single value. If null or "" is set, default value *CURUSR is used.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    
    ExtendedIllegalArgumentException - If currentLib or librariesForThread lengths are not valid.
    
    IOException - If an error occurs while communicating with the system.
    
    InterruptedException - If this thread is interrupted.
    
    PropertyVetoException - If the recipient wishes the property change to be rolled back.
  - setIASPGroup
```
public void setIASPGroup(String IASPGroup,
                         String currentLib,
                         String[] librariesForThread)
                  throws AS400SecurityException,
                         ErrorCompletingRequestException,
                         IOException,
                         InterruptedException,
                         PropertyVetoException
```
    Set ASP group for the AS400 connection to the Remote Command Host server. It calls SETASPGRP command to change the asp setting for corresponding CommandCall, ProgramCall and ServiceProgramCall in the same connection. If an ASP group had already been set, it will remove the old ASP group and set the specified ASP group for the current thread. Once the specified ASP group has been set, all libraries in the independent ASPs in the ASP group are accessible and objects in those libraries can be referenced using regular library-qualified object name syntax.
    
    Parameters:
    
    IASPGroup - asp group name
    
    currentLib - Current library which can be *CURSYSBAS, *CURUSR, *CRTDFT, name. If null or "" is set, default value *CURUSR is used.
    
    librariesForThread - Libraries for current thread. If null is set, default value *CURUSR is used. Up to 250 libraries can be set.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    
    IOException - If an error occurs while communicating with the system.
    
    InterruptedException - If this thread is interrupted.
    
    PropertyVetoException - If the recipient wishes the property change to be rolled back.
  - newInstance
```
public static AS400 newInstance(boolean useSSL)
```
    Returns a new instance of an AS400 object.
    If running on IBM i, the target is the local system. This has the same effect as using localhost for the system name, *CURRENT for the user ID, and *CURRENT for the password.
    If running on another operating system, a sign-on prompt may be displayed. The user is then able to specify the system name, user ID, and password.
    
    Parameters:
    
    useSSL - Whether or not the new AS400 object should use secure connections when communicating with the host servers.
    
    Returns:
    
    AS400 object.
  - newInstance
```
public static AS400 newInstance(boolean useSSL,
                                String systemName)
```
    Returns a new instance of an AS400 object. It uses the specified system name.
    If running on IBM i to another system or to itself, the user ID and password of the current job are used.
    If running on another operating system, the user may be prompted for the user ID and password if a default user has not been established for this system name.
    
    Parameters:
    
    useSSL - Whether or not the new AS400 object should use secure connections when communicating with the host servers.
    
    systemName - The name of the IBM i system. Use localhost to access data locally.
    
    Returns:
    
    AS400 object.
  - newInstance
```
public static AS400 newInstance(boolean useSSL,
                                String systemName,
                                String userId)
                         throws IOException,
                                AS400SecurityException
```
    Returns a new instance of an AS400 object. It uses the specified system name, and user ID. When the sign-on prompt is displayed, the user is able to specify the password. Note that the user ID may be overridden in the AS400 object.
    
    Parameters:
    
    useSSL - Whether or not the new AS400 object should use secure connections when communicating with the host servers.
    
    systemName - The name of the IBM i system. Use localhost to access data locally.
    
    userId - The user profile name to use to authenticate to the system. If running on IBM i, *CURRENT may be used to specify the current user ID.
    
    Returns:
    
    AS400 object.
    
    Throws:
    
    IOException - If an error occurs while communicating with the system.
    
    AS400SecurityException - If a security or authority error occurs.
  - newInstance
```
public static AS400 newInstance(boolean useSSL,
                                String systemName,
                                String userId,
                                char[] password,
                                char[] additionalAuthFactor)
                         throws IOException,
                                AS400SecurityException
```
    Returns a new instance of an AS400 object. It uses the specified system name, user ID, password, and additional authentication factor. No sign-on prompt is displayed unless the sign-on fails.
    
    Parameters:
    
    useSSL - Whether or not the new AS400 object should use secure connections when communicating with the host servers.
    
    systemName - The name of the IBM i system. Use localhost to access data locally.
    
    userId - The user profile name to use to authenticate to the system. If running on IBM i, *CURRENT may be used to specify the current user ID.
    
    password - The user profile password to use to authenticate to the system. The caller is responsible for clearing the password array to keep the password from residing in memory.
    
    additionalAuthFactor - Additional authentication factor (or null if not providing one).
    
    Returns:
    
    AS400 object.
    
    Throws:
    
    IOException - If an error occurs while communicating with the system.
    
    AS400SecurityException - If a security or authority error occurs.
  - newInstance
```
public static AS400 newInstance(boolean useSSL,
                                String systemName,
                                String userId,
                                char[] password,
                                String proxyServer)
```
    Returns a new instance of an AS400 object. It uses the specified system name, user ID, and password. No sign-on prompt is displayed unless the sign-on fails.
    
    Parameters:
    
    useSSL - Whether or not the new AS400 object should use secure connections when communicating with the host servers.
    
    systemName - The name of the IBM i system. Use localhost to access data locally.
    
    userId - The user profile name to use to authenticate to the system. If running on IBM i, *CURRENT may be used to specify the current user ID.
    
    password - The user profile password to use to authenticate to the system. The caller is responsible fore clearing sensitive data from password after the constructor runs.
    
    proxyServer - The name and port of the proxy server in the format serverName[:port]. If no port is specified, a default will be used.
    
    Returns:
    
    AS400 object.
  - newInstance
```
public static AS400 newInstance(boolean useSSL,
                                String systemName,
                                ProfileTokenCredential profileToken)
```
    Returns a new instance of an AS400 object. It uses the specified system name and profile token.
    
    Parameters:
    
    useSSL - Whether or not the new AS400 object should use secure connections when communicating with the host servers.
    
    systemName - The name of the IBM i system. Use localhost to access data locally.
    
    profileToken - The profile token to use to authenticate to the system.
    
    Returns:
    
    AS400 object.
  - newInstance
```
public static AS400 newInstance(boolean useSSL,
                                AS400 system)
```
    Returns a new instance of an AS400 object. It uses the same system name and user ID. This does not create a clone. The new object has the same behavior, but results in a new set of socket connections.
    
    Parameters:
    
    useSSL - Whether or not the new AS400 object should use secure connections when communicating with the host server.
    
    system - A previously instantiated AS400 object.
    
    Returns:
    
    AS400 object.
  - addConnectionListener
```
public void addConnectionListener(ConnectionListener listener)
```
    Adds a listener to be notified when a connection event occurs.
    
    Parameters:
    
    listener - The listener object.
  - addPasswordCacheEntry
```
public static void addPasswordCacheEntry(String systemName,
                                         String userId,
                                         String password)
                                  throws AS400SecurityException,
                                         IOException
```
    Deprecated.
    Use addPasswordCacheEntry(String systemName, String userId, char[] password) instead
    
    Validates the user ID and password, and if successful, adds the information to the password cache.
    
    Parameters:
    
    systemName - The name of the IBM i system.
    
    userId - The user profile name.
    
    password - The user profile password.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    IOException - If an error occurs while communicating with the system.
  - addPasswordCacheEntry
```
public static void addPasswordCacheEntry(String systemName,
                                         String userId,
                                         char[] password)
                                  throws AS400SecurityException,
                                         IOException
```
    Validates the user ID and password, and if successful, adds the information to the password cache.
    
    Parameters:
    
    systemName - The name of the IBM i system.
    
    userId - The user profile name.
    
    password - The user profile password.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    IOException - If an error occurs while communicating with the system.
  - addPasswordCacheEntry
```
public static void addPasswordCacheEntry(String systemName,
                                         String userId,
                                         char[] password,
                                         boolean useSSL)
                                  throws AS400SecurityException,
                                         IOException
```
    Validates the user ID and password, and if successful, adds the information to the password cache.
    
    Parameters:
    
    systemName - The name of the IBM i system.
    
    userId - The user profile name.
    
    password - The user profile password.
    
    useSSL - Whether or not secure connections should be used when communicating with the host servers.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    IOException - If an error occurs while communicating with the system.
  - addPasswordCacheEntry
```
@Deprecated
public static void addPasswordCacheEntry(String systemName,
                                         String userId,
                                         String password,
                                         String proxyServer)
                                  throws AS400SecurityException,
                                         IOException
```
    Deprecated.
    Use addPasswordCacheEntry(String systemName, String userId, char[] password, String proxyServer) instead.
    
    Validates the user ID and password, and if successful, adds the information to the password cache.
    
    Parameters:
    
    systemName - The name of the IBM i system.
    
    userId - The user profile name.
    
    password - The user profile password.
    
    proxyServer - The name and port of the proxy server in the format serverName[:port]. If no port is specified, a default will be used.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    IOException - If an error occurs while communicating with the system.
  - addPasswordCacheEntry
```
public static void addPasswordCacheEntry(String systemName,
                                         String userId,
                                         char[] password,
                                         String proxyServer)
                                  throws AS400SecurityException,
                                         IOException
```
    Validates the user ID and password, and if successful, adds the information to the password cache.
    
    Parameters:
    
    systemName - The name of the IBM i system.
    
    userId - The user profile name.
    
    password - The user profile password.
    
    proxyServer - The name and port of the proxy server in the format serverName[:port]. If no port is specified, a default will be used.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    IOException - If an error occurs while communicating with the system.
  - addPasswordCacheEntry
```
public static void addPasswordCacheEntry(String systemName,
                                         String userId,
                                         char[] password,
                                         String proxyServer,
                                         boolean useSSL)
                                  throws AS400SecurityException,
                                         IOException
```
    Validates the user ID and password, and if successful, adds the information to the password cache.
    
    Parameters:
    
    systemName - The name of the IBM i system.
    
    userId - The user profile name.
    
    password - The user profile password.
    
    proxyServer - The name and port of the proxy server in the format serverName[:port]. If no port is specified, a default will be used.
    
    useSSL - Whether or not secure connections should be used when communicating with the host servers.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    IOException - If an error occurs while communicating with the system.
  - addPropertyChangeListener
```
public void addPropertyChangeListener(PropertyChangeListener listener)
```
    Adds a listener to be notified when the value of any property is changed.
    
    Parameters:
    
    listener - The listener object.
  - addVetoableChangeListener
```
public void addVetoableChangeListener(VetoableChangeListener listener)
```
    Adds a listener to be notified when the value of any constrained property is changed. The vetoableChange method will be called.
    
    Parameters:
    
    listener - The listener object.
  - arePropertiesFrozen
```
public boolean arePropertiesFrozen()
```
    Indicates if properties are frozen. If this is true, property changes should not be made. Properties are not the same thing as attributes. Properties are basic pieces of information which must be set to make the object usable, such as the system name, user ID or other properties that identify the resource.
    
    Returns:
    
    true if properties are frozen, false otherwise.
  - isAdditionalAuthenticationFactorAccepted
```
public boolean isAdditionalAuthenticationFactorAccepted()
                                                 throws IOException,
                                                        AS400SecurityException
```
    Checks whether an additional authentication factor is accepted for the given system. The communications with the host server is done over a secure channel if the AS400 object was created to use SSL; otherwise, the communications with the host server is done over an unsecure channel.
    
    Returns:
    
    whether the server accepts the additional authentication factor
    
    Throws:
    
    IOException - If an error occurs while communicating with the system.
    
    AS400SecurityException - If an error occurs exchanging client/server information
  - isAdditionalAuthenticationFactorAccepted
```
public static boolean isAdditionalAuthenticationFactorAccepted(String systemName,
                                                               boolean useSSL)
                                                        throws IOException,
                                                               AS400SecurityException
```
    Checks whether an additional authentication factor is accepted for the given system
    
    Parameters:
    
    systemName - The IP address or hostname of the target system
    
    useSSL - Whether or not secure connections should be used when communicating with the host servers.
    
    Returns:
    
    whether the server accepts the additional authentication factor
    
    Throws:
    
    IOException - If an error occurs while communicating with the system.
    
    AS400SecurityException - If an error occurs exchanging client/server information
  - isAdditionalAuthenticationFactorAccepted
```
@Deprecated
public static boolean isAdditionalAuthenticationFactorAccepted(String systemName)
                                                        throws IOException,
                                                               AS400SecurityException
```
    Deprecated.
    Use isAdditionalAuthenticationFactorAccepted(String, boolean)
    
    Checks whether an additional authentication factor is accepted for the given system
    
    Parameters:
    
    systemName - The IP address or hostname of the target system
    
    Returns:
    
    whether the server accepts the additional authentication factor
    
    Throws:
    
    IOException - If an error occurs while communicating with the system.
    
    AS400SecurityException - If an error occurs exchanging client/server information
  - authenticate
```
public boolean authenticate()
                     throws AS400SecurityException,
                            IOException
```
    Authenticate the user ID and password on the system and adds to the signon-list. This means that authentication is performed using the AS400 object instance for which this method is invoked - a new AS400 object is not created to do the authentication (unlike the other authenticate(String, String) or validateSignon() methods).
    If the AS400 object has previously been authenticated, either by using authenticate() or indirectly such as when establishing a connection to a host server, and if any of the setter methods are used after the authentication to change credentials, such as user ID or system name, the AS400.HOSTCNN and/or AS400.SIGNON server connections, if they exist, may be discarded if the change is different than what was previously used in the authentication process.
    Note: This will return true if the information is successfully validated. An unsuccessful validation will cause an exception to be thrown, false is never returned.
    Note:If an additional authentication factor has been set in the AS400 object, it is used.
    
    Returns:
    
    true if successful.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    ExtendedIllegalStateException - If system name or user ID not set.
    
    IOException - If an error occurs while communicating with the system.
  - authenticate
```
@Deprecated
public boolean authenticate(String userId,
                            String password)
                     throws AS400SecurityException,
                            IOException
```
    Deprecated.
    Using a String as a password is insecure.
    
    Authenticates the user profile name and user profile password.
    This method is functionally equivalent to the validateSignon() method, except it does not alter the user profile assigned to this object, impact the status of existing connections, or otherwise impact the user and authorities on which the application is running.
    The system name needs to be set prior to calling this method.
    Note: Providing an incorrect password increments the number of failed sign-on attempts for the user profile, and can result in the profile being disabled.
    Note: This will return true if the information is successfully validated. An unsuccessful validation will cause an exception to be thrown, false is never returned.
    
    Parameters:
    
    userId - The user profile name.
    
    password - The user profile password.
    
    Returns:
    
    true if successful.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    IOException - If an error occurs while communicating with the system.
  - authenticate
```
public boolean authenticate(String userId,
                            char[] password)
                     throws AS400SecurityException,
                            IOException
```
    Authenticates the user profile name and user profile password.
    This method is functionally equivalent to the validateSignon() method, except it does not alter the user profile assigned to this object, impact the status of existing connections, or otherwise impact the user and authorities on which the application is running.
    The system name needs to be set prior to calling this method.
    Note: Providing an incorrect password increments the number of failed sign-on attempts for the user profile, and can result in the profile being disabled.
    Note: This will return true if the information is successfully validated. An unsuccessful validation will cause an exception to be thrown, false is never returned.
    
    Parameters:
    
    userId - The user profile name.
    
    password - The user profile password.
    
    Returns:
    
    true if successful.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    IOException - If an error occurs while communicating with the system.
  - canUseNativeOptimizations
```
public boolean canUseNativeOptimizations()
```
    Indicates if this AS400 object is enabled to exploit Toolbox native optimizations. This requires that the native optimization classes are available on the classpath, and this AS400 object represents the local system and is configured to allow the native optimizations to be used. Note: If the authentication scheme is other than AUTHENTICATION_SCHEME_PASSWORD, native optimizations will not be used.
    
    Returns:
    
    true if the native optimizations can be used; false otherwise.
    
    See Also:
    
    isLocal(), isMustUseSockets(), getAuthenticationScheme()
  - changePassword
```
@Deprecated
public void changePassword(String oldPassword,
                           String newPassword)
                    throws AS400SecurityException,
                           IOException
```
    Deprecated.
    Use changePassword(char[] oldPassword, char[] newPassword) instead
    
    Changes the user profile password. The system name and user profile name need to be set prior to calling this method.
    
    Parameters:
    
    oldPassword - The old user profile password.
    
    newPassword - The new user profile password.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    IOException - If an error occurs while communicating with the system.
  - changePassword
```
public void changePassword(char[] oldPassword,
                           char[] newPassword)
                    throws AS400SecurityException,
                           IOException
```
    Changes the user profile password. The system name and user profile name need to be set prior to calling this method.
    
    Parameters:
    
    oldPassword - The old user profile password.
    
    newPassword - The new user profile password.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    IOException - If an error occurs while communicating with the system.
  - changePassword
```
public void changePassword(char[] oldPassword,
                           char[] newPassword,
                           char[] additionalAuthFactor)
                    throws AS400SecurityException,
                           IOException
```
    Changes the user profile password. The system name and user profile name need to be set prior to calling this method.
    
    Parameters:
    
    oldPassword - The old user profile password.
    
    newPassword - The new user profile password.
    
    additionalAuthFactor - Additional authentication factor (or null if not providing one).
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    ExtendedIllegalStateException - If system name or user ID not set.
    
    IOException - If an error occurs while communicating with the system.
  - clearPasswordCache
```
public static void clearPasswordCache()
```
    Clears the password cache for all systems within this Java virtual machine.
  - clearPasswordCache
```
public static void clearPasswordCache(String systemName)
```
    Clears all the passwords that are cached for the given system name within this Java virtual machine.
    
    Parameters:
    
    systemName - The name of the IBM i system.
  - connectService
```
public void connectService(int service)
                    throws AS400SecurityException,
                           IOException
```
    Connects to a service. Security is validated and a connection is established.
    Services typically connect implicitly; therefore, this method does not have to be called to use a service. This method can be used to control when the connection is established.
    Parameters:
    service - The name of the service. Valid services are:
    
    FILE - IFS file classes.
    PRINT - print classes.
    COMMAND - command and program call classes.
    DATAQUEUE - data queue classes.
    DATABASE - JDBC classes.
    RECORDACCESS - record level access classes.
    CENTRAL - license management classes.
    SIGNON - sign-on classes.
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    IOException - If an error occurs while communicating with the system.
  - connectService
```
public void connectService(int service,
                           int overridePort)
                    throws AS400SecurityException,
                           IOException
```
    Connects to a service. Security is validated and a connection is established.
    Services typically connect implicitly; therefore, this method does not have to be called to use a service. This method can be used to control when the connection is established.
    Parameters:
    service - The name of the service. Valid services are:
    
    FILE - IFS file classes.
    PRINT - print classes.
    COMMAND - command and program call classes.
    DATAQUEUE - data queue classes.
    DATABASE - JDBC classes.
    RECORDACCESS - record level access classes.
    CENTRAL - license management classes.
    SIGNON - sign-on classes.
    overridePort - If non-negative, used to override the port to be used for the connection.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    ExtendedIllegalArgumentException - If service is not valid.
    
    IOException - If an error occurs while communicating with the system.
  - disconnectAllServices
```
public void disconnectAllServices()
```
    Disconnects all services. All socket connections associated with this object will be closed. The signon information is not changed, and connection properties remain frozen.
    
    See Also:
    
    resetAllServices()
  - disconnectService
```
public void disconnectService(int service)
```
    Disconnects the service. All socket connections associated with this service and this object will be closed.
    Parameters:
    service - The name of the service. Valid services are:
    
    FILE - IFS file classes.
    PRINT - print classes.
    COMMAND - command and program call classes.
    DATAQUEUE - data queue classes.
    DATABASE - JDBC classes.
    RECORDACCESS - record level access classes.
    CENTRAL - license management classes.
    SIGNON - sign-on classes.
    HOSTCNN - host-connection classes.
    Throws:
    
    ExtendedIllegalArgumentException - If service is not valid.
  - generateProfileToken
```
public ProfileTokenCredential generateProfileToken(String userIdentity,
                                                   int tokenType,
                                                   int timeoutInterval)
                                            throws AS400SecurityException,
                                                   IOException
```
    Generates a profile token on behalf of the provided user identity. This user identity must be associated with a user profile via EIM.
    Invoking this method does not change the user ID and password assigned to the system or otherwise modify the user or authorities under which the application is running. The profile associated with this system object must have enough authority to generate an authentication token for another user.
    This function is only supported on i5/OS V5R3M0 or greater.
    Parameters:
    
    userIdentity - The LDAP distinguished name.
    tokenType - The type of profile token to create. Possible types are defined as fields on the ProfileTokenCredential class:
    
    TYPE_SINGLE_USE
    TYPE_MULTIPLE_USE_NON_RENEWABLE
    TYPE_MULTIPLE_USE_RENEWABLE
    timeoutInterval - The number of seconds to expiration when the token is created (1-3600).
    
    Returns:
    
    A ProfileTokenCredential representing the provided user identity.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    IOException - If an error occurs while communicating with the system.
  - generateProfileToken
```
public ProfileTokenCredential generateProfileToken(String userIdentity,
                                                   int tokenType,
                                                   int timeoutInterval,
                                                   String verificationID,
                                                   String remoteIPAddress)
                                            throws AS400SecurityException,
                                                   IOException
```
    Generates a profile token on behalf of the provided user identity. This user identity must be associated with a user profile via EIM.
    Invoking this method does not change the user ID and password assigned to the system or otherwise modify the user or authorities under which the application is running. The profile associated with this system object must have enough authority to generate an authentication token for another user.
    This function is only supported on i5/OS V5R3M0 or greater.
    Parameters:
    
    userIdentity - The LDAP distinguished name.
    tokenType - The type of profile token to create. Possible types are defined as fields on the ProfileTokenCredential class:
    
    TYPE_SINGLE_USE
    TYPE_MULTIPLE_USE_NON_RENEWABLE
    TYPE_MULTIPLE_USE_RENEWABLE
    timeoutInterval - The number of seconds to expiration when the token is created (1-3600).
    
    verificationID - The verification ID that will be associated with profile token. The verification ID is the label that identifies the specific application, service, or action associated with the profile token request. A null value will result in the usage of the default value of QIBM_OS400_JT400.
    
    remoteIPAddress - The remote IP address (the IP address of the requester) that will be associated with profile token. A null value will result in the usage of the local IP address returned on the connection to the host server, assuming that the profile token is being created by the host server. If the profile token is being created by an ILE API, the remoteIPAddress will be null.
    
    Returns:
    
    A ProfileTokenCredential representing the provided user identity.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    IOException - If an error occurs while communicating with the system.
  - generateVRM
```
public static int generateVRM(int version,
                              int release,
                              int modification)
```
    Generates a VRM from a version, release, and modification. This can then be used to compare against the VRM returned by getVRM().
    
    Parameters:
    
    version - The version.
    
    release - The release.
    
    modification - The modification level.
    
    Returns:
    
    The generated VRM.
    
    Throws:
    
    ExtendedIllegalArgumentException - If version, release, or modification is not valid.
  - getAuthenticationScheme
```
public int getAuthenticationScheme()
```
    Returns the authentication scheme for this object. By default this object starts in password mode. This value may not be correct before a connection to the system has been made. Valid authentication schemes are:
    - AUTHENTICATION_SCHEME_PASSWORD - passwords are used.
    - AUTHENTICATION_SCHEME_GSS_TOKEN - GSS tokens are used.
    - AUTHENTICATION_SCHEME_PROFILE_TOKEN - profile tokens are used.
    - AUTHENTICATION_SCHEME_IDENTITY_TOKEN - identity tokens are used.
    Returns:
    
    The authentication scheme in use for this object.
  - getCcsid
```
public int getCcsid()
```
    Returns the CCSID for this object. The CCSID returned either is the one retrieved based on the user profile or is set by the setCcsid() method.
    
    Returns:
    
    The CCSID in use for this object.
  - getDefaultSignonHandler
```
public static SignonHandler getDefaultSignonHandler()
```
    Returns the default sign-on handler. If none has been specified, returns an instance of the Toolbox's internal sign-on handler.
    
    Returns:
    
    The default sign-on handler. Never returns null.
    
    See Also:
    
    setDefaultSignonHandler(com.ibm.as400.access.SignonHandler)
  - getDDMRDB
```
public String getDDMRDB()
```
    Returns the relational database name (RDB name) used for record-level access (DDM) connections. The RDB name corresponds to the independent auxiliary storage pool (IASP) that is being used.
    
    Returns:
    
    The name of the IASP or RDB that is in use by this object's RECORDACCESS service, or null if the IASP used will be the default system pool (*SYSBAS).
    
    See Also:
    
    setDDMRDB(java.lang.String)
  - getDefaultUser
```
public static String getDefaultUser(String systemName)
```
    Returns the default user ID for this system name. This user ID is used to connect if a user ID was not used to construct the object.
    
    Parameters:
    
    systemName - The name of the IBM i system.
    
    Returns:
    
    The default user ID for this system. A null is returned if there is not a default user.
  - getGSSName
```
public String getGSSName()
```
    Returns the GSS name string. This method will only return the information provided on the setGSSName() method.
    
    Returns:
    
    The GSS name string, or an empty string ("") if not set.
  - getGSSOption
```
public int getGSSOption()
```
    Returns the option for how the JGSS framework will be used.
    Returns:
    A constant indicating how the JGSS framework will be used. Valid values are:
    
    GSS_OPTION_MANDATORY
    GSS_OPTION_FALLBACK
    GSS_OPTION_NONE
  - getImpl
```
public com.ibm.as400.access.AS400Impl getImpl()
```
    Get underlying AS400Impl object. Should only be used by code internal to the driver.
    
    Returns:
    
    underlying AS400Impl object
  - getJobCCSIDEncoding
```
public String getJobCCSIDEncoding()
                           throws AS400SecurityException,
                                  IOException,
                                  InterruptedException
```
    Returns the encoding that corresponds to the job CCSID.
    
    Returns:
    
    The encoding.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    IOException - If an error occurs while communicating with the system.
    
    InterruptedException - If this thread is interrupted.
  - getJobs
```
public Job[] getJobs(int service)
```
    Returns an array of Job objects representing the jobs to which this object is connected. This information is only available when connecting to i5/OS V5R2M0 and later systems. The array will be of length zero if no connections are currently active.
    Parameters:
    service - The name of the service. Valid services are:
    
    FILE - IFS file classes.
    PRINT - print classes.
    COMMAND - command and program call classes.
    DATAQUEUE - data queue classes.
    DATABASE - JDBC classes.
    RECORDACCESS - record level access classes.
    CENTRAL - license management classes.
    SIGNON - sign-on classes.
    HOSTCNN - host-connection classes.
    Returns:
    
    The array of job objects.
    
    Throws:
    
    ExtendedIllegalArgumentException - If service is not valid.
  - getLocale
```
public Locale getLocale()
```
    Returns the Locale associated with this system object. The Locale may have been set with the setLocale() method, or it may be the default Locale for the client environment. Unless specifically overridden, this Locale is used to set the National Language Version (NLV) on the system. Only the COMMAND, PRINT, and DATABASE services accept an NLV.
    
    Returns:
    
    The Locale object.
  - getModification
```
public int getModification()
                    throws AS400SecurityException,
                           IOException
```
    Returns the modification level of the IBM i system.
    A connection is required to the system to retrieve this information. If a connection has not been established, one is created to retrieve the information.
    
    Returns:
    
    The modification level. For example, version 5, release 1, modification level 0 returns 0.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    IOException - If an error occurs while communicating with the system.
  - getNLV
```
public String getNLV()
```
    Returns the National Language Version (NLV) that will be sent to the system. Only the COMMAND, PRINT, and DATABASE services accept an NLV.
    
    Returns:
    
    The NLV.
  - getPasswordExpirationDate
```
public GregorianCalendar getPasswordExpirationDate()
                                            throws AS400SecurityException,
                                                   IOException
```
    Returns the password expiration date for the signed-on user. If the profile's password expiration interval is set to *NOMAX, null is returned.
    A connection is required to retrieve this information. If a connection has not been established, one is created to retrieve the information.
    
    Returns:
    
    The password expiration date. If the profile has no password expiration data (*NOMAX), null is returned.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    IOException - If an error occurs while communicating with the system.
  - setUseSystemPasswordExpirationWarningDays
```
public void setUseSystemPasswordExpirationWarningDays(boolean useSystem)
```
    Set a flag to indicate whether or not to use the password expiration warning days from the QPWDEXPWRN system value. This capability is supported with V6R1M0 and later systems with V6R1M0 5761SS1 PTF SI48808 or V7R1M0 5770SS1 PTF SI48809.
    
    Parameters:
    
    useSystem - indicates whether or not to use password expiration warning days from the QPWDEXPWRN system value
  - getSystemPasswordExpirationWarningDays
```
public int getSystemPasswordExpirationWarningDays()
                                           throws AS400SecurityException,
                                                  IOException
```
    Returns the number of days before password expiration to start warning the user based on the value of the QPWDEXPWRN system value. This capability is supported with V6R1M0 and later systems with V6R1M0 5761SS1 PTF SI48808 or V7R1M0 5770SS1 PTF SI48809.
    
    Returns:
    
    The number of days before password expiration to start warning the user. If setUseSystemPasswordExpirationWarningDays(boolean) is enabled and supported, return the value of the QPWDEXPWRN system value. Otherwise, return getPasswordExpirationWarningDays().
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    IOException - If an error occurs while communicating with the system.
  - isInPasswordExpirationWarningDays
```
public boolean isInPasswordExpirationWarningDays()
                                          throws AS400SecurityException,
                                                 IOException
```
    Determines if the password expiration date for the user profile is within the password expiration warning days for the system returned by getPasswordExpirationDays().
    
    Returns:
    
    true if the password expiration date for the user profile is within the password expiration days; otherwise, return false
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    IOException - If an error occurs while communicating with the system.
  - getPasswordExpirationDays
```
public int getPasswordExpirationDays()
                              throws AS400SecurityException,
                                     IOException
```
    Returns the number of days until the user profile's password expires.
    A connection is required to retrieve this information. If a connection has not been established, one is created to retrieve the information.
    
    Returns:
    
    The number of days until the user profiles' password expires.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    IOException - If an error occurs while communicating with the system.
  - getPasswordExpirationWarningDays
```
public static int getPasswordExpirationWarningDays()
```
    Returns the number of days before password expiration to start warning the user.
    
    Returns:
    
    The number of days before expiration to warn the user.
  - getPreviousSignonDate
```
public GregorianCalendar getPreviousSignonDate()
                                        throws AS400SecurityException,
                                               IOException
```
    Returns the date of the last successful sign-on.
    A connection is required to retrieve this information. If a connection has not been established, one is created to retrieve the information.
    
    Returns:
    
    The date of the last successful sign-on.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    IOException - If an error occurs while communicating with the system.
  - getProfileToken
```
@Deprecated
public ProfileTokenCredential getProfileToken()
                                       throws AS400SecurityException,
                                              IOException,
                                              InterruptedException
```
    Deprecated.
    Use getProfileToken(int,int) instead.
    
    Returns a profile token representing the signed-on user profile.
    The returned token will be created single-use with a one hour time to expiration. Subsequent method calls will return the same token, regardless of the token status.
    This function is not supported if the assigned password is *CURRENT.
    This function is only supported if the system is at i5/OS V4R5M0 or greater.
    Note: If an additional authentication factor has been set for the AS400 object, it will be used when generating the profile token.
    
    Returns:
    
    A ProfileTokenCredential representing the currently signed on user.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    IOException - If an error occurs while communicating with the system.
    
    InterruptedException - If this thread is interrupted.
  - getProfileToken
```
public ProfileTokenCredential getProfileToken(int tokenType,
                                              int timeoutInterval)
                                       throws AS400SecurityException,
                                              IOException,
                                              InterruptedException
```
    Authenticates the assigned user profile and password and returns a corresponding ProfileTokenCredential if successful.
    This function is not supported if the assigned password is *CURRENT and cannot be used to generate a renewable token. This function is only supported if the system is at i5/OS V4R5M0 or greater.
    Note: If an additional authentication factor has been set for the AS400 object, it will be used when generating the profile token.
    Parameters:
    tokenType - The type of profile token to create. Possible types are defined as fields on the ProfileTokenCredential class:
    
    TYPE_SINGLE_USE
    TYPE_MULTIPLE_USE_NON_RENEWABLE
    timeoutInterval - The number of seconds to expiration when the token is created (1-3600).
    
    Returns:
    
    A ProfileTokenCredential representing the signed-on user.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    IOException - If an error occurs while communicating with the system.
    
    InterruptedException - If this thread is interrupted.
  - getProfileToken
```
public ProfileTokenCredential getProfileToken(int tokenType,
                                              int timeoutInterval,
                                              String verificationID,
                                              String remoteIPAddress)
                                       throws AS400SecurityException,
                                              IOException,
                                              InterruptedException
```
    Authenticates the assigned user profile and password and returns a corresponding ProfileTokenCredential if successful.
    This function is not supported if the assigned password is *CURRENT and cannot be used to generate a renewable token. This function is only supported if the system is at i5/OS V4R5M0 or greater.
    Note: If an additional authentication factor has been set for the AS400 object, it will be used when generating the profile token.
    Parameters:
    tokenType - The type of profile token to create. Possible types are defined as fields on the ProfileTokenCredential class:
    
    TYPE_SINGLE_USE
    TYPE_MULTIPLE_USE_NON_RENEWABLE
    timeoutInterval - The number of seconds to expiration when the token is created (1-3600).
    
    verificationID - The verification ID that will be associated with profile token. The verification ID is the label that identifies the specific application, service, or action associated with the profile token request. A null value will result in the usage of the default value of QIBM_OS400_JT400.
    
    remoteIPAddress - The remote IP address (the IP address of the requester) that will be associated with profile token. A null value will result in the usage of the local IP address returned on the connection to the host server, assuming that the profile token is being created by the host server. If the profile token is being created by an ILE API, the remoteIPAddress will be null.
    
    Returns:
    
    A ProfileTokenCredential representing the signed-on user.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    IOException - If an error occurs while communicating with the system.
    
    InterruptedException - If this thread is interrupted.
  - getProfileToken
```
@Deprecated
public ProfileTokenCredential getProfileToken(String userId,
                                              String password)
                                       throws AS400SecurityException,
                                              IOException,
                                              InterruptedException
```
    Deprecated.
    Use getProfileToken(String, char[]) instead.
    
    Authenticates the given user profile and password and returns a corresponding ProfileTokenCredential if successful.
    Invoking this method does not change the user ID and password assigned to the system or otherwise modify the user or authorities under which the application is running.
    This method generates a single use token with a timeout of one hour.
    This function is only supported if the system is at i5/OS V4R5M0 or greater.
    Note: Providing an incorrect password increments the number of failed sign-on attempts for the user profile, and can result in the profile being disabled. Refer to documentation on the ProfileTokenCredential class for additional restrictions.
    
    Parameters:
    
    userId - The user profile name.
    
    password - The user profile password.
    
    Returns:
    
    A ProfileTokenCredential representing the authenticated profile and password.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    IOException - If an error occurs while communicating with the system.
    
    InterruptedException - If this thread is interrupted.
  - getProfileToken
```
public ProfileTokenCredential getProfileToken(String userId,
                                              char[] password)
                                       throws AS400SecurityException,
                                              IOException,
                                              InterruptedException
```
    Authenticates the given user profile and password and returns a corresponding ProfileTokenCredential if successful.
    Invoking this method does not change the user ID and password assigned to the system or otherwise modify the user or authorities under which the application is running.
    This method generates a single use token with a timeout of one hour.
    This function is only supported if the system is at i5/OS V4R5M0 or greater.
    Note: Providing an incorrect password increments the number of failed sign-on attempts for the user profile, and can result in the profile being disabled. Refer to documentation on the ProfileTokenCredential class for additional restrictions.
    
    Parameters:
    
    userId - The user profile name.
    
    password - The user profile password.
    
    Returns:
    
    A ProfileTokenCredential representing the authenticated profile and password.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    IOException - If an error occurs while communicating with the system.
    
    InterruptedException - If this thread is interrupted.
  - getProfileToken
```
@Deprecated
public ProfileTokenCredential getProfileToken(String userId,
                                              String password,
                                              int tokenType,
                                              int timeoutInterval)
                                       throws AS400SecurityException,
                                              IOException,
                                              InterruptedException
```
    Deprecated.
    Use getProfileToken(String, char[],int,int) instead.
    
    Authenticates the given user profile and password and returns a corresponding ProfileTokenCredential if successful.
    Invoking this method does not change the user ID and password assigned to the system or otherwise modify the user or authorities under which the application is running.
    This function is only supported if the system is at i5/OS V4R5M0 or greater.
    Note: Providing an incorrect password increments the number of failed sign-on attempts for the user profile, and can result in the profile being disabled. Refer to documentation on the ProfileTokenCredential class for additional restrictions.
    Parameters:
    
    userId - The user profile name.
    
    password - The user profile password.
    tokenType - The type of profile token to create. Possible types are defined as fields on the ProfileTokenCredential class:
    
    TYPE_SINGLE_USE
    TYPE_MULTIPLE_USE_NON_RENEWABLE
    TYPE_MULTIPLE_USE_RENEWABLE
    timeoutInterval - The number of seconds to expiration when the token is created (1-3600).
    
    Returns:
    
    A ProfileTokenCredential representing the authenticated profile and password.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    IOException - If an error occurs while communicating with the system.
    
    InterruptedException - If this thread is interrupted.
  - getProfileToken
```
public ProfileTokenCredential getProfileToken(String userId,
                                              char[] password,
                                              int tokenType,
                                              int timeoutInterval)
                                       throws AS400SecurityException,
                                              IOException,
                                              InterruptedException
```
    Authenticates the given user profile and password and returns a corresponding ProfileTokenCredential if successful.
    Invoking this method does not change the user ID and password assigned to the system or otherwise modify the user or authorities under which the application is running.
    This function is only supported if the system is at i5/OS V4R5M0 or greater.
    Note: Providing an incorrect password increments the number of failed sign-on attempts for the user profile, and can result in the profile being disabled. Refer to documentation on the ProfileTokenCredential class for additional restrictions.
    Parameters:
    
    userId - The user profile name.
    
    password - The user profile password.
    tokenType - The type of profile token to create. Possible types are defined as fields on the ProfileTokenCredential class:
    
    TYPE_SINGLE_USE
    TYPE_MULTIPLE_USE_NON_RENEWABLE
    TYPE_MULTIPLE_USE_RENEWABLE
    timeoutInterval - The number of seconds to expiration when the token is created (1-3600).
    
    Returns:
    
    A ProfileTokenCredential representing the authenticated profile and password.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    IOException - If an error occurs while communicating with the system.
    
    InterruptedException - If this thread is interrupted.
  - getProfileToken
```
public ProfileTokenCredential getProfileToken(String userId,
                                              char[] password,
                                              char[] additionalAuthFactor,
                                              int tokenType,
                                              int timeoutInterval,
                                              String verificationID,
                                              String remoteIPAddress)
                                       throws AS400SecurityException,
                                              IOException,
                                              InterruptedException
```
    Authenticates the given user profile and password and returns a corresponding ProfileTokenCredential if successful.
    Invoking this method does not change the user ID and password assigned to the system or otherwise modify the user or authorities under which the application is running.
    This function is only supported if the system is at i5/OS V4R5M0 or greater.
    Note: Providing an incorrect password increments the number of failed sign-on attempts for the user profile, and can result in the profile being disabled. Refer to documentation on the ProfileTokenCredential class for additional restrictions.
    Parameters:
    
    userId - The user profile name.
    
    password - The user profile password.
    
    additionalAuthFactor - The additional authentication factor or null if not specifying one.
    tokenType - The type of profile token to create. Possible types are defined as fields on the ProfileTokenCredential class:
    
    TYPE_SINGLE_USE
    TYPE_MULTIPLE_USE_NON_RENEWABLE
    TYPE_MULTIPLE_USE_RENEWABLE
    timeoutInterval - The number of seconds to expiration when the token is created (1-3600).
    
    verificationID - The verification ID that will be associated with profile token. The verification ID is the label that identifies the specific application, service, or action associated with the profile token request. A null value will result in the usage of the default value of QIBM_OS400_JT400.
    
    remoteIPAddress - The remote IP address (the IP address of the requester) that will be associated with profile token. AA null value will result in the usage of the local IP address returned on the connection to the host server, assuming that the profile token is being created by the host server. If the profile token is being created by an ILE API, the remoteIPAddress will be null.
    
    Returns:
    
    A ProfileTokenCredential representing the authenticated profile and password.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    ExtendedIllegalArgumentException - If userId length is not valid.
    
    IOException - If an error occurs while communicating with the system.
    
    InterruptedException - If this thread is interrupted.
  - getProfileToken
```
public ProfileTokenCredential getProfileToken(String userId,
                                              char[] password,
                                              char[] additionalAuthFactor,
                                              int tokenType,
                                              int timeoutInterval,
                                              ProfileTokenEnhancedInfo enhancedInfo)
                                       throws AS400SecurityException,
                                              IOException,
                                              InterruptedException
```
    Authenticates the given user profile and password and returns a corresponding ProfileTokenCredential if successful.
    Invoking this method does not change the user ID and password assigned to the system or otherwise modify the user or authorities under which the application is running.
    This function is only supported if the system is at i5/OS V4R5M0 or greater.
    Note: Providing an incorrect password increments the number of failed sign-on attempts for the user profile, and can result in the profile being disabled. Refer to documentation on the ProfileTokenCredential class for additional restrictions.
    Parameters:
    
    userId - The user profile name.
    
    password - The user profile password.
    
    additionalAuthFactor - The additional authentication factor or null if not specifying one.
    tokenType - The type of profile token to create. Possible types are defined as fields on the ProfileTokenCredential class:
    
    TYPE_SINGLE_USE
    TYPE_MULTIPLE_USE_NON_RENEWABLE
    TYPE_MULTIPLE_USE_RENEWABLE
    timeoutInterval - The number of seconds to expiration when the token is created (1-3600).
    
    enhancedInfo - Information used for creating an enhanced profile token.
    
    Returns:
    
    A ProfileTokenCredential representing the authenticated profile and password.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    ExtendedIllegalArgumentException - If userId length is not valid.
    
    IOException - If an error occurs while communicating with the system.
    
    InterruptedException - If this thread is interrupted.
  - getProxyServer
```
public String getProxyServer()
```
    Returns the name of the middle-tier machine where the proxy server is running.
    
    Returns:
    
    The name of the middle-tier machine where the proxy server is running, or an empty string ("") if not set.
  - getRelease
```
public int getRelease()
               throws AS400SecurityException,
                      IOException
```
    Returns the release of the IBM i system.
    A connection is required to the system in order to retrieve this information. If a connection has not been established, one is created to retrieve the system information.
    
    Returns:
    
    The release of the IBM i system. For example, version 5, release 1, modification level 0, returns 1.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    IOException - If an error occurs while communicating with the system.
  - getServerName
```
public static String getServerName(int service)
```
    Converts a service constant to the string representation of the service. For example, the integer AS400.File corresponds to the string "as-file".
    
    Parameters:
    
    service - The service represented by it's integer value.
    
    Returns:
    
    The string representation of the service.
    
    Throws:
    
    ExtendedIllegalArgumentException - If service is not valid.
  - getServicePort
```
public int getServicePort(int service)
```
    Returns the service port stored in the service port table for the specified service.
    Parameters:
    service - The name of the service. Valid services are:
    
    FILE - IFS file classes.
    PRINT - print classes.
    COMMAND - command and program call classes.
    DATAQUEUE - data queue classes.
    DATABASE - JDBC classes.
    RECORDACCESS - record level access classes.
    CENTRAL - license management classes.
    SIGNON - sign-on classes.
    HOSTCNN - host-connection classes.
    Returns:
    
    The port specified in the service port table. The value USE_PORT_MAPPER will be returned if the service has not been set, and the service has not been connected.
    
    Throws:
    
    ExtendedIllegalArgumentException - If service is not valid.
    
    ExtendedIllegalStateException - If system name not set.
  - getSignonDate
```
public GregorianCalendar getSignonDate()
                                throws AS400SecurityException,
                                       IOException
```
    Returns the date for the current sign-on.
    A connection is required to the system to retrieve this information. If a connection has not been established, one is created to retrieve the system information.
    
    Returns:
    
    The date for the current sign-on.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    IOException - If an error occurs while communicating with the system.
  - getSignonHandler
```
public SignonHandler getSignonHandler()
```
    Returns the sign-on handler that is used by this object. Never returns null.
    
    Returns:
    
    The sign-on handler.
    
    See Also:
    
    setSignonHandler(com.ibm.as400.access.SignonHandler), setDefaultSignonHandler(com.ibm.as400.access.SignonHandler)
  - getSocketProperties
```
public SocketProperties getSocketProperties()
```
    Returns a copy of the socket options object.
    
    Returns:
    
    The socket options object.
  - getSystemName
```
public String getSystemName()
```
    Returns the name of the IBM i system. The system name is provided on the constructor or may have been provided by the user at the sign-on prompt.
    
    Returns:
    
    The name of the IBM i system, or an empty string ("") if not set.
  - getSystemTimeZone
```
@Deprecated
public TimeZone getSystemTimeZone()
                           throws AS400SecurityException,
                                  ErrorCompletingRequestException,
                                  InterruptedException,
                                  IOException,
                                  ObjectDoesNotExistException
```
    Deprecated.
    Use getTimeZone() instead.
    
    Returns the time zone of the IBM i system. The TimeZone object will have the correct UTC offset for the system.
    
    Returns:
    
    A TimeZone object representing the time zone for the system.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    
    InterruptedException - If this thread is interrupted.
    
    IOException - If an error occurs while communicating with the system.
    
    ObjectDoesNotExistException - If the API used to retrieve the information does not exist on the system.
    
    See Also:
    
    DateTimeConverter.timeZoneForSystem(com.ibm.as400.access.AS400)
  - getTimeZone
```
public TimeZone getTimeZone()
                     throws AS400SecurityException,
                            ErrorCompletingRequestException,
                            InterruptedException,
                            IOException,
                            ObjectDoesNotExistException
```
    Returns the time zone of the IBM i system. The TimeZone object will have the correct UTC offset for the system.
    
    Returns:
    
    A TimeZone object representing the time zone for the system.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    
    InterruptedException - If this thread is interrupted.
    
    IOException - If an error occurs while communicating with the system.
    
    ObjectDoesNotExistException - If the API used to retrieve the information does not exist on the system.
    
    See Also:
    
    DateTimeConverter.timeZoneForSystem(com.ibm.as400.access.AS400)
  - getDefaultTimeZone
```
public static TimeZone getDefaultTimeZone(AS400 system)
```
    Returns the timezone of the IBM i, if available. If the timezone is not available, then the default timezone for the client will be return.
    
    Parameters:
    
    system - System to get the timezone from
    
    Returns:
    
    The timezone of the IBM i if available.
  - getUserId
```
public String getUserId()
```
    Returns the user ID. The user ID returned may be set as a result of the constructor, or it may be what the user typed in at the sign-on prompt.
    
    Returns:
    
    The user ID, or an empty string ("") if not set.
  - getUserId
```
public String getUserId(boolean forceRefresh)
```
    Returns the user ID. The user ID returned may be set as a result of the constructor, or it may be what the user typed in at the sign-on prompt.
    
    Parameters:
    
    forceRefresh - If true, force the current userID information to be reloaded. When running natively with system name specified as localhost, this will obtain the user profile under which the thread is currently running. This may have changed since object construction, if a profile swap has been performed on the thread. If false, or if running remotely, then this method behaves identically to getUserId().
    
    Returns:
    
    The user ID, or an empty string ("") if not set.
  - getVersion
```
public int getVersion()
               throws AS400SecurityException,
                      IOException
```
    Returns the version of the IBM i system.
    A connection is required to the system to retrieve this information. If a connection has not been established, one is created to retrieve the system information.
    
    Returns:
    
    The version of the IBM i system. For example, version 5, release 1, modification level 0, returns 5.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    IOException - If an error occurs while communicating with the system.
  - getVRM
```
public static int getVRM(String systemName,
                         boolean useSSL)
                  throws AS400SecurityException,
                         IOException
```
    Returns the version, release, and modification level a given system.
    
    Parameters:
    
    systemName - The IP address or hostname of the target system.
    
    useSSL - Whether or not secure connections should be used when communicating with the host servers.
    
    Returns:
    
    The high 16-bit is the version, the next 8 bits is the release, and the low 8 bits is the modification level. Thus version 5, release 1, modification level 0, returns 0x00050100.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    IOException - If an error occurs while communicating with the system.
  - getVRM
```
public int getVRM()
           throws AS400SecurityException,
                  IOException
```
    Returns the version, release, and modification level for the system.
    A connection is required to the system to retrieve this information. If a connection has not been established, one is created to retrieve the system information.
    
    Returns:
    
    The high 16-bit is the version, the next 8 bits is the release, and the low 8 bits is the modification level. Thus version 5, release 1, modification level 0, returns 0x00050100.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    IOException - If an error occurs while communicating with the system.
  - setVRM
```
protected void setVRM(int v,
                      int r,
                      int m)
```
    Sets the VRM for the object, creating a signonInfo as needed
  - initializeConverter
```
public void initializeConverter(int ccsid)
                         throws UnsupportedEncodingException
```
    Initialize conversion table for the given CCSID. The default EBCDIC to unicode converters are not shipped with some browsers. This method can be used to check and download converters if they are not available locally.
    
    Parameters:
    
    ccsid - the CCSID for the conversion table to initialize.
    
    Throws:
    
    UnsupportedEncodingException - If the Character Encoding is not supported.
  - isConnected
```
public boolean isConnected()
```
    Indicates if any service is currently connected through this object.
    A service is considered "connected" if connectService() has been called, or an implicit connect has been done by the service, and disconnectService() or disconnectAllServices() has not been called. If the most recent attempt to contact the service failed with an exception, the service is considered disconnected.
    
    Returns:
    
    true if any service is connected; false otherwise.
    
    See Also:
    
    isConnectionAlive()
  - isConnected
```
public boolean isConnected(int service)
```
    Indicates if a service is currently connected through this object.
    A service is considered "connected" if connectService() has been called, or an implicit connect has been done by the service, and disconnectService() or disconnectAllServices() has not been called. If the most recent attempt to contact the service failed with an exception, the service is considered disconnected.
    Parameters:
    service - The name of the service. Valid services are:
    
    FILE - IFS file classes.
    PRINT - print classes.
    COMMAND - command and program call classes.
    DATAQUEUE - data queue classes.
    DATABASE - JDBC classes.
    RECORDACCESS - record level access classes.
    CENTRAL - license management classes.
    SIGNON - sign-on classes.
    HOSTCNN - host connection classes.
    Returns:
    
    true if service is connected; false otherwise.
    
    Throws:
    
    ExtendedIllegalArgumentException - If service is not valid.
    
    See Also:
    
    isConnectionAlive()
  - isConnectionAlive
```
public boolean isConnectionAlive()
```
    Tests the connection to the system, to verify that it is still working. This is similar in concept to "pinging" the system over the connection. If no services have been connected, this method returns false; it doesn't implicitly connect services.
    Note: This method is not fully supported until IBM i 7.1. If running to IBM i 6.1 or lower, then the behavior of this method matches that of isConnected(), and therefore may incorrectly return true if the connection has failed recently.
    Note: If the only service connected is RECORDACCESS, then this method defaults to the behavior of isConnected().
    
    Returns:
    
    true if the connection is still working; false otherwise.
    
    See Also:
    
    isConnected(), AS400JPing
  - isConnectionAlive
```
public boolean isConnectionAlive(int service)
```
    Tests the connection to a service on the system, to verify that it is still working. This is similar in concept to "pinging" the system over the connection. If no services have been connected, this method returns false; it doesn't implicitly connect services.
    Note: This method is not fully supported until IBM i 7.1. If running to IBM i 6.1 or lower, then the behavior of this method matches that of isConnected(), and therefore may incorrectly return true if the connection has failed recently.
    Note: If the specified service is RECORDACCESS, then this method defaults to the behavior of isConnected().
    Parameters:
    service - The name of the service. Valid services are:
    
    FILE - IFS file classes.
    PRINT - print classes.
    COMMAND - command and program call classes.
    DATAQUEUE - data queue classes.
    DATABASE - JDBC classes.
    RECORDACCESS - record level access classes.
    CENTRAL - license management classes.
    SIGNON - sign-on classes.
    HOSTCNN - host connection classes.
    Returns:
    
    true if the connection to the service is still working; false otherwise.
    
    See Also:
    
    isConnected(), AS400JPing
  - isGuiAvailable
```
public boolean isGuiAvailable()
```
    Returns the sign-on prompting mode for this object. If true, then messages are displayed. If warnings or errors occur, the sign-on and change password dialogs are displayed if needed. If false, warnings and errors result in exceptions, and password dialogs are not displayed. The caller has to provide the user ID and password.
    
    Returns:
    
    true if using GUI; false otherwise.
  - isLocal
```
public boolean isLocal()
```
    Indicates if this object is representing the system you are currently running on.
    
    Returns:
    
    true if you are running on the local system; false otherwise.
  - isMustUseSockets
```
public boolean isMustUseSockets()
```
    When your Java program runs on the system, some Toolbox classes access data via a call to an API instead of making a socket call to the system. There are minor differences in the behavior of the classes when they use API calls instead of socket calls. If your program is affected by these differences you can check whether the Toolbox classes will use socket calls instead of API calls by using this method.
    
    Returns:
    
    true if you have indicated that the services must use sockets; false otherwise.
  - isShowCheckboxes
```
public boolean isShowCheckboxes()
```
    Indicates if checkboxes should be shown on the sign-on dialog.
    
    Returns:
    
    true if checkboxes should be shown; false otherwise.
  - isThreadUsed
```
public boolean isThreadUsed()
```
    Indicates whether threads are used in communication with the host servers.
    
    Returns:
    
    true if threads are used; false otherwise.
  - isUseDefaultUser
```
public boolean isUseDefaultUser()
```
    Indicates if the default user should be used by this object. If the default user is not used and a user ID was not specified on the constructor, then the user will be prompted for a user ID.
    
    Returns:
    
    true if default user should be used; false otherwise.
  - isUsePasswordCache
```
public boolean isUsePasswordCache()
```
    Indicates if the password cache is being used by this object. If the password cache is not used, the user will always be prompted for password if one was not provided.
    
    Returns:
    
    true if password cache is being used; false otherwise.
  - isUsePassphrase
```
public boolean isUsePassphrase()
                        throws AS400SecurityException,
                               IOException
```
    Is the AS400 object configured to use a pass phrase
    
    Returns:
    
    true if pass phrase can be used
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    IOException - If an error occurs while communicating with the system.
  - removeConnectionListener
```
public void removeConnectionListener(ConnectionListener listener)
```
    Removes a listener from the connection event list.
    
    Parameters:
    
    listener - The listener object.
  - removeDefaultUser
```
public static void removeDefaultUser(String systemName)
```
    Removes the default user for the given system name.
    
    Parameters:
    
    systemName - The name of the IBM i system.
  - removePasswordCacheEntry
```
public static void removePasswordCacheEntry(String systemName,
                                            String userId)
```
    Removes the password cache entry associated with this system name and user ID. Only applies within this Java virtual machine.
    
    Parameters:
    
    systemName - The name of the IBM i system.
    
    userId - The user profile name.
    
    Throws:
    
    ExtendedIllegalArgumentException - If userId length is not valid.
  - removePropertyChangeListener
```
public void removePropertyChangeListener(PropertyChangeListener listener)
```
    Removes a property changed listener from the listener list.
    
    Parameters:
    
    listener - The listener object.
  - removeVetoableChangeListener
```
public void removeVetoableChangeListener(VetoableChangeListener listener)
```
    Removes a listener from the veto list.
    
    Parameters:
    
    listener - The listener object.
  - resetAllServices
```
public void resetAllServices()
```
    Disconnects all services, and clears the sign-on information. This intent of this method is to "wipe the slate clean" for this AS400 object, enabling connection properties to be subsequently changed.
    Note: A call to resetAllServices() results in the stay-alive seconds value to be reset to zero. You will need to invoke the setStayAlive() method to re-enable the stay-alive functionality.
    
    See Also:
    
    disconnectAllServices(), setStayAlive(long)
  - setIdentityToken
```
public void setIdentityToken(byte[] identityToken)
```
    Sets or resets the identity token for this object. Using this method will clear any previously set authentication information.
    Note: Authentication via IdentityToken is supported in operating system release V5R3M0 and by PTF in operating system releases V5R2M0 and V5R1M0.
    
    Parameters:
    
    identityToken - The identity token.
  - setAdditionalAuthenticationFactor
```
public void setAdditionalAuthenticationFactor(char[] additionalAuthFactor)
```
    Set the additional authentication factor for the AS400 object. This will be used when establishing host server connections if the IBM i server supports multifactor authentication.
    
    Parameters:
    
    additionalAuthFactor - The additional authentication factor.
    
    Throws:
    
    ExtendedIllegalArgumentException - If additionalAuthFactor length is not valid.
  - setCcsid
```
public void setCcsid(int ccsid)
              throws PropertyVetoException
```
    Sets the CCSID to be used for this object. The CCSID property cannot be changed once a connection to the system has been established.
    
    Parameters:
    
    ccsid - The CCSID to use for this object.
    
    Throws:
    
    ExtendedIllegalStateException - If a connection has already been made.
    
    PropertyVetoException - If any of the registered listeners vetos the property change.
  - setDDMRDB
```
public void setDDMRDB(String ddmRDB)
```
    Sets the relational database name (RDB name) used for record-level access (DDM) connections. The RDB name corresponds to the independent auxiliary storage pool (IASP) that it is using on the system. The RDB name cannot be changed while this object is actively connected to the RECORDACCESS service; you must call AS400.disconnectService(AS400.RECORDACCESS) first.
    
    Parameters:
    
    ddmRDB - The name of the IASP or RDB to use, or null to indicate the default system ASP should be used.
    
    Throws:
    
    ExtendedIllegalArgumentException - If ddmRDB length is not valid.
    
    ExtendedIllegalStateException - If a connection has already been made.
    
    See Also:
    
    isConnected(int), getDDMRDB()
  - setDefaultSignonHandler
```
public static void setDefaultSignonHandler(SignonHandler handler)
```
    Sets the default sign-on handler, globally across the JVM. The specified handler object will be called at runtime if any AS400 object needs to obtain additional signon information, and a sign-on handler has not been set on the AS400 object via setSignonHandler().
    Users are advised to implement the default sign-on handler in a thread-safe manner, since it may occasionally be in simultaneous use by multiple threads.
    If a default sign-on handler is not set, then the name of the default sign-on handler class is retrieved from the com.ibm.as400.access.AS400.signonHandler system property.
    If not specified, an internal AWT-based sign-on handler is used.
    Note: This property may also be set by specifying a fully-qualified class name in Java system property com.ibm.as400.access.AS400.signonHandler
    
    Parameters:
    
    handler - The sign-on handler. Specifying null will reset the default sign-on handler to the internal AWT-based handler.
    
    See Also:
    
    getDefaultSignonHandler()
  - setDefaultUser
```
public static boolean setDefaultUser(String systemName,
                                     String userId)
```
    Sets the default user for a given system name. The default user is the user ID that is used to connect if a user ID is not provided for that system name. There can be only one default user per system name. Once the default user is set, it cannot be overridden. To change the default user, the caller should remove the default user and then set it.
    
    Parameters:
    
    systemName - The name of the IBM i system.
    
    userId - The user profile name.
    
    Returns:
    
    true if default user has been set; false otherwise.
    
    Throws:
    
    ExtendedIllegalArgumentException - If userId length is not valid.
  - setGSSManager
```
public static void setGSSManager(GSSManager gssMgr)
```
    Sets the GSS manager to be used for all GSS operations.
    
    Parameters:
    
    gssMgr - The GSS manager object.
  - setGSSCredential
```
public void setGSSCredential(GSSCredential gssCredential)
```
    Sets the GSS credential for this object. Using this method will set the authentication scheme to AUTHENTICATION_SCHEME_GSS_TOKEN. Only one authentication means (Kerberos ticket, profile token, identity token, or password) can be used at a single time. Using this method will clear any previously set authentication information.
    
    Parameters:
    
    gssCredential - The GSS credential object.
  - setGSSOption
```
public void setGSSOption(int gssOption)
```
    Sets the option for how the JGSS framework will be used to retrieve a GSS token for authenticating to the system. By default, if no password or profile token is set on this object, it will attempt to retrieve a GSS token. If that retrieval fails, a sign-on dialog can be presented, or on the system, the current user profile information can be used. This option can also be set to only do the GSS token retrieval or to skip the GSS token retrieval.
    Parameters:
    gssOption - A constant indicating how GSS will be used. Valid values are:
    
    GSS_OPTION_MANDATORY
    GSS_OPTION_FALLBACK
    GSS_OPTION_NONE
    Throws:
    
    ExtendedIllegalArgumentException - If gssOption is not valid.
  - setGSSName
```
public void setGSSName(String gssName)
```
    Sets the GSS name for this object. Using this method will set the authentication scheme to AUTHENTICATION_SCHEME_GSS_TOKEN. Only one authentication means (Kerberos ticket, profile token, identity token, or password) can be used at a single time. Using this method will clear any previously set authentication information.
    
    Parameters:
    
    gssName - The GSS name string.
  - setGuiAvailable
```
public void setGuiAvailable(boolean guiAvailable)
                     throws PropertyVetoException
```
    Sets the environment in which you are running. If guiAvailable is set to true, then prompting may occur during sign-on to display error conditions, to prompt for additional information, or to prompt for change password. If guiAvailable is set to false, then error conditions or missing information will result in exceptions. Applications that are running as IBM i applications or want to control the sign-on user interface may want to run with prompting mode set to false. Prompting mode is set to true by default.
    Note: This property may also be set by specifying 'true' or 'false' in Java system property com.ibm.as400.access.AS400.guiAvailable
    
    Parameters:
    
    guiAvailable - true to prompt; false otherwise.
    
    Throws:
    
    PropertyVetoException - If any of the registered listeners vetos the property change.
    
    See Also:
    
    SignonHandler
  - setLocale
```
public void setLocale(Locale locale)
```
    Sets the Locale used to set the National Language Version (NLV) on the system. Only the COMMAND, PRINT, and DATABASE services accept an NLV. This method will set the NLV based on a mapping from the Locale object to the NLV.
    
    Parameters:
    
    locale - The Locale object.
    
    Throws:
    
    ExtendedIllegalStateException - If a connection has already been made.
  - setLocale
```
public void setLocale(Locale locale,
                      String nlv)
```
    Sets the Locale and a specific National Language Version (NLV) to send to the system. Only the COMMAND, PRINT, and DATABASE services accept an NLV.
    
    Parameters:
    
    locale - The Locale object.
    
    nlv - The NLV.
    
    Throws:
    
    ExtendedIllegalStateException - If a connection has already been made.
  - setMustAddLanguageLibrary
```
public void setMustAddLanguageLibrary(boolean mustAddLanguageLibrary)
```
    Sets this object to attempt to add the appropriate secondary language library to the library list, when running on the system. The default is false. Setting the language library will ensure that any system error messages that are returned, will be returned in the appropriate national language for the client locale. If the user profile has insufficient authority to call CHGSYSLIBL, an error entry will appear in the job log, and the Toolbox will disregard the error and proceed normally.
    Note: This property may also be set by specifying 'true' or 'false' in Java system property com.ibm.as400.access.AS400.mustAddLanguageLibrary
    
    Parameters:
    
    mustAddLanguageLibrary - true to add language library; false otherwise.
    
    Throws:
    
    ExtendedIllegalStateException - If a connection has already been made.
  - isMustAddLanguageLibrary
```
public boolean isMustAddLanguageLibrary()
```
    Indicates whether this object will attempt to add the appropriate secondary language library to the library list, when running on the system.
    
    Returns:
    
    true if you have indicated that the secondary language library must be added; false otherwise.
  - setMustUseSockets
```
public void setMustUseSockets(boolean mustUseSockets)
```
    Sets this object to using sockets. When your Java program runs on the system, some Toolbox classes access data via a call to an API instead of making a socket call to the system. There are minor differences in the behavior of the classes when they use API calls instead of socket calls. If your program is affected by these differences you can force the Toolbox classes to use socket calls instead of API calls by using this method. The default is false. The must use sockets property cannot be changed once a connection to the system has been established.
    Note: This property may also be set by specifying 'true' or 'false' in Java system property com.ibm.as400.access.AS400.mustUseSockets
    
    Parameters:
    
    mustUseSockets - true to use sockets; false otherwise.
    
    Throws:
    
    ExtendedIllegalStateException - If a connection has already been made.
  - isMustUseNetSockets
```
public boolean isMustUseNetSockets()
```
    Indicates if Internet domain sockets only will be used.
    
    Returns:
    
    true if must use Internet domain sockets only; false otherwise.
  - setMustUseNetSockets
```
public void setMustUseNetSockets(boolean mustUseNetSockets)
```
    Sets this object to using Internet domain sockets only. When your Java program runs on the system, some Toolbox classes create UNIX domain socket connections. Using this method forces the Toolbox to only use Internet domain sockets. The default is false. The must use net sockets property cannot be changed once a connection to the system has been established.
    Note: This property may also be set by specifying 'true' or 'false' in Java system property com.ibm.as400.access.AS400.mustUseNetSockets
    
    Parameters:
    
    mustUseNetSockets - true to use Internet domain sockets only; false otherwise.
    
    Throws:
    
    ExtendedIllegalStateException - If a connection has already been made.
  - isMustUseSuppliedProfile
```
public boolean isMustUseSuppliedProfile()
```
    Indicates if only a supplied profile will be used.
    
    Returns:
    
    true if must use a supplied profile only; false otherwise.
  - setMustUseSuppliedProfile
```
public void setMustUseSuppliedProfile(boolean mustUseSuppliedProfile)
```
    Sets this object to using a supplied profile only. When your Java program runs on the system, the information from the currently signed-on user profile can be used. Using this method prevents the Toolbox from retrieving the current user profile information. The default is false. The must use supplied profile property cannot be changed once a connection to the system has been established.
    Note: This property may also be set by specifying 'true' or 'false' in Java system property com.ibm.as400.access.AS400.mustUseSuppliedProfile
    
    Parameters:
    
    mustUseSuppliedProfile - true to use a supplied profile only; false otherwise.
    
    Throws:
    
    ExtendedIllegalStateException - If a connection has already been made.
  - setPassword
```
@Deprecated
public void setPassword(String password)
```
    Deprecated.
    
    Sets the password for this object. Only one authentication means (Kerberos ticket, profile token, identity token, or password) can be used at a single time. Using this method will clear any previously set authentication information.
    
    Parameters:
    
    password - The user profile password.
  - setPassword
```
public void setPassword(char[] password)
```
    Sets the password for this object using a char array. The caller is responsible for clearing the array after the method returns. Only one authentication means (Kerberos ticket, profile token, identity token, or password) can be used at a single time. Using this method will clear any previously set authentication information.
    
    Parameters:
    
    password - The user profile password.
  - setPasswordExpirationWarningDays
```
public static void setPasswordExpirationWarningDays(int days)
```
    Sets the number of days before password expiration to warn the user.
    
    Parameters:
    
    days - The number of days before expiration to start the warning. Set to -1 to turn off warning.
  - setProfileToken
```
public void setProfileToken(ProfileTokenCredential profileToken)
```
    Sets or resets the profile token for this object. Using this method will clear any previously set authentication information.
    
    Parameters:
    
    profileToken - The profile token.
  - setProxyServer
```
public void setProxyServer(String proxyServer)
                    throws PropertyVetoException
```
    Sets the name and port of the middle-tier machine where the proxy server is running. If this is not set, then the name is retrieved from the com.ibm.as400.access.AS400.proxyServer system property. The ProxyServer must be running on the middle-tier machine.
    The name of the middle-tier machine is ignored in a two-tier environment. If no middle-tier machine is specified, then it is assumed that no middle-tier will be accessed. The name of the middle-tier machine cannot be changed once a connection to this machine has been established.
    
    Parameters:
    
    proxyServer - The name and port of the proxy server in the format serverName[:port]. If no port is specified, a default will be used.
    
    Throws:
    
    ExtendedIllegalStateException - If a connection has already been made.
    
    PropertyVetoException - If any of the registered listeners vetos the property change.
  - setServicePort
```
public void setServicePort(int service,
                           int port)
```
    Sets the service port in the service port table for the specified service for this system name.
    Parameters:
    service - The name of the service. Valid services are:
    
    FILE - IFS file classes.
    PRINT - print classes.
    COMMAND - command and program call classes.
    DATAQUEUE - data queue classes.
    DATABASE - JDBC classes.
    RECORDACCESS - record level access classes.
    CENTRAL - license management classes.
    SIGNON - sign-on classes.
    HOSTCNN - host-connection classes.
    port - The port to use for this service. The value USE_PORT_MAPPER can be used to specify that the next connection to this service should ask the port mapper server for the port number.
    
    Throws:
    
    ExtendedIllegalArgumentException - If service or port is not valid.
    
    ExtendedIllegalStateException - If system name has not been set.
  - setServicePortsToDefault
```
public void setServicePortsToDefault()
```
    Sets the ports in the service port table for all the services for this system name to their default values. This causes the connections to this system name to use the default ports for those services rather than querying the port number through a port mapper connection. The use of this method can reduce the number of connections made to the system.
    
    Throws:
    
    ExtendedIllegalStateException - If system name has not been set.
  - setShowCheckboxes
```
public void setShowCheckboxes(boolean showCheckboxes)
```
    Indicates if checkboxes should be shown on the sign-on dialog.
    
    Parameters:
    
    showCheckboxes - true to show checkboxes; false otherwise.
  - setSignonHandler
```
public void setSignonHandler(SignonHandler handler)
```
    Sets the sign-on handler for this AS400 object. The specified handler will be called at runtime if the AS400 object needs to obtain additional signon information.
    By default, an internal AWT-based implementation is used, if no sign-on handler has been statically set via setDefaultSignonHandler().
    
    Parameters:
    
    handler - The sign-on handler. Specifying null will reset the default sign-on handler to the internal AWT-based handler.
    
    See Also:
    
    getSignonHandler(), setDefaultSignonHandler(com.ibm.as400.access.SignonHandler)
  - setStayAlive
```
public void setStayAlive(long seconds)
```
    Set the stay-alve interval. When enabled, a request is sent at the specified seconds interval to all currently opened connections to help keep the connections alive. This is sometimes needed to prevent firewalls from dropping stale connections.
    This stay-alive functionality only applies to connections to the following host servers: COMMAND, DATABASE, DATAQUEUE, FILE, PRINT, and HOSTCNN.
    Notes:
    - A background thread is used to ensure the connections stay alive. Any errors that occur while attempting to ensure connections are alive are ignored.
    - If resetAllServices() is called on the object, the number of seconds is set to zero. You will need to invoke setStayAlive() method to re-enable the stay-alive functionality.
    Parameters:
    
    seconds - The number of seconds between requests to the server. If set to zero, then this stay-alive capability will not be used.
    
    Throws:
    
    ExtendedIllegalArgumentException - if the value of seconds is negative.
  - setSocketProperties
```
public void setSocketProperties(SocketProperties socketProperties)
```
    Sets the socket options the IBM Toolbox for Java will set on its client side sockets. The socket properties cannot be changed once a connection to the system has been established.
    
    Parameters:
    
    socketProperties - The set of socket options to set. The options are copied from this object, not shared.
    
    Throws:
    
    ExtendedIllegalStateException - if a connection has already been made.
  - setSystemName
```
public void setSystemName(String systemName)
                   throws PropertyVetoException
```
    Sets the system name for this object. The system name cannot be changed once a connection to the system has been established.
    
    Parameters:
    
    systemName - The name of the IBM i system. Use localhost to access data locally.
    
    Throws:
    
    ExtendedIllegalStateException - if a connection has already been made.
    
    PropertyVetoException - If any of the registered listeners vetos the property change.
  - setThreadUsed
```
public void setThreadUsed(boolean useThreads)
                   throws PropertyVetoException
```
    Sets whether the IBM Toolbox for Java uses threads in communication with the host servers. The default is true. Letting the IBM Toolbox for Java use threads may be beneficial to performance, turning threads off may be necessary if your application needs to be compliant with the Enterprise Java Beans specification. The thread used property cannot be changed once a connection to the system has been established.
    Note: This property may also be set by specifying 'true' or 'false' in Java system property com.ibm.as400.access.AS400.threadUsed
    
    Parameters:
    
    useThreads - true to use threads; false otherwise.
    
    Throws:
    
    ExtendedIllegalStateException - If a connection has already been made.
    
    PropertyVetoException - If any of the registered listeners vetos the property change.
  - setUseDefaultUser
```
public void setUseDefaultUser(boolean useDefaultUser)
                       throws PropertyVetoException
```
    Sets the indicator for whether the default user is used. The default user is used if a system name is provided, but a user ID is not. If a default user is set for that system, then the default user is used.
    
    Parameters:
    
    useDefaultUser - The value indicating if the default user should be used. Set to true if default user should be used; false otherwise. The default is true, indicating that the default user is used.
    
    Throws:
    
    PropertyVetoException - If any of the registered listeners vetos the property change.
  - setUsePasswordCache
```
public void setUsePasswordCache(boolean usePasswordCache)
                         throws PropertyVetoException
```
    Sets the indicator for whether the password cache is used. If password cache is used, then the user would only have to enter password once within a Java virtual machine. The default is to use the cache.
    Unless the application is running in its own private JVM, users are advised to turn off password caching, in order to ensure that another application within the same JVM cannot create a connection using the cached password.
    
    Parameters:
    
    usePasswordCache - The value indicating whether the password cache should be used. Set to true to use the password cache; false otherwise.
    
    Throws:
    
    PropertyVetoException - If any of the registered listeners vetos the property change.
  - setUserId
```
public void setUserId(String userId)
               throws PropertyVetoException
```
    Sets the user ID for this object. The user ID cannot be changed once a connection to the system has been established. If this method is used in conjunction with a Kerberos ticket, profile token, or identity token, the user profile associated with the authentication token must match this user ID.
    
    Parameters:
    
    userId - The user profile name.
    
    Throws:
    
    ExtendedIllegalArgumentException - If userId length is not valid.
    
    ExtendedIllegalStateException - If a connection has already been made.
    
    PropertyVetoException - If any of the registered listeners vetos the property change.
  - toString
```
public String toString()
```
    Returns the text representation of this AS400 object.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    The string representing this AS400 object.
  - validateSignon
```
public boolean validateSignon()
                       throws AS400SecurityException,
                              IOException
```
    Validates the user ID and password on the system but does not add to the signed-on list. This means that a new AS400 object instance is created to do the validation. The user ID and system name need to be set before calling this method.
    Note: This will return true if the information is successfully validated. An unsuccessful validation will cause an exception to be thrown, false is never returned.
    Note:If an additional authentication factor has been set in the AS400 object, it is used.
    
    Returns:
    
    true if successful.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    ExtendedIllegalStateException - If system name or user ID is not set.
    
    IOException - If an error occurs while communicating with the system.
  - validateSignon
```
@Deprecated
public boolean validateSignon(String password)
                       throws AS400SecurityException,
                              IOException
```
    Deprecated.
    
    Validates the user ID and password on the system but does not add to the signed-on list. This means that a new AS400 object instance is created to do the validation. The user ID and system name need to be set before calling this method.
    Note: This will return true if the information is successfully validated. An unsuccessful validation will cause an exception to be thrown, false is never returned.
    Note:If an additional authentication factor has been set in the AS400 object, it is used.
    
    Parameters:
    
    password - The user profile password to validate.
    
    Returns:
    
    true if successful.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    IOException - If an error occurs while communicating with the system.
  - validateSignon
```
public boolean validateSignon(char[] password)
                       throws AS400SecurityException,
                              IOException
```
    Validates the user ID and password on the system but does not add to the signed-on list. This means that a new AS400 object instance is created to do the validation. The user ID and system name need to be set before calling this method.
    Note: This will return true if the information is successfully validated. An unsuccessful validation will cause an exception to be thrown, false is never returned.
    Note:If an additional authentication factor has been set in the AS400 object, it is used.
    
    Parameters:
    
    password - The user profile password to validate.
    
    Returns:
    
    true if successful.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    ExtendedIllegalStateException - If system name or user ID is not set.
    
    IOException - If an error occurs while communicating with the system.
  - validateSignon
```
@Deprecated
public boolean validateSignon(String userId,
                              String password)
                       throws AS400SecurityException,
                              IOException
```
    Deprecated.
    Using a string as a password is insecure
    
    Validates the user ID and password on the system but does not add to the signed-on list. This means that a new AS400 object instance is created to do the validation. The system name needs to be set prior to calling this method.
    Note: This will return true if the information is successfully validated. An unsuccessful validation will cause an exception to be thrown, false is never returned.
    Note:If an additional authentication factor has been set in the AS400 object, it is not used. If you want to use an additional authentication factor, see validateSignon(String, char[], char[])
    
    Parameters:
    
    userId - The user profile name to validate.
    
    password - The user profile password to validate.
    
    Returns:
    
    true if successful.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    IOException - If an error occurs while communicating with the system.
  - validateSignon
```
public boolean validateSignon(String userId,
                              char[] password)
                       throws AS400SecurityException,
                              IOException
```
    Validates the user ID and password on the system but does not add to the signed-on list. This means that a new AS400 object instance is created to do the validation. The system name needs to be set prior to calling this method.
    Note: This will return true if the information is successfully validated. An unsuccessful validation will cause an exception to be thrown, false is never returned.
    Note:If an additional authentication factor has been set in the AS400 object, it is not used. If you want to use an additional authentication factor, see validateSignon(String, char[], char[])
    
    Parameters:
    
    userId - The user profile name to validate.
    
    password - The user profile password to validate.
    
    Returns:
    
    true if successful.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    IOException - If an error occurs while communicating with the system.
  - validateSignon
```
public boolean validateSignon(String userId,
                              char[] password,
                              char[] additionalAuthFactor)
                       throws AS400SecurityException,
                              IOException
```
    Validates the user ID and password on the system but does not add to the signed-on list. This means that a new AS400 object instance is created to do the validation. The system name needs to be set prior to calling this method.
    Note: This will return true if the information is successfully validated. An unsuccessful validation will cause an exception to be thrown, false is never returned.
    
    Parameters:
    
    userId - The user profile name to validate.
    
    password - The user profile password to validate.
    
    additionalAuthFactor - Additional authentication factor (or null if not providing one).
    
    Returns:
    
    true if successful.
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    ExtendedIllegalArgumentException - If userId or additionalAuthFactor length is not valid.
    
    ExtendedIllegalStateException - If system name or is not set.
    
    IOException - If an error occurs while communicating with the system.
  - setBidiStringType
```
public void setBidiStringType(int bidiStringType)
```
    Sets bidi string type of the connection. See BidiStringType for more information and valid values.
    
    Parameters:
    
    bidiStringType - bidi string type to use for the connection.
  - getBidiStringType
```
public int getBidiStringType()
```
    Returns bidi string type of the connection. See BidiStringType for more information and valid values.
    
    Returns:
    
    The bidi string type of the connection.
  - isTurkish
```
public static boolean isTurkish()
```
    Return whether default locale is Turkish.
    
    Returns:
    
    true if Turkish; otherwise, false.
  - getvalidateSignonTimeOut
```
public int getvalidateSignonTimeOut()
```
    Returns the timeout value when attempting to validate the sign on information.
    
    Returns:
    
    The timeout value in milliseconds.
  - setvalidateSignonTimeOut
```
public void setvalidateSignonTimeOut(int validateSignonTimeOut)
```
    Set the the timeout value when when attempting to validate the sign on information.
    
    Parameters:
    
    validateSignonTimeOut - The timeout value in milliseconds.
  - passwordLevel
```
public int passwordLevel()
                  throws AS400SecurityException,
                         IOException
```
    Password level
    
    Returns:
    
    -1 - Not remote method, such as proxy method. 0, 1 - password type is DES 2, 3 - password type is SHA-1 4 - password type is SHA-512
    
    Throws:
    
    AS400SecurityException - If a security or authority error occurs.
    
    IOException - If an error occurs while communicating with the system.
  - close
```
public void close()
```
    This method is functionally equivalent to the resetAllServices() method.
    
    Specified by:
    
    close in interface AutoCloseable
    
    See Also:
    
    resetAllServices()
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable
  - isSecure
```
public boolean isSecure()
```
    Returns true if host server communications is performed over a secure channel.
    Note:This method is the only reliable way to determine whether host server communications is performed over a secure channel. An AS400 object that is not an instance of SecureAS400 class can use secure communications in some instances.
    
    Returns:
    
    true if communications is done over secure channel; otherwise false.
  - getKeyRingName
```
@Deprecated
public String getKeyRingName()
```
    Deprecated.
    
    Returns the key ring class name used for SSL communications with the system. The class com.ibm.as400.access.KeyRing is the default and will be returned if not overridden.
    Note:An exception will be thrown if the AS400 object is not an instance of SecureAS400.
    
    Returns:
    
    The key ring class name.
  - getProxyEncryptionMode
```
public int getProxyEncryptionMode()
```
    Returns the proxy encryption mode. The proxy encryption mode specifies which portions of the communications between the client, proxy server, and IBM i system are encrypted.
    Note:An exception will be thrown if the AS400 object is not an instance of SecureAS400.
    
    Returns:
    
    The proxy encryption mode.
  - setKeyRingName
```
public void setKeyRingName(String keyRingName)
                    throws PropertyVetoException
```
    Sets the key ring class name used for SSL communications with the system. This method is no longer supported because sslight is not longer supported.
    Note:An exception will be thrown if the AS400 object is not an instance of SecureAS400.
    
    Parameters:
    
    keyRingName - The key ring class name.
    
    Throws:
    
    ExtendedIllegalStateException - If object is not a secure instance.
    
    PropertyVetoException - If any of the registered listeners vetos the property change.
  - setKeyRingName
```
public void setKeyRingName(String keyRingName,
                           String keyRingPassword)
                    throws PropertyVetoException
```
    Sets the key ring class name used for SSL communications with the system. This method is no longer available since support for sslight has been removed.
    Note:An exception will be thrown if the AS400 object is not an instance of SecureAS400.
    
    Parameters:
    
    keyRingName - The key ring class name.
    
    keyRingPassword - The password for the key ring class.
    
    Throws:
    
    ExtendedIllegalStateException - If object is not a secure instance.
    
    PropertyVetoException - If any of the registered listeners vetos the property change.
  - setKeyRingPassword
```
@Deprecated
public void setKeyRingPassword(String keyRingPassword)
```
    Deprecated.
    
    Sets the key ring password used for SSL communications with the system.
    Note:An exception will be thrown if the AS400 object is not an instance of SecureAS400.
    
    Parameters:
    
    keyRingPassword - The password for the key ring class.
    
    Throws:
    
    ExtendedIllegalStateException - If object is not a secure instance.
  - setProxyEncryptionMode
```
public void setProxyEncryptionMode(int proxyEncryptionMode)
                            throws PropertyVetoException
```
    Sets the proxy encryption mode. The proxy encryption mode specifies which portions of the communications between the client, proxy server, and IBM i system are encrypted. The default is to encrypt all communications. This value is ignored if a proxy server is not used.
    Valid proxy encryption modes are:
    CLIENT_TO_PROXY_SERVER - encrypt between client and proxy server.
    PROXY_SERVER_TO_SERVER - encrypt between proxy server and IBM i system.
    CLIENT_TO_SERVER - encrypt both portions of connection.
    Note:An exception will be thrown if the AS400 object is not an instance of SecureAS400.
    
    Parameters:
    
    proxyEncryptionMode - The proxy encryption mode.
    
    Throws:
    
    ExtendedIllegalArgumentException - If proxyEncryptionMode value is not valid.
    
    ExtendedIllegalStateException - If object is not a secure instance.
    
    PropertyVetoException - If any of the registered listeners vetos the property change.
  - setEnabledCipherSuites
```
public void setEnabledCipherSuites(String[] suites)
```
    Set list of cipher suites.
    Note:An exception will be thrown if the AS400 object is not an instance of SecureAS400.
    
    Parameters:
    
    suites - Array of cipher suites.
    
    Throws:
    
    ExtendedIllegalStateException - If object is not a secure instance.

Class AS400

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FILE

PRINT

COMMAND

DATAQUEUE

DATABASE

RECORDACCESS

CENTRAL

SIGNON

HOSTCNN

USE_PORT_MAPPER

AUTHENTICATION_SCHEME_PASSWORD

AUTHENTICATION_SCHEME_GSS_TOKEN

AUTHENTICATION_SCHEME_PROFILE_TOKEN

AUTHENTICATION_SCHEME_IDENTITY_TOKEN

AUTHENTICATION_SCHEME_DDM_EUSERIDPWD

GSS_OPTION_MANDATORY

GSS_OPTION_FALLBACK

GSS_OPTION_NONE

CLIENT_TO_PROXY_SERVER

PROXY_SERVER_TO_SERVER

CLINT_TO_SERVER

CLIENT_TO_SERVER

changeCipherSuites

newCipherSuites

currentLib_

librariesForThread_

aspName

bidiAS400Text

bidiAS400Varchar

Constructor Detail

AS400

AS400

AS400

AS400

AS400

AS400

AS400

AS400

AS400

AS400

AS400

AS400

Method Detail

setIASPGroup

setIASPGroup

setIASPGroup

setIASPGroup

newInstance

newInstance

newInstance

newInstance

newInstance

newInstance

newInstance

addConnectionListener

addPasswordCacheEntry

addPasswordCacheEntry

addPasswordCacheEntry

addPasswordCacheEntry

addPasswordCacheEntry

addPasswordCacheEntry

addPropertyChangeListener

addVetoableChangeListener

arePropertiesFrozen

isAdditionalAuthenticationFactorAccepted

isAdditionalAuthenticationFactorAccepted

isAdditionalAuthenticationFactorAccepted

authenticate

authenticate

authenticate

canUseNativeOptimizations

changePassword

changePassword

changePassword