Package org.apache.axis.description
Class JavaServiceDesc
java.lang.Object
org.apache.axis.description.JavaServiceDesc
- All Implemented Interfaces:
Serializable,ServiceDesc
A ServiceDesc is an abstract description of a service.
ServiceDescs contain OperationDescs, which are descriptions of operations.
The information about a service's operations comes from one of two places:
1) deployment, or 2) introspection.
- Author:
- Glen Daniels (gdaniels@apache.org)
- See Also:
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddOperationDesc(OperationDesc operation) get the documentation for the servicegetName()the name of the servicegetOperationByElementQName(QName qname) Map an XML QName to an operation.getOperationByName(String methodName) Return an operation matching the given method name.get all the operations as a list of OperationDescs.getOperationsByName(String methodName) get all overloaded operations by namegetOperationsByQName(QName qname) Return all operations which match this QName (i.e.getProperty(String name) getStyle()What kind of service is this?getUse()What kind of use is this?the wsdl file of the service.booleanbooleanDetermine whether or not this is a "wrapped" invocation, i.e.voidFill in a service description by introspecting the implementation class.voidloadServiceDescByIntrospection(Class implClass) Fill in a service description by introspecting the implementation class.voidFill in a service description by introspecting the implementation class.voidremoveOperationDesc(OperationDesc operation) voidsetAllowedMethods(List allowedMethods) voidsetDefaultNamespace(String namespace) voidsetDisallowedMethods(List disallowedMethods) voidsetDocumentation(String documentation) set the documentation for the servicevoidsetEndpointURL(String endpointURL) voidsetImplClass(Class implClass) set the implementation classvoidthe name of the servicevoidsetNamespaceMappings(List namespaces) voidsetProperty(String name, Object value) voidsetStopClasses(ArrayList stopClasses) voidvoidvoidvoidvoidsetWSDLFile(String wsdlFileName) set the wsdl file of the service; this causes the named file to be returned on a ?wsdl, probe, not introspection generated wsdl.
-
Field Details
-
log
protected static org.apache.commons.logging.Log log
-
-
Constructor Details
-
JavaServiceDesc
public JavaServiceDesc()Default constructor
-
-
Method Details
-
getStyle
What kind of service is this?- Specified by:
getStylein interfaceServiceDesc- Returns:
-
setStyle
- Specified by:
setStylein interfaceServiceDesc
-
getUse
What kind of use is this?- Specified by:
getUsein interfaceServiceDesc- Returns:
-
setUse
- Specified by:
setUsein interfaceServiceDesc
-
isWrapped
public boolean isWrapped()Determine whether or not this is a "wrapped" invocation, i.e. whether the outermost XML element of the "main" body element represents a method call, with the immediate children of that element representing arguments to the method.- Specified by:
isWrappedin interfaceServiceDesc- Returns:
- true if this is wrapped (i.e. RPC or WRAPPED style), false otherwise
-
getWSDLFile
the wsdl file of the service. When null, it means that the wsdl should be autogenerated- Specified by:
getWSDLFilein interfaceServiceDesc- Returns:
- filename or null
-
setWSDLFile
set the wsdl file of the service; this causes the named file to be returned on a ?wsdl, probe, not introspection generated wsdl.- Specified by:
setWSDLFilein interfaceServiceDesc- Parameters:
wsdlFileName- filename or null to re-enable introspection
-
getAllowedMethods
- Specified by:
getAllowedMethodsin interfaceServiceDesc
-
setAllowedMethods
- Specified by:
setAllowedMethodsin interfaceServiceDesc
-
getImplClass
-
setImplClass
set the implementation classWarning: You cannot call getInitializedServiceDesc() after setting this as it uses this to indicate its work has already been done.
- Parameters:
implClass-- Throws:
IllegalArgumentException- if the implementation class is already set
-
getTypeMapping
- Specified by:
getTypeMappingin interfaceServiceDesc
-
setTypeMapping
- Specified by:
setTypeMappingin interfaceServiceDesc
-
getName
the name of the service- Specified by:
getNamein interfaceServiceDesc
-
setName
the name of the service- Specified by:
setNamein interfaceServiceDesc- Parameters:
name-
-
getDocumentation
get the documentation for the service- Specified by:
getDocumentationin interfaceServiceDesc
-
setDocumentation
set the documentation for the service- Specified by:
setDocumentationin interfaceServiceDesc
-
getStopClasses
-
setStopClasses
-
getDisallowedMethods
- Specified by:
getDisallowedMethodsin interfaceServiceDesc
-
setDisallowedMethods
- Specified by:
setDisallowedMethodsin interfaceServiceDesc
-
removeOperationDesc
- Specified by:
removeOperationDescin interfaceServiceDesc
-
addOperationDesc
- Specified by:
addOperationDescin interfaceServiceDesc
-
getOperations
get all the operations as a list of OperationDescs. this method triggers an evaluation of the valid operations by introspection, so use sparingly- Specified by:
getOperationsin interfaceServiceDesc- Returns:
- reference to the operations array. This is not a copy
-
getOperationsByName
get all overloaded operations by name- Specified by:
getOperationsByNamein interfaceServiceDesc- Parameters:
methodName-- Returns:
- null for no match, or an array of OperationDesc objects
-
getOperationByName
Return an operation matching the given method name. Note that if we have multiple overloads for this method, we will return the first one.- Specified by:
getOperationByNamein interfaceServiceDesc- Returns:
- null for no match
-
getOperationByElementQName
Map an XML QName to an operation. Returns the first one it finds in the case of mulitple matches.- Specified by:
getOperationByElementQNamein interfaceServiceDesc- Returns:
- null for no match
-
getOperationsByQName
Return all operations which match this QName (i.e. get all the overloads)- Specified by:
getOperationsByQNamein interfaceServiceDesc- Returns:
- null for no match
-
loadServiceDescByIntrospection
public void loadServiceDescByIntrospection()Fill in a service description by introspecting the implementation class. -
loadServiceDescByIntrospection
Fill in a service description by introspecting the implementation class. -
loadServiceDescByIntrospection
Fill in a service description by introspecting the implementation class. This version takes the implementation class and the in-scope TypeMapping. -
setNamespaceMappings
- Specified by:
setNamespaceMappingsin interfaceServiceDesc
-
getDefaultNamespace
- Specified by:
getDefaultNamespacein interfaceServiceDesc
-
setDefaultNamespace
- Specified by:
setDefaultNamespacein interfaceServiceDesc
-
setProperty
- Specified by:
setPropertyin interfaceServiceDesc
-
getProperty
- Specified by:
getPropertyin interfaceServiceDesc
-
getEndpointURL
- Specified by:
getEndpointURLin interfaceServiceDesc
-
setEndpointURL
- Specified by:
setEndpointURLin interfaceServiceDesc
-
getTypeMappingRegistry
- Specified by:
getTypeMappingRegistryin interfaceServiceDesc
-
setTypeMappingRegistry
- Specified by:
setTypeMappingRegistryin interfaceServiceDesc
-
isInitialized
public boolean isInitialized()- Specified by:
isInitializedin interfaceServiceDesc
-