org.apache.axis2.description
Class ServiceDescription

java.lang.Object
  extended byorg.apache.axis2.description.ServiceDescription
All Implemented Interfaces:
org.apache.wsdl.Component, DescriptionConstants, FlowInclude, ParameterInclude, org.apache.wsdl.WSDLService

public class ServiceDescription
extends java.lang.Object
implements org.apache.wsdl.WSDLService, ParameterInclude, FlowInclude, DescriptionConstants

Class ServiceDescription


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
ServiceDescription()
           
ServiceDescription(javax.xml.namespace.QName qName)
          Constructor ServiceDescription
ServiceDescription(org.apache.wsdl.impl.WSDLServiceImpl serviceimpl)
          Constructor ServiceDescription
 
Method Summary
 void addExtensibilityElement(org.apache.wsdl.WSDLExtensibilityElement element)
          Adds the ExtensibilityElement to the Extensible Component.
 void addExtensibleAttributes(org.apache.wsdl.WSDLExtensibilityAttribute attribute)
          Adds the ExtensibilityAttribute as a attrebute of this Component.
 void addMapping(java.lang.String mappingKey, OperationDescription operation)
          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(OperationDescription operation)
          Method addOperation
 void addParameter(Parameter param)
          Method addParameter
 void addToEngagModuleList(ModuleDescription moduleName)
           
 void engageModule(ModuleDescription moduleref, AxisConfiguration axisConfig)
          To ebgage a module it is reuired to use this method
 java.lang.ClassLoader getClassLoader()
          Method getClassLoader
 java.util.HashMap getComponentProperties()
          Returns the properties that are specific to this WSDL Component.
 java.lang.Object getComponentProperty(java.lang.Object key)
          Gets the component property
 java.lang.String getContextPath()
          Method getContextPath
 org.apache.wsdl.WSDLEndpoint getEndpoint(javax.xml.namespace.QName qName)
          Endpoint will be retrived by its qName.
 java.util.HashMap getEndpoints()
          Method getEndpoints
 java.util.Collection getEngagedModules()
          Method getEngadgedModules
 java.util.List getExtensibilityAttributes()
          Returns a List of ExtensibleAttributes of this component.
 java.util.List getExtensibilityElements()
          Returns the Extensibility Elements of the Extensible component;
 Flow getFaultInFlow()
          Method getFaultInFlow
 Flow getFaultOutFlow()
           
 java.lang.String getFileName()
           
 Flow getInFlow()
          Method getInFlow
 long getLastupdate()
           
 java.util.Map getMetadataBag()
          Get access to the metadata bag associated with this component (which contains anything we feel like hanging off it)
 ModuleConfiguration getModuleConfig(javax.xml.namespace.QName moduleName)
           
 java.util.ArrayList getModules()
           
 javax.xml.namespace.QName getName()
          Method getName
 java.lang.String getNamespace()
          If the Name of the WSDLService is not set a WSDLProcessingException will be thrown.
 OperationDescription getOperation(javax.xml.namespace.QName operationName)
          Method getOperation
 OperationDescription getOperation(java.lang.String ncName)
           
 OperationDescription getOperationBySOAPAction(java.lang.String soapAction)
          This method will return the operation given particular SOAP Action.
 OperationDescription 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
 ServiceGroupDescription getParent()
          To get the parent (which is AxisConfiguration in this case)
 java.lang.String getServiceDescription()
          To get the description about the service ty67tyuio
 org.apache.wsdl.WSDLInterface getServiceInterface()
          Method getServiceInterface
 java.lang.String getStyle()
          Method getStyle
 Definition getWSDLDefinition()
           
 boolean isParamterLocked(java.lang.String paramterName)
           
 void printWSDL(java.io.Writer out, java.lang.String PortURL)
           
 void setClassLoader(java.lang.ClassLoader classLoader)
          Method setClassLoader
 void setComponentProperties(java.util.HashMap properties)
          Sets the properties of the Component if any.
 void setComponentProperty(java.lang.Object key, java.lang.Object obj)
          Will set the property keyed with the relavent key
 void setContextPath(java.lang.String contextPath)
          Method setContextPath
 void setEndpoint(org.apache.wsdl.WSDLEndpoint endpoint)
          Will add a WSDLEndpoint object to the WOM keyed with qname;
 void setEndpoints(java.util.HashMap endpoints)
          Method setEndpoints
 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 setName(javax.xml.namespace.QName name)
          Method setName
 void setOutFlow(Flow outFlow)
          Method setOutFlow
 void setParent(ServiceGroupDescription parent)
           
 void setServiceDescription(java.lang.String serviceDescription)
          Set the description about the service
 void setServiceInterface(org.apache.wsdl.WSDLInterface serviceInterface)
          Method setServiceInterface
 void setStyle(java.lang.String style)
          Method setStyle
 void setWSDLDefinition(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

ServiceDescription

public ServiceDescription(org.apache.wsdl.impl.WSDLServiceImpl serviceimpl)
Constructor ServiceDescription


ServiceDescription

public ServiceDescription()

ServiceDescription

public ServiceDescription(javax.xml.namespace.QName qName)
Constructor ServiceDescription

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

addToEngagModuleList

public void addToEngagModuleList(ModuleDescription moduleName)

getEngagedModules

public java.util.Collection getEngagedModules()
Method getEngadgedModules

Returns:
Collection

getOperation

public OperationDescription getOperation(javax.xml.namespace.QName operationName)
Method getOperation

Parameters:
operationName -
Returns:
OperationDescription

addOperation

public void addOperation(OperationDescription operation)
Method addOperation

Parameters:
operation -

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

getOperation

public OperationDescription getOperation(java.lang.String ncName)

getOperationBySOAPAction

public OperationDescription 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 OperationDescription if a unque Operation can be found with the given SOAP Action otherwise will return null.

getOperationBySOAPAction

public OperationDescription 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 OperationDescription 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

getServiceDescription

public java.lang.String getServiceDescription()
To get the description about the service ty67tyuio

Returns:
String

setServiceDescription

public void setServiceDescription(java.lang.String serviceDescription)
Set the description about the service

Parameters:
serviceDescription -

getWSDLDefinition

public Definition getWSDLDefinition()

setWSDLDefinition

public void setWSDLDefinition(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()
Description copied from interface: org.apache.wsdl.WSDLService
Method getEndpoints

Specified by:
getEndpoints in interface org.apache.wsdl.WSDLService
Returns:

setEndpoints

public void setEndpoints(java.util.HashMap endpoints)
Description copied from interface: org.apache.wsdl.WSDLService
Method setEndpoints

Specified by:
setEndpoints in interface org.apache.wsdl.WSDLService
Parameters:
endpoints -

setEndpoint

public void setEndpoint(org.apache.wsdl.WSDLEndpoint endpoint)
Description copied from interface: org.apache.wsdl.WSDLService
Will add a WSDLEndpoint object to the WOM keyed with qname;

Specified by:
setEndpoint in interface org.apache.wsdl.WSDLService
Parameters:
endpoint -

getEndpoint

public org.apache.wsdl.WSDLEndpoint getEndpoint(javax.xml.namespace.QName qName)
Description copied from interface: org.apache.wsdl.WSDLService
Endpoint will be retrived by its qName.

Specified by:
getEndpoint in interface org.apache.wsdl.WSDLService
Parameters:
qName - qName of the Service
Returns:
WSDLService Object or will throw an WSDLProcessingException in the case of object not found.

getName

public javax.xml.namespace.QName getName()
Description copied from interface: org.apache.wsdl.WSDLService
Method getName

Specified by:
getName in interface org.apache.wsdl.WSDLService
Returns:

setName

public void setName(javax.xml.namespace.QName name)
Description copied from interface: org.apache.wsdl.WSDLService
Method setName

Specified by:
setName in interface org.apache.wsdl.WSDLService
Parameters:
name -

getNamespace

public java.lang.String getNamespace()
Description copied from interface: org.apache.wsdl.WSDLService
If the Name of the WSDLService is not set a WSDLProcessingException will be thrown.

Specified by:
getNamespace in interface org.apache.wsdl.WSDLService
Returns:
Target Namespace as a String

getServiceInterface

public org.apache.wsdl.WSDLInterface getServiceInterface()
Description copied from interface: org.apache.wsdl.WSDLService
Method getServiceInterface

Specified by:
getServiceInterface in interface org.apache.wsdl.WSDLService
Returns:

setServiceInterface

public void setServiceInterface(org.apache.wsdl.WSDLInterface serviceInterface)
Description copied from interface: org.apache.wsdl.WSDLService
Method setServiceInterface

Specified by:
setServiceInterface in interface org.apache.wsdl.WSDLService
Parameters:
serviceInterface -

getComponentProperties

public java.util.HashMap getComponentProperties()
Description copied from interface: org.apache.wsdl.Component
Returns the properties that are specific to this WSDL Component.

Specified by:
getComponentProperties in interface org.apache.wsdl.Component
Returns:

setComponentProperties

public void setComponentProperties(java.util.HashMap properties)
Description copied from interface: org.apache.wsdl.Component
Sets the properties of the Component if any.

Specified by:
setComponentProperties in interface org.apache.wsdl.Component
Parameters:
properties -

setComponentProperty

public void setComponentProperty(java.lang.Object key,
                                 java.lang.Object obj)
Description copied from interface: org.apache.wsdl.Component
Will set the property keyed with the relavent key

Specified by:
setComponentProperty in interface org.apache.wsdl.Component
Parameters:
key - Key in the map
obj - Object to be put

getComponentProperty

public java.lang.Object getComponentProperty(java.lang.Object key)
Description copied from interface: org.apache.wsdl.Component
Gets the component property

Specified by:
getComponentProperty in interface org.apache.wsdl.Component
Parameters:
key - key for the map search.
Returns:

addExtensibilityElement

public void addExtensibilityElement(org.apache.wsdl.WSDLExtensibilityElement element)
Description copied from interface: org.apache.wsdl.Component
Adds the ExtensibilityElement to the Extensible Component.

Specified by:
addExtensibilityElement in interface org.apache.wsdl.Component
Parameters:
element -

getExtensibilityElements

public java.util.List getExtensibilityElements()
Description copied from interface: org.apache.wsdl.Component
Returns the Extensibility Elements of the Extensible component;

Specified by:
getExtensibilityElements in interface org.apache.wsdl.Component
Returns:
List of Elements

getExtensibilityAttributes

public java.util.List getExtensibilityAttributes()
Description copied from interface: org.apache.wsdl.Component
Returns a List of ExtensibleAttributes of this component.

Specified by:
getExtensibilityAttributes in interface org.apache.wsdl.Component
Returns:
List

addExtensibleAttributes

public void addExtensibleAttributes(org.apache.wsdl.WSDLExtensibilityAttribute attribute)
Description copied from interface: org.apache.wsdl.Component
Adds the ExtensibilityAttribute as a attrebute of this Component.

Specified by:
addExtensibleAttributes in interface org.apache.wsdl.Component
Parameters:
attribute - ExtensibilityAttribute

getMetadataBag

public java.util.Map getMetadataBag()
Description copied from interface: org.apache.wsdl.Component
Get access to the metadata bag associated with this component (which contains anything we feel like hanging off it)

Specified by:
getMetadataBag in interface org.apache.wsdl.Component
Returns:
the metadata Map.

addMapping

public void addMapping(java.lang.String mappingKey,
                       OperationDescription operation)
To add the was action paramater into has map so that was action based dispatch can support


getParent

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

Returns:
AxisConfiguration

setParent

public void setParent(ServiceGroupDescription parent)

isParamterLocked

public boolean isParamterLocked(java.lang.String paramterName)
Specified by:
isParamterLocked in interface ParameterInclude

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()