|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.axis2.description.AxisDescription
org.apache.axis2.description.AxisService
Class AxisService
Field Summary |
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 | |
AxisService()
Constructor AxisService. |
|
AxisService(java.lang.String name)
Constructor AxisService. |
Method Summary | |
void |
addDataLocatorClassNames(java.lang.String dialect,
java.lang.String dataLocatorClassName)
Save data Locator configured at service level for this Axis Service |
void |
addEndpoint(java.lang.String key,
AxisEndpoint axisEndpoint)
|
void |
addExposedTransport(java.lang.String transport)
|
void |
addHttpLocationDispatcherString(java.lang.String string,
AxisOperation axisOperation)
Maps an constant string in the whttp:location to the given operation. |
void |
addMessageElementQNameToOperationMapping(javax.xml.namespace.QName messageElementQName,
AxisOperation operation)
Add an entry to the map between element QNames in WSDL messages and AxisOperations for this service. |
void |
addMessageReceiver(java.lang.String mepURI,
MessageReceiver messageReceiver)
|
void |
addModuleConfig(ModuleConfiguration moduleConfiguration)
Adds module configuration , if there is moduleConfig tag in service. |
void |
addModuleOperations(AxisModule module,
AxisConfiguration axisConfig)
Adds an operation to a service if a module is required to do so. |
void |
addModuleref(java.lang.String moduleref)
|
void |
addOperation(AxisOperation axisOperation)
Method addOperation. |
void |
addSchema(java.util.Collection schemas)
|
void |
addSchema(org.apache.ws.commons.schema.XmlSchema schema)
|
static AxisService |
createClientSideAxisService(javax.wsdl.Definition wsdlDefinition,
javax.xml.namespace.QName wsdlServiceName,
java.lang.String portName,
Options options)
|
static AxisService |
createClientSideAxisService(java.net.URL wsdlURL,
javax.xml.namespace.QName wsdlServiceName,
java.lang.String portName,
Options options)
To create a AxisService for a given WSDL and the created client is most suitable for client side invocation not for server side invocation. |
static AxisService |
createService(java.lang.String implClass,
AxisConfiguration axisConfig)
|
static AxisService |
createService(java.lang.String implClass,
AxisConfiguration axisConfig,
java.lang.Class messageReceiverClass)
To create an AxisService using given service impl class name first generate schema corresponding to the given java class , next for each methods AxisOperation will be created. |
static AxisService |
createService(java.lang.String implClass,
AxisConfiguration axisConfig,
java.lang.Class messageReceiverClass,
java.lang.String targetNameSpace,
java.lang.String schemaNameSpace)
To create a service for a given Java class with user defined schema and target namespaces. |
static AxisService |
createService(java.lang.String implClass,
AxisConfiguration axisConfiguration,
java.util.Map messageReceiverClassMap,
java.lang.String targetNamespace,
java.lang.String schemaNamespace)
|
static AxisService |
createService(java.lang.String implClass,
AxisConfiguration axisConfiguration,
java.util.Map messageReceiverClassMap,
java.lang.String targetNamespace,
java.lang.String schemaNamespace,
java.lang.ClassLoader loader)
messageReceiverClassMap will hold the MessageReceivers for given meps. |
void |
disengageModule(AxisModule module)
|
void |
engageModule(AxisModule axisModule,
AxisConfiguration axisConfig)
Engages a module. |
AxisConfiguration |
getAxisConfiguration()
|
java.lang.String |
getBindingName()
|
java.lang.ClassLoader |
getClassLoader()
Method getClassLoader. |
java.util.ArrayList |
getControlOperations()
Gets the control operation which are added by module like RM. |
java.lang.String |
getCustomSchemaNamePrefix()
|
java.lang.String |
getCustomSchemaNameSuffix()
|
Data[] |
getData(DataRetrievalRequest request,
MessageContext msgContext)
Find a data locator from the available data locators (both configured and default ones) to retrieve Metadata or data specified in the request. |
AxisEndpoint |
getEndpoint(java.lang.String key)
|
java.lang.String |
getEndpointName()
get the endpointName |
java.util.Map |
getEndpoints()
|
java.lang.String |
getEndpointURL()
|
java.util.Collection |
getEngagedModules()
Method getEngagedModules. |
java.lang.String[] |
getEPRs()
|
java.util.List |
getExposedTransports()
|
java.net.URL |
getFileName()
|
AxisDataLocator |
getGlobalDataLocator(java.lang.String dialect)
|
java.lang.Object |
getKey()
|
long |
getLastupdate()
|
MessageReceiver |
getMessageReceiver(java.lang.String mepURL)
|
ModuleConfiguration |
getModuleConfig(java.lang.String moduleName)
|
java.util.ArrayList |
getModules()
|
java.lang.String |
getName()
|
java.util.Map |
getNameSpacesMap()
|
ObjectSupplier |
getObjectSupplier()
|
AxisOperation |
getOperation(javax.xml.namespace.QName operationName)
Method getOperation. |
AxisOperation |
getOperationByAction(java.lang.String action)
Returns the AxisOperation which has been mapped to the given action. |
AxisOperation |
getOperationByMessageElementQName(javax.xml.namespace.QName messageElementQName)
Look up an AxisOperation for this service based off of an element QName from a WSDL message element. |
AxisOperation |
getOperationBySOAPAction(java.lang.String soapAction)
Returns the operation given a SOAP Action. |
java.util.Iterator |
getOperations()
Method getOperations. |
java.util.List |
getOperationsNameList()
|
java.util.Map |
getP2nMap()
|
java.lang.String |
getPortTypeName()
Deprecated. use AxisService#getEndpointName() instead. |
java.util.ArrayList |
getPublishedOperations()
Gets only the published operations. |
java.util.ArrayList |
getSchema()
|
org.apache.ws.commons.schema.XmlSchema |
getSchema(int index)
|
org.apache.ws.commons.schema.XmlSchemaElement |
getSchemaElement(javax.xml.namespace.QName elementQName)
|
java.util.Map |
getSchemaMappingTable()
|
java.lang.String |
getSchematargetNamespace()
|
java.lang.String |
getSchematargetNamespacePrefix()
|
java.lang.String |
getScope()
|
java.lang.String |
getServiceDescription()
Gets the description about the service which is specified in services.xml. |
ServiceLifeCycle |
getServiceLifeCycle()
|
java.lang.String |
getSoapNsUri()
get the SOAPVersion |
java.lang.String |
getTargetNamespace()
|
java.lang.String |
getTargetNamespacePrefix()
|
org.apache.ws.java2wsdl.utils.TypeTable |
getTypeTable()
|
java.lang.String |
getWSAddressingFlag()
|
boolean |
isActive()
|
boolean |
isClientSide()
|
boolean |
isCustomWsdl()
|
boolean |
isElementFormDefault()
|
boolean |
isEnableAllTransports()
|
boolean |
isEngaged(java.lang.String moduleName)
|
boolean |
isExposedTransport(java.lang.String transport)
|
boolean |
isModifyUserWSDLPortAddress()
By default the port address in user WSDLs is modified, set the following parameter to override this behaviour |
boolean |
isSchemaLocationsAdjusted()
|
boolean |
isUseDefaultChains()
|
boolean |
isUseUserWSDL()
User can set a parameter in services.xml saying he want to show the original wsdl that he put into META-INF once someone ask for ?wsdl so if you want to use your own wsdl then add following parameter into services.xml |
boolean |
isWsdlFound()
|
protected AxisDataLocator |
loadDataLocator(java.lang.String className)
|
void |
mapActionToOperation(java.lang.String action,
AxisOperation axisOperation)
Maps an action (a SOAPAction or WSA action) to the given operation. |
java.util.Map |
populateSchemaMappings()
runs the schema mappings if it has not been run previously it is best that this logic be in the axis service since one can call the axis service to populate the schema mappings |
void |
printSchema(java.io.OutputStream out)
|
void |
printWSDL(java.io.OutputStream out)
Print the WSDL with a default URL. |
void |
printWSDL(java.io.OutputStream out,
java.lang.String requestIP)
Deprecated. try to use the method which takes three arguments |
void |
printWSDL(java.io.OutputStream out,
java.lang.String requestIP,
java.lang.String servicePath)
|
void |
printWSDL2(java.io.OutputStream out)
|
void |
printWSDL2(java.io.OutputStream out,
java.lang.String requestIP,
java.lang.String servicePath)
|
void |
releaseSchemaList()
Release the list of schema objects. |
void |
removeExposedTransport(java.lang.String transport)
|
void |
removeOperation(javax.xml.namespace.QName opName)
|
void |
setActive(boolean active)
|
void |
setBindingName(java.lang.String bindingName)
|
void |
setClassLoader(java.lang.ClassLoader classLoader)
Method setClassLoader. |
void |
setClientSide(boolean clientSide)
|
void |
setCustomSchemaNamePrefix(java.lang.String customSchemaNamePrefix)
|
void |
setCustomSchemaNameSuffix(java.lang.String customSchemaNameSuffix)
|
void |
setCustomWsdl(boolean customWsdl)
|
void |
setElementFormDefault(boolean elementFormDefault)
|
void |
setEnableAllTransports(boolean enableAllTransports)
To eneble service to be expose in all the transport |
void |
setEndpointName(java.lang.String endpoint)
|
void |
setEndpointURL(java.lang.String endpointURL)
|
void |
setExposedTransports(java.util.List transports)
|
void |
setFileName(java.net.URL fileName)
|
void |
setLastupdate()
Sets the current time as last update time of the service. |
void |
setMessageElementQNameToOperationMap(java.util.Map messageElementQNameToOperationMap)
Set the map of WSDL message element QNames to AxisOperations for this service. |
void |
setName(java.lang.String name)
|
void |
setNameSpacesMap(org.apache.ws.commons.schema.utils.NamespaceMap nameSpacesMap)
|
void |
setObjectSupplier(ObjectSupplier objectSupplier)
|
void |
setOperationsNameList(java.util.List operationsNameList)
|
void |
setP2nMap(java.util.Map p2nMap)
|
void |
setPortTypeName(java.lang.String portTypeName)
Deprecated. use AxisService#setEndpointName() instead |
void |
setSchemaLocationsAdjusted(boolean schemaLocationsAdjusted)
|
void |
setSchemaMappingTable(java.util.Map schemaMappingTable)
|
void |
setSchematargetNamespace(java.lang.String schematargetNamespace)
|
void |
setSchematargetNamespacePrefix(java.lang.String schematargetNamespacePrefix)
|
void |
setScope(java.lang.String scope)
|
void |
setServiceDescription(java.lang.String serviceDescription)
Sets the description about the service which is specified in services.xml |
void |
setServiceLifeCycle(ServiceLifeCycle serviceLifeCycle)
|
void |
setSoapNsUri(java.lang.String soapNsUri)
|
void |
setTargetNamespace(java.lang.String targetNamespace)
|
void |
setTargetNamespacePrefix(java.lang.String targetNamespacePrefix)
|
void |
setTypeTable(org.apache.ws.java2wsdl.utils.TypeTable typeTable)
|
void |
setUseDefaultChains(boolean useDefaultChains)
|
void |
setWSAddressingFlag(java.lang.String ar)
|
void |
setWsdlFound(boolean wsdlFound)
|
Methods inherited from class org.apache.axis2.description.AxisDescription |
addChild, addChild, addParameter, applyPolicy, applyPolicy, deserializeParameters, 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 |
Constructor Detail |
public AxisService()
public AxisService(java.lang.String name)
Method Detail |
public AxisEndpoint getEndpoint(java.lang.String key)
public void addEndpoint(java.lang.String key, AxisEndpoint axisEndpoint)
public java.lang.String getWSAddressingFlag()
public void setWSAddressingFlag(java.lang.String ar)
public boolean isSchemaLocationsAdjusted()
public void setSchemaLocationsAdjusted(boolean schemaLocationsAdjusted)
public java.util.Map getSchemaMappingTable()
public void setSchemaMappingTable(java.util.Map schemaMappingTable)
public java.lang.String getCustomSchemaNamePrefix()
public void setCustomSchemaNamePrefix(java.lang.String customSchemaNamePrefix)
public java.lang.String getCustomSchemaNameSuffix()
public void setCustomSchemaNameSuffix(java.lang.String customSchemaNameSuffix)
public java.lang.String getPortTypeName()
public void setPortTypeName(java.lang.String portTypeName)
portTypeName
- public java.lang.String getBindingName()
public void setBindingName(java.lang.String bindingName)
public java.lang.String getSoapNsUri()
public void setSoapNsUri(java.lang.String soapNsUri)
public java.lang.String getEndpointName()
public void setEndpointName(java.lang.String endpoint)
public void addMessageReceiver(java.lang.String mepURI, MessageReceiver messageReceiver)
public MessageReceiver getMessageReceiver(java.lang.String mepURL)
public void addModuleConfig(ModuleConfiguration moduleConfiguration)
moduleConfiguration
- public void addModuleOperations(AxisModule module, AxisConfiguration axisConfig) throws AxisFault
module
-
AxisFault
public void addModuleref(java.lang.String moduleref)
public void addOperation(AxisOperation axisOperation)
axisOperation
- public void engageModule(AxisModule axisModule, AxisConfiguration axisConfig) throws AxisFault
engageModule
in class AxisDescription
axisModule
- axisConfig
-
AxisFault
public void mapActionToOperation(java.lang.String action, AxisOperation axisOperation)
action
- the action keyaxisOperation
- the operation to map topublic void addHttpLocationDispatcherString(java.lang.String string, AxisOperation axisOperation)
string
- the constant drawn from whttp:locationaxisOperation
- the operation to map topublic void printSchema(java.io.OutputStream out) throws AxisFault
AxisFault
public org.apache.ws.commons.schema.XmlSchema getSchema(int index)
public void releaseSchemaList()
In some environments, this can provide significant relief of memory consumption in the java heap, as long as the need for the schema list has completed.
public AxisConfiguration getAxisConfiguration()
getAxisConfiguration
in class AxisDescription
public void printWSDL(java.io.OutputStream out, java.lang.String requestIP, java.lang.String servicePath) throws AxisFault
out
- requestIP
- servicePath
-
AxisFault
public java.lang.String[] getEPRs() throws AxisFault
AxisFault
public void printWSDL(java.io.OutputStream out, java.lang.String requestIP) throws AxisFault
out
- requestIP
-
AxisFault
public void printWSDL(java.io.OutputStream out) throws AxisFault
out
-
AxisFault
public void printWSDL2(java.io.OutputStream out) throws AxisFault
AxisFault
public void printWSDL2(java.io.OutputStream out, java.lang.String requestIP, java.lang.String servicePath) throws AxisFault
AxisFault
public java.lang.String getServiceDescription()
public java.lang.ClassLoader getClassLoader()
public java.util.ArrayList getControlOperations()
public java.util.Collection getEngagedModules()
public java.net.URL getFileName()
public long getLastupdate()
public ModuleConfiguration getModuleConfig(java.lang.String moduleName)
public java.util.ArrayList getModules()
public java.lang.String getName()
public AxisOperation getOperation(javax.xml.namespace.QName operationName)
operationName
-
public AxisOperation getOperationByAction(java.lang.String action)
action
- the action key
public AxisOperation getOperationBySOAPAction(java.lang.String soapAction)
soapAction
- SOAP Action defined for the particular Operation
public java.util.Iterator getOperations()
public java.util.ArrayList getPublishedOperations()
public void setServiceDescription(java.lang.String serviceDescription)
serviceDescription
- public void setClassLoader(java.lang.ClassLoader classLoader)
classLoader
- public void setFileName(java.net.URL fileName)
public void setLastupdate()
public void setName(java.lang.String name)
public java.util.ArrayList getSchema()
public void addSchema(org.apache.ws.commons.schema.XmlSchema schema)
public void addSchema(java.util.Collection schemas)
public boolean isWsdlFound()
public void setWsdlFound(boolean wsdlFound)
public java.lang.String getScope()
public void setScope(java.lang.String scope)
scope
- - Available scopes :
Constants.SCOPE_APPLICATION
Constants.SCOPE_TRANSPORT_SESSION
Constants.SCOPE_SOAP_SESSION
Constants.SCOPE_REQUEST.equalspublic boolean isUseDefaultChains()
public void setUseDefaultChains(boolean useDefaultChains)
public java.lang.Object getKey()
getKey
in class AxisDescription
public boolean isActive()
public void setActive(boolean active)
public java.lang.String getSchematargetNamespace()
public void setSchematargetNamespace(java.lang.String schematargetNamespace)
public java.lang.String getSchematargetNamespacePrefix()
public void setSchematargetNamespacePrefix(java.lang.String schematargetNamespacePrefix)
public java.lang.String getTargetNamespace()
public void setTargetNamespace(java.lang.String targetNamespace)
public java.lang.String getTargetNamespacePrefix()
public void setTargetNamespacePrefix(java.lang.String targetNamespacePrefix)
public org.apache.ws.commons.schema.XmlSchemaElement getSchemaElement(javax.xml.namespace.QName elementQName)
public boolean isEnableAllTransports()
public void setEnableAllTransports(boolean enableAllTransports)
enableAllTransports
- public java.util.List getExposedTransports()
public void setExposedTransports(java.util.List transports)
public void addExposedTransport(java.lang.String transport)
public void removeExposedTransport(java.lang.String transport)
public boolean isExposedTransport(java.lang.String transport)
public void disengageModule(AxisModule module)
public boolean isEngaged(java.lang.String moduleName)
isEngaged
in class AxisDescription
public static AxisService createClientSideAxisService(java.net.URL wsdlURL, javax.xml.namespace.QName wsdlServiceName, java.lang.String portName, Options options) throws AxisFault
wsdlURL
- location of the WSDLwsdlServiceName
- name of the service to be invoke , if it is null then the first one will
be selected if there are more than oneportName
- name of the port , if there are more than one , if it is null then the
first one in the iterator will be selectedoptions
- Service client options, to set the target EPR
AxisFault
public static AxisService createClientSideAxisService(javax.wsdl.Definition wsdlDefinition, javax.xml.namespace.QName wsdlServiceName, java.lang.String portName, Options options) throws AxisFault
AxisFault
public static AxisService createService(java.lang.String implClass, AxisConfiguration axisConfig, java.lang.Class messageReceiverClass) throws AxisFault
implClass
- axisConfig
-
AxisFault
public static AxisService createService(java.lang.String implClass, AxisConfiguration axisConfiguration, java.util.Map messageReceiverClassMap, java.lang.String targetNamespace, java.lang.String schemaNamespace, java.lang.ClassLoader loader) throws AxisFault
implClass
- axisConfiguration
- messageReceiverClassMap
- targetNamespace
- schemaNamespace
-
AxisFault
public static AxisService createService(java.lang.String implClass, AxisConfiguration axisConfiguration, java.util.Map messageReceiverClassMap, java.lang.String targetNamespace, java.lang.String schemaNamespace) throws AxisFault
AxisFault
public static AxisService createService(java.lang.String implClass, AxisConfiguration axisConfig, java.lang.Class messageReceiverClass, java.lang.String targetNameSpace, java.lang.String schemaNameSpace) throws AxisFault
implClass
- : full name of the classaxisConfig
- : current AxisConfgiurationmessageReceiverClass
- : Message receiver that you want to usetargetNameSpace
- : Service namespaceschemaNameSpace
- : Schema namespace
AxisFault
public static AxisService createService(java.lang.String implClass, AxisConfiguration axisConfig) throws AxisFault
AxisFault
public void removeOperation(javax.xml.namespace.QName opName)
public java.util.Map getNameSpacesMap()
public void setNameSpacesMap(org.apache.ws.commons.schema.utils.NamespaceMap nameSpacesMap)
public java.util.Map populateSchemaMappings()
public boolean isClientSide()
public void setClientSide(boolean clientSide)
public boolean isElementFormDefault()
public void setElementFormDefault(boolean elementFormDefault)
public boolean isUseUserWSDL()
public boolean isModifyUserWSDLPortAddress()
public ServiceLifeCycle getServiceLifeCycle()
public void setServiceLifeCycle(ServiceLifeCycle serviceLifeCycle)
public java.util.Map getP2nMap()
public void setP2nMap(java.util.Map p2nMap)
public ObjectSupplier getObjectSupplier()
public void setObjectSupplier(ObjectSupplier objectSupplier)
public org.apache.ws.java2wsdl.utils.TypeTable getTypeTable()
public void setTypeTable(org.apache.ws.java2wsdl.utils.TypeTable typeTable)
public Data[] getData(DataRetrievalRequest request, MessageContext msgContext) throws AxisFault
request
- an DataRetrievalRequest
objectmsgContext
- message context
Data
object for the request.
AxisFault
public void addDataLocatorClassNames(java.lang.String dialect, java.lang.String dataLocatorClassName)
dataLocatorClassName
- - class name of the Data Locator configured to support data retrieval
for the specified dialect.public AxisDataLocator getGlobalDataLocator(java.lang.String dialect) throws AxisFault
AxisFault
protected AxisDataLocator loadDataLocator(java.lang.String className) throws AxisFault
AxisFault
public void setMessageElementQNameToOperationMap(java.util.Map messageElementQNameToOperationMap)
messageElementQNameToOperationMap
- The map from WSDL message
element QNames to
AxisOperations.public AxisOperation getOperationByMessageElementQName(javax.xml.namespace.QName messageElementQName)
messageElementQName
- The QName to search for.
setMessageElementQNameToOperationMap(Map)
public void addMessageElementQNameToOperationMapping(javax.xml.namespace.QName messageElementQName, AxisOperation operation)
messageElementQName
- The QName of the element on the input message
that maps to the given operation.operation
- The AxisOperation to be mapped to.setMessageElementQNameToOperationMap(Map)
public java.lang.String getEndpointURL()
public void setEndpointURL(java.lang.String endpointURL)
public java.util.Map getEndpoints()
public boolean isCustomWsdl()
public void setCustomWsdl(boolean customWsdl)
public java.util.List getOperationsNameList()
public void setOperationsNameList(java.util.List operationsNameList)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |