/projects/jtopen-7.8/src/com/ibm/as400/access/AS400.java

///////////////////////////////////////////////////////////////////////////////

//

// JTOpen (IBM Toolbox for Java - OSS version)

//

// Filename:  AS400.java

//

// The source code contained herein is licensed under the IBM Public License

// Version 1.0, which has been approved by the Open Source Initiative.

// Copyright (C) 1997-2006 International Business Machines Corporation and

// others.  All rights reserved.

//

///////////////////////////////////////////////////////////////////////////////



package com.ibm.as400.access;



import java.beans.PropertyChangeListener;

import java.beans.PropertyChangeSupport;

import java.beans.PropertyVetoException;

import java.beans.VetoableChangeListener;

import java.beans.VetoableChangeSupport;

import java.io.IOException;

import java.io.ObjectInputStream;

import java.io.Serializable;

import java.io.UnsupportedEncodingException;

import java.net.InetAddress;

import java.net.UnknownHostException;

import java.net.Socket;

import java.net.URL;

import java.util.GregorianCalendar;

import java.util.Hashtable;

import java.util.Locale;

import java.util.StringTokenizer;

import java.util.TimeZone;

import java.util.Vector;



import com.ibm.as400.security.auth.ProfileTokenCredential;

import com.ibm.as400.security.auth.ProfileTokenProvider;



/**

 Represents the authentication information and a set of connections to the IBM i host servers.

 <p>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 <code>localhost</code> can be used to specify the local system.

    For the user ID and password, *CURRENT can be used.

 <p>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 <code>localhost</code> and *CURRENT will not work when running on another operating

    system.

 <p>For example:

 <pre>

 *    AS400 system = new AS400();

 *    system.connectService(AS400.DATAQUEUE);   // This causes a password prompt.

 *    ...

 *    system.connectService(AS400.FILE);        // This does not cause a prompt.

 </pre>

 **/

public class AS400 implements Serializable

{

    private static final String CLASSNAME = "com.ibm.as400.access.AS400";

    static boolean jdk14 = false;



    static

    {

        if (Trace.traceOn_) Trace.logLoadPath(CLASSNAME);

        jdk14 = JVMInfo.isJDK14();

    }



    static final long serialVersionUID = 4L;

    private static final boolean PASSWORD_TRACE = false;



    /**

     Constant indicating the File service.

     **/

    public static final int FILE = 0;

    /**

     Constant indicating the Print service.

     **/

    public static final int PRINT = 1;

    /**

     Constant indicating the Command service.

     **/

    public static final int COMMAND = 2;

    /**

     Constant indicating the Dataqueue service.

     **/

    public static final int DATAQUEUE = 3;

    /**

     Constant indicating the Database service.

     **/

    public static final int DATABASE = 4;

    /**

     Constant indicating the Record Access service.

     **/

    public static final int RECORDACCESS = 5;

    /**

     Constant indicating the Central service.

     **/

    public static final int CENTRAL = 6;

    /**

     Constant indicating the Sign-on service.

     **/

    public static final int SIGNON = 7;

    // Constants 8-15 reserved for SSL versions of the above services.



    /**

     Special value indicating the service port should be retrieved from the port mapper server.

     **/

    public static final int USE_PORT_MAPPER = -1;



    /**

     Constant indicating the authentication scheme is password.

     **/

    public static final int AUTHENTICATION_SCHEME_PASSWORD = 0;

    /**

     Constant indicating the authentication scheme is GSS token.

     **/

    public static final int AUTHENTICATION_SCHEME_GSS_TOKEN = 1;

    /**

     Constant indicating the authentication scheme is profile token.

     **/

    public static final int AUTHENTICATION_SCHEME_PROFILE_TOKEN = 2;

    /**

     Constant indicating the authentication scheme is identity token.

     **/

    public static final int AUTHENTICATION_SCHEME_IDENTITY_TOKEN = 3;



    /**

     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.

     **/

    public static final int GSS_OPTION_MANDATORY = 0;

    /**

     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.

     **/

    public static final int GSS_OPTION_FALLBACK = 1;

    /**

     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.

     **/

    public static final int GSS_OPTION_NONE = 2;



    // Determine if we are running on IBM i.

    static boolean onAS400 = false;

    // VRM from system property, if we are native.

    static ServerVersion nativeVRM = null;

    // The static default sign-on handler.

    static Class defaultSignonHandlerClass_ = ToolboxSignonHandler.class;

    static SignonHandler defaultSignonHandler_;

    // Default setting for guiAvailable property.

    private static boolean defaultGuiAvailable_ = true;

    // Default setting for mustAddLanguageLibrary property.

    private static boolean defaultMustAddLanguageLibrary_ = false;

    // Default setting for mustUseSockets property.

    private static boolean defaultMustUseSockets_ = false;

    // Default setting for mustUseNetSockets property.

    private static boolean defaultMustUseNetSockets_ = false;

    // Default setting for mustUseSuppliedProfile property.

    private static boolean defaultMustUseSuppliedProfile_ = false;

    // Default setting for threadUsed property.

    private static boolean defaultThreadUsed_ = true;

    static

    {

        try

        {

            String s = System.getProperty("os.name");

            if (Trace.traceOn_) Trace.log(Trace.DIAGNOSTIC, "Detected os.name:", s);

            if (s != null && s.equalsIgnoreCase("OS/400"))

            {

                String version = System.getProperty("os.version");

                if (Trace.traceOn_) Trace.log(Trace.DIAGNOSTIC, "Detected os.version:", version);

                if (version != null)

                {

                    char[] versionChars = version.toCharArray();

                    if (versionChars.length == 6)

                    {

                        int vrm = ((versionChars[1] & 0x000F) << 16) +

                                  ((versionChars[3] & 0x000F) <<  8) +

                                   (versionChars[5] & 0x000F);

                        AS400.nativeVRM = new ServerVersion(vrm);

                    }

                }

                AS400.onAS400 = true;

            }

        }

        catch (SecurityException e)

        {

            Trace.log(Trace.WARNING, "Error retrieving os.name:", e);

        }



        // Get the "default sign-on handler" property.

        {

          String propVal = SystemProperties.getProperty(SystemProperties.AS400_SIGNON_HANDLER);

          if (propVal != null)

          {

            try

            {

              defaultSignonHandlerClass_ = Class.forName(propVal);

            }

            catch (Exception e)

            {

              Trace.log(Trace.WARNING, "Error retrieving default sign-on handler (specified by property):", e);

              defaultSignonHandlerClass_ = ToolboxSignonHandler.class;

            }

          }

        }



        // Get the "GUI available" property.

        {

          String propVal = SystemProperties.getProperty(SystemProperties.AS400_GUI_AVAILABLE);

          if (propVal != null)

          {

            try

            {

              defaultGuiAvailable_ = Boolean.valueOf(propVal).booleanValue();

            }

            catch (Exception e)

            {

              Trace.log(Trace.WARNING, "Error retrieving guiAvailable property value:", e);

            }

          }

        }



        // Get the "must add language library" property.

        {

          String propVal = SystemProperties.getProperty(SystemProperties.AS400_MUST_ADD_LANGUAGE_LIBRARY);

          if (propVal != null)

          {

            try

            {

              defaultMustAddLanguageLibrary_ = Boolean.valueOf(propVal).booleanValue();

            }

            catch (Exception e)

            {

              Trace.log(Trace.WARNING, "Error retrieving mustAddLanguageLibrary property value:", e);

            }

          }

        }



        // Get the "must use sockets" property.

        {

          String propVal = SystemProperties.getProperty(SystemProperties.AS400_MUST_USE_SOCKETS);

          if (propVal != null)

          {

            try

            {

              defaultMustUseSockets_ = Boolean.valueOf(propVal).booleanValue();

            }

            catch (Exception e)

            {

              Trace.log(Trace.WARNING, "Error retrieving mustUseSockets property value:", e);

            }

          }

        }



        // Get the "must use net sockets" property.

        {

          String propVal = SystemProperties.getProperty(SystemProperties.AS400_MUST_USE_NET_SOCKETS);

          if (propVal != null)

          {

            try

            {

              defaultMustUseNetSockets_ = Boolean.valueOf(propVal).booleanValue();

            }

            catch (Exception e)

            {

              Trace.log(Trace.WARNING, "Error retrieving mustUseNetSockets property value:", e);

            }

          }

        }



        // Get the "must use supplied profile" property.

        {

          String propVal = SystemProperties.getProperty(SystemProperties.AS400_MUST_USE_SUPPLIED_PROFILE);

          if (propVal != null)

          {

            try

            {

              defaultMustUseSuppliedProfile_ = Boolean.valueOf(propVal).booleanValue();

            }

            catch (Exception e)

            {

              Trace.log(Trace.WARNING, "Error retrieving mustUseSuppliedProfile property value:", e);

            }

          }

        }



        // Get the "thread used" property.

        {

          String propVal = SystemProperties.getProperty(SystemProperties.AS400_THREAD_USED);

          if (propVal != null)

          {

            try

            {

              defaultThreadUsed_ = Boolean.valueOf(propVal).booleanValue();

            }

            catch (Exception e)

            {

              Trace.log(Trace.WARNING, "Error retrieving threadUsed property value:", e);

            }

          }

        }



    }



    // System list:  elements are 3 element Object[]: systemName, userId, credential vault

    private static Vector systemList = new Vector();

    // Default users is a hash from systemName to userId.

    private static Hashtable defaultUsers = new Hashtable();

    // Number of days previous to password expiration to start to warn user.

    private static int expirationWarning = 7;



    private static int alreadyCheckedForMultipleVersions_ = 0;



    // System name.

    private String systemName_ = "";

    // Flag indicating if system name refers to local system.

    private boolean systemNameLocal_ = false;

    // User ID.

    private String userId_ = "";



    // Credential vault used to store password, GSS token, identity token,

    // or profile token.  An AS400 object must always have its own copy of

    // a credential vault (i.e. there must be a 1-to-1 correlation between

    // AS400 objects and CredentialVault objects).  Sharing a credential vault

    // amongst two different AS400 objects is NEVER allowed.

    // If you need to share the credential in the vault with another AS400 object,

    // you must provide a copy of the credential vault.  This is achieved using

    // the clone() method provided by the CredentialVault class.

    private transient CredentialVault credVault_;  // never null after construction



    // GSS Credential object, for Kerberos.  Type set to Object to prevent dependency on 1.4 JDK.

    private transient Object gssCredential_ = null;

    // GSS name string, for Kerberos.

    private String gssName_ = "";

    // How to use the GSS framework.

    int gssOption_ = GSS_OPTION_FALLBACK;



    // Proxy server system name.

    private transient String proxyServer_ = "";

    // Client side proxy connection information.

    private transient Object proxyClientConnection_ = null;  // Tolerate not having class ProxyClientConnection in the jar.



    // This controls the prompting.  If set to true, then prompting will occur during sign-on if needed.  If set to false, no prompting will occur and all security errors are returned as exceptions.

    private boolean guiAvailable_ = defaultGuiAvailable_;

    // Use the password cache.

    private boolean usePasswordCache_ = true;

    // Use the default user.

    private boolean useDefaultUser_ = true;

    // Show the checkboxes on the password dialog.

    private boolean showCheckboxes_ = true;

    // Detect/prevent recursion when interacting with sign-on handler.

    private boolean signingOn_ = false;



    // SSL options, null value indicates SSL is not to be used.  Options set in SecureAS400 subclass.

    SSLOptions useSSLConnection_ = null;

    // Flag that indicates if we must add the secondary language library to the library list.

    private boolean mustAddLanguageLibrary_ = defaultMustAddLanguageLibrary_;

    // Flag that indicates if we must use the host servers and no native optimizations.

    private boolean mustUseSockets_ = defaultMustUseSockets_;

    // Flag that indicates if we must use network sockets and not unix domain sockets.

    private boolean mustUseNetSockets_ = defaultMustUseNetSockets_;

    // Flag that indicates if we must not use the current profile.

    private boolean mustUseSuppliedProfile_ = defaultMustUseSuppliedProfile_;

    // Flag that indicates if we use threads in communication with the host servers.

    private boolean threadUsed_ = defaultThreadUsed_;

    // Locale object to use for determining NLV.

    private Locale locale_ = Locale.getDefault();

    // The NLV set or determined from the locale.

    private String nlv_ = ExecutionEnvironment.getNlv(Locale.getDefault());

    // The system's default time zone.

    private transient TimeZone timezone_;

    // Set of socket options to use when creating connections.

    private SocketProperties socketProperties_ = new SocketProperties();



    // No CCSID to start.

    private transient int ccsid_ = 0;



    // List of connection event bean listeners.

    private transient Vector connectionListeners_ = null;  // Set on first add.

    // Inner class that connects connection events that occur in the ImplRemote to this class.

    private transient ConnectionListener dispatcher_ = null;  // Set on first add.

    // List of property change event bean listeners.

    transient PropertyChangeSupport propertyChangeListeners_ = null;  // Set on first add.

    // List of vetoable change event bean listeners.

    transient VetoableChangeSupport vetoableChangeListeners_ = null;  // Set on first add.



    // Flag for when object state is allowed to change.

    transient boolean propertiesFrozen_ = false;



    // Implementation object.

    private transient AS400Impl impl_ = null;



    // This object is created by the initial sign-on process.  It contains the information from the retrieve sign-on information flow with the sign-on server.

    private transient SignonInfo signonInfo_ = null;



    // The IASP name used for the RECORDACCESS service.

    private String ddmRDB_ = null;



    // The sign-on handler for this object's instance.

    private transient SignonHandler signonHandler_ = null;

    private transient boolean handlerCanceled_ = false;



    /* forcePrompt_ is a flag that tells AS400 to force prompt by displaying login dialog (actually the sign-on handler) prior to even trying to authenticate.

    This is useful in cases where an application sends in incorrect dummy id/password and expects Toolbox to display the logon dialog.

    In JDBC, we do some pre-validation of id/password.  So JDBC may flag the id/password as invalid and then need

    to let AS400 know that it just needs to display the logon dialog. */

    private boolean forcePrompt_ = false;  //@prompt



    /**

     Constructs an AS400 object.

     <p>If running on IBM i, the target is the local system.  This has the same effect as using <code>localhost</code> for the system name, *CURRENT for the user ID, and *CURRENT for the password.

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

     **/

    public AS400()

    {

        super();

        if (Trace.traceOn_) Trace.log(Trace.DIAGNOSTIC, "Constructing AS400 object.");

        construct();

        systemNameLocal_ = resolveSystemNameLocal("");

        proxyServer_ = resolveProxyServer(proxyServer_);



        // Default to password authentication

        credVault_ = new PasswordVault();

    }



    /**

     Constructs an AS400 object.  It uses the specified system name.

     <p>If running on IBM i to another system or to itself, the user ID and password of the current job are used.

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

     @param  systemName  The name of the IBM i system.  Use <code>localhost</code> to access data locally.

     **/

    public AS400(String systemName)

    {

        super();

        if (Trace.traceOn_) Trace.log(Trace.DIAGNOSTIC, "Constructing AS400 object, system name: '" + systemName + "'");

        if (systemName == null)

        {

            throw new NullPointerException("systemName");

        }

        construct();

        systemName_ = systemName;

        systemNameLocal_ = resolveSystemNameLocal(systemName);

        proxyServer_ = resolveProxyServer(proxyServer_);



        // Default to password authentication

        credVault_ = new PasswordVault();

    }



    /**

     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.

     @param  systemName  The name of the IBM i system.  Use <code>localhost</code> to access data locally.

     @param  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.

     **/

    public AS400(String systemName, String userId)

    {

        super();

        if (Trace.traceOn_) Trace.log(Trace.DIAGNOSTIC, "Constructing AS400 object, system name: '" + systemName + "' user ID: '" + userId + "'");

        if (systemName == null)

        {

            throw new NullPointerException("systemName");

        }

        if (userId == null)

        {

            throw new NullPointerException("userId");

        }

        if (userId.length() > 10)

        {

            throw new ExtendedIllegalArgumentException("userId (" + userId + ")", ExtendedIllegalArgumentException.LENGTH_NOT_VALID);

        }

        construct();

        systemName_ = systemName;

        systemNameLocal_ = resolveSystemNameLocal(systemName);

        userId_ = userId.toUpperCase();

        proxyServer_ = resolveProxyServer(proxyServer_);



        // Default to password authentication

        credVault_ = new PasswordVault();

    }



    /**

     Constructs an AS400 object.  It uses the specified system name and profile token.

     @param  systemName  The name of the IBM i system.  Use <code>localhost</code> to access data locally.

     @param  profileToken  The profile token to use to authenticate to the system.

     **/

    public AS400(String systemName, ProfileTokenCredential profileToken)

    {

        super();

        if (Trace.traceOn_) Trace.log(Trace.DIAGNOSTIC, "Constructing AS400 object with profile token, system name: '" + systemName + "'");

        if (PASSWORD_TRACE) Trace.log(Trace.DIAGNOSTIC, "profile token: " + profileToken);



        if (profileToken == null)

        {

            throw new NullPointerException("profileToken");

        }



    	constructWithProfileToken(systemName, new ProfileTokenVault(profileToken));

    }



    /**

     * Constructs an AS400 object.  The specified ProfileTokenProvider is used.

     * The token refresh threshold is determined by the ProfileTokenProvider.

     * @param tokenProvider The provider to use when a new profile token needs to be generated.

     * @see #AS400(String,ProfileTokenProvider,int)

     */

    public AS400(String systemName, ProfileTokenProvider tokenProvider)

    {

      this(systemName, tokenProvider, null);

    }



    /**

     * Constructs an AS400 object.  The specified ProfileTokenProvider is used.

     * @param tokenProvider The provider to use when a new profile token needs to be generated.

     * @param 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 #AS400(String,ProfileTokenProvider)

     */

    public AS400(String systemName, ProfileTokenProvider tokenProvider, int refreshThreshold)

    {

      this(systemName, tokenProvider, new Integer(refreshThreshold));

    }



    private AS400(String systemName, ProfileTokenProvider tokenProvider, Integer refreshThreshold)

    {

        super();

        if (Trace.traceOn_) Trace.log(Trace.DIAGNOSTIC, "Constructing AS400 object with a profile token provider, system name: '" + systemName + "'");



        if (tokenProvider == null)

        {

            throw new NullPointerException("tokenProvider");

        }

        if (PASSWORD_TRACE) Trace.log(Trace.DIAGNOSTIC, "profile token provider:", tokenProvider.getClass().getName());



        // Was a refresh threshold specified?

        if (refreshThreshold != null) {

        	constructWithProfileToken(systemName, new ManagedProfileTokenVault(tokenProvider, refreshThreshold.intValue()));

        }

        else {

        	constructWithProfileToken(systemName, new ManagedProfileTokenVault(tokenProvider));

        }

    }



    /**

     * Common code for constructing an AS400 object that uses profile token authentication

     */

    private void constructWithProfileToken(String systemName, ProfileTokenVault credVault)

    {

        if (systemName == null)

        {

            throw new NullPointerException("systemName");

        }

        construct();

        systemName_ = systemName;

        systemNameLocal_ = resolveSystemNameLocal(systemName);



        // Assumption: The caller of this method has ensured that the credential

        // vault has been created and initialized correctly.

        credVault_ = credVault;

        proxyServer_ = resolveProxyServer(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.

     @param  systemName  The name of the IBM i system.  Use <code>localhost</code> to access data locally.

     @param  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.

     @param  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.

     **/

    public AS400(String systemName, String userId, String password)

    {

        super();

        if (Trace.traceOn_) Trace.log(Trace.DIAGNOSTIC, "Constructing AS400 object, system name: '" + systemName + "' user ID: '" + userId + "'");

        if (PASSWORD_TRACE) Trace.log(Trace.DIAGNOSTIC, "password: '" + password + "'");

        if (systemName == null)

        {

            throw new NullPointerException("systemName");

        }

        if (userId == null)

        {

            throw new NullPointerException("userId");

        }

        if (userId.length() > 10)

        {

            throw new ExtendedIllegalArgumentException("userId (" + userId + ")", ExtendedIllegalArgumentException.LENGTH_NOT_VALID);

        }

        if (password == null)

        {

            throw new NullPointerException("password");

        }

        if (password.length() > 128)

        {

            throw new ExtendedIllegalArgumentException("password.length {" + password.length() + ")", ExtendedIllegalArgumentException.LENGTH_NOT_VALID);

        }

        construct();

        systemName_ = systemName;

        systemNameLocal_ = resolveSystemNameLocal(systemName);

        userId_ = userId.toUpperCase();

        credVault_ = new PasswordVault(password);

        proxyServer_ = resolveProxyServer(proxyServer_);

    }



    // Private constructor for use when a new object is needed and the password is already twiddled.

    // Used by password cache and password verification code.

    private AS400(String systemName, String userId, CredentialVault pwVault)

    {

        super();

        if (Trace.traceOn_) Trace.log(Trace.DIAGNOSTIC, "Constructing internal AS400 object, system name: '" + systemName + "' user ID: '" + userId + "'");

        if (PASSWORD_TRACE) Trace.log(Trace.DIAGNOSTIC, pwVault.trace());

        // System name and user ID validation has been deferred to here.

        if (systemName == null)

        {

            throw new NullPointerException("systemName");

        }

        if (userId == null)

        {

            throw new NullPointerException("userId");

        }

        if (userId.length() > 10)

        {

            throw new ExtendedIllegalArgumentException("userId (" + userId + ")", ExtendedIllegalArgumentException.LENGTH_NOT_VALID);

        }

        construct();

        systemName_ = systemName;

        systemNameLocal_ = resolveSystemNameLocal(systemName);

        userId_ = userId.toUpperCase();



        // Create a copy of the supplied credential vault.  This allows the AS400

        // object to have its own credential vault object while making the vault

        // contain the the same credential as the original vault we have been provided.

        // It is VERY important that the copy of the vault contain the same credential

        // as the original vault.  This is because the Toolbox implementation has

        // always allowed two AS400 objects to share a credential (i.e. two AS400

        // objects can both share the same password credential).  So we must maintain

        // that behavior, but we need to do so using two different credential vaults,

        // because each AS400 object must always have its very own credential vault.

        credVault_ = (CredentialVault)pwVault.clone();

        proxyServer_ = resolveProxyServer(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.

     @param  systemName  The name of the IBM i system.  Use <code>localhost</code> to access data locally.

     @param  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.

     @param  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.

     @param  proxyServer  The name and port of the proxy server in the format <code>serverName[:port]</code>.  If no port is specified, a default will be used.

     **/

    public AS400(String systemName, String userId, String password, String proxyServer)

    {

        super();

        if (Trace.traceOn_) Trace.log(Trace.DIAGNOSTIC, "Constructing AS400 object, system name: '" + systemName + "' user ID: '" + userId + "' proxy server: '" + proxyServer + "'");

        if (PASSWORD_TRACE) Trace.log(Trace.DIAGNOSTIC, "password: '" + password + "'");

        if (systemName == null)

        {

            throw new NullPointerException("systemName");

        }

        if (userId == null)

        {

            throw new NullPointerException("userId");

        }

        if (userId.length() > 10)

        {

            throw new ExtendedIllegalArgumentException("userId (" + userId + ")", ExtendedIllegalArgumentException.LENGTH_NOT_VALID);

        }

        if (password == null)

        {

            throw new NullPointerException("password");

        }

        if (password.length() > 128)

        {

            throw new ExtendedIllegalArgumentException("password.length {" + password.length() + ")", ExtendedIllegalArgumentException.LENGTH_NOT_VALID);

        }

        if (proxyServer == null)

        {

            throw new NullPointerException("proxyServer");

        }

        construct();

        systemName_ = systemName;

        systemNameLocal_ = resolveSystemNameLocal(systemName);

        userId_ = userId.toUpperCase();

        credVault_ = new PasswordVault(password);

        proxyServer_ = resolveProxyServer(proxyServer);

    }



    /**

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

     @param  system  A previously instantiated AS400 object.

     **/

    public AS400(AS400 system)

    {

        super();

        if (Trace.traceOn_) Trace.log(Trace.DIAGNOSTIC, "Constructing AS400 object, system: " + system);

        if (system == null)

        {

            throw new NullPointerException("system");

        }

        construct();

        systemName_ = system.systemName_;

        systemNameLocal_ = system.systemNameLocal_;

        userId_ = system.userId_;



        // Create a copy of the supplied credential vault.  This allows the AS400

        // object to have its own credential vault object while making the vault

        // contain the the same credential as the original vault we have been provided.

        // It is VERY important that the copy of the vault contain the same credential

        // as the original vault.  This is because the Toolbox implementation has

        // always allowed two AS400 objects to share a credential (i.e. two AS400

        // objects can both share the same password credential).  So we must maintain

        // that behavior, but we need to do so using two different credential vaults,

        // because each AS400 object must always have its very own credential vault.

        credVault_ = (CredentialVault)system.credVault_.clone();



        gssCredential_ = system.gssCredential_;

        gssName_ = system.gssName_;

        gssOption_ = system.gssOption_;



        proxyServer_ = system.proxyServer_;

        // proxyClientConnection_ is not copied.



        guiAvailable_ = system.guiAvailable_;

        usePasswordCache_ = system.usePasswordCache_;

        useDefaultUser_ = system.useDefaultUser_;

        showCheckboxes_ = system.showCheckboxes_;



        // useSSLConnection_ is handled by SecureAS400 subclass.

        mustAddLanguageLibrary_ = system.mustAddLanguageLibrary_;

        mustUseSockets_ = system.mustUseSockets_;

        mustUseNetSockets_ = system.mustUseNetSockets_;

        mustUseSuppliedProfile_ = system.mustUseSuppliedProfile_;

        threadUsed_ = system.threadUsed_;

        locale_ = system.locale_;

        nlv_ = system.nlv_;

        socketProperties_ = system.socketProperties_;



        ccsid_ = system.ccsid_;



        // connectionListeners_ is not copied.

        // dispatcher_ is not copied.

        // propertyChangeListeners_ is not copied.

        // vetoableChangeListeners_ is not copied.



        // propertiesFrozen_ is not copied.

        // impl_ is not copied.

        // signonInfo_ is not copied.

        ddmRDB_ = system.ddmRDB_;

    }



    /**

     Adds a listener to be notified when a connection event occurs.

     @param  listener  The listener object.

     **/

    public void addConnectionListener(ConnectionListener listener)

    {

        if (Trace.traceOn_) Trace.log(Trace.DIAGNOSTIC, "Adding connection listener.");

        if (listener == null)

        {

            throw new NullPointerException("listener");

        }

        synchronized (this)

        {

            // If first add.

            if (connectionListeners_ == null)

            {

                connectionListeners_ = new Vector();

                dispatcher_ = new ConnectionListener()

                {

                    public void connected(ConnectionEvent event)

                    {

                        fireConnectEvent(event, true);

                    }

                    public void disconnected(ConnectionEvent event)

                    {

                        fireConnectEvent(event, false);

                    }

                };

            }

            // If this is the first add and we are already connected.

            if (impl_ != null && connectionListeners_.isEmpty())

            {

                if (Trace.traceOn_) Trace.log(Trace.DIAGNOSTIC, "Enabling connection listener dispatcher.");

                impl_.addConnectionListener(dispatcher_);

            }

            connectionListeners_.addElement(listener);

        }

    }



    /**

     Validates the user ID and password, and if successful, adds the information to the password cache.

     @param  systemName  The name of the IBM i system.

     @param  userId  The user profile name.

     @param  password  The user profile password.

     @exception  AS400SecurityException  If a security or authority error occurs.

     @exception  IOException  If an error occurs while communicating with the system.

     **/

    public static void addPasswordCacheEntry(String systemName, String userId, String password) throws AS400SecurityException, IOException

    {

        if (Trace.traceOn_) Trace.log(Trace.DIAGNOSTIC, "Adding password cache entry, system name: '" + systemName + "' user ID: '" + userId + "'");

        addPasswordCacheEntry(new AS400(systemName, userId, password));

    }



    /**

     Validates the user ID and password, and if successful, adds the information to the password cache.

     @param  systemName  The name of the IBM i system.

     @param  userId  The user profile name.

     @param  password  The user profile password.

     @param  proxyServer  The name and port of the proxy server in the format <code>serverName[:port]</code>.  If no port is specified, a default will be used.

     @exception  AS400SecurityException  If a security or authority error occurs.

     @exception  IOException  If an error occurs while communicating with the system.

     **/

    public static void addPasswordCacheEntry(String systemName, String userId, String password, String proxyServer) throws AS400SecurityException, IOException

    {

        if (Trace.traceOn_) Trace.log(Trace.DIAGNOSTIC, "Adding password cache entry, system name: '" + systemName + "' user ID: '" + userId + "' proxy server: '" + proxyServer + "'");

        addPasswordCacheEntry(new AS400(systemName, userId, password, proxyServer));

    }



    // For use by AS400 and SecureAS400 objects.

    static void addPasswordCacheEntry(AS400 system) throws AS400SecurityException, IOException

    {

        system.validateSignon();  // Exception thrown if info not valid.

        setCacheEntry(system.systemName_, system.userId_, system.credVault_);

    }



    /**

     Adds a listener to be notified when the value of any property is changed.

     @param  listener  The listener object.

     **/

    public void addPropertyChangeListener(PropertyChangeListener listener)

    {

        if (Trace.traceOn_) Trace.log(Trace.DIAGNOSTIC, "Adding property change listener.");

        if (listener == null)

        {

            throw new NullPointerException("listener");

        }

        synchronized (this)

        {

            // If first add.

            if (propertyChangeListeners_ == null)

            {

                propertyChangeListeners_ = new PropertyChangeSupport(this);

            }

            propertyChangeListeners_.addPropertyChangeListener(listener);

        }

    }



    /**

     Adds a listener to be notified when the value of any constrained property is changed.  The vetoableChange method will be called.

     @param  listener  The listener object.

     **/

    public void addVetoableChangeListener(VetoableChangeListener listener)

    {

        if (Trace.traceOn_) Trace.log(Trace.DIAGNOSTIC, "Adding vetoable change listener.");

        if (listener == null)

        {

            throw new NullPointerException("listener");

        }

        synchronized (this)

        {

            // If first add.

            if (vetoableChangeListeners_ == null)

            {

                vetoableChangeListeners_ = new VetoableChangeSupport(this);

            }

            vetoableChangeListeners_.addVetoableChangeListener(listener);

        }

    }



    /**

     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.

     @return  true if properties are frozen, false otherwise.

     **/

    public boolean arePropertiesFrozen()

    {

        if (Trace.traceOn_) Trace.log(Trace.DIAGNOSTIC, "Checking if properties are frozen:", propertiesFrozen_);

        return propertiesFrozen_;

    }



    /**

     Authenticates the user profile name and user profile password.

     <p>This method is functionally equivalent to the <i>validateSignon()</i> method.  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.

     <p>The system name needs to be set prior to calling this method.

     <p><b>Note:</b> Providing an incorrect password increments the number of failed sign-on attempts for the user profile, and can result in the profile being disabled.

     <p><b>Note:</b> This will return true if the information is successfully validated.  An unsuccessful validation will cause an exception to be thrown, false is never returned.

     @param  userId  The user profile name.

     @param  password  The user profile password.

     @return  true if successful.

     @exception  AS400SecurityException  If a security or authority error occurs.

     @exception  IOException  If an error occurs while communicating with the system.

     **/

    public boolean authenticate(String userId, String password) throws AS400SecurityException, IOException

    {

        if (Trace.traceOn_) Trace.log(Trace.DIAGNOSTIC, "Authenticating signon information:", userId);

        return validateSignon(userId, password);

    }



    // Only load native version once.

    private static int nativeVersion = -1;

    private static int getNativeVersion()

    {

        try

        {

            if (AS400.nativeVersion == -1)

            {

                AS400.nativeVersion = Class.forName("com.ibm.as400.access.NativeVersion").newInstance().hashCode();

            }

        }

        catch (ClassNotFoundException e)

        {

            if (Trace.traceOn_) Trace.log(Trace.DIAGNOSTIC, "Not using native optimizations; class 'NativeVersion' is not found.");

            AS400.nativeVersion = 0;

        }

        catch (Exception e)

        {

            if (Trace.traceOn_) Trace.log(Trace.DIAGNOSTIC, "Not using native optimizations; unexpected exception while loading native version:", e);

            AS400.nativeVersion = 0;

        }

        return AS400.nativeVersion;

    }



    /**

     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 {@link #AUTHENTICATION_SCHEME_PASSWORD AUTHENTICATION_SCHEME_PASSWORD}, native optimizations will not be used.

     @return true if the native optimizations can be used; false otherwise.

     @see #isLocal

     @see #isMustUseSockets

     @see #getAuthenticationScheme

     **/

    public boolean canUseNativeOptimizations()

    {

        if (AS400.onAS400 && !mustUseSockets_ && systemNameLocal_ && proxyServer_.length() == 0 && credVault_.getType() == AUTHENTICATION_SCHEME_PASSWORD && getNativeVersion() == 2)

        {

            if (Trace.traceOn_) Trace.log(Trace.DIAGNOSTIC, "Using native optimizations.");

            return true;

        }

        else

        {

          if (Trace.traceOn_)

          {

            Trace.log(Trace.DIAGNOSTIC, "Not using native optimizations. Reason follows:");

            if (!AS400.onAS400) {

              Trace.log(Trace.DIAGNOSTIC, "  onAS400:", AS400.onAS400);

            }

            if (mustUseSockets_) {

              Trace.log(Trace.DIAGNOSTIC, "  mustUseSockets:", mustUseSockets_);

            }

            if (!systemNameLocal_) {

              Trace.log(Trace.DIAGNOSTIC, "  systemNameLocal:", systemNameLocal_);

            }

            if (proxyServer_.length() != 0) {

              Trace.log(Trace.DIAGNOSTIC, "  proxyServer:", proxyServer_);

            }

            int credType = credVault_.getType();

            if (credType != AUTHENTICATION_SCHEME_PASSWORD) {

              // Design note: For various reasons (such as lack of requirement, and potential complications

              // when swapping during a token-based session), the Toolbox has never supported staying

              //on-thread when using profile tokens or other non-password based authentication schemes.

              Trace.log(Trace.DIAGNOSTIC, "  authenticationScheme:", credType +

                        " ("+credTypeToString(credType)+")");

            }

            if (getNativeVersion() != 2) {

              Trace.log(Trace.DIAGNOSTIC, "  nativeVersion:", getNativeVersion());

            }

          }

          return false;

        }

    }



    private static final String credTypeToString(int credType)

    {

      String result;

      switch (credType)

      {

        case AUTHENTICATION_SCHEME_PASSWORD :

          result = "password";

          break;

        case AUTHENTICATION_SCHEME_GSS_TOKEN :

          result = "GSS token";

          break;

        case AUTHENTICATION_SCHEME_PROFILE_TOKEN :

          result = "profile token";

          break;

        case AUTHENTICATION_SCHEME_IDENTITY_TOKEN :

          result = "identity token";

          break;

        default :

          result = "unrecognized";

      }

      return result;

    }



    /**

     Changes the user profile password.  The system name and user profile name need to be set prior to calling this method.

     @param  oldPassword  The old user profile password.

     @param  newPassword  The new user profile password.

     @exception  AS400SecurityException  If a security or authority error occurs.

     @exception  IOException  If an error occurs while communicating with the system.

     **/

    public void changePassword(String oldPassword, String newPassword) throws AS400SecurityException, IOException

    {

        if (Trace.traceOn_) Trace.log(Trace.DIAGNOSTIC, "Changing password.");

        if (PASSWORD_TRACE)

        {

            Trace.log(Trace.DIAGNOSTIC, "oldPassword: '" + oldPassword + "'");

            Trace.log(Trace.DIAGNOSTIC, "newPassword: '" + newPassword + "'");

        }

        if (oldPassword == null)

        {

            throw new NullPointerException("oldPassword");

        }

        if (oldPassword.length() > 128)

        {

            throw new ExtendedIllegalArgumentException("oldPassword.length {" + oldPassword.length() + ")", ExtendedIllegalArgumentException.LENGTH_NOT_VALID);

        }

        if (newPassword == null)

        {

            throw new NullPointerException("newPassword");

        }

        if (newPassword.length() > 128)

        {

            throw new ExtendedIllegalArgumentException("newPassword.length {" + newPassword.length() + ")", ExtendedIllegalArgumentException.LENGTH_NOT_VALID);

        }



        if (systemName_.length() == 0 && !systemNameLocal_)

        {

            Trace.log(Trace.ERROR, "Cannot change password before system name is set.");

            throw new ExtendedIllegalStateException("systemName", ExtendedIllegalStateException.PROPERTY_NOT_SET);

        }

        userId_ = resolveUserId(userId_);

        if (userId_.length() == 0)

        {

            Trace.log(Trace.ERROR, "Cannot change password before user ID is set.");

            throw new ExtendedIllegalStateException("userId", ExtendedIllegalStateException.PROPERTY_NOT_SET);

        }



        chooseImpl();



        // Synchronize to protect sign-on information.

        synchronized (this)

        {

            byte[] proxySeed = new byte[9];

            CredentialVault.rng.nextBytes(proxySeed);

            byte[] remoteSeed = impl_.exchangeSeed(proxySeed);



            if (PASSWORD_TRACE)

            {

                Trace.log(Trace.DIAGNOSTIC, "AS400 object proxySeed:", proxySeed);

                Trace.log(Trace.DIAGNOSTIC, "AS400 object remoteSeed:", remoteSeed);

            }



            // Note that in this particular case it is OK to just pass byte arrays

            // instead of credential vaults.  That is because we have the clear text

            // passwords, so all we need to do is encode them and send them over

            // to the impl.  After the password has been changed, we will update

            // our own credential vault with the new password, and create ourselves

            // the appropriate type of credential vault to store the password in.



            signonInfo_ = impl_.changePassword(systemName_, systemNameLocal_, userId_, CredentialVault.encode(proxySeed, remoteSeed, BinaryConverter.charArrayToByteArray(oldPassword.toCharArray())), CredentialVault.encode(proxySeed, remoteSeed, BinaryConverter.charArrayToByteArray(newPassword.toCharArray())));



            if (Trace.traceOn_) Trace.log(Trace.DIAGNOSTIC, "Password changed successfully.");



            // Update credential vault with new password.

            credVault_.empty();

            credVault_ = new PasswordVault(newPassword);

        }

    }



    // Choose between remote and proxy implementation objects, set state information into remote implementation object.  Synchronized to protect impl_ and propertiesFrozen_ instance variables.  This method can safely be called multiple times because it checks its state before performing the code.

    private synchronized void chooseImpl()

    {

        if (impl_ == null)

        {

            impl_ = (AS400Impl)loadImpl2("com.ibm.as400.access.AS400ImplRemote", "com.ibm.as400.access.AS400ImplProxy");



            // If there is a connection listener.  Connect the remote implementation connection events to this object.

            if (connectionListeners_ != null && !connectionListeners_.isEmpty())

            {

                if (Trace.traceOn_) Trace.log(Trace.DIAGNOSTIC, "Enabling connection listener dispatcher.");

                impl_.addConnectionListener(dispatcher_);

            }

        }

        if (!propertiesFrozen_)

        {

            impl_.setState(useSSLConnection_, canUseNativeOptimizations(), threadUsed_, ccsid_, nlv_, socketProperties_, ddmRDB_, mustUseNetSockets_, mustUseSuppliedProfile_, mustAddLanguageLibrary_);

            propertiesFrozen_ = true;

        }

        impl_.setBidiStringType(this.getBidiStringType());				//@Bidi-HCG3

    }



    /**

     Clears the password cache for all systems within this Java virtual machine.

     **/

    public static void clearPasswordCache()

    {

        if (Trace.traceOn_) Trace.log(Trace.DIAGNOSTIC, "Clearing password cache.");

        synchronized (AS400.systemList)

        {

	        AS400.systemList.removeAllElements();

        }

    }



    /**

     Clears all the passwords