org.apache.axis2.description
Class AxisService

java.lang.Object
  org.apache.axis2.description.AxisService

All Implemented Interfaces:

org.apache.wsdl.Component, DescriptionConstants, FlowInclude, ParameterInclude, org.apache.wsdl.WSDLService

public class AxisService

extends java.lang.Object

implements org.apache.wsdl.WSDLService, ParameterInclude, FlowInclude, DescriptionConstants

Class AxisService

Field Summary

Fields inherited from interface org.apache.wsdl.WSDLService

STYLE_DOC, STYLE_MSG, STYLE_RPC

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, SERVICE_CLASS_NAME, STYLE_KEY

Constructor Summary

AxisService()

AxisService(javax.xml.namespace.QName qName)
Constructor AxisService

AxisService(org.apache.wsdl.impl.WSDLServiceImpl serviceimpl)
Constructor AxisService

Method Summary

void	addExtensibilityElement(org.apache.wsdl.WSDLExtensibilityElement element)
void	addExtensibleAttributes(org.apache.wsdl.WSDLExtensibilityAttribute attribute)
void	addMapping(java.lang.String mappingKey, AxisOperation axisOperation) To add the was action paramater into has map so that was action based dispatch can support
void	addModuleConfig(ModuleConfiguration moduleConfiguration) Adding module configuration , if there is moduleConfig tag in service
void	addModuleOperations(ModuleDescription module, AxisConfiguration axisConfig) To add a opeartion to a service if a module requird to do so
void	addModuleref(javax.xml.namespace.QName moduleref)
void	addOperation(AxisOperation axisOperation) Method addOperation
void	addParameter(Parameter param) Method addParameter
void	deserializeParameters(OMElement parameterElement)
void	engageModule(ModuleDescription moduleref, AxisConfiguration axisConfig) To ebgage a module it is reuired to use this method
java.lang.String	getAxisServiceName() To get the description about the service ty67tyuio
java.lang.ClassLoader	getClassLoader() Method getClassLoader
java.util.HashMap	getComponentProperties()
java.lang.Object	getComponentProperty(java.lang.Object key)
java.lang.String	getContextPath() Method getContextPath
java.util.ArrayList	getControlOperations() To get the control operation which are added by module like RM
org.apache.wsdl.WSDLEndpoint	getEndpoint(javax.xml.namespace.QName qName)
java.util.HashMap	getEndpoints()
java.util.Collection	getEngagedModules() Method getEngadgedModules
java.util.List	getExtensibilityAttributes()
java.util.List	getExtensibilityElements()
Flow	getFaultInFlow() Method getFaultInFlow
Flow	getFaultOutFlow()
java.lang.String	getFileName()
Flow	getInFlow() Method getInFlow
long	getLastupdate()
java.util.Map	getMetadataBag()
ModuleConfiguration	getModuleConfig(javax.xml.namespace.QName moduleName)
java.util.ArrayList	getModules()
javax.xml.namespace.QName	getName()
java.lang.String	getNamespace()
AxisOperation	getOperation(javax.xml.namespace.QName operationName) Method getOperation
AxisOperation	getOperation(java.lang.String ncName)
AxisOperation	getOperationBySOAPAction(java.lang.String soapAction) This method will return the operation given particular SOAP Action.
AxisOperation	getOperationBySOAPAction(java.lang.String soapAction, javax.xml.namespace.QName endpoint) This method will return the operation given the particular endpoing and the particular SOAP Action.
java.util.HashMap	getOperations() Method getOperations
Flow	getOutFlow() Method getOutFlow
Parameter	getParameter(java.lang.String name) Method getParameter
java.util.ArrayList	getParameters() To get all the parameters in a given description
AxisServiceGroup	getParent() To get the parent (which is AxisConfiguration in this case)
java.util.ArrayList	getPublishedOperations() To get only the publish operations
org.apache.wsdl.WSDLInterface	getServiceInterface()
java.lang.String	getStyle() Method getStyle
javax.wsdl.Definition	getWSDLDefinition()
org.apache.wsdl.WSDLOperation	getWSDLOPOperation(javax.xml.namespace.QName operationName) To get the WSDL opeartion element in servic einterface
boolean	isParameterLocked(java.lang.String paramterName) to check whether the parameter is locked at any level
void	printWSDL(java.io.Writer out, java.lang.String PortURL)
void	setAxisServiceName(java.lang.String axisServiceName) Set the description about the service
void	setClassLoader(java.lang.ClassLoader classLoader) Method setClassLoader
void	setComponentProperties(java.util.HashMap properties)
void	setComponentProperty(java.lang.Object key, java.lang.Object obj)
void	setContextPath(java.lang.String contextPath) Method setContextPath
void	setEndpoint(org.apache.wsdl.WSDLEndpoint endpoint)
void	setEndpoints(java.util.HashMap endpoints)
void	setFaultInFlow(Flow faultFlow) Method setFaultInFlow
void	setFaultOutFlow(Flow faultFlow) Method setFaultInFlow
void	setFileName(java.lang.String fileName)
void	setInFlow(Flow inFlow) Method setInFlow
void	setLastupdate() This method will set the current time as last update time of the service
void	setMetadataBag(java.util.Map map)
void	setName(javax.xml.namespace.QName name)
void	setOutFlow(Flow outFlow) Method setOutFlow
void	setParent(AxisServiceGroup parent)
void	setServiceInterface(org.apache.wsdl.WSDLInterface serviceInterface)
void	setStyle(java.lang.String style) Method setStyle
void	setWSDLDefinition(javax.wsdl.Definition difDefinition)
ServiceContext	u(MessageContext msgContext) This finds the ServiceContext provided that the incomming message that has have some serviceInstanceID.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AxisService

public AxisService(org.apache.wsdl.impl.WSDLServiceImpl serviceimpl)

Constructor AxisService

AxisService

public AxisService()

AxisService

public AxisService(javax.xml.namespace.QName qName)

Constructor AxisService

Parameters:

qName -

Method Detail

engageModule

public void engageModule(ModuleDescription moduleref,
                         AxisConfiguration axisConfig)
                  throws AxisFault

To ebgage a module it is reuired to use this method

Parameters:

moduleref -

Throws:

AxisFault

addModuleOperations

public void addModuleOperations(ModuleDescription module,
                                AxisConfiguration axisConfig)
                         throws AxisFault

To add a opeartion to a service if a module requird to do so

Parameters:

module -

Throws:

AxisFault

getEngagedModules

public java.util.Collection getEngagedModules()

Method getEngadgedModules

Returns:

Collection

getOperation

public AxisOperation getOperation(javax.xml.namespace.QName operationName)

Method getOperation

Parameters:

operationName -

Returns:

AxisOperation

getWSDLOPOperation

public org.apache.wsdl.WSDLOperation getWSDLOPOperation(javax.xml.namespace.QName operationName)

To get the WSDL opeartion element in servic einterface

Parameters:

operationName - QName

Returns:

WSDLOperation WSDLOperation

addOperation

public void addOperation(AxisOperation axisOperation)

Method addOperation

Parameters:

axisOperation -

setClassLoader

public void setClassLoader(java.lang.ClassLoader classLoader)

Method setClassLoader

Parameters:

classLoader -

getClassLoader

public java.lang.ClassLoader getClassLoader()

Method getClassLoader

Returns:

ClassLoader

setContextPath

public void setContextPath(java.lang.String contextPath)

Method setContextPath

Parameters:

contextPath -

getContextPath

public java.lang.String getContextPath()

Method getContextPath

Returns:

String

setStyle

public void setStyle(java.lang.String style)

Method setStyle

Parameters:

style -

getStyle

public java.lang.String getStyle()

Method getStyle

Returns:

String

addParameter

public void addParameter(Parameter param)
                  throws AxisFault

Method addParameter

Specified by:

addParameter in interface ParameterInclude

Parameters:

param -

Throws:

AxisFault

getParameter

public Parameter getParameter(java.lang.String name)

Method getParameter

Specified by:

getParameter in interface ParameterInclude

Parameters:

name -

Returns:

Parameter

getParameters

public java.util.ArrayList getParameters()

Description copied from interface: ParameterInclude

To get all the parameters in a given description

Specified by:

getParameters in interface ParameterInclude

Returns:

getInFlow

public Flow getInFlow()

Method getInFlow

Specified by:

getInFlow in interface FlowInclude

Returns:

Flow

setInFlow

public void setInFlow(Flow inFlow)

Method setInFlow

Specified by:

setInFlow in interface FlowInclude

Parameters:

inFlow -

getOutFlow

public Flow getOutFlow()

Method getOutFlow

Specified by:

getOutFlow in interface FlowInclude

Returns:

Flow

setOutFlow

public void setOutFlow(Flow outFlow)

Method setOutFlow

Specified by:

setOutFlow in interface FlowInclude

Parameters:

outFlow -

getFaultInFlow

public Flow getFaultInFlow()

Method getFaultInFlow

Specified by:

getFaultInFlow in interface FlowInclude

Returns:

Flow

setFaultInFlow

public void setFaultInFlow(Flow faultFlow)

Method setFaultInFlow

Specified by:

setFaultInFlow in interface FlowInclude

Parameters:

faultFlow -

getFaultOutFlow

public Flow getFaultOutFlow()

Specified by:

getFaultOutFlow in interface FlowInclude

setFaultOutFlow

public void setFaultOutFlow(Flow faultFlow)

Description copied from interface: FlowInclude

Method setFaultInFlow

Specified by:

setFaultOutFlow in interface FlowInclude

Parameters:

faultFlow -

getOperations

public java.util.HashMap getOperations()

Method getOperations

Returns:

HashMap

getPublishedOperations

public java.util.ArrayList getPublishedOperations()

To get only the publish operations

getControlOperations

public java.util.ArrayList getControlOperations()

To get the control operation which are added by module like RM

getOperation

public AxisOperation getOperation(java.lang.String ncName)

getOperationBySOAPAction

public AxisOperation getOperationBySOAPAction(java.lang.String soapAction)

This method will return the operation given particular SOAP Action. This method should only be called if there is only one Endpoint is defined for this Service. If more than one Endpoint exists one of them will be picked. If more than one Operation is found with the given SOAP Action; null will be ruturned. If no particular Operation is found with the given SOAP Action; null will be returned.

Parameters:

soapAction - SOAP Action defined for the particular Operation

Returns:

A AxisOperation if a unque Operation can be found with the given SOAP Action otherwise will return null.

getOperationBySOAPAction

public AxisOperation getOperationBySOAPAction(java.lang.String soapAction,
                                              javax.xml.namespace.QName endpoint)

This method will return the operation given the particular endpoing and the particular SOAP Action. If more than one Operation is found with the given SOAP Action; null will be ruturned. If no particular Operation is found with the given SOAP Action; null will be returned

Parameters:

endpoint - Particular Enpoint in which the bining is defined with the particular SOAP Action.

soapAction - SOAP Action defined for the particular Operation

Returns:

A AxisOperation if a unque Operation can be found with the given SOAP Action otherwise will return null.

u

public ServiceContext u(MessageContext msgContext)

This finds the ServiceContext provided that the incomming message that has have some serviceInstanceID. Currently this will not be added to the EngineContext's ServiceContextMap.

Parameters:

msgContext -

Returns:

ServiceContext

getAxisServiceName

public java.lang.String getAxisServiceName()

To get the description about the service ty67tyuio

Returns:

String

setAxisServiceName

public void setAxisServiceName(java.lang.String axisServiceName)

Set the description about the service

Parameters:

axisServiceName -

getWSDLDefinition

public javax.wsdl.Definition getWSDLDefinition()

setWSDLDefinition

public void setWSDLDefinition(javax.wsdl.Definition difDefinition)

printWSDL

public void printWSDL(java.io.Writer out,
                      java.lang.String PortURL)
               throws AxisFault

Throws:

AxisFault

setLastupdate

public void setLastupdate()

This method will set the current time as last update time of the service

getLastupdate

public long getLastupdate()

getFileName

public java.lang.String getFileName()

setFileName

public void setFileName(java.lang.String fileName)

getEndpoints

public java.util.HashMap getEndpoints()

Specified by:

getEndpoints in interface org.apache.wsdl.WSDLService

setEndpoints

public void setEndpoints(java.util.HashMap endpoints)

Specified by:

setEndpoints in interface org.apache.wsdl.WSDLService

setEndpoint

public void setEndpoint(org.apache.wsdl.WSDLEndpoint endpoint)

Specified by:

setEndpoint in interface org.apache.wsdl.WSDLService

getEndpoint

public org.apache.wsdl.WSDLEndpoint getEndpoint(javax.xml.namespace.QName qName)

Specified by:

getEndpoint in interface org.apache.wsdl.WSDLService

getName

public javax.xml.namespace.QName getName()

Specified by:

getName in interface org.apache.wsdl.WSDLService

setName

public void setName(javax.xml.namespace.QName name)

Specified by:

setName in interface org.apache.wsdl.WSDLService

getNamespace

public java.lang.String getNamespace()

Specified by:

getNamespace in interface org.apache.wsdl.WSDLService

getServiceInterface

public org.apache.wsdl.WSDLInterface getServiceInterface()

Specified by:

getServiceInterface in interface org.apache.wsdl.WSDLService

setServiceInterface

public void setServiceInterface(org.apache.wsdl.WSDLInterface serviceInterface)

Specified by:

setServiceInterface in interface org.apache.wsdl.WSDLService

getComponentProperties

public java.util.HashMap getComponentProperties()

Specified by:

getComponentProperties in interface org.apache.wsdl.Component

setComponentProperties

public void setComponentProperties(java.util.HashMap properties)

Specified by:

setComponentProperties in interface org.apache.wsdl.Component

setComponentProperty

public void setComponentProperty(java.lang.Object key,
                                 java.lang.Object obj)

Specified by:

setComponentProperty in interface org.apache.wsdl.Component

getComponentProperty

public java.lang.Object getComponentProperty(java.lang.Object key)

Specified by:

getComponentProperty in interface org.apache.wsdl.Component

addExtensibilityElement

public void addExtensibilityElement(org.apache.wsdl.WSDLExtensibilityElement element)

Specified by:

addExtensibilityElement in interface org.apache.wsdl.Component

getExtensibilityElements

public java.util.List getExtensibilityElements()

Specified by:

getExtensibilityElements in interface org.apache.wsdl.Component

getExtensibilityAttributes

public java.util.List getExtensibilityAttributes()

Specified by:

getExtensibilityAttributes in interface org.apache.wsdl.Component

addExtensibleAttributes

public void addExtensibleAttributes(org.apache.wsdl.WSDLExtensibilityAttribute attribute)

Specified by:

addExtensibleAttributes in interface org.apache.wsdl.Component

getMetadataBag

public java.util.Map getMetadataBag()

Specified by:

getMetadataBag in interface org.apache.wsdl.Component

setMetadataBag

public void setMetadataBag(java.util.Map map)

Specified by:

setMetadataBag in interface org.apache.wsdl.Component

addMapping

public void addMapping(java.lang.String mappingKey,
                       AxisOperation axisOperation)

To add the was action paramater into has map so that was action based dispatch can support

getParent

public AxisServiceGroup getParent()

To get the parent (which is AxisConfiguration in this case)

Returns:

AxisConfiguration

setParent

public void setParent(AxisServiceGroup parent)

isParameterLocked

public boolean isParameterLocked(java.lang.String paramterName)

Description copied from interface: ParameterInclude

to check whether the parameter is locked at any level

Specified by:

isParameterLocked in interface ParameterInclude

deserializeParameters

public void deserializeParameters(OMElement parameterElement)
                           throws AxisFault

Specified by:

deserializeParameters in interface ParameterInclude

Throws:

AxisFault

addModuleConfig

public void addModuleConfig(ModuleConfiguration moduleConfiguration)

Adding module configuration , if there is moduleConfig tag in service

Parameters:

moduleConfiguration -

getModuleConfig

public ModuleConfiguration getModuleConfig(javax.xml.namespace.QName moduleName)

addModuleref

public void addModuleref(javax.xml.namespace.QName moduleref)

getModules

public java.util.ArrayList getModules()