com.wles.blm
Class BLMManager

java.lang.Object
  com.wles.blm.BLMManager

All Implemented Interfaces:

java.lang.Cloneable

public class BLMManager

extends java.lang.Object

implements java.lang.Cloneable

Manages access to the BLM server. This is the starting point for accessing all BLM functionality.

Field Summary

static java.lang.String	CREDENTIALS_DIRECTORY Authentication credentials identifier for specifying the user's directory.
static java.lang.String	CREDENTIALS_PASSWORD Authentication credentials identifier for specifying the user's password.
static java.lang.String	CREDENTIALS_USERNAME Authentication credentials identifier for specifying the user's name.
static java.lang.String	TOKEN_NAME Identity Assertion identifier for specifying the name of the token.
static java.lang.String	TOKEN_VALUE Identity Assertion identifier for specifying the value of the token.

Constructor Summary

BLMManager(java.net.URL blmURL)
Create a new BLM connection.

Method Summary

BLMContextManager	createContext(java.util.Hashtable credentials) Creates BLMContextManager (BLM session) based on the supplied credentials.
BLMContextManager	createContext(java.util.Hashtable credentials, java.util.Hashtable appCtx) Creates BLMContextManager (BLM session) based on the supplied credentials and application context.
java.net.URL	getURL() Gets the URL used to connect to this BLMManager.

Methods inherited from class java.lang.Object

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

Field Detail

CREDENTIALS_DIRECTORY

public static final java.lang.String CREDENTIALS_DIRECTORY

Authentication credentials identifier for specifying the user's directory. Specification of directory is optional, and if ommited will be determined by BLM configuration. If specified the value must be supplied a String containing an unqualified directory name. i.e. people rather then //dir/people.

See Also:

Constant Field Values

CREDENTIALS_PASSWORD

public static final java.lang.String CREDENTIALS_PASSWORD

Authentication credentials identifier for specifying the user's password. The password value must be supplied as a character array char[].

See Also:

Constant Field Values

CREDENTIALS_USERNAME

public static final java.lang.String CREDENTIALS_USERNAME

Authentication credentials identifier for specifying the user's name. The value must be a String containing an unqualified user name. i.e. Bob rather then //user/dirName/Bob/.

See Also:

Constant Field Values

TOKEN_NAME

public static final java.lang.String TOKEN_NAME

Identity Assertion identifier for specifying the name of the token.

See Also:

Constant Field Values

TOKEN_VALUE

public static final java.lang.String TOKEN_VALUE

Identity Assertion identifier for specifying the value of the token.

See Also:

Constant Field Values

Constructor Detail

BLMManager

public BLMManager(java.net.URL blmURL)
           throws BadParameterException,
                  ServiceNotFoundException

Create a new BLM connection. The URL for the BLM is typically two port numbers higher then that of the ALES admin console i.e. if the admin is accessable from https://localhost:7010 then the BLM will reside at https://localhost:7012

Parameters:

blmURL - the URL of the BLM SOAP service

Method Detail

createContext

public BLMContextManager createContext(java.util.Hashtable credentials)
                                throws com.wles.blm.BLMDBException,
                                       com.wles.blm.BLMBadParameterException,
                                       com.wles.blm.BLMRuntimeException,
                                       com.wles.blm.BLMServiceBusyException

Creates BLMContextManager (BLM session) based on the supplied credentials. Supported credential types include CREDENTIALS_USERNAME, CREDENTIALS_DIRECTORY, CREDENTIALS_PASSWORD. Note these are not string literals, but rather static members of this class, i.e. BLMManager.CREDENTIALS_USERNAME not "CREDENTIALS_USERNAME" See the description of each credentials type of more information regarding credential formats. You must call BLMContextManager.destroyContext to terminate the session when finished.

Parameters:

credentials - Hashtable with authentication credentials.

Returns:

BLMContextManager representing the authenticated user's BLM session.

Throws:

com.wles.blm.BLMDBException

com.wles.blm.BLMBadParameterException

com.wles.blm.BLMRuntimeException

com.wles.blm.BLMServiceBusyException

See Also:

BLMContextManager.destroyContext(), CREDENTIALS_USERNAME, CREDENTIALS_DIRECTORY, CREDENTIALS_PASSWORD

createContext

public BLMContextManager createContext(java.util.Hashtable credentials,
                                       java.util.Hashtable appCtx)
                                throws com.wles.blm.BLMDBException,
                                       com.wles.blm.BLMBadParameterException,
                                       com.wles.blm.BLMRuntimeException,
                                       com.wles.blm.BLMServiceBusyException

Creates BLMContextManager (BLM session) based on the supplied credentials and application context. Supported credential types include CREDENTIALS_USERNAME, CREDENTIALS_DIRECTORY, CREDENTIALS_PASSWORD. Note these are not string literals, but rather static members of this class, i.e. BLMManager.CREDENTIALS_USERNAME not "CREDENTIALS_USERNAME" See the description of each credentials type of more information regarding credential formats. You must call BLMContextManager.destroyContext to terminate the session when finished.

Parameters:

credentials - Hashtable with authentication credentials.

appCtx - Hashtable of name=value pairs to be passed to auditing messages.

Returns:

BLMContextManager representing the authenticated user's BLM session.

Throws:

com.wles.blm.BLMDBException

com.wles.blm.BLMBadParameterException

com.wles.blm.BLMRuntimeException

com.wles.blm.BLMServiceBusyException

See Also:

BLMContextManager.destroyContext(), CREDENTIALS_USERNAME, CREDENTIALS_DIRECTORY, CREDENTIALS_PASSWORD

getURL

public java.net.URL getURL()

Gets the URL used to connect to this BLMManager.