oracle.security.am.asdk

Class LocalAccessClient

java.lang.Object

oracle.security.am.asdk.LocalAccessClient

public final class LocalAccessClient
extends java.lang.Object

Implements LocalAccessClient 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LocalAccessClient.CompatibilityMode

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFG_SERVER_IP
static java.lang.String	CFG_WEBGATE_ID
static java.lang.String	SESSION_ID
static java.lang.String	SESSION_KEY_DELIM
static java.lang.String	SESSION_TYPE
static java.lang.String	SESSION_VAL_DELIM

Method Summary

Modifier and Type	Method and Description
static LocalAccessClient	createInstance(java.lang.String webgateProfile, java.lang.String loggerName, LocalAccessClient.CompatibilityMode mode) Creates a new instance of LocalAccessClient.
java.lang.String	get_webgateProfile()
protected oracle.security.am.asdk.impl.AccessCacheManagerImpl	getCacheManager() Returns cache manager instance
protected ObAAAServiceClient	getClient()
protected oracle.security.am.asdk.impl.Configuration	getConfig()
static LocalAccessClient	getDefaultInstance() Returns a reference to the Singleton object of AccessClient; if already created.
java.lang.String	getInstanceNAPVersion() Returns Oracle Access Protocol version of the current AccessClient instance.
protected java.util.logging.Logger	getLogger() Returns logger instance
java.lang.String	getMasterToken(java.lang.String sessionId, java.lang.String deviceFingerPrintId)
static java.lang.String	getNAPVersion() Returns Oracle Access Protocol version of the default singleton object instance.
protected ObAAAServiceClient	getObClient()
static java.lang.String	getSDKVersion() Returns the OAM Access SDK version number.
static java.lang.String	getSessionIdFormat(java.lang.String sessionId)
java.lang.String	getUserToken(java.lang.String oamMasterToken, java.lang.String agentId)
java.lang.String	getUserToken(java.lang.String sessionId, java.lang.String oamMasterToken, java.lang.String agentId)
boolean	isInitialized() Checks if LocalAccessClient is initialized or not.
void	set_webgateProfile(java.lang.String profile)
protected void	updateLastAccessTime()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CFG_WEBGATE_ID

public static final java.lang.String CFG_WEBGATE_ID

See Also:

Constant Field Values

CFG_SERVER_IP

public static final java.lang.String CFG_SERVER_IP

See Also:

Constant Field Values

SESSION_ID

public static final java.lang.String SESSION_ID

See Also:

Constant Field Values

SESSION_TYPE

public static final java.lang.String SESSION_TYPE

See Also:

Constant Field Values

SESSION_KEY_DELIM

public static final java.lang.String SESSION_KEY_DELIM

See Also:

Constant Field Values

SESSION_VAL_DELIM

public static final java.lang.String SESSION_VAL_DELIM

See Also:

Constant Field Values

Method Detail

get_webgateProfile

public java.lang.String get_webgateProfile()

Returns:

the m_webgateProfile

set_webgateProfile

public void set_webgateProfile(java.lang.String profile)

Parameters:

profile - the m_webgateProfile to set

isInitialized

public boolean isInitialized()

Checks if LocalAccessClient is initialized or not.

Returns:

Boolean true if LocalAccessClient is initialized

createInstance

public static LocalAccessClient createInstance(java.lang.String webgateProfile,
                                               java.lang.String loggerName,
                                               LocalAccessClient.CompatibilityMode mode)
                                        throws AccessException

Creates a new instance of LocalAccessClient. This instance is created using the configuration specified by bootstrapConfig.

Parameters:

webgateProfile - Webgate profile id.

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.

Returns:

A reference to a new object of LocalAccessClient.

Throws:

AccessException - In case if bootstrapConfig is null or provided bootstrapConfig is incomplete

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.

getClient

protected ObAAAServiceClient getClient()
                                throws AccessException

Throws:

AccessException

getConfig

protected oracle.security.am.asdk.impl.Configuration getConfig()
                                                        throws AccessException

Throws:

AccessException

updateLastAccessTime

protected void updateLastAccessTime()

getDefaultInstance

public static LocalAccessClient 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.

getObClient

protected ObAAAServiceClient getObClient()
                                  throws AccessException

Throws:

AccessException

getLogger

protected java.util.logging.Logger getLogger()

Returns logger instance

getCacheManager

protected oracle.security.am.asdk.impl.AccessCacheManagerImpl getCacheManager()
                                                                       throws AccessException

Returns cache manager instance

Throws:

AccessException

getMasterToken

public java.lang.String getMasterToken(java.lang.String sessionId,
                                       java.lang.String deviceFingerPrintId)

getUserToken

public java.lang.String getUserToken(java.lang.String oamMasterToken,
                                     java.lang.String agentId)

getUserToken

public java.lang.String getUserToken(java.lang.String sessionId,
                                     java.lang.String oamMasterToken,
                                     java.lang.String agentId)

getSessionIdFormat

public static java.lang.String getSessionIdFormat(java.lang.String sessionId)