Save This Page
Home » axis2-1.5-src » org.apache » axis2 » engine » [javadoc | source]
org.apache.axis2.engine
public class: AxisConfiguration [javadoc | source]
java.lang.Object
   org.apache.axis2.description.AxisDescription
      org.apache.axis2.engine.AxisConfiguration

All Implemented Interfaces:
    ParameterInclude, DescriptionConstants

Class AxisConfiguration
Field Summary
protected  PhasesInfo phasesinfo     
Fields inherited from org.apache.axis2.description.AxisDescription:
parent,  engagedModules,  parameterObservers,  NULL_MODULES
Constructor:
 public AxisConfiguration() 
Method from org.apache.axis2.engine.AxisConfiguration Summary:
addDataLocator,   addDataLocatorClassNames,   addDefaultModuleVersion,   addGlobalModuleRef,   addLocalPolicyAssertion,   addMessageBuilder,   addMessageFormatter,   addMessageReceiver,   addModule,   addModuleConfig,   addObservers,   addService,   addServiceGroup,   addTargetResolver,   addToAllServicesMap,   addTransportIn,   addTransportOut,   cleanup,   deployModule,   engageGlobalModules,   engageModule,   engageModule,   engageModule,   getClusterManager,   getConfigurator,   getDataLocator,   getDataLocatorClassName,   getDefaultModule,   getDefaultModuleVersion,   getFaultyModules,   getFaultyServices,   getGlobalModules,   getInFaultFlowPhases,   getInFlowPhases,   getKey,   getLocalPolicyAssertions,   getMessageBuilder,   getMessageBuilder,   getMessageFormatter,   getMessageReceiver,   getModule,   getModule,   getModuleClassLoader,   getModuleConfig,   getModules,   getModulesForPolicyNamesapce,   getObserversList,   getOutFaultFlowPhases,   getOutFlowPhases,   getPhasesInfo,   getRepository,   getService,   getServiceClassLoader,   getServiceForActivation,   getServiceGroup,   getServiceGroups,   getServices,   getSystemClassLoader,   getTargetResolverChain,   getTransactionConfiguration,   getTransportIn,   getTransportOut,   getTransportsIn,   getTransportsOut,   insertPhase,   isAssertionLocal,   isEngaged,   isEngaged,   isEngaged,   isStart,   notifyObservers,   notifyObservers,   notifyObservers,   onDisengage,   onEngage,   registerLocalPolicyAssertions,   registerModulePolicySupport,   removeFaultyService,   removeLocalPolicyAssertion,   removeModule,   removeModule,   removeService,   removeServiceGroup,   setClusterManager,   setConfigurator,   setGlobalOutPhase,   setInFaultPhases,   setInPhasesUptoAndIncludingPostDispatch,   setModuleClassLoader,   setOutFaultPhases,   setPhasesInfo,   setRepository,   setServiceClassLoader,   setStart,   setSystemClassLoader,   setTransactionConfig,   startService,   stopService,   validateSystemPredefinedPhases
Methods from org.apache.axis2.description.AxisDescription:
addChild,   addChild,   addParameter,   addParameter,   addParameterObserver,   applyPolicy,   applyPolicy,   deserializeParameters,   disengageModule,   engageModule,   engageModule,   getAxisConfiguration,   getChild,   getChildren,   getDocumentation,   getDocumentationNode,   getEngagedModules,   getKey,   getParameter,   getParameterValue,   getParameters,   getParent,   getPolicyInclude,   getPolicySubject,   isEngaged,   isEngaged,   isParameterLocked,   isParameterTrue,   onDisengage,   onEngage,   removeChild,   removeParameter,   removeParameterObserver,   setDocumentation,   setDocumentation,   setParent,   setPolicyInclude
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.axis2.engine.AxisConfiguration Detail:
 public  void addDataLocator(String dialect,
    AxisDataLocator dataLocator) 
    For internal used only! To store instance of DataLocator when it is first loaded. This allows to reuse of the DataLocator after it is initially loaded.
 public  void addDataLocatorClassNames(String dialect,
    String classname) 
    Allows to define/configure Data Locator for specified dialect at Axis 2 Configuration.
 public  void addDefaultModuleVersion(String moduleName,
    String moduleVersion) 
    Adds a default module version, which can be done either programmatically 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, the default version is engaged.
 public  void addGlobalModuleRef(String moduleName) 
    Add an AxisModule to the list of globally deployed modules.

    TODO: should this check for duplicate names?

 public  void addLocalPolicyAssertion(QName name) 
 public  void addMessageBuilder(String contentType,
    Builder messageBuilder) 
    Register a messageBuilder implementation against a content type. This is used by Axis2 to support different message formats.
 public  void addMessageFormatter(String contentType,
    MessageFormatter messageFormatter) 
    Register a messageFormatter implementation against a content type. This is used by Axis2 to support serialization of messages to different message formats. (Eg: JSON)
 public  void addMessageReceiver(String mepURL,
    MessageReceiver messageReceiver) 
 public  void addModule(AxisModule module) throws AxisFault 
    Add an available Module to this configuration
 public  void addModuleConfig(ModuleConfiguration moduleConfiguration) 
    Adds module configuration, if there is a moduleConfig tag in service.
 public  void addObservers(AxisObserver axisObserver) 
 public synchronized  void addService(AxisService service) throws AxisFault 
    Method addService.
 public synchronized  void addServiceGroup(AxisServiceGroup axisServiceGroup) throws AxisFault 
 public  void addTargetResolver(TargetResolver tr) 
 public  void addToAllServicesMap(AxisService axisService) throws AxisFault 
 public  void addTransportIn(TransportInDescription transport) throws AxisFault 
    Method addTransportIn.
 public  void addTransportOut(TransportOutDescription transport) throws AxisFault 
    Method addTransportOut.
 public  void cleanup() 
 public  void deployModule(String moduleFileName) throws DeploymentException 
 public  void engageGlobalModules() throws AxisFault 
    Engage all the previously added global modules.
 public  void engageModule(QName moduleref) throws AxisFault 
Deprecated! Please - use the String version instead

    Engages the default module version corresponding to the given module name, or if the module name contains version number in it then it will engage the correct module. Both the below cases are valid : - 1. engageModule("addressing"); 2. engageModule("addressing-1.23");
 public  void engageModule(String 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");
 public  void engageModule(String moduleName,
    String versionID) throws AxisFault 
    Engages a module using given name and its version ID.
 public ClusterManager getClusterManager() 
 public AxisConfigurator getConfigurator() 
 public AxisDataLocator getDataLocator(String dialect) 
    Return DataLocator instance for specified dialect.
 public String getDataLocatorClassName(String dialect) 
    Return classname of DataLocator configured for specified dialect.
 public AxisModule getDefaultModule(String moduleName) 
 public String getDefaultModuleVersion(String moduleName) 
 public Hashtable getFaultyModules() 
 public Hashtable getFaultyServices() 
 public List getGlobalModules() 
Deprecated! please - use addGlobalModule()

    Get a list of the global modules
 public List getInFaultFlowPhases() 
 public List getInFlowPhases() 
 public Object getKey() 
 public List getLocalPolicyAssertions() 
 public Builder getMessageBuilder(String contentType) 
 public Builder getMessageBuilder(String contentType,
    boolean defaultBuilder) 
 public MessageFormatter getMessageFormatter(String contentType) 
 public MessageReceiver getMessageReceiver(String mepURL) 
 public AxisModule getModule(String name) 
    Method getModule. First it will check whether the given module is there in the hashMap, if so returns that and the name, which can be either with version string or without version string.

    If its not found and the name does not contain the version string in it then checks whether the default version of the module is available in the sytem for the given name, then returns that.

 public AxisModule getModule(String moduleName,
    String moduleVersion) 
    Return the module having name=moduleName & version=moduleVersion
 public ClassLoader getModuleClassLoader() 
    The class loader that becomes the parent of all the modules
 public ModuleConfiguration getModuleConfig(String moduleName) 
 public HashMap getModules() 
 public List getModulesForPolicyNamesapce(String namesapce) 
 public ArrayList getObserversList() 
 public List getOutFaultFlowPhases() 
 public List getOutFlowPhases() 
 public PhasesInfo getPhasesInfo() 
 public URL getRepository() 
 public AxisService getService(String name) throws AxisFault 
    Method getService.
 public ClassLoader getServiceClassLoader() 
 public AxisService getServiceForActivation(String serviceName) 
    Service can start and stop, once stopped it cannot be accessed, so we need a way to get the service even if service is not active.
 public AxisServiceGroup getServiceGroup(String serviceNameAndGroupString) 
 public Iterator getServiceGroups() 
 public HashMap getServices() 
 public ClassLoader getSystemClassLoader() 
 public TargetResolver getTargetResolverChain() 
    getTargetResolverChain returns an instance of TargetResolver which iterates over the registered TargetResolvers, calling each one in turn when resolveTarget is called.
 public TransactionConfiguration getTransactionConfiguration() 
 public TransportInDescription getTransportIn(String name) 
 public TransportOutDescription getTransportOut(String name) 
 public HashMap getTransportsIn() 
 public HashMap getTransportsOut() 
 public  void insertPhase(Deployable d,
    int flow) throws AxisFault 
    This method can be used to insert a phase at the runtime for a given location And the relative location can be specified by beforePhase and afterPhase. Parameters Either or both of them can be null , if both the parameters are null then the phase will be added some where in the global phase. If one of them are null then the phase will be added - If the beforePhase is null then the phase will be added after the afterPhase - If the after phase is null then the phase will be added before the beforePhase Type of the flow will be specified by the parameter flow. 1 - Inflow 2 - out flow 3 - fault in flow 4 - fault out flow
 public boolean isAssertionLocal(QName name) 
 public boolean isEngaged(QName qname) 
Deprecated! Use - #isEngaged(String)

    This method needs to remain for a few Axis2 releases to support legacy apps still using it.
 public boolean isEngaged(String moduleId) 
 public boolean isEngaged(AxisModule axisModule) 
 public boolean isStart() 
 public  void notifyObservers(int event_type,
    AxisService service) 
 public  void notifyObservers(int event_type,
    AxisModule moule) 
 public  void notifyObservers(int event_type,
    AxisServiceGroup serviceGroup) 
 public  void onDisengage(AxisModule module) throws AxisFault 
    To dis-engage a module from the system. This will remove all the handlers belonging to this module from all the handler chains.
 public  void onEngage(AxisModule module,
    AxisDescription engager) throws AxisFault 
 public  void registerLocalPolicyAssertions(AxisModule axisModule) 
 public  void registerModulePolicySupport(AxisModule axisModule) 
 public  void removeFaultyService(String key) 
 public  void removeLocalPolicyAssertion(QName name) 
 public  void removeModule(String module) 
Deprecated! Use - #removeModule(String,String)

    To remove a given module from the system
 public  void removeModule(String moduleName,
    String moduleVersion) 
    Remove a module with moduleName & moduleVersion
 public synchronized  void removeService(String name) throws AxisFault 
    Method removeService.
 public AxisServiceGroup removeServiceGroup(String serviceGroupName) throws AxisFault 
 public  void setClusterManager(ClusterManager clusterManager) 
 public  void setConfigurator(AxisConfigurator configurator) 
 public  void setGlobalOutPhase(List outPhases) 
 public  void setInFaultPhases(List list) 
 public  void setInPhasesUptoAndIncludingPostDispatch(List inPhasesUptoAndIncludingPostDispatch) 
 public  void setModuleClassLoader(ClassLoader classLoader) 
 public  void setOutFaultPhases(List list) 
 public  void setPhasesInfo(PhasesInfo phasesInfo) 
 public  void setRepository(URL axis2Repository) 
 public  void setServiceClassLoader(ClassLoader classLoader) 
 public  void setStart(boolean start) 
 public  void setSystemClassLoader(ClassLoader classLoader) 
 public  void setTransactionConfig(TransactionConfiguration transactionConfiguration) 
 public  void startService(String serviceName) throws AxisFault 
 public  void stopService(String serviceName) throws AxisFault 
 public  void validateSystemPredefinedPhases() throws DeploymentException 
    Checks whether the system pre-defined phases for all the flows, have been changed. If they have been changed, throws a DeploymentException.