|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.as400.access.AS400
The AS400 class represents a system sign-on.
If running from an AS/400 to another AS/400 or to itself, 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 from a non-AS/400 to an AS/400, the system name, user ID, and password need to be supplied. If not supplied, the first open request associated with an AS400 object will prompt the workstation user. Subsequent opens associated with the same AS400 object will not prompt the workstation user. Keywords localhost and *CURRENT will not work when running from a non-AS/400 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.
Field Summary | |
static int |
CENTRAL
Constant indicating the Central service. |
static int |
COMMAND
Constant indicating the Command service. |
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 |
PRINT
Constant indicating the Print service. |
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 | |
AS400()
Constructs an AS400 object. |
|
AS400(AS400 system)
Constructs an AS400 object. |
|
AS400(java.lang.String systemName)
Constructs an AS400 object. |
|
AS400(java.lang.String systemName,
java.lang.String userId)
Constructs an AS400 object. |
|
AS400(java.lang.String systemName,
java.lang.String userId,
java.lang.String password)
Constructs an AS400 object. |
|
AS400(java.lang.String systemName,
java.lang.String userId,
java.lang.String password,
java.lang.String proxyServer)
Constructs an AS400 object. |
Method Summary | |
void |
addConnectionListener(ConnectionListener listener)
Adds a listener to the event list. |
static void |
addPasswordCacheEntry(java.lang.String systemName,
java.lang.String userId,
java.lang.String password)
Validates the user ID and password against the system, and if successful, adds the information to the password cache. |
static void |
addPasswordCacheEntry(java.lang.String systemName,
java.lang.String userId,
java.lang.String password,
java.lang.String proxyServer)
Validates the user ID and password against the system, and if successful, adds the information to the password cache. |
void |
addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Adds a property changed listener to the list. |
void |
addVetoableChangeListener(java.beans.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(java.lang.String userId,
java.lang.String password)
Authenticates the user profile and password for this system. |
void |
changePassword(java.lang.String oldPassword,
java.lang.String newPassword)
Changes the password on the AS/400. |
static void |
clearPasswordCache()
Clears the password cache for all systems within this Java virtual machine. |
static void |
clearPasswordCache(java.lang.String systemName)
Clears all the passwords that are cached for the given AS/400 within this Java virtual machine. |
void |
connectService(int service)
Connects to an AS/400 service on this AS/400. |
void |
disconnectAllServices()
Disconnects from the AS/400. |
void |
disconnectService(int service)
Disconnects the service from the AS/400. |
static int |
generateVRM(int version,
int release,
int modification)
Generates a VRM from a version, release, and modification. |
int |
getCcsid()
Returns the CCSID for this AS/400. |
static java.lang.String |
getDefaultUser(java.lang.String systemName)
Returns the default user ID for this AS/400. |
java.lang.String |
getJobCCSIDEncoding()
Returns the encoding that corresponds to the Job CCSID of this AS/400. |
int |
getModification()
Returns the modification level of the AS/400. |
java.util.GregorianCalendar |
getPasswordExpirationDate()
Returns the password expiration date for the signed on user. |
static int |
getPasswordExpirationWarningDays()
Returns the number of days before password expiration to start warning the user. |
java.util.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(java.lang.String userId,
java.lang.String password)
Authenticates the given user profile and password and returns a corresponding ProfileTokenCredential if successful. |
ProfileTokenCredential |
getProfileToken(java.lang.String userId,
java.lang.String password,
int tokenType,
int timeoutInterval)
Authenticates the given user profile and password and returns a corresponding ProfileTokenCredential if successful. |
java.lang.String |
getProxyServer()
Returns the name of the middle-tier machine where the proxy server is running. |
int |
getRelease()
Returns the release of the AS/400. |
int |
getServicePort(int service)
Returns the service port stored in the service port table for the specified service. |
java.util.GregorianCalendar |
getSignonDate()
Returns the date for the current sign-on. |
java.lang.String |
getSystemName()
Returns the name of the system. |
java.lang.String |
getUserId()
Returns the user ID. |
int |
getVersion()
Returns the version of the AS/400. |
int |
getVRM()
Returns the version, release, and modification level for the AS/400. |
void |
initializeConverter(int ccsid)
Initialize conversion table for the given CCSID. |
boolean |
isConnected()
Indicates if any service is currently connected through this AS400 object. |
boolean |
isConnected(int service)
Indicates if a service is currently connected through this AS400 object. |
boolean |
isGuiAvailable()
Returns the sign-on prompting mode for this AS400 object. |
boolean |
isLocal()
Indicates if this AS400 object is representing the system you are currently running on. |
boolean |
isMustUseSockets()
When your Java program runs on a V4R3 or later AS/400, the Toolbox record-level database access, data queues, and user space classes access data via a call to an AS/400 API instead of making a socket call to a server. |
boolean |
isShowCheckboxes()
Indicates if checkboxes should be shown on the signon dialog. |
boolean |
isThreadUsed()
Indicates whether threads are used in communication with the host servers. |
boolean |
isUseDefaultUser()
Indicates if the default user should be used by this AS400 object. |
boolean |
isUsePasswordCache()
Indicates if password cache is being used by this AS400 object. |
void |
removeConnectionListener(ConnectionListener listener)
Removes a listener from the connection event list. |
static void |
removeDefaultUser(java.lang.String systemName)
Removes the default user for the given AS/400. |
static void |
removePasswordCacheEntry(java.lang.String systemName,
java.lang.String userId)
Removes the password entry associated with this user and AS/400. |
void |
removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Removes a property changed listener from the listener list. |
void |
removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
Removes a listener from the veto list. |
void |
resetAllServices()
Disconnect all services and clear signon information. |
void |
setCcsid(int ccsid)
Sets the CCSID to be used for this AS/400. |
static boolean |
setDefaultUser(java.lang.String systemName,
java.lang.String userId)
Sets the default user for a given AS/400. |
void |
setGuiAvailable(boolean guiAvailable)
Sets the environment you are running in. |
void |
setMustUseSockets(boolean mustUseSockets)
When your Java program runs on a V4R3 or later AS/400, the Toolbox record-level database access, data queues, and user space classes access data via a call to an AS/400 API instead of making a socket call to a server. |
void |
setPassword(java.lang.String password)
Sets the password for this AS400 object. |
static void |
setPasswordExpirationWarningDays(int days)
Sets the number of days before password expiration to warn the user. |
void |
setProxyServer(java.lang.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. |
void |
setServicePortsToDefault()
Sets the ports in the service port table for all the services for this system to their default values. |
void |
setShowCheckboxes(boolean showCheckboxes)
Indicates if checkboxes should be shown on the signon dialog. |
void |
setSystemName(java.lang.String systemName)
Sets the system name for this AS400 object. |
void |
setThreadUsed(boolean useThreads)
Sets whether the AS/400 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(java.lang.String userId)
Sets the user ID for this AS400 object. |
java.lang.String |
toString()
Returns the text representation of this AS400 object. |
boolean |
validateSignon()
Validates the user ID and password for this AS/400 but does not add to the signed-on list. |
boolean |
validateSignon(java.lang.String password)
Validates the user ID and password for this AS/400 but does not add to the signed-on list. |
boolean |
validateSignon(java.lang.String userId,
java.lang.String password)
Validates the user ID and password for this AS/400 but does not add to the signed-on list. |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait |
Field Detail |
public static final int FILE
public static final int PRINT
public static final int COMMAND
public static final int DATAQUEUE
public static final int DATABASE
public static final int RECORDACCESS
public static final int CENTRAL
public static final int SIGNON
public static final int USE_PORT_MAPPER
Constructor Detail |
public AS400()
If running on an AS/400, 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 from a non-AS/400 to an AS/400, a sign-on prompt is displayed. The user is then able to specify the system name, user ID, and password.
public AS400(java.lang.String systemName)
If running from an AS/400 to another AS/400 or to itself, the user ID and password of the current job are used.
If running from a non-AS/400 to an AS/400, the user is prompted for the user ID and password if a default user has not been established for this AS/400.
systemName
- The name of the system. Use localhost to access data locally.public AS400(java.lang.String systemName, java.lang.String userId)
systemName
- The name of the system. Use localhost to access data locally.userId
- The user ID to use to connect to the system. If running from an AS/400, *CURRENT may be used to specify the current user ID.public AS400(java.lang.String systemName, java.lang.String userId, java.lang.String password)
systemName
- The name of the system. Use localhost to access data locally.userId
- The user ID to use to connect to the system. If running from an AS/400, *CURRENT may be used to specify the current user ID.password
- The password to use to connect to the system. If running from an AS/400, *CURRENT may be used to specify the current user ID.public AS400(java.lang.String systemName, java.lang.String userId, java.lang.String password, java.lang.String proxyServer)
systemName
- The name of the system. Use localhost to access data locally.userId
- The user ID to use to connect to the system. If running from an AS/400, *CURRENT may be used to specify the current user ID.password
- The password to use to connect to the system. If running from an AS/400, *CURRENT may be used to specify the current user ID.proxyServer
- The name and port in the format serverName[:port]
. If no port is specified, a default will be used.public AS400(AS400 system)
system
- A previously instantiated AS400 object.Method Detail |
public void addConnectionListener(ConnectionListener listener)
listener
- The listener object.public static void addPasswordCacheEntry(java.lang.String systemName, java.lang.String userId, java.lang.String password) throws AS400SecurityException, java.io.IOException
systemName
- The name of the system.userId
- The user ID.password
- The password.public static void addPasswordCacheEntry(java.lang.String systemName, java.lang.String userId, java.lang.String password, java.lang.String proxyServer) throws AS400SecurityException, java.io.IOException
systemName
- The name of the system.userId
- The user ID.password
- The password.proxyServer
- The name and port in the format serverName[:port]
. If no port is specified, a default will be used.public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
listener
- The listener to add.public void addVetoableChangeListener(java.beans.VetoableChangeListener listener)
listener
- The VetoableChangeListener.public boolean arePropertiesFrozen()
public boolean authenticate(java.lang.String userId, java.lang.String password) throws AS400SecurityException, java.io.IOException
This method is functionally equivalent to the validateSignon() method. It does not alter the user profile assigned to the system, impact the status of existing connections, or otherwise impact the user and authorities under 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, and can result in the profile being disabled.
userId
- The user profile name.password
- The user profile password.public void changePassword(java.lang.String oldPassword, java.lang.String newPassword) throws AS400SecurityException, java.io.IOException
oldpassword
- The old password.newpassword
- The new password.public static void clearPasswordCache()
public static void clearPasswordCache(java.lang.String systemName)
systemName
- The name of the system.public void connectService(int service) throws AS400SecurityException, java.io.IOException
Services typically connect implicitly; therefore, this method does not have to be called to use an AS/400 service. This method can be used to control when the connection is established.
Valid services are:
FILE - IFS file classes
PRINT - print classes
COMMAND - command and program call classes
DATAQUEUE - data queue classes
RECORDACCESS - record level access classes
public void disconnectAllServices()
public void disconnectService(int service)
service
- The name of the service.
public static int generateVRM(int version, int release, int modification)
version
- The version.release
- The release.modification
- The modification level.public int getCcsid()
public static java.lang.String getDefaultUser(java.lang.String systemName)
systemName
- The name of the system.public java.lang.String getJobCCSIDEncoding() throws AS400SecurityException, java.io.IOException, java.lang.InterruptedException
public int getModification() throws AS400SecurityException, java.io.IOException
A connection is required to the AS/400 to retrieve this information. If a connection has not been established, one is created to retrieve the system information.
public java.util.GregorianCalendar getPasswordExpirationDate() throws AS400SecurityException, java.io.IOException
A connection is required to the AS/400 to retrieve this information. If a connection has not been established, one is created to retrieve the system information.
public static int getPasswordExpirationWarningDays()
public java.util.GregorianCalendar getPreviousSignonDate() throws AS400SecurityException, java.io.IOException
A connection is required to the AS/400 to retrieve this information. If a connection has not been established, one is created to retrieve the system information.
public ProfileTokenCredential getProfileToken() throws AS400SecurityException, java.io.IOException, java.lang.InterruptedException
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 AS/400 system is at release V4R5M0 or greater.
getProfileToken(int, int)
public ProfileTokenCredential getProfileToken(int tokenType, int timeoutInterval) throws AS400SecurityException, java.io.IOException, java.lang.InterruptedException
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 AS/400 system is at release V4R5M0 or greater.
tokenType
- The type of profile token to create. Possible types are defined as fields on the ProfileTokenCredential class:
timeoutInterval
- The number of seconds to expiration when the token is created (1-3600).public ProfileTokenCredential getProfileToken(java.lang.String userId, java.lang.String password) throws AS400SecurityException, java.io.IOException, java.lang.InterruptedException
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 AS/400 system is at release V4R5M0 or greater.
Note: Providing an incorrect password increments the number of failed sign-on attempts for the user, and can result in the profile being disabled. Refer to documentation on the ProfileTokenCredential class for additional restrictions.
userId
- The user profile name.password
- The user profile password. The following special values are allowed:
public ProfileTokenCredential getProfileToken(java.lang.String userId, java.lang.String password, int tokenType, int timeoutInterval) throws AS400SecurityException, java.io.IOException, java.lang.InterruptedException
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 AS/400 system is at release V4R5M0 or greater.
Note: Providing an incorrect password increments the number of failed sign-on attempts for the user, and can result in the profile being disabled. Refer to documentation on the ProfileTokenCredential class for additional restrictions.
userId
- The user profile name.password
- The user profile password. The following special values are allowed:
tokenType
- The type of profile token to create. Possible types are defined as fields on the ProfileTokenCredential class:
timeoutInterval
- The number of seconds to expiration when the token is created (1-3600).public java.lang.String getProxyServer()
public int getRelease() throws AS400SecurityException, java.io.IOException
A connection is required to the AS/400 in order to retrieve this information. If a connection has not been established, one is created to retrieve the system information.
public int getServicePort(int service)
service
- The name of the service.public java.util.GregorianCalendar getSignonDate() throws AS400SecurityException, java.io.IOException
A connection is required to the AS/400 to retrieve this information. If a connection has not been established, one is created to retrieve the system information.
public java.lang.String getSystemName()
public java.lang.String getUserId()
public int getVersion() throws AS400SecurityException, java.io.IOException
A connection is required to the AS/400 to retrieve this information. If a connection has not been established, one is created to retrieve the system information.
public int getVRM() throws AS400SecurityException, java.io.IOException
A connection is required to the AS/400 to retrieve this information. If a connection has not been established, one is created to retrieve the system information.
public void initializeConverter(int ccsid) throws java.io.UnsupportedEncodingException
ccsid
- the CCSID for the conversion table to initialize.public boolean isConnected()
public boolean isConnected(int service)
A service is connected if connectService() has been called, or an implicit connect has been done by the service, and disconnectService() or disconnectAllServices() has not been called.
Valid services are:
FILE - IFS file classes
PRINT - print classes
COMMAND - command and program call classes
DATAQUEUE - data queue classes
RECORDACCESS - record-level access
public boolean isGuiAvailable()
public boolean isLocal()
public boolean isMustUseSockets()
public boolean isShowCheckboxes()
public boolean isThreadUsed()
public boolean isUseDefaultUser()
public boolean isUsePasswordCache()
public void removeConnectionListener(ConnectionListener listener)
listener
- The listener to remove.public static void removeDefaultUser(java.lang.String systemName)
systemName
- The name of the system.public static void removePasswordCacheEntry(java.lang.String systemName, java.lang.String userId)
systemName
- The name of the system.user
- The user ID associated with the cache entry.public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
listener
- The listener to remove.public void removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
listener
- The VetoableChangeListener.public void resetAllServices()
public void setCcsid(int ccsid) throws java.beans.PropertyVetoException
ccsid
- The CCSID to use for this AS/400.public static boolean setDefaultUser(java.lang.String systemName, java.lang.String userId)
systemName
- The name of the system.userId
- The user ID.public void setGuiAvailable(boolean guiAvailable) throws java.beans.PropertyVetoException
guiAvailable
- true to prompt; otherwise false.public void setMustUseSockets(boolean mustUseSockets)
mustUseSockets
- true to use sockets; otherwise false.public void setPassword(java.lang.String password)
password
- The password with which to connect to the AS/400.public static void setPasswordExpirationWarningDays(int days)
days
- The number of days before expiration to start the warning. Set to -1 to turn off warning.public void setProxyServer(java.lang.String proxyServer) throws java.beans.PropertyVetoException
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.
proxyServer
- The name and port in the format serverName[:port]
. If no port is specified, a default will be used.public void setServicePort(int service, int port)
service
- The name of the service.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.public void setServicePortsToDefault()
public void setShowCheckboxes(boolean showCheckboxes)
showCheckboxes
- true to show checkboxes; otherwise false.public void setSystemName(java.lang.String systemName) throws java.beans.PropertyVetoException
systemName
- The name of the system. Use localhost to access data locally.public void setThreadUsed(boolean useThreads) throws java.beans.PropertyVetoException
useThreads
- true to use threads; false otherwise.public void setUseDefaultUser(boolean useDefaultUser) throws java.beans.PropertyVetoException
useDefaultUser
- The value indicating if the default user should be used. Set to true if default user should be used; false otherwise.public void setUsePasswordCache(boolean usePasswordCache) throws java.beans.PropertyVetoException
usePasswordCache
- The value indicating whether the password cache should be used. Set to true to use the password cache; false otherwise.public void setUserId(java.lang.String userId) throws java.beans.PropertyVetoException
user
- The user ID with which to connect to the AS/400.public java.lang.String toString()
public boolean validateSignon() throws AS400SecurityException, java.io.IOException
public boolean validateSignon(java.lang.String password) throws AS400SecurityException, java.io.IOException
password
- Password to use for sign-on. The user ID and system name need to be set before calling this method.public boolean validateSignon(java.lang.String userId, java.lang.String password) throws AS400SecurityException, java.io.IOException
userId
- The user ID to validate.password
- The password to validate.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |