Skip navigation links
oracle.security.am.asdk
Class AccessClient
java.lang.Object
oracle.security.am.asdk.AccessClient
-
public final class AccessClient
- extends java.lang.Object
Implements AccessClient Class.
Implements methods that allow applications to initialize the Access Server API Client.
The initialization functions are used to:
- indicate the location of an Access Server API configuration file,
- initialize the Access Server API from the configuration file,
- get information from the Access Server API configuration.
The AccessClient class includes class methods to indicate the location of a properties configuration file, to initialize the Access Server API from the XML configuration file and to retrieve a value of a configuration item.
Method Summary |
static AccessClient |
createDefaultInstance()
Returns a reference to a Singleton object of AccessClient. |
static AccessClient |
createDefaultInstance(AccessClient.CompatibilityMode mode)
Returns a reference to a Singleton object of AccessClient. |
static AccessClient |
createDefaultInstance(java.util.Hashtable bootstrapConfig, AccessClient.CompatibilityMode mode, ConfigUpdateCallback confupdtcallbk)
Returns a reference to a Singleton object of AccessClient. |
static AccessClient |
createDefaultInstance(java.util.Hashtable bootstrapConfig, ConfigUpdateCallback confupdtcallbk)
Returns a reference to a Singleton object of AccessClient. |
static AccessClient |
createDefaultInstance(java.lang.String configLocation)
Returns a reference to a Singleton object of AccessClient. |
static AccessClient |
createDefaultInstance(java.lang.String configLocation, AccessClient.CompatibilityMode mode)
Returns a reference to a Singleton object of AccessClient. |
static AccessClient |
createInstance(java.util.Hashtable bootstrapConfig, java.lang.String loggerName, AccessClient.CompatibilityMode mode, ConfigUpdateCallback confupdtcallbk)
Creates a new instance of AccessClient. |
static AccessClient |
createInstance(java.util.Hashtable bootstrapConfig, java.lang.String loggerName, ConfigUpdateCallback confupdtcallbk)
Returns a reference to a new object of AccessClient (using default OAM_11G compatibility mode). |
static AccessClient |
createInstance(java.lang.String loggerName)
Returns a reference to a new object of AccessClient (using default OAM_11G compatibility mode). |
static AccessClient |
createInstance(java.lang.String loggerName, AccessClient.CompatibilityMode mode)
Returns a reference to a new object of AccessClient. |
static AccessClient |
createInstance(java.lang.String configLocation, java.lang.String loggerName)
Returns a reference to a new object of AccessClient (using default OAM_11G compatibility mode). |
static AccessClient |
createInstance(java.lang.String configLocation, java.lang.String loggerName, AccessClient.CompatibilityMode mode)
Returns a reference to a new object of AccessClient. |
java.util.Hashtable |
getClientDiagnosticInfo()
Returns the diagnostic information about the connectivity to OAM 10g servers including host, port, time since when the connection is established and the server state. |
java.util.Hashtable |
getConfigDifference()
Returns the difference or changes occurred in configurations after configuration update. |
java.util.Hashtable |
getConfigurations()
Returns all the configuration settings from the configuration file before connecting to the server, or the configuration fetched from the server |
static AccessClient |
getDefaultInstance()
Returns a reference to the Singleton object of AccessClient; if already created. |
java.util.Hashtable |
getDirectoryDiagnosticInfo()
Returns the directory diagnostic information from the OAM 10g servers about the Directory Servers used to store User, Policy, Config information. |
java.lang.String |
getInstanceNAPVersion()
Returns Oracle Access Protocol version of the current AccessClient instance. |
static java.lang.String |
getNAPVersion()
Returns Oracle Access Protocol version of the default singleton object instance. |
static java.lang.String |
getSDKVersion()
Returns the OAM Access SDK version number. |
java.util.Hashtable |
getServerDiagnosticInfo()
Returns the diagnostic information from the OAM 10g server containing server health, host, port, number of connections. |
boolean |
isInitialized()
Checks if AccessClient is initialized or not. |
void |
shutdown()
It disconnects client from the OAM server. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
CFG_WEBGATE_ID
public static final java.lang.String CFG_WEBGATE_ID
-
- See Also:
- Constant Field Values
CFG_DEBUG_VALUE
public static final java.lang.String CFG_DEBUG_VALUE
-
- See Also:
- Constant Field Values
CFG_TRANSPORT_SECURITY
public static final java.lang.String CFG_TRANSPORT_SECURITY
-
- See Also:
- Constant Field Values
CFG_ENCRYPTED_PASSWORD
public static final java.lang.String CFG_ENCRYPTED_PASSWORD
-
- See Also:
- Constant Field Values
CFG_PRIMARY_SERVER_LIST
public static final java.lang.String CFG_PRIMARY_SERVER_LIST
-
- See Also:
- Constant Field Values
CFG_SEC_SERVER_LIST
public static final java.lang.String CFG_SEC_SERVER_LIST
-
- See Also:
- Constant Field Values
CFG_USER_DEF_VALS
public static final java.lang.String CFG_USER_DEF_VALS
-
- See Also:
- Constant Field Values
CFG_PASSPHRASE
public static final java.lang.String CFG_PASSPHRASE
-
- See Also:
- Constant Field Values
CFG_KEYSTORE
public static final java.lang.String CFG_KEYSTORE
-
- See Also:
- Constant Field Values
CFG_TRUSTSTORE
public static final java.lang.String CFG_TRUSTSTORE
-
- See Also:
- Constant Field Values
CFG_SERVER_HOST
public static final java.lang.String CFG_SERVER_HOST
-
- See Also:
- Constant Field Values
CFG_SERVER_PORT
public static final java.lang.String CFG_SERVER_PORT
-
- See Also:
- Constant Field Values
CFG_SERVER_MAX_CONNS
public static final java.lang.String CFG_SERVER_MAX_CONNS
-
- See Also:
- Constant Field Values
CFG_POOL_TIMEOUT
public static final java.lang.String CFG_POOL_TIMEOUT
-
- See Also:
- Constant Field Values
CFG_SERVER_CONNECTION_READ_TIMEOUT
public static final java.lang.String CFG_SERVER_CONNECTION_READ_TIMEOUT
-
- See Also:
- Constant Field Values
CFG_TCP_CONNECT_TIMEOUT
public static final java.lang.String CFG_TCP_CONNECT_TIMEOUT
-
- See Also:
- Constant Field Values
isInitialized
public boolean isInitialized()
- Checks if AccessClient is initialized or not.
-
- Returns:
- Boolean true if AccessClient is initialized
createDefaultInstance
public static AccessClient createDefaultInstance(AccessClient.CompatibilityMode mode)
throws AccessException
- Returns a reference to a Singleton object of AccessClient. Creates the singleton object if one does not already exist.
In addition, it also performs initialization required before any ASDK api can be used. For initialization, it searches for the configuration file in locations in the order given below:
- OAM_ASDK_CONFIG_DIR java property can be provided that points to the directory location of the configuration file. It will use the configuration file available in the directory location pointed by this property. If the file is not found, it will throw AccessException. If this property is not set,it will fall back to the next option.
- Deprecated.OBACCESS_INSTALL_DIR environment variable can be defined, which points to the directory location of the configuration file. This option is supported for backward compatibility. If this environment variable is set, it will search for configuration file in sub directory structure. If file is not found, it will throw AccessException. If this environment variable is not set, it will fall back to the next option.
- ASDK Jar location, the location where ASDK jar is located.
-
- Parameters:
mode
- indicates the compatibility mode to be used by the AccessClient object.
- Returns:
- A reference to the Singleton object of AccessClient.
- Throws:
AccessException
- In case of initialization failure.
createDefaultInstance
public static AccessClient createDefaultInstance()
throws AccessException
- Returns a reference to a Singleton object of AccessClient. Creates the singleton object (using default OAM_11G compatibility mode) if one does not already exist.
In addition, it also performs initialization required before any ASDK api can be used. For initialization, it searches for the configuration file in locations in the order given below:
- OAM_ASDK_CONFIG_DIR java property can be provided that points to the directory location of the configuration file. It will use the configuration file available in the directory location pointed by this property. If the file is not found, it will throw AccessException. If this property is not set,it will fall back to the next option.
- Deprecated.OBACCESS_INSTALL_DIR environment variable can be defined, which points to the directory location of the configuration file. This option is supported for backward compatibility. If this environment variable is set, it will search for configuration file in sub directory structure. If file is not found, it will throw AccessException. If this environment variable is not set, it will fall back to the next option.
- ASDK Jar location, the location where ASDK jar is located.
-
- Returns:
- A reference to the Singleton object of AccessClient.
- Throws:
AccessException
- In case of initialization failure.
createDefaultInstance
public static AccessClient createDefaultInstance(java.lang.String configLocation,
AccessClient.CompatibilityMode mode)
throws AccessException
- Returns a reference to a Singleton object of AccessClient. Creates the singleton object if one does not already exist.
ConfigLocation is a directory location where configuration file will be searched first underneath and if not found, it searches in a OAM 10g JNI ASDK sub directory path.Deprecated. The OAM 10g JNI ASDK sub directory is searched for backward compatibility. If the configuration file is not found, it will throw AccessException.
If configLocation is null, it searches for the configuration file in locations in the order given below:
- OAM_ASDK_CONFIG_DIR java property can be provided that points to the directory location of the configuration file. It will use the configuration file available in the directory location pointed by this property. If the file is not found, it will throw AccessException. If this property is not set,it will fall back to the next option.
- Deprecated.OBACCESS_INSTALL_DIR environment variable can be defined, which points to the directory location of the configuration file. This option is supported for backward compatibility. If this environment variable is set, it will search for configuration file in sub directory structure. If file is not found, it will throw AccessException. If this environment variable is not set, it will fall back to the next option.
- ASDK Jar location, the location where ASDK jar is located.
-
- Parameters:
configLocation
- indicates the directory location of configuration file used for initializing the singleton AccessClient object.
mode
- indicates the compatibility mode to be used by the AccessClient object.
- Returns:
- A reference to the Singleton object of AccessClient.
- Throws:
AccessException
- In case of initialization failure OR there is an reinitialization attempt detected by invoking with different configLocation.
createDefaultInstance
public static AccessClient createDefaultInstance(java.lang.String configLocation)
throws AccessException
- Returns a reference to a Singleton object of AccessClient. Creates the singleton object (using default OAM_11G compatibility mode) if one does not already exist.
ConfigLocation is a directory location where configuration file will be searched first underneath and if not found, it searches in a OAM 10g JNI ASDK sub directory path.Deprecated. The OAM 10g JNI ASDK sub directory is searched for backward compatibility. If the configuration file is not found, it will throw AccessException.
If configLocation is null, it searches for the configuration file in locations in the order given below:
- OAM_ASDK_CONFIG_DIR java property can be provided that points to the directory location of the configuration file. It will use the configuration file available in the directory location pointed by this property. If the file is not found, it will throw AccessException. If this property is not set,it will fall back to the next option.
- Deprecated.OBACCESS_INSTALL_DIR environment variable can be defined, which points to the directory location of the configuration file. This option is supported for backward compatibility. If this environment variable is set, it will search for configuration file in sub directory structure. If file is not found, it will throw AccessException. If this environment variable is not set, it will fall back to the next option.
- ASDK Jar location, the location where ASDK jar is located.
-
- Parameters:
configLocation
- indicates the directory location of configuration file used for initializing the singleton AccessClient object.
- Returns:
- A reference to the Singleton object of AccessClient.
- Throws:
AccessException
- In case of initialization failure OR there is an reinitialization attempt detected by invoking with different configLocation.
createDefaultInstance
public static AccessClient createDefaultInstance(java.util.Hashtable bootstrapConfig,
AccessClient.CompatibilityMode mode,
ConfigUpdateCallback confupdtcallbk)
throws AccessException
- Returns a reference to a Singleton object of AccessClient. Creates the singleton object if one does not already exist.
Bootstrap Config consists of minimal configuration required for initializing the singleton AccessClient object.
-
- Parameters:
bootstrapConfig
- hashtable containing configuration variables in form of key value pairs of String type. The possible key values are defined as constants in this class.
mode
- indicates the compatibility mode to be used by the AccessClient object.
confupdtcallbk
- object implementing the callback interface
- Returns:
- A reference to the Singleton object of AccessClient.
- Throws:
AccessException
- In case of initialization failure OR there is an reinitialization attempt.
createDefaultInstance
public static AccessClient createDefaultInstance(java.util.Hashtable bootstrapConfig,
ConfigUpdateCallback confupdtcallbk)
throws AccessException
- Returns a reference to a Singleton object of AccessClient. Creates the singleton object (using default OAM_11G compatibility mode) if one does not already exist.
Bootstrap Config consists of minimal configuration required for initializing the singleton AccessClient object.
-
- Parameters:
bootstrapConfig
- hashtable containing configuration variables in form of key value pairs of String type. The possible key values are defined as constants in this class.
confupdtcallbk
- object implementing the callback interface
- Returns:
- A reference to the Singleton object of AccessClient.
- Throws:
AccessException
- In case of initialization failure OR there is an reinitialization attempt.
getServerDiagnosticInfo
public final java.util.Hashtable getServerDiagnosticInfo()
throws AccessException
- Returns the diagnostic information from the OAM 10g server containing server health, host, port, number of connections.
-
- Returns:
- Hashtable containing server diagnostic information in name/value pairs of String type.
- Throws:
AccessException
- If OAM server fails to return the information
getDirectoryDiagnosticInfo
public final java.util.Hashtable getDirectoryDiagnosticInfo()
throws AccessException
- Returns the directory diagnostic information from the OAM 10g servers about the Directory Servers used to store User, Policy, Config information. The information includes host, port, bind credentials, search base.
-
- Returns:
- Hashtable containing directory diagnostic information in name/value pairs of String type.
- Throws:
AccessException
- If OAM server fails to return the information
getClientDiagnosticInfo
public final java.util.Hashtable getClientDiagnosticInfo()
throws AccessException
- Returns the diagnostic information about the connectivity to OAM 10g servers including host, port, time since when the connection is established and the server state.
-
- Returns:
- Hashtable containing diagnostic information about the connectivity in name/value pairs of String type.
- Throws:
AccessException
- If diagnostic information cannot be fetched
createInstance
public static AccessClient createInstance(java.lang.String loggerName,
AccessClient.CompatibilityMode mode)
throws AccessException
- Returns a reference to a new object of AccessClient.
In addition, it also performs initialization required before any ASDK api can be used. For initialization, it searches for the configuration file in locations in the order given below:
- OAM_ASDK_CONFIG_DIR java property can be provided that points to the directory location of the configuration file. It will use the configuration file available in the directory location pointed by this property. If the file is not found, it will throw AccessException. If this property is not set,it will fall back to the next option.
- Deprecated.OBACCESS_INSTALL_DIR environment variable can be defined, which points to the directory location of the configuration file. This option is supported for backward compatibility. If this environment variable is set, it will search for configuration file in sub directory structure. If file is not found, it will throw AccessException. If this environment variable is not set, it will fall back to the next option.
- ASDK Jar location, the location where ASDK jar is located.
-
- Parameters:
loggerName
- indicates the name with which the Java Logger object would be created.
mode
- indicates the compatibility mode to be used by the AccessClient object.
- Returns:
- A reference to a new object of AccessClient.
- Throws:
AccessException
- In case of initialization failure.
createInstance
public static AccessClient createInstance(java.lang.String loggerName)
throws AccessException
- Returns a reference to a new object of AccessClient (using default OAM_11G compatibility mode).
In addition, it also performs initialization required before any ASDK api can be used. For initialization, it searches for the configuration file in locations in the order given below:
- OAM_ASDK_CONFIG_DIR java property can be provided that points to the directory location of the configuration file. It will use the configuration file available in the directory location pointed by this property. If the file is not found, it will throw AccessException. If this property is not set,it will fall back to the next option.
- Deprecated.OBACCESS_INSTALL_DIR environment variable can be defined, which points to the directory location of the configuration file. This option is supported for backward compatibility. If this environment variable is set, it will search for configuration file in sub directory structure. If file is not found, it will throw AccessException. If this environment variable is not set, it will fall back to the next option.
- ASDK Jar location, the location where ASDK jar is located.
-
- Parameters:
loggerName
- indicates the name with which the Java Logger object would be created.
- Returns:
- A reference to a new object of AccessClient.
- Throws:
AccessException
- In case of initialization failure.
createInstance
public static AccessClient createInstance(java.lang.String configLocation,
java.lang.String loggerName,
AccessClient.CompatibilityMode mode)
throws AccessException
- Returns a reference to a new object of AccessClient.
ConfigLocation is a directory location where configuration file will be searched first underneath and if not found, it searches in a OAM 10g JNI ASDK sub directory path.Deprecated. The OAM 10g JNI ASDK sub directory is searched for backward compatibility.If the configuration file is not found, it will throw AccessException.
If configLocation is null, it searches for the configuration file in locations in the order given below:
- OAM_ASDK_CONFIG_DIR java property can be provided that points to the directory location of the configuration file. It will use the configuration file available in the directory location pointed by this property. If the file is not found, it will throw AccessException. If this property is not set,it will fall back to the next option.
- Deprecated. OBACCESS_INSTALL_DIR environment variable can be defined, which points to the directory location of the configuration file. This option is supported for backward compatibility. If this environment variable is set, it will search for configuration file in sub directory structure. If file is not found, it will throw AccessException. If this environment variable is not set, it will fall back to the next option.
- ASDK Jar location, the location where ASDK jar is located.
-
- Parameters:
configLocation
- indicates the directory location of configuration file to be used while initializing the AccessClient object.
loggerName
- indicates the name with which the Java Logger object would be created.
mode
- indicates the compatibility mode to be used by the AccessClient object.
- Returns:
- A reference to a new object of AccessClient.
- Throws:
AccessException
- In case of initialization failure.
createInstance
public static AccessClient createInstance(java.lang.String configLocation,
java.lang.String loggerName)
throws AccessException
- Returns a reference to a new object of AccessClient (using default OAM_11G compatibility mode).
ConfigLocation is a directory location where configuration file will be searched first underneath and if not found, it searches in a OAM 10g JNI ASDK sub directory path.Deprecated. The OAM 10g JNI ASDK sub directory is searched for backward compatibility.If the configuration file is not found, it will throw AccessException.
If configLocation is null, it searches for the configuration file in locations in the order given below:
- OAM_ASDK_CONFIG_DIR java property can be provided that points to the directory location of the configuration file. It will use the configuration file available in the directory location pointed by this property. If the file is not found, it will throw AccessException. If this property is not set,it will fall back to the next option.
- Deprecated. OBACCESS_INSTALL_DIR environment variable can be defined, which points to the directory location of the configuration file. This option is supported for backward compatibility. If this environment variable is set, it will search for configuration file in sub directory structure. If file is not found, it will throw AccessException. If this environment variable is not set, it will fall back to the next option.
- ASDK Jar location, the location where ASDK jar is located.
-
- Parameters:
configLocation
- indicates the directory location of configuration file to be used while initializing the AccessClient object.
loggerName
- indicates the name with which the Java Logger object would be created.
- Returns:
- A reference to a new object of AccessClient.
- Throws:
AccessException
- In case of initialization failure.
createInstance
public static AccessClient createInstance(java.util.Hashtable bootstrapConfig,
java.lang.String loggerName,
AccessClient.CompatibilityMode mode,
ConfigUpdateCallback confupdtcallbk)
throws AccessException
- Creates a new instance of AccessClient. This instance is created using the configuration specified by bootstrapConfig.
-
- Parameters:
bootstrapConfig
- Hashtable containing configuration variables in form of key value pairs of String type. The possible key values are defined as constants in this class.
mode
- indicates the compatibility mode to be used by the AccessClient object.
loggerName
- indicates the name with which the Java Logger object would be created.
confupdtcallbk
- object implementing the callback interface
- Returns:
- A reference to a new object of AccessClient.
- Throws:
AccessException
- In case if bootstrapConfig is null or provided bootstrapConfig is incomplete
createInstance
public static AccessClient createInstance(java.util.Hashtable bootstrapConfig,
java.lang.String loggerName,
ConfigUpdateCallback confupdtcallbk)
throws AccessException
- Returns a reference to a new object of AccessClient (using default OAM_11G compatibility mode).
Bootstrap Config consists of minimal set of configuration required for initializing the AccessClient object.
-
- Parameters:
bootstrapConfig
- Hashtable containing configuration variables in form of key value pairs of String type. The possible key values are defined as constants in this class.
loggerName
- indicates the name with which the Java Logger object would be created.
confupdtcallbk
- object implementing the callback interface
- Returns:
- A reference to a new object of AccessClient.
- Throws:
AccessException
- In case if bootstrapConfig is null or provided bootstrapConfig is incomplete
getConfigurations
public java.util.Hashtable getConfigurations()
throws AccessException
- Returns all the configuration settings from the configuration file before connecting to the server, or the configuration fetched from the server
-
- Returns:
- Hashtable containing the configuration vars in name/value pairs of String type.
- Throws:
AccessException
- If method is invoked before successful initialization
shutdown
public void shutdown()
- It disconnects client from the OAM server.
getNAPVersion
public static java.lang.String getNAPVersion()
- Returns Oracle Access Protocol version of the default singleton object instance.
-
- Returns:
- String representing Oracle Access Protocol version.
getInstanceNAPVersion
public java.lang.String getInstanceNAPVersion()
- Returns Oracle Access Protocol version of the current AccessClient instance.
-
- Returns:
- String representing Oracle Access Protocol version.
getSDKVersion
public static java.lang.String getSDKVersion()
- Returns the OAM Access SDK version number.
-
- Returns:
- String representing OAM Access SDK version number.
getConfigDifference
public java.util.Hashtable getConfigDifference()
- Returns the difference or changes occurred in configurations after configuration update.
-
- Returns:
- Hashtable representing changes occurred in configurations after configuration update.
getDefaultInstance
public static AccessClient getDefaultInstance()
throws AccessException
- Returns a reference to the Singleton object of AccessClient; if already created.
-
- Returns:
- A reference to the Singleton object of AccessClient; if already created.
- Throws:
AccessException
- In case if Singleton object of AccessClient is not created or Singleton AccessClient object initialization fails.
Skip navigation links
Copyright © 2000, 2013, Oracle® and/or its affiliates. All rights reserved.