public class AxisConfiguration extends AxisDescription
Modifier and Type | Field and Description |
---|---|
protected PhasesInfo |
phasesinfo |
engagedModules, parameterObservers, parent
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 and Description |
---|
AxisConfiguration()
Constructor AxisConfiguration.
|
Modifier and Type | Method and Description |
---|---|
void |
addDataLocator(String dialect,
AxisDataLocator dataLocator)
For internal used only! To store instance of DataLocator when it is first loaded.
|
void |
addDataLocatorClassNames(String dialect,
String classname)
Allows to define/configure Data Locator for specified dialect at Axis 2 Configuration.
|
void |
addDefaultModuleVersion(String moduleName,
String moduleVersion)
Adds a default module version, which can be done either programmatically
or by using axis2.xml.
|
void |
addFaultyServiceDuetoModule(String moduleName,
FaultyServiceData faultyServiceData)
Updates the map that keeps track of faulty services due to modules
|
void |
addGlobalModuleRef(String moduleName)
Add an AxisModule to the list of globally deployed modules.
|
void |
addLocalPolicyAssertion(QName name) |
void |
addMessageBuilder(String contentType,
Builder messageBuilder)
Register a messageBuilder implementation against a content type.
|
void |
addMessageFormatter(String contentType,
MessageFormatter messageFormatter)
Register a messageFormatter implementation against a content type.
|
void |
addMessageReceiver(String mepURL,
MessageReceiver messageReceiver) |
void |
addModule(AxisModule module)
Add an available Module to this configuration
|
void |
addModuleConfig(ModuleConfiguration moduleConfiguration)
Adds module configuration, if there is a moduleConfig tag in service.
|
void |
addObservers(AxisObserver axisObserver)
Register given AxisObserver object to the
AxisConfiguration . |
void |
addService(AxisService service)
Add an AxisService to our global configuration.
|
void |
addServiceGroup(AxisServiceGroup axisServiceGroup) |
void |
addServiceToExistingServiceGroup(AxisService axisService,
String serviceGroupName)
This method is used to add a service to an existing active service group in the axis configuration
|
void |
addTargetResolver(TargetResolver tr) |
void |
addToAllServicesMap(AxisService axisService) |
void |
addTransportIn(TransportInDescription transport)
Add an incoming transport description (i.e.
|
void |
addTransportOut(TransportOutDescription transport)
Add an outgoing transport description (i.e.
|
void |
cleanup() |
void |
deployModule(String moduleFileName) |
void |
engageGlobalModules()
Engage all the previously added global modules.
|
void |
engageModule(String 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 given name and its version ID.
|
ClusteringAgent |
getClusteringAgent() |
AxisConfigurator |
getConfigurator() |
AxisDataLocator |
getDataLocator(String dialect)
Return DataLocator instance for specified dialect.
|
String |
getDataLocatorClassName(String dialect)
Return classname of DataLocator configured for specified dialect.
|
AxisModule |
getDefaultModule(String moduleName) |
String |
getDefaultModuleVersion(String moduleName) |
Hashtable<String,String> |
getFaultyModules() |
Hashtable<String,String> |
getFaultyServices() |
Map<String,FaultyServiceData> |
getFaultyServicesDuetoModule(String moduleName)
Returns a map which contains the faulty services due a particular module.
|
Map<String,Map<String,FaultyServiceData>> |
getFaultyServicesDuetoModules()
Returns the map which keeps track of faulty services due to modules.
|
List<Phase> |
getInFaultFlowPhases() |
List<Phase> |
getInFlowPhases() |
Object |
getKey() |
List<QName> |
getLocalPolicyAssertions() |
Builder |
getMessageBuilder(String contentType)
Get a Builder for a particular content type.
|
Builder |
getMessageBuilder(String contentType,
boolean defaultBuilder) |
MessageFormatter |
getMessageFormatter(String contentType)
Get a MessageFormatter for the specified content type.
|
MessageReceiver |
getMessageReceiver(String mepURL) |
AxisModule |
getModule(String name)
Get an AxisModule by name.
|
AxisModule |
getModule(String moduleName,
String moduleVersion)
Return the module having name=moduleName & version=moduleVersion
|
ClassLoader |
getModuleClassLoader()
Get the class loader that becomes the parent of all the modules
|
ModuleConfiguration |
getModuleConfig(String moduleName) |
HashMap<String,AxisModule> |
getModules() |
List<AxisModule> |
getModulesForPolicyNamesapce(String namesapce) |
ArrayList<AxisObserver> |
getObserversList()
This method returns read-only list of AxisObservers registered with this
AxisConfiguration . |
List<Phase> |
getOutFaultFlowPhases() |
List<Phase> |
getOutFlowPhases() |
PhasesInfo |
getPhasesInfo() |
URL |
getRepository() |
AxisService |
getService(String name)
Method getService.
|
ClassLoader |
getServiceClassLoader() |
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.
|
AxisServiceGroup |
getServiceGroup(String serviceNameAndGroupString) |
Iterator<AxisServiceGroup> |
getServiceGroups() |
HashMap<String,AxisService> |
getServices() |
ClassLoader |
getSystemClassLoader() |
TargetResolver |
getTargetResolverChain()
getTargetResolverChain returns an instance of
TargetResolver which iterates over the registered
TargetResolvers, calling each one in turn when
resolveTarget is called.
|
TransactionConfiguration |
getTransactionConfiguration() |
TransportInDescription |
getTransportIn(String name) |
TransportOutDescription |
getTransportOut(String name) |
HashMap<String,TransportInDescription> |
getTransportsIn() |
HashMap<String,TransportOutDescription> |
getTransportsOut() |
void |
insertPhase(Deployable d,
int flow)
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.
|
boolean |
isAssertionLocal(QName name) |
boolean |
isChildFirstClassLoading() |
boolean |
isEngaged(AxisModule axisModule) |
boolean |
isEngaged(String moduleId)
Check if a given module is engaged at this level.
|
boolean |
isGlobalModulesRegistered(String moduleName) |
boolean |
isStart() |
void |
notifyObservers(AxisEvent event,
AxisModule moule) |
void |
notifyObservers(AxisEvent event,
AxisService service) |
void |
notifyObservers(AxisEvent event,
AxisServiceGroup serviceGroup) |
void |
onDisengage(AxisModule module)
To dis-engage a module from the system.
|
void |
onEngage(AxisModule module,
AxisDescription engager) |
void |
registerLocalPolicyAssertions(AxisModule axisModule) |
void |
registerModulePolicySupport(AxisModule axisModule) |
void |
removeFaultyService(String key) |
void |
removeFaultyServiceDuetoModule(String moduleName,
String serviceGroupName)
Removes a faulty service for a given module from the internal map.
|
void |
removeLocalPolicyAssertion(QName name) |
void |
removeModule(String moduleName,
String moduleVersion)
Remove a module with moduleName & moduleVersion
|
void |
removeModule(String moduleName,
Version moduleVersion)
Remove a module with moduleName & moduleVersion
|
void |
removeObserver(AxisObserver axisObserver)
Unregister the given AxisObserver object if it is registered with
the
AxisConfiguration . |
void |
removeService(String name)
Remove a service.
|
AxisServiceGroup |
removeServiceGroup(String serviceGroupName) |
void |
setClusteringAgent(ClusteringAgent clusteringAgent) |
void |
setConfigurator(AxisConfigurator configurator) |
void |
setGlobalOutPhase(List<Phase> outPhases) |
void |
setInFaultPhases(List<Phase> list)
Set the inbound fault phases
TODO: Passing mutable lists like this and using them directly is bad practice.
|
void |
setInPhasesUptoAndIncludingPostDispatch(List<Phase> inPhasesUptoAndIncludingPostDispatch) |
void |
setModuleClassLoader(ClassLoader classLoader) |
void |
setOutFaultPhases(List<Phase> list)
Set the outbound fault phases
TODO: Passing mutable lists like this and using them directly is bad practice.
|
void |
setPhasesInfo(PhasesInfo phasesInfo) |
void |
setRepository(URL axis2Repository) |
void |
setServiceClassLoader(ClassLoader classLoader) |
void |
setStart(boolean start) |
void |
setSystemClassLoader(ClassLoader classLoader) |
void |
setTransactionConfig(TransactionConfiguration transactionConfiguration) |
void |
startService(String serviceName) |
void |
stopService(String serviceName) |
void |
validateSystemPredefinedPhases()
Checks whether the system pre-defined phases
for all the flows, have been changed.
|
addChild, addChild, addParameter, addParameter, addParameterObserver, applyPolicy, applyPolicy, deserializeParameters, disengageModule, engageModule, engageModule, getAxisConfiguration, getChild, getChildren, getDocumentation, getDocumentationNode, getEngagedModules, getParameter, getParameters, getParameterValue, getParent, getPolicyInclude, getPolicySubject, isParameterLocked, isParameterTrue, removeChild, removeParameter, removeParameterObserver, setDocumentation, setDocumentation, setParent, setPolicyInclude
protected PhasesInfo phasesinfo
public void addMessageReceiver(String mepURL, MessageReceiver messageReceiver)
public void addMessageBuilder(String contentType, Builder messageBuilder)
contentType
- the relevant content-type (i.e. "text/xml")messageBuilder
- a Builder implementationpublic void addMessageFormatter(String contentType, MessageFormatter messageFormatter)
contentType
- the relevant content-type (i.e. "text/xml")messageFormatter
- a MessageFormatter implementationpublic void addModule(AxisModule module) throws AxisFault
module
- an AxisModuleAxisFault
- in case of errorpublic void deployModule(String moduleFileName) throws DeploymentException
DeploymentException
public void removeModule(String moduleName, String moduleVersion)
moduleName
- the name of the module to removemoduleVersion
- the version of the module to removepublic void removeModule(String moduleName, Version moduleVersion)
moduleName
- the name of the module to removemoduleVersion
- the version of the module to removepublic void addModuleConfig(ModuleConfiguration moduleConfiguration)
moduleConfiguration
- a ModuleConfiguration to rememberpublic void addObservers(AxisObserver axisObserver)
AxisConfiguration
.axisObserver
- the axis observerpublic void removeObserver(AxisObserver axisObserver)
AxisConfiguration
.axisObserver
- the axis observerpublic void addService(AxisService service) throws AxisFault
service
- an AxisService to deploy.AxisFault
- if something goes wrong (invalid service, service is
already deployed, etc...)public void addServiceGroup(AxisServiceGroup axisServiceGroup) throws AxisFault
AxisFault
public void addServiceToExistingServiceGroup(AxisService axisService, String serviceGroupName) throws AxisFault
axisService
- service to be added to the existing service group providedserviceGroupName
- name of the service group which should be existing in the axis configurationAxisFault
- in case of an error in adding the service to the group specified or if the group is not existingpublic void addToAllServicesMap(AxisService axisService) throws AxisFault
AxisFault
public AxisServiceGroup removeServiceGroup(String serviceGroupName) throws AxisFault
AxisFault
public void addTransportIn(TransportInDescription transport) throws AxisFault
transport
- TransportInDescription to add.AxisFault
public void addTransportOut(TransportOutDescription transport) throws AxisFault
transport
- TransportOutDescription to add.AxisFault
public void engageModule(String moduleref) throws AxisFault
moduleref
- name of module to engageAxisFault
public void engageModule(String moduleName, String versionID) throws AxisFault
moduleName
- name of module to engageversionID
- version of module to engageAxisFault
public void onEngage(AxisModule module, AxisDescription engager) throws AxisFault
onEngage
in class AxisDescription
AxisFault
public void onDisengage(AxisModule module) throws AxisFault
onDisengage
in class AxisDescription
module
- module to disengageAxisFault
public void notifyObservers(AxisEvent event, AxisService service)
public void notifyObservers(AxisEvent event, AxisModule moule)
public void notifyObservers(AxisEvent event, AxisServiceGroup serviceGroup)
public void removeService(String name) throws AxisFault
name
- name of service to removeAxisFault
public void addGlobalModuleRef(String moduleName)
moduleName
- name of AxisModule to add to list.public void engageGlobalModules() throws AxisFault
AxisFault
- if an individual engageModule() failspublic void addFaultyServiceDuetoModule(String moduleName, FaultyServiceData faultyServiceData)
moduleName
- This service has become faulty due this module.faultyServiceData
- Data that are required when recovering the faulty service.public Map<String,FaultyServiceData> getFaultyServicesDuetoModule(String moduleName)
moduleName
- name of the module about which to inquirepublic Map<String,Map<String,FaultyServiceData>> getFaultyServicesDuetoModules()
public void removeFaultyServiceDuetoModule(String moduleName, String serviceGroupName)
moduleName
- name of the module to look upserviceGroupName
- name of the service group to removepublic void removeFaultyService(String key)
public MessageReceiver getMessageReceiver(String mepURL)
public Builder getMessageBuilder(String contentType)
contentType
- the desired content typepublic MessageFormatter getMessageFormatter(String contentType)
contentType
- content type to look uppublic AxisModule getModule(String name)
name
- module name to look uppublic AxisModule getModule(String moduleName, String moduleVersion)
moduleName
- The module namemoduleVersion
- The version of the modulepublic ClassLoader getModuleClassLoader()
public ModuleConfiguration getModuleConfig(String moduleName)
public HashMap<String,AxisModule> getModules()
public PhasesInfo getPhasesInfo()
public URL getRepository()
public AxisService getService(String name) throws AxisFault
name
- the name of the service to look upAxisFault
public AxisService getServiceForActivation(String serviceName)
serviceName
- name to look uppublic ClassLoader getServiceClassLoader()
public AxisServiceGroup getServiceGroup(String serviceNameAndGroupString)
public Iterator<AxisServiceGroup> getServiceGroups()
public HashMap<String,AxisService> getServices()
public ClassLoader getSystemClassLoader()
public TransportInDescription getTransportIn(String name)
public TransportOutDescription getTransportOut(String name)
public HashMap<String,TransportInDescription> getTransportsIn()
public HashMap<String,TransportOutDescription> getTransportsOut()
public boolean isEngaged(String moduleId)
AxisDescription
isEngaged
in class AxisDescription
moduleId
- module to investigate.public boolean isEngaged(AxisModule axisModule)
isEngaged
in class AxisDescription
public void setInFaultPhases(List<Phase> list)
list
- a List of Phases which will become our inbound fault flowpublic void setInPhasesUptoAndIncludingPostDispatch(List<Phase> inPhasesUptoAndIncludingPostDispatch)
public void setModuleClassLoader(ClassLoader classLoader)
public void setOutFaultPhases(List<Phase> list)
list
- a List of Phases which will become our outbound fault flowpublic void setPhasesInfo(PhasesInfo phasesInfo)
public void setRepository(URL axis2Repository)
public void setServiceClassLoader(ClassLoader classLoader)
public void setSystemClassLoader(ClassLoader classLoader)
public void addDefaultModuleVersion(String moduleName, String moduleVersion)
moduleName
- the name of the module for which we're setting the default versionmoduleVersion
- the default versionpublic AxisModule getDefaultModule(String moduleName)
public ClusteringAgent getClusteringAgent()
public void setClusteringAgent(ClusteringAgent clusteringAgent)
public TransactionConfiguration getTransactionConfiguration()
public void setTransactionConfig(TransactionConfiguration transactionConfiguration)
public Object getKey()
getKey
in class AxisDescription
public List<AxisModule> getModulesForPolicyNamesapce(String namesapce)
public void registerModulePolicySupport(AxisModule axisModule)
public void registerLocalPolicyAssertions(AxisModule axisModule)
public ArrayList<AxisObserver> getObserversList()
AxisConfiguration
.public boolean isStart()
public void setStart(boolean start)
public TargetResolver getTargetResolverChain()
public void addTargetResolver(TargetResolver tr)
public void addLocalPolicyAssertion(QName name)
public void removeLocalPolicyAssertion(QName name)
public boolean isAssertionLocal(QName name)
public void addDataLocatorClassNames(String dialect, String classname)
dialect-
- an absolute URI represents the format and version of dataclassname
- - class name of the Data Locator configured to support retrieval
for the specified dialect.public void addDataLocator(String dialect, AxisDataLocator dataLocator)
dialect-
- an absolute URI represents the format and version of datadataLocator
- - specified an DataLocator instance to support retrieval
of the specified dialect.public AxisDataLocator getDataLocator(String dialect)
dialect
- the dialect to look uppublic String getDataLocatorClassName(String dialect)
dialect
- the dialect to look uppublic void validateSystemPredefinedPhases() throws DeploymentException
DeploymentException
public AxisConfigurator getConfigurator()
public void setConfigurator(AxisConfigurator configurator)
public void cleanup()
public void insertPhase(Deployable d, int flow) throws AxisFault
d
- the Deployable representing the Phase to deployflow
- the type of the flowAxisFault
- : If something went wrongpublic boolean isChildFirstClassLoading()
public boolean isGlobalModulesRegistered(String moduleName)
Copyright © 2004–2019 The Apache Software Foundation. All rights reserved.