org.apache.axis2.engine
Class AxisConfiguration

java.lang.Object
  extended byorg.apache.axis2.description.AxisDescription
      extended byorg.apache.axis2.engine.AxisConfiguration
All Implemented Interfaces:
DescriptionConstants, ParameterInclude

public class AxisConfiguration
extends AxisDescription

Class AxisConfiguration


Field Summary
protected  PhasesInfo phasesinfo
           
 
Fields inherited from interface org.apache.axis2.description.DescriptionConstants
CLASSLOADER_KEY, CONTEXTPATH_KEY, EXECUTION_CHAIN_KEY, EXECUTION_FAULT_CHAIN_KEY, EXECUTION_OUT_CHAIN_KEY, IN_FAULTFLOW_KEY, INFLOW_KEY, MESSAGE_RECEIVER_KEY, MODULEREF_KEY, OPERATION_KEY, OUT_FAULTFLOW_KEY, OUTFLOW_KEY, PARAMETER_KEY, PHASES_KEY, SERVICE_CLASS_NAME, STYLE_KEY
 
Constructor Summary
AxisConfiguration()
          Constructor AxisConfigurationImpl.
 
Method Summary
 void addDefaultModuleVersion(String moduleName, String moduleVersion)
          Adds a dafault module version , which can be done either programatically or by using axis2.xml .
 void addLocalPolicyAssertion(QName name)
           
 void addMessageReceiver(String mepURL, MessageReceiver messageReceiver)
           
 void addModule(AxisModule module)
          Method addModule.
 void addModuleConfig(ModuleConfiguration moduleConfiguration)
          Adds module configuration, if there is moduleConfig tag in service.
 void addObservers(AxisObserver axisObserver)
           
 void addService(AxisService service)
          Method addService.
 void addServiceGroup(AxisServiceGroup axisServiceGroup)
           
 void addTargetResolver(TargetResolver tr)
           
 void addTransportIn(TransportInDescription transport)
          Method addTransportIn.
 void addTransportOut(TransportOutDescription transport)
          Method addTransportOut.
 void disengageModule(AxisModule module)
          To dis-engage module from the system, this will remove all the handlers belongs to this module from all the handler chains
 void engageModule(AxisModule axisModule, AxisConfiguration axisConfig)
          Engaging a module to different level
 void engageModule(QName moduleref)
          Engages the default module version corresponding to given module name , or if the module name contains version number in it then it will engage the correct module.
 void engageModule(String moduleName, String versionID)
          Engages a module using give name and its version ID.
 AxisModule getDefaultModule(String moduleName)
           
 String getDefaultModuleVersion(String moduleName)
           
 Collection getEngagedModules()
          Method getEngagedModules.
 Hashtable getFaultyModules()
           
 Hashtable getFaultyServices()
           
 ArrayList getGlobalInFlow()
           
 List getGlobalModules()
           
 ArrayList getGlobalOutPhases()
           
 ArrayList getInFaultFlow()
           
 Object getKey()
           
 List getLocalPolicyAssertions()
           
 MessageReceiver getMessageReceiver(String mepURL)
           
 AxisModule getModule(QName name)
          Method getModule.
 ClassLoader getModuleClassLoader()
           
 ModuleConfiguration getModuleConfig(QName moduleName)
           
 HashMap getModules()
           
 List getModulesForPolicyNamesapce(String namesapce)
           
 ArrayList getObserversList()
           
 ArrayList getOutFaultFlow()
           
 PhasesInfo getPhasesInfo()
           
 URL getRepository()
           
 AxisService getService(String name)
          Method getService.
 ClassLoader getServiceClassLoader()
           
 AxisService getServiceForActivation(String serviceName)
          Service can start and stop , if once stop we can not acess that , so we need a way to get the service even if service is not active
 AxisServiceGroup getServiceGroup(String serviceNameAndGroupString)
           
 Iterator getServiceGroups()
           
 HashMap getServices()
           
 ClassLoader getSystemClassLoader()
           
 TargetResolver getTargetResolverChain()
          getTargetResolverChain returns and instance of TargetResolver which iterates over the registered TargetResolvers, calling each one in turn when resolveTarget is called
 TransportInDescription getTransportIn(QName name)
           
 TransportOutDescription getTransportOut(QName name)
           
 HashMap getTransportsIn()
           
 HashMap getTransportsOut()
           
 boolean isAssertionLocal(QName name)
           
 boolean isEngaged(QName moduleName)
           
 boolean isManageTransportSession()
           
 boolean isStart()
           
 void notifyObservers(int event_type, AxisModule moule)
           
 void notifyObservers(int event_type, AxisService service)
           
 void notifyObservers(int event_type, AxisServiceGroup serviceGroup)
           
 void registerLocalPolicyAssertions(AxisModule axisModule)
           
 void registerModulePolicySupport(AxisModule axisModule)
           
 void removeFaultyService(String key)
           
 void removeLocalPolicyAssertion(QName name)
           
 void removeModule(QName module)
          To remove a given module from the system
 void removeService(String name)
          Method removeService.
 void removeServiceGroup(String serviceGroupName)
           
 void setGlobalOutPhase(ArrayList outPhases)
           
 void setInFaultPhases(ArrayList list)
           
 void setInPhasesUptoAndIncludingPostDispatch(ArrayList inPhasesUptoAndIncludingPostDispatch)
           
 void setManageTransportSession(boolean manageTransportSession)
           
 void setModuleClassLoader(ClassLoader classLoader)
           
 void setOutFaultPhases(ArrayList list)
           
 void setPhasesInfo(PhasesInfo phasesInfo)
           
 void setRepository(URL axis2Repository)
           
 void setServiceClassLoader(ClassLoader classLoader)
           
 void setStart(boolean start)
           
 void setSystemClassLoader(ClassLoader classLoader)
           
 void startService(String serviceName)
           
 void stopService(String serviceName)
           
 
Methods inherited from class org.apache.axis2.description.AxisDescription
addChild, addChild, addParameter, applyPolicy, applyPolicy, deserializeParameters, getAxisConfiguration, getChild, getChildren, getParameter, getParameters, getParameterValue, getParent, getPolicyInclude, isParameterLocked, removeChild, removeParameter, setParent, setPolicyInclude
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

phasesinfo

protected PhasesInfo phasesinfo
Constructor Detail

AxisConfiguration

public AxisConfiguration()
Constructor AxisConfigurationImpl.

Method Detail

addMessageReceiver

public void addMessageReceiver(String mepURL,
                               MessageReceiver messageReceiver)

addModule

public void addModule(AxisModule module)
               throws AxisFault
Method addModule.

Parameters:
module -
Throws:
AxisFault

removeModule

public void removeModule(QName module)
To remove a given module from the system

Parameters:
module -

addModuleConfig

public void addModuleConfig(ModuleConfiguration moduleConfiguration)
Adds module configuration, if there is moduleConfig tag in service.

Parameters:
moduleConfiguration -

addObservers

public void addObservers(AxisObserver axisObserver)

addService

public void addService(AxisService service)
                throws AxisFault
Method addService.

Parameters:
service -
Throws:
AxisFault

addServiceGroup

public void addServiceGroup(AxisServiceGroup axisServiceGroup)
                     throws AxisFault
Throws:
AxisFault

removeServiceGroup

public void removeServiceGroup(String serviceGroupName)
                        throws AxisFault
Throws:
AxisFault

addTransportIn

public void addTransportIn(TransportInDescription transport)
                    throws AxisFault
Method addTransportIn.

Parameters:
transport -
Throws:
AxisFault

addTransportOut

public void addTransportOut(TransportOutDescription transport)
                     throws AxisFault
Method addTransportOut.

Parameters:
transport -
Throws:
AxisFault

engageModule

public void engageModule(QName moduleref)
                  throws AxisFault
Engages the default module version corresponding to given module name , or if the module name contains version number in it then it will engage the correct module. Both of the below two cases are valid 1. engageModule("addressing"); 2. engageModule("addressing-1.23");

Parameters:
moduleref -
Throws:
AxisFault

engageModule

public void engageModule(String moduleName,
                         String versionID)
                  throws AxisFault
Engages a module using give name and its version ID.

Parameters:
moduleName -
versionID -
Throws:
AxisFault

engageModule

public void engageModule(AxisModule axisModule,
                         AxisConfiguration axisConfig)
                  throws AxisFault
Description copied from class: AxisDescription
Engaging a module to different level

Specified by:
engageModule in class AxisDescription
Parameters:
axisModule -
axisConfig -
Throws:
AxisFault

disengageModule

public void disengageModule(AxisModule module)
To dis-engage module from the system, this will remove all the handlers belongs to this module from all the handler chains

Parameters:
module -

notifyObservers

public void notifyObservers(int event_type,
                            AxisService service)

notifyObservers

public void notifyObservers(int event_type,
                            AxisModule moule)

notifyObservers

public void notifyObservers(int event_type,
                            AxisServiceGroup serviceGroup)

removeService

public void removeService(String name)
                   throws AxisFault
Method removeService.

Parameters:
name -
Throws:
AxisFault

getEngagedModules

public Collection getEngagedModules()
Method getEngagedModules.

Returns:
Collection

getGlobalModules

public List getGlobalModules()

getFaultyModules

public Hashtable getFaultyModules()

getFaultyServices

public Hashtable getFaultyServices()

removeFaultyService

public void removeFaultyService(String key)

getGlobalOutPhases

public ArrayList getGlobalOutPhases()

getInFaultFlow

public ArrayList getInFaultFlow()
Returns:
Returns ArrayList.

getGlobalInFlow

public ArrayList getGlobalInFlow()

getMessageReceiver

public MessageReceiver getMessageReceiver(String mepURL)

getModule

public AxisModule getModule(QName name)
Method getModule. first it will check whether the given module is there in the hashMap , if so just return that and the name can be either with version string or without vresion string

if it not found and , the nane does not have version string in it then try to check whether default vresion of module available in the sytem for the give name , if so return that

Parameters:
name -
Returns:
Returns ModuleDescription.

getModuleClassLoader

public ClassLoader getModuleClassLoader()

getModuleConfig

public ModuleConfiguration getModuleConfig(QName moduleName)

getModules

public HashMap getModules()
Returns:
Returns HashMap.

getOutFaultFlow

public ArrayList getOutFaultFlow()
Returns:
Returns ArrayList.

getPhasesInfo

public PhasesInfo getPhasesInfo()

getRepository

public URL getRepository()

getService

public AxisService getService(String name)
                       throws AxisFault
Method getService.

Parameters:
name -
Returns:
Returns AxisService.
Throws:
AxisFault

getServiceForActivation

public AxisService getServiceForActivation(String serviceName)
Service can start and stop , if once stop we can not acess that , so we need a way to get the service even if service is not active

Returns:
AxisService

getServiceClassLoader

public ClassLoader getServiceClassLoader()

getServiceGroup

public AxisServiceGroup getServiceGroup(String serviceNameAndGroupString)

getServiceGroups

public Iterator getServiceGroups()

getServices

public HashMap getServices()

getSystemClassLoader

public ClassLoader getSystemClassLoader()

getTransportIn

public TransportInDescription getTransportIn(QName name)
                                      throws AxisFault
Throws:
AxisFault

getTransportOut

public TransportOutDescription getTransportOut(QName name)
                                        throws AxisFault
Throws:
AxisFault

getTransportsIn

public HashMap getTransportsIn()

getTransportsOut

public HashMap getTransportsOut()

isEngaged

public boolean isEngaged(QName moduleName)
Specified by:
isEngaged in class AxisDescription

setGlobalOutPhase

public void setGlobalOutPhase(ArrayList outPhases)

setInFaultPhases

public void setInFaultPhases(ArrayList list)
Parameters:
list -

setInPhasesUptoAndIncludingPostDispatch

public void setInPhasesUptoAndIncludingPostDispatch(ArrayList inPhasesUptoAndIncludingPostDispatch)

setModuleClassLoader

public void setModuleClassLoader(ClassLoader classLoader)

setOutFaultPhases

public void setOutFaultPhases(ArrayList list)
Parameters:
list -

setPhasesInfo

public void setPhasesInfo(PhasesInfo phasesInfo)

setRepository

public void setRepository(URL axis2Repository)

setServiceClassLoader

public void setServiceClassLoader(ClassLoader classLoader)

setSystemClassLoader

public void setSystemClassLoader(ClassLoader classLoader)

addDefaultModuleVersion

public void addDefaultModuleVersion(String moduleName,
                                    String moduleVersion)
Adds a dafault module version , which can be done either programatically or by using axis2.xml . The default module version is important if user asks to engage a module without given version ID, in which case, we will engage the default version.

Parameters:
moduleName -
moduleVersion -

getDefaultModuleVersion

public String getDefaultModuleVersion(String moduleName)

getDefaultModule

public AxisModule getDefaultModule(String moduleName)

getKey

public Object getKey()
Specified by:
getKey in class AxisDescription

stopService

public void stopService(String serviceName)
                 throws AxisFault
Throws:
AxisFault

startService

public void startService(String serviceName)
                  throws AxisFault
Throws:
AxisFault

isManageTransportSession

public boolean isManageTransportSession()

setManageTransportSession

public void setManageTransportSession(boolean manageTransportSession)

getModulesForPolicyNamesapce

public List getModulesForPolicyNamesapce(String namesapce)

registerModulePolicySupport

public void registerModulePolicySupport(AxisModule axisModule)

registerLocalPolicyAssertions

public void registerLocalPolicyAssertions(AxisModule axisModule)

getObserversList

public ArrayList getObserversList()

isStart

public boolean isStart()

setStart

public void setStart(boolean start)

getTargetResolverChain

public TargetResolver getTargetResolverChain()
getTargetResolverChain returns and instance of TargetResolver which iterates over the registered TargetResolvers, calling each one in turn when resolveTarget is called


addTargetResolver

public void addTargetResolver(TargetResolver tr)

addLocalPolicyAssertion

public void addLocalPolicyAssertion(QName name)

getLocalPolicyAssertions

public List getLocalPolicyAssertions()

removeLocalPolicyAssertion

public void removeLocalPolicyAssertion(QName name)

isAssertionLocal

public boolean isAssertionLocal(QName name)