Home » axis2-1.5-src » org.apache » axis2 » description » [javadoc | source]
org.apache.axis2.description
public class: AxisService [javadoc | source]
java.lang.Object
   org.apache.axis2.description.AxisDescription
      org.apache.axis2.description.AxisService

All Implemented Interfaces:
    ParameterInclude, DescriptionConstants

Class AxisService
Field Summary
public static final  String SUPPORT_SINGLE_OP    If this param is true, and the service has exactly one AxisOperation, normal operation dispatch (via URI/soapAction/etc) will not be necessary, and we'll just default to funneling all messages to that op. This is useful for passthrough/ESB/embedded applications. 
public static final  String IMPORT_TAG     
public static final  String INCLUDE_TAG     
public static final  String SCHEMA_LOCATION     
 LocatorType[] availableDataLocatorTypes     
Fields inherited from org.apache.axis2.description.AxisDescription:
parent,  engagedModules,  parameterObservers,  NULL_MODULES
Constructor:
 public AxisService() 
 public AxisService(String name) 
    Constructor AxisService.
Method from org.apache.axis2.description.AxisService Summary:
addDataLocatorClassNames,   addEndpoint,   addExposedTransport,   addHttpLocationDispatcherString,   addMessageContextListener,   addMessageElementQNameToOperationMapping,   addMessageReceiver,   addModuleConfig,   addModuleOperations,   addModuleref,   addOperation,   addSchema,   addSchema,   attachEnvelopeEvent,   attachServiceContextEvent,   createClientSideAxisService,   createClientSideAxisService,   createService,   createService,   createService,   getAxisServiceGroup,   getBindingName,   getClassLoader,   getControlOperations,   getCustomSchemaNamePrefix,   getCustomSchemaNameSuffix,   getData,   getDataLocator,   getEPRs,   getEndpoint,   getEndpointName,   getEndpointURL,   getEndpoints,   getExcludeInfo,   getExposedTransports,   getFileName,   getGlobalDataLocator,   getImportedNamespaces,   getKey,   getLastUpdate,   getLastupdate,   getMessageReceiver,   getModuleConfig,   getModules,   getName,   getNameSpacesMap,   getNamespaceMap,   getObjectSupplier,   getOperation,   getOperationByAction,   getOperationByMessageElementQName,   getOperationBySOAPAction,   getOperations,   getOperationsNameList,   getP2nMap,   getPortTypeName,   getPublishedOperations,   getSchema,   getSchema,   getSchemaElement,   getSchemaMappingTable,   getSchemaTargetNamespace,   getSchemaTargetNamespacePrefix,   getSchematargetNamespace,   getScope,   getServiceDescription,   getServiceLifeCycle,   getSoapNsUri,   getTargetNamespace,   getTargetNamespacePrefix,   getTypeTable,   getWSAddressingFlag,   hasMessageContextListener,   isActive,   isClientSide,   isCustomWsdl,   isElementFormDefault,   isEnableAllTransports,   isExposedTransport,   isModifyUserWSDLPortAddress,   isSchemaLocationsAdjusted,   isUseDefaultChains,   isUseUserWSDL,   isWsdlFound,   loadDataLocator,   lookupPolicy,   mapActionToOperation,   onDisengage,   onEngage,   populateSchemaMappings,   populateSchemaMappings,   printSchema,   printUserWSDL,   printWSDL,   printWSDL,   printWSDL2,   printWSDL2,   printWSDL2,   printXSD,   registerPolicy,   releaseSchemaList,   removeExposedTransport,   removeMessageContextListener,   removeOperation,   setActive,   setBindingName,   setClassLoader,   setClientSide,   setCustomSchemaNamePrefix,   setCustomSchemaNameSuffix,   setCustomWsdl,   setEPRs,   setElementFormDefault,   setEnableAllTransports,   setEndpointName,   setEndpointURL,   setExcludeInfo,   setExposedTransports,   setFileName,   setImportedNamespaces,   setLastUpdate,   setLastupdate,   setMessageElementQNameToOperationMap,   setName,   setNameSpacesMap,   setNamespaceMap,   setObjectSupplier,   setOperationsNameList,   setP2nMap,   setParent,   setPortTypeName,   setSchemaLocationsAdjusted,   setSchemaMappingTable,   setSchemaTargetNamespace,   setSchemaTargetNamespacePrefix,   setSchematargetNamespacePrefix,   setScope,   setServiceDescription,   setServiceLifeCycle,   setSoapNsUri,   setTargetNamespace,   setTargetNamespacePrefix,   setTypeTable,   setUseDefaultChains,   setWSAddressingFlag,   setWsdlFound,   toString
Methods from org.apache.axis2.description.AxisDescription:
addChild,   addChild,   addParameter,   addParameter,   addParameterObserver,   applyPolicy,   applyPolicy,   deserializeParameters,   disengageModule,   engageModule,   engageModule,   getAxisConfiguration,   getChild,   getChildren,   getDocumentation,   getDocumentationNode,   getEngagedModules,   getKey,   getParameter,   getParameterValue,   getParameters,   getParent,   getPolicyInclude,   getPolicySubject,   isEngaged,   isEngaged,   isParameterLocked,   isParameterTrue,   onDisengage,   onEngage,   removeChild,   removeParameter,   removeParameterObserver,   setDocumentation,   setDocumentation,   setParent,   setPolicyInclude
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.axis2.description.AxisService Detail:
 public  void addDataLocatorClassNames(String dialect,
    String dataLocatorClassName) 
    Save data Locator configured at service level for this Axis Service
 public  void addEndpoint(String key,
    AxisEndpoint axisEndpoint) 
 public  void addExposedTransport(String transport) 
 public  void addHttpLocationDispatcherString(String string,
    AxisOperation axisOperation) 
    Maps an constant string in the whttp:location to the given operation. This is used by RequestURIOperationDispatcher based dispatching to figure out which operation it is that a given message is for.
 public  void addMessageContextListener(MessageContextListener scl) 
    Add a ServiceContextListener
 public  void addMessageElementQNameToOperationMapping(QName messageElementQName,
    AxisOperation operation) 
    Add an entry to the map between element QNames in WSDL messages and AxisOperations for this service.
 public  void addMessageReceiver(String mepURI,
    MessageReceiver messageReceiver) 
 public  void addModuleConfig(ModuleConfiguration moduleConfiguration) 
    Adds module configuration , if there is moduleConfig tag in service.
  void addModuleOperations(AxisModule module) throws AxisFault 
    Add any control operations defined by a Module to this service.
 public  void addModuleref(String moduleref) 
 public  void addOperation(AxisOperation axisOperation) 
    Method addOperation.
 public  void addSchema(XmlSchema schema) 
 public  void addSchema(Collection schemas) 
 public  void attachEnvelopeEvent(MessageContext mc) 
    Signal an Attach Envelope Event
 public  void attachServiceContextEvent(ServiceContext sc,
    MessageContext mc) 
    Signal an Attach ServiceContext Event
 public static AxisService createClientSideAxisService(URL wsdlURL,
    QName wsdlServiceName,
    String portName,
    Options options) throws AxisFault 
    To create a AxisService for a given WSDL and the created client is most suitable for client side invocation not for server side invocation. Since all the soap action and wsa action is added to operations
 public static AxisService createClientSideAxisService(Definition wsdlDefinition,
    QName wsdlServiceName,
    String portName,
    Options options) throws AxisFault 
 public static AxisService createService(String implClass,
    AxisConfiguration axisConfig) throws AxisFault 
    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. If the method is in-out it will uses RPCMessageReceiver else RPCInOnlyMessageReceiver

    Note : Inorder to work this properly RPCMessageReceiver should be available in the class path otherewise operation can not continue

 public static AxisService createService(String implClass,
    AxisConfiguration axisConfiguration,
    Map messageReceiverClassMap,
    String targetNamespace,
    String schemaNamespace,
    ClassLoader loader) throws AxisFault 
    messageReceiverClassMap will hold the MessageReceivers for given meps. Key will be the mep and value will be the instance of the MessageReceiver class. Ex: Map mrMap = new HashMap(); mrMap.put("http://www.w3.org/2004/08/wsdl/in-only", RPCInOnlyMessageReceiver.class.newInstance()); mrMap.put("http://www.w3.org/2004/08/wsdl/in-out", RPCMessageReceiver.class.newInstance());
 public static AxisService createService(String implClass,
    String serviceName,
    AxisConfiguration axisConfiguration,
    Map messageReceiverClassMap,
    String targetNamespace,
    ClassLoader loader,
    SchemaGenerator schemaGenerator,
    AxisService axisService) throws AxisFault 
    messageReceiverClassMap will hold the MessageReceivers for given meps. Key will be the mep and value will be the instance of the MessageReceiver class. Ex: Map mrMap = new HashMap(); mrMap.put("http://www.w3.org/2004/08/wsdl/in-only", RPCInOnlyMessageReceiver.class.newInstance()); mrMap.put("http://www.w3.org/2004/08/wsdl/in-out", RPCMessageReceiver.class.newInstance());
 public AxisServiceGroup getAxisServiceGroup() 
 public String getBindingName() 
 public ClassLoader getClassLoader() 
    Method getClassLoader.
 public ArrayList getControlOperations() 
    Gets the control operation which are added by module like RM.
 public String getCustomSchemaNamePrefix() 
 public String getCustomSchemaNameSuffix() 
 public Data[] getData(DataRetrievalRequest request,
    MessageContext msgContext) throws AxisFault 
    Find a data locator from the available data locators (both configured and default ones) to retrieve Metadata or data specified in the request.
 public AxisDataLocator getDataLocator(LocatorType locatorType,
    String dialect) throws AxisFault 
 public String[] getEPRs() 
 public AxisEndpoint getEndpoint(String key) 
 public String getEndpointName() 
    get the endpointName
 public String getEndpointURL() 
 public Map getEndpoints() 
 public ExcludeInfo getExcludeInfo() 
 public List getExposedTransports() 
 public URL getFileName() 
 public AxisDataLocator getGlobalDataLocator(String dialect) throws AxisFault 
 public List getImportedNamespaces() 
    Get the namespaces associated with imported WSDLs
 public Object getKey() 
 public long getLastUpdate() 
 public long getLastupdate() 
Deprecated! please - use getLastUpdate

 public MessageReceiver getMessageReceiver(String mepURL) 
 public ModuleConfiguration getModuleConfig(String moduleName) 
 public ArrayList getModules() 
 public String getName() 
 public Map getNameSpacesMap() 
Deprecated! please - use getNamespaceMap()

    Get the namespace map for this service.
 public Map getNamespaceMap() 
    Get the namespace map for this service.
 public ObjectSupplier getObjectSupplier() 
 public AxisOperation getOperation(QName operationName) 
    Method getOperation.
 public AxisOperation getOperationByAction(String action) 
    Returns the AxisOperation which has been mapped to the given alias.
 public AxisOperation getOperationByMessageElementQName(QName messageElementQName) 
    Look up an AxisOperation for this service based off of an element QName from a WSDL message element.
 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. If the action is in the list of invaliad aliases, which means it did not uniquely identify an operation, a null will be returned.
 public Iterator getOperations() 
    Method getOperations.
 public List getOperationsNameList() 
 public Map getP2nMap() 
 public String getPortTypeName() 
Deprecated! use - AxisService#getEndpointName() instead.

 public ArrayList getPublishedOperations() 
    Gets only the published operations.
 public ArrayList getSchema() 
 public XmlSchema getSchema(int index) 
 public XmlSchemaElement getSchemaElement(QName elementQName) 
 public Map getSchemaMappingTable() 
 public String getSchemaTargetNamespace() 
 public String getSchemaTargetNamespacePrefix() 
 public String getSchematargetNamespace() 
Deprecated! please - use getSchemaTargetNamespace

 public String getScope() 
 public String getServiceDescription() 
Deprecated! Use - getDocumentation() instead

    Gets the description about the service which is specified in services.xml.
 public ServiceLifeCycle getServiceLifeCycle() 
 public String getSoapNsUri() 
    get the SOAPVersion
 public String getTargetNamespace() 
 public String getTargetNamespacePrefix() 
 public TypeTable getTypeTable() 
 public String getWSAddressingFlag() 
Deprecated! Use - AddressingHelper.getAddressingRequirementParemeterValue

 public boolean hasMessageContextListener(Class cls) 
 public boolean isActive() 
 public boolean isClientSide() 
 public boolean isCustomWsdl() 
 public boolean isElementFormDefault() 
 public boolean isEnableAllTransports() 
 public boolean isExposedTransport(String transport) 
 public boolean isModifyUserWSDLPortAddress() 
    By default the port address in user WSDLs is modified, set the following parameter to override this behaviour false
 public boolean isSchemaLocationsAdjusted() 
 public boolean isUseDefaultChains() 
 public 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 true
 public boolean isWsdlFound() 
 protected AxisDataLocator loadDataLocator(String className) throws AxisFault 
 public Policy lookupPolicy(String key) 
 public  void mapActionToOperation(String action,
    AxisOperation axisOperation) 
    Maps an alias (such as a SOAPAction, WSA action, or an operation name) to the given AxisOperation. This is used by dispatching (both SOAPAction- and WSAddressing- based dispatching) to figure out which operation a given message is for. Some notes on restrictions of "action" - A null or empty action will be ignored - An action that is a duplicate and references an idential operation is allowed - An acton that is a duplicate and references a different operation is NOT allowed. In this case, the action for the original operation is removed from the alias table, thus removing the ability to route based on this action. This is necessary to prevent mis-directing incoming message to the wrong operation based on SOAPAction. Note that an alias could be a SOAPAction, WS-Addressing Action, the operation name, or some other alias.
 public  void onDisengage(AxisModule module) throws AxisFault 
 public  void onEngage(AxisModule axisModule,
    AxisDescription engager) throws AxisFault 
    Engages a module. It is required to use this method.
 public Map populateSchemaMappings() 
 public Map populateSchemaMappings(boolean overrideAbsoluteAddress) 
    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
 public  void printSchema(OutputStream out) throws AxisFault 
 public  void printUserWSDL(OutputStream out,
    String wsdlName) throws AxisFault 
 public  void printWSDL(OutputStream out) throws AxisFault 
    Print the WSDL with a default URL. This will be called only during codegen time.
 public  void printWSDL(OutputStream out,
    String requestIP) throws AxisFault 
    Produces a WSDL for this AxisService and prints it to the specified OutputStream.
 public  void printWSDL2(OutputStream out) throws AxisFault 
    Print the WSDL2.0 with a default URL. This will be called only during codegen time.
 public  void printWSDL2(OutputStream out,
    String requestIP) throws AxisFault 
 public int printWSDL2(OutputStream out,
    String requestIP,
    String wsdl) throws IOException, AxisFault 
    Produces a WSDL2 for this AxisService and prints it to the specified OutputStream.
 public int printXSD(OutputStream out,
    String xsd) throws IOException 
    Produces a XSD for this AxisService and prints it to the specified OutputStream.
 public  void registerPolicy(String key,
    Policy policy) 
 public  void releaseSchemaList() 
    Release the list of schema objects.

    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  void removeExposedTransport(String transport) 
 public  void removeMessageContextListener(MessageContextListener scl) 
    Remove a ServiceContextListener
 public  void removeOperation(QName opName) 
 public  void setActive(boolean active) 
 public  void setBindingName(String bindingName) 
 public  void setClassLoader(ClassLoader classLoader) 
    Method setClassLoader.
 public  void setClientSide(boolean clientSide) 
 public  void setCustomSchemaNamePrefix(String customSchemaNamePrefix) 
 public  void setCustomSchemaNameSuffix(String customSchemaNameSuffix) 
 public  void setCustomWsdl(boolean customWsdl) 
 public  void setEPRs(String[] eprs) 
 public  void setElementFormDefault(boolean elementFormDefault) 
 public  void setEnableAllTransports(boolean enableAllTransports) 
    To eneble service to be expose in all the transport
 public  void setEndpointName(String endpoint) 
 public  void setEndpointURL(String endpointURL) 
 public  void setExcludeInfo(ExcludeInfo excludeInfo) 
 public  void setExposedTransports(List transports) 
 public  void setFileName(URL fileName) 
 public  void setImportedNamespaces(List importedNamespaces) 
    Set the namespaces associated with imported WSDLs
 public  void setLastUpdate() 
    Sets the current time as last update time of the service.
 public  void setLastupdate() 
Deprecated! please - use setLastUpdate

    Sets the current time as last update time of the service.
 public  void setMessageElementQNameToOperationMap(Map messageElementQNameToOperationMap) 
    Set the map of WSDL message element QNames to AxisOperations for this service. This map is used during SOAP Body-based routing for document/literal bare services to match the first child element of the SOAP Body element to an operation. (Routing for RPC and document/literal wrapped services occurs via the operationsAliasesMap.)

    From section 4.7.6 of the WS-I BP 1.1: the "operation signature" is "the fully qualified name of the child element of SOAP body of the SOAP input message described by an operation in a WSDL binding," and thus this map must be from a QName to an operation.

 public  void setName(String name) 
 public  void setNameSpacesMap(NamespaceMap nameSpacesMap) 
Deprecated! please - use setNamespaceMap

 public  void setNamespaceMap(NamespaceMap namespaceMap) 
 public  void setObjectSupplier(ObjectSupplier objectSupplier) 
 public  void setOperationsNameList(List operationsNameList) 
 public  void setP2nMap(Map p2nMap) 
 public  void setParent(AxisServiceGroup parent) 
 public  void setPortTypeName(String portTypeName) 
Deprecated! use - AxisService#setEndpointName() instead

 public  void setSchemaLocationsAdjusted(boolean schemaLocationsAdjusted) 
 public  void setSchemaMappingTable(Map schemaMappingTable) 
 public  void setSchemaTargetNamespace(String schematargetNamespace) 
 public  void setSchemaTargetNamespacePrefix(String schematargetNamespacePrefix) 
 public  void setSchematargetNamespacePrefix(String schematargetNamespacePrefix) 
Deprecated! please - use setSchemaTargetNamespacePrefix

 public  void setScope(String scope) 
 public  void setServiceDescription(String documentation) 
Deprecated! Use - setDocumentation() instead

    Sets the description about the service which is specified in services.xml
 public  void setServiceLifeCycle(ServiceLifeCycle serviceLifeCycle) 
 public  void setSoapNsUri(String soapNsUri) 
 public  void setTargetNamespace(String targetNamespace) 
 public  void setTargetNamespacePrefix(String targetNamespacePrefix) 
 public  void setTypeTable(TypeTable typeTable) 
 public  void setUseDefaultChains(boolean useDefaultChains) 
 public  void setWSAddressingFlag(String ar) 
Deprecated! Use - AddressingHelper.setAddressingRequirementParemeterValue

 public  void setWsdlFound(boolean wsdlFound) 
 public String toString()