IBM WebSphere Application ServerTM
Release 8

com.ibm.wsspi.al
Class ALContext

java.lang.Object
  extended by com.ibm.wsspi.al.ALContext
All Implemented Interfaces:
com.ibm.ws.al.ralclient.RALClientConstants

public class ALContext
extends java.lang.Object
implements com.ibm.ws.al.ralclient.RALClientConstants

The AL Context provides the dynamic api of setting/adding/removing remote AL configuarations


Field Summary
static java.lang.String COPYRIGHT
           
 
Fields inherited from interface com.ibm.ws.al.ralclient.RALClientConstants
EXTADMINNAME, EXTAPPNAME, EXTDEPLOYMENTMANAGER, EXTSECURITY, EXTSERVER, RALSVRMBEANNAME, WCCM_ALCONFIGURATIONS_NAME, WCCM_ALCONFIGURATIONS_TYPE, WCCM_PROP_NAMEATTRIBUTE_NAME, WCCM_PROP_VALUEATTRIBUTE_NAME, WCCM_RALCONFIG_PROP_NAME, WCCM_RALCONFIG_PROP_TYPE, WCCM_RALSECURITY_NAME, WCCM_RALSECURITY_TYPE, WCCM_RALSERVER_ATTR_PASSWORD, WCCM_RALSERVER_ATTR_SECURITYENABLE, WCCM_RALSERVER_ATTR_USER, WCCM_ROOT_CONFIGOBJ_NAME
 
Constructor Summary
ALContext()
           
 
Method Summary
static void add(ALConfiguration config)
          add an instance of ALConfig to the current thread's ALContext.
static void cleanRALCache(ALConfiguration config)
          clean the corresponding ALConfiguration from the cache.
static void cleanRALCache(java.util.Collection<ALConfiguration> configs)
          clean the corresponding collections of ALConfiguration from the cache.The operation need to happen after setContext/ unset() pair
static void remove(ALConfiguration config)
          remove an instance of ALConfig from the current thread's ALContext.
static void setContext(ALConfiguration config)
          set AL context to an instance of ALConfig.
static void setContext(java.util.Collection<ALConfiguration> configs)
          set AL context to a list of ALConfig.
static void setContext(java.lang.String tempName, java.lang.String appName)
          This is a easy of use wrapper method.
static void unset()
          unset the current thread's AL context
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
See Also:
Constant Field Values
Constructor Detail

ALContext

public ALContext()
Method Detail

setContext

public static void setContext(ALConfiguration config)
                       throws InvalidConfigException
set AL context to an instance of ALConfig. When context is set to an ALConfig, the AL for the current thread is configured to use the ALConfig to locate artifact

Parameters:
config - an instance of ALConfig
Throws:
InvalidConfigException - this exception will be thrown if the configuration is invalid. For example, in RAL case, if a configuration does not have server information or application name, the configuration is incomplete, therefore is invalid.

setContext

public static void setContext(java.util.Collection<ALConfiguration> configs)
                       throws InvalidConfigException
set AL context to a list of ALConfig. When context is set to an ALConfig, the AL for the current thread is configured to use the ALConfig to locate artifact

Parameters:
configs - an config list of ALConfig
Throws:
InvalidConfigException - this exception will be thrown if the configuration is invalid. For example, in RAL case, if a configuration does not have server information or application name, the configuration is incomplete, therefore is invalid.

unset

public static void unset()
unset the current thread's AL context


cleanRALCache

public static void cleanRALCache(ALConfiguration config)
                          throws InvalidConfigException
clean the corresponding ALConfiguration from the cache. The operation need to happen after setContext/ unset() pair

Parameters:
config - the ALConfiguration
Throws:
InvalidConfigException

cleanRALCache

public static void cleanRALCache(java.util.Collection<ALConfiguration> configs)
                          throws InvalidConfigException
clean the corresponding collections of ALConfiguration from the cache.The operation need to happen after setContext/ unset() pair

Parameters:
configs - the collection of ALConfigurations
Throws:
InvalidConfigException

add

public static void add(ALConfiguration config)
                throws InvalidConfigException
add an instance of ALConfig to the current thread's ALContext.

Parameters:
config - an instance of ALConfig
Throws:
InvalidConfigException - this exception will be thrown if the configuration is invalid. For example, in RAL case, if a configuration does not have server information or application name, the configuration is incomplete, therefore is invalid

remove

public static void remove(ALConfiguration config)
remove an instance of ALConfig from the current thread's ALContext.

Parameters:
config - an instance of ALConfig that to be removed

setContext

public static void setContext(java.lang.String tempName,
                              java.lang.String appName)
                       throws InvalidConfigException
This is a easy of use wrapper method. What it does is, Step1: it will fetch a RAL template based on tempName. If a template does not exist, it will create a new template using default value. Step2: it will set application property using appName to the template created in step1. Step3: it will set the template to current AL context.

Parameters:
tempName - a template name
appName - a name of a remote application
Throws:
InvalidConfigException - invalid configuration

IBM WebSphere Application ServerTM
Release 8