Home » axis2-1.5-src » org.apache » axis2 » context » [javadoc | source]
org.apache.axis2.context
public class: ConfigurationContext [javadoc | source]
java.lang.Object
   org.apache.axis2.context.AbstractContext
      org.apache.axis2.context.ConfigurationContext

Axis2 states are held in two information models, called description hierarchy and context hierarchy. Description hierarchy hold deployment configuration and it's values does not change unless deployment configuration change occurs where Context hierarchy hold run time information. Both hierarchies consists four levels, Global, Service Group, Operation and Message. Please look at "Information Model" section of "Axis2 Architecture Guide" for more information.

Configuration Context hold Global level run-time information. This allows same configurations to be used by two Axis2 instances and most Axis2 wide configurations can changed by setting name value pairs of the configurationContext. This hold all OperationContexts, ServiceGroups, Sessions, and ListenerManager.
Field Summary
protected  List contextListeners     
Fields inherited from org.apache.axis2.context.AbstractContext:
COPY_PROPERTIES,  lastTouchedTime,  parent,  properties
Constructor:
 public ConfigurationContext(AxisConfiguration axisConfiguration) 
    Constructor
    Parameters:
    axisConfiguration - - AxisConfiguration for which to create a context
Method from org.apache.axis2.context.ConfigurationContext Summary:
addContextListener,   addServiceGroupContextIntoApplicationScopeTable,   addServiceGroupContextIntoSoapSessionTable,   cleanupContexts,   contextCreated,   contextRemoved,   createMessageContext,   createServiceGroupContext,   deployService,   fillServiceContextAndServiceGroupContext,   findOperationContext,   getAxisConfiguration,   getContextRoot,   getListenerManager,   getOperationContext,   getRealPath,   getRootContext,   getServiceContextPath,   getServiceGroupContext,   getServiceGroupContextFromSoapSessionTable,   getServiceGroupContextIDs,   getServiceGroupContextTimeoutInterval,   getServiceGroupContextTimoutInterval,   getServiceGroupContexts,   getServicePath,   getThreadPool,   initCluster,   isAnyOperationContextRegistered,   registerOperationContext,   registerOperationContext,   removeContextListener,   removeServiceGroupContext,   removeServiceGroupContext,   setAxisConfiguration,   setContextRoot,   setServicePath,   setThreadPool,   setTransportManager,   terminate,   unregisterOperationContext
Methods from org.apache.axis2.context.AbstractContext:
clearPropertyDifferences,   flush,   getLastTouchedTime,   getLocalProperty,   getParent,   getProperties,   getProperty,   getPropertyDifferences,   getPropertyNames,   getPropertyNonReplicable,   getRootContext,   isAncestor,   mergeProperties,   removeProperty,   removePropertyNonReplicable,   setLastTouchedTime,   setNonReplicableProperty,   setParent,   setProperties,   setProperty,   touch
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.axis2.context.ConfigurationContext Detail:
 public  void addContextListener(ContextListener contextListener) 
 public  void addServiceGroupContextIntoApplicationScopeTable(ServiceGroupContext serviceGroupContext) 
    Adds the given ServiceGroupContext into the Application Scope table
 public  void addServiceGroupContextIntoSoapSessionTable(ServiceGroupContext serviceGroupContext) 
    Adds the given ServiceGroupContext into the SOAP session table
 public  void cleanupContexts() 
    Called during shutdown to clean up all Contexts
  void contextCreated(AbstractContext context) 
    Inform any listeners of a new context being created
  void contextRemoved(AbstractContext context) 
    Inform any listeners of a context being removed
 public MessageContext createMessageContext() 
    Create a MessageContext, and notify any registered ContextListener.
 public ServiceGroupContext createServiceGroupContext(AxisServiceGroup serviceGroup) 
    Create a ServiceGroupContext for the specified service group, and notify any registered ContextListener.
 public  void deployService(AxisService service) throws AxisFault 
    Deploy a service to the embedded AxisConfiguration, and initialize it.
 public  void fillServiceContextAndServiceGroupContext(MessageContext messageContext) throws AxisFault 
    Searches for a ServiceGroupContext in the map with given id as the key.
    If(key != null && found)
    check for a service context for the intended service.
    if (!found)
    create one and hook up to ServiceGroupContext
    else
    create new ServiceGroupContext with the given key or if key is null with a new key
    create a new service context for the service
    
 public OperationContext findOperationContext(String operationName,
    String serviceName,
    String serviceGroupName) 
    Finds the OperationContext given the Operation name, Service Name, and ServiceGroupName
 public AxisConfiguration getAxisConfiguration() 
    Returns the AxisConfiguration
 public String getContextRoot() 
    Retrieves the ContextRoot
 public ListenerManager getListenerManager() 
    Retrieve the ListenerManager
 public OperationContext getOperationContext(String messageID) 
    Gets a OperationContext given a Message ID.
 public File getRealPath(String path) 
    Allows users to resolve the path relative to the root directory.
 public ConfigurationContext getRootContext() 
 public String getServiceContextPath() 
    Retrieves the ServiceContext path
 public ServiceGroupContext getServiceGroupContext(String serviceGroupCtxId) 
    Returns a ServiceGroupContext object associated with the specified ID from the internal table.
 public ServiceGroupContext getServiceGroupContextFromSoapSessionTable(String serviceGroupContextId,
    MessageContext msgContext) throws AxisFault 
    Retrieve the ServiceGroupContext from the SOAP session table
 public String[] getServiceGroupContextIDs() 
    Gets all service groups in the system.
 public long getServiceGroupContextTimeoutInterval() 
    This will be used to fetch the serviceGroupContextTimoutInterval from any place available.
 public long getServiceGroupContextTimoutInterval() 
Deprecated! MISSPELLING - - Please use getServiceGroupContextTimeoutInterval()

 public Hashtable getServiceGroupContexts() 
Deprecated! Use - #getServiceGroupContextIDs & #getServiceGroupContext(String)

 public String getServicePath() 
    Retrieves the ServicePath
 public ThreadFactory getThreadPool() 
    Returns the thread factory.
 public  void initCluster() throws AxisFault 
    Initializes the ClusterManager for this ConfigurationContext
 public boolean isAnyOperationContextRegistered() 
 public boolean registerOperationContext(String messageID,
    OperationContext operationContext) 
    Registers a OperationContext with a given message ID. If the given message id already has a registered operation context, no change is made and the method returns false.
 public boolean registerOperationContext(String messageID,
    OperationContext mepContext,
    boolean override) 
    Registers a OperationContext with a given message ID. If the given message id already has a registered operation context, no change is made unless the override flag is set.
 public  void removeContextListener(ContextListener contextListener) 
 public  void removeServiceGroupContext(String serviceGroupContextId) 
    Remove a ServiceGroupContext
 public  void removeServiceGroupContext(AxisServiceGroup serviceGroup) 
    Removes the given ServiceGroup from the ServiceGroup context
 public  void setAxisConfiguration(AxisConfiguration configuration) 
    Set the AxisConfiguration to the specified configuration
 public  void setContextRoot(String contextRoot) 
    Sets the context root to the given string
 public  void setServicePath(String servicePath) 
    Sets the ServicePath to the given string
 public  void setThreadPool(ThreadFactory pool) throws AxisFault 
    Sets the thread factory.
 public  void setTransportManager(ListenerManager listenerManager) 
    Set the TransportManager to the given ListenerManager
 public  void terminate() throws AxisFault 
    Invoked during shutdown to stop the ListenerManager and perform configuration cleanup
 public  void unregisterOperationContext(String messageID) 
    Unregisters the operation context associated with the given messageID