org.apache.axis2.description
Class AxisService

java.lang.Object
  extended byorg.apache.axis2.description.AxisService
All Implemented Interfaces:
DescriptionConstants, ParameterInclude

public class AxisService
extends Object
implements ParameterInclude, DescriptionConstants

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, SERVICE_CLASS_NAME, STYLE_KEY
 
Constructor Summary
AxisService()
          Constructor AxisService.
AxisService(String name)
          Constructor AxisService.
 
Method Summary
 void addMessageReceiver(String mepURL, MessageReceiver messageReceiver)
           
 void addModuleConfig(ModuleConfiguration moduleConfiguration)
          Adds module configuration , if there is moduleConfig tag in service.
 void addModuleOperations(ModuleDescription module, AxisConfiguration axisConfig)
          Adds an operation to a service if a module is required to do so.
 void addModuleref(QName moduleref)
           
 void addOperation(AxisOperation axisOperation)
          Method addOperation.
 void addParameter(Parameter param)
          Method addParameter.
 void deserializeParameters(OMElement parameterElement)
           
 void engageModule(ModuleDescription moduleref, AxisConfiguration axisConfig)
          Engages a module.
 ClassLoader getClassLoader()
          Method getClassLoader.
 ArrayList getControlOperations()
          Gets the control operation which are added by module like RM.
 Collection getEngagedModules()
          Method getEngagedModules.
 String getFileName()
           
 long getLastupdate()
           
 MessageReceiver getMessageReceiver(String mepURL)
           
 ModuleConfiguration getModuleConfig(QName moduleName)
           
 ArrayList getModules()
           
 String getName()
           
 AxisOperation getOperation(QName operationName)
          Method getOperation.
 AxisOperation getOperationByAction(String action)
          Returns the AxisOperation which has been mapped to the given action.
 AxisOperation getOperationBySOAPAction(String soapAction)
          Returns the operation given a SOAP Action.
 HashMap getOperations()
          Method getOperations.
 Parameter getParameter(String name)
          Method getParameter.
 ArrayList getParameters()
          Gets all the parameters in a given description.
 AxisServiceGroup getParent()
          Gets the parent.
 PolicyInclude getPolicyInclude()
           
 ArrayList getPublishedOperations()
          Gets only the published operations.
 org.apache.ws.commons.schema.XmlSchema getSchema()
           
 String getScope()
           
 String getServiceDescription()
          Gets the description about the service which is specified in services.xml.
 javax.wsdl.Definition getWSDLDefinition()
           
 boolean isParameterLocked(String parameterName)
          Checks whether the parameter is locked at any level.
 boolean isUseDefaultChains()
           
 boolean isWsdlfound()
           
 void mapActionToOperation(String action, AxisOperation axisOperation)
          Maps an action (aka WSA action) to the given operation.
 void printSchema(OutputStream out)
           
 void printUsingWOM(OutputStream out, String serviceURL)
           
 void printUsingWSDLDefinition(OutputStream out, String serviceURL)
           
 void printWSDL(OutputStream out, String serviceURL)
           
 void setClassLoader(ClassLoader classLoader)
          Method setClassLoader.
 void setFileName(String fileName)
           
 void setLastupdate()
          Sets the current time as last update time of the service.
 void setName(String name)
           
 void setParent(AxisServiceGroup parent)
           
 void setPolicyInclude(PolicyInclude policyInclude)
           
 void setSchema(org.apache.ws.commons.schema.XmlSchema schema)
           
 void setScope(String scope)
           
 void setServiceDescription(String serviceDescription)
          Sets the description about the service whish is specified in services.xml
 void setUseDefaultChains(boolean useDefaultChains)
           
 void setWSDLDefinition(javax.wsdl.Definition difDefinition)
           
 void setWsdlfound(boolean wsdlfound)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AxisService

public AxisService()
Constructor AxisService.


AxisService

public AxisService(String name)
Constructor AxisService.

Method Detail

addMessageReceiver

public void addMessageReceiver(String mepURL,
                               MessageReceiver messageReceiver)

getMessageReceiver

public MessageReceiver getMessageReceiver(String mepURL)

addModuleConfig

public void addModuleConfig(ModuleConfiguration moduleConfiguration)
Adds module configuration , if there is moduleConfig tag in service.

Parameters:
moduleConfiguration -

addModuleOperations

public void addModuleOperations(ModuleDescription module,
                                AxisConfiguration axisConfig)
                         throws AxisFault
Adds an operation to a service if a module is required to do so.

Parameters:
module -
Throws:
AxisFault

addModuleref

public void addModuleref(QName moduleref)

addOperation

public void addOperation(AxisOperation axisOperation)
Method addOperation.

Parameters:
axisOperation -

addParameter

public void addParameter(Parameter param)
                  throws AxisFault
Method addParameter.

Specified by:
addParameter in interface ParameterInclude
Parameters:
param -
Throws:
AxisFault

deserializeParameters

public void deserializeParameters(OMElement parameterElement)
                           throws AxisFault
Specified by:
deserializeParameters in interface ParameterInclude
Throws:
AxisFault

engageModule

public void engageModule(ModuleDescription moduleref,
                         AxisConfiguration axisConfig)
                  throws AxisFault
Engages a module. It is required to use this method.

Parameters:
moduleref -
Throws:
AxisFault

mapActionToOperation

public void mapActionToOperation(String action,
                                 AxisOperation axisOperation)
Maps an action (aka WSA action) to the given operation. This is used by addressing based dispatching to figure out which operation it is that a given message is for.

Parameters:
action - the action key
axisOperation - the operation to map to

printSchema

public void printSchema(OutputStream out)
                 throws AxisFault
Throws:
AxisFault

printWSDL

public void printWSDL(OutputStream out,
                      String serviceURL)
               throws AxisFault
Throws:
AxisFault

printUsingWSDLDefinition

public void printUsingWSDLDefinition(OutputStream out,
                                     String serviceURL)
                              throws AxisFault
Throws:
AxisFault

printUsingWOM

public void printUsingWOM(OutputStream out,
                          String serviceURL)
                   throws AxisFault
Throws:
AxisFault

getServiceDescription

public String getServiceDescription()
Gets the description about the service which is specified in services.xml.

Returns:
Returns String.

getClassLoader

public ClassLoader getClassLoader()
Method getClassLoader.

Returns:
Returns ClassLoader.

getControlOperations

public ArrayList getControlOperations()
Gets the control operation which are added by module like RM.


getEngagedModules

public Collection getEngagedModules()
Method getEngagedModules.

Returns:
Returns Collection.

getFileName

public String getFileName()

getLastupdate

public long getLastupdate()

getModuleConfig

public ModuleConfiguration getModuleConfig(QName moduleName)

getModules

public ArrayList getModules()

getName

public String getName()

getOperation

public AxisOperation getOperation(QName operationName)
Method getOperation.

Parameters:
operationName -
Returns:
Returns AxisOperation.

getOperationByAction

public AxisOperation getOperationByAction(String action)
Returns the AxisOperation which has been mapped to the given action.

Parameters:
action - the action key
Returns:
Returns the corresponding AxisOperation or null if it isn't found.

getOperationBySOAPAction

public AxisOperation getOperationBySOAPAction(String soapAction)
Returns the operation given a SOAP Action. This method should be called if 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 returned. 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:
Returns an AxisOperation if a unique Operation can be found with the given SOAP Action otherwise will return null.

getOperations

public HashMap getOperations()
Method getOperations.

Returns:
Returns HashMap

getParameter

public Parameter getParameter(String name)
Method getParameter.

Specified by:
getParameter in interface ParameterInclude
Parameters:
name -
Returns:
Returns Parameter.

getParameters

public ArrayList getParameters()
Description copied from interface: ParameterInclude
Gets all the parameters in a given description.

Specified by:
getParameters in interface ParameterInclude
Returns:
Returns ArrayList.

getParent

public AxisServiceGroup getParent()
Gets the parent. (AxisConfiguration in this case)

Returns:
Returns AxisConfiguration

getPublishedOperations

public ArrayList getPublishedOperations()
Gets only the published operations.


getWSDLDefinition

public javax.wsdl.Definition getWSDLDefinition()

isParameterLocked

public boolean isParameterLocked(String parameterName)
Description copied from interface: ParameterInclude
Checks whether the parameter is locked at any level.

Specified by:
isParameterLocked in interface ParameterInclude

setServiceDescription

public void setServiceDescription(String serviceDescription)
Sets the description about the service whish is specified in services.xml

Parameters:
serviceDescription -

setClassLoader

public void setClassLoader(ClassLoader classLoader)
Method setClassLoader.

Parameters:
classLoader -

setFileName

public void setFileName(String fileName)

setLastupdate

public void setLastupdate()
Sets the current time as last update time of the service.


setName

public void setName(String name)

setParent

public void setParent(AxisServiceGroup parent)

setWSDLDefinition

public void setWSDLDefinition(javax.wsdl.Definition difDefinition)

getSchema

public org.apache.ws.commons.schema.XmlSchema getSchema()

setSchema

public void setSchema(org.apache.ws.commons.schema.XmlSchema schema)

isWsdlfound

public boolean isWsdlfound()

setWsdlfound

public void setWsdlfound(boolean wsdlfound)

getScope

public String getScope()

setScope

public void setScope(String scope)

setPolicyInclude

public void setPolicyInclude(PolicyInclude policyInclude)

getPolicyInclude

public PolicyInclude getPolicyInclude()

isUseDefaultChains

public boolean isUseDefaultChains()

setUseDefaultChains

public void setUseDefaultChains(boolean useDefaultChains)