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 TypeMethodDescriptionvoid
addOperationDesc
(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.boolean
boolean
Determine whether or not this is a "wrapped" invocation, i.e.void
Fill in a service description by introspecting the implementation class.void
loadServiceDescByIntrospection
(Class implClass) Fill in a service description by introspecting the implementation class.void
Fill in a service description by introspecting the implementation class.void
removeOperationDesc
(OperationDesc operation) void
setAllowedMethods
(List allowedMethods) void
setDefaultNamespace
(String namespace) void
setDisallowedMethods
(List disallowedMethods) void
setDocumentation
(String documentation) set the documentation for the servicevoid
setEndpointURL
(String endpointURL) void
setImplClass
(Class implClass) set the implementation classvoid
the name of the servicevoid
setNamespaceMappings
(List namespaces) void
setProperty
(String name, Object value) void
setStopClasses
(ArrayList stopClasses) void
void
void
void
void
setWSDLFile
(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:
getStyle
in interfaceServiceDesc
- Returns:
-
setStyle
- Specified by:
setStyle
in interfaceServiceDesc
-
getUse
What kind of use is this?- Specified by:
getUse
in interfaceServiceDesc
- Returns:
-
setUse
- Specified by:
setUse
in 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:
isWrapped
in 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:
getWSDLFile
in 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:
setWSDLFile
in interfaceServiceDesc
- Parameters:
wsdlFileName
- filename or null to re-enable introspection
-
getAllowedMethods
- Specified by:
getAllowedMethods
in interfaceServiceDesc
-
setAllowedMethods
- Specified by:
setAllowedMethods
in 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:
getTypeMapping
in interfaceServiceDesc
-
setTypeMapping
- Specified by:
setTypeMapping
in interfaceServiceDesc
-
getName
the name of the service- Specified by:
getName
in interfaceServiceDesc
-
setName
the name of the service- Specified by:
setName
in interfaceServiceDesc
- Parameters:
name
-
-
getDocumentation
get the documentation for the service- Specified by:
getDocumentation
in interfaceServiceDesc
-
setDocumentation
set the documentation for the service- Specified by:
setDocumentation
in interfaceServiceDesc
-
getStopClasses
-
setStopClasses
-
getDisallowedMethods
- Specified by:
getDisallowedMethods
in interfaceServiceDesc
-
setDisallowedMethods
- Specified by:
setDisallowedMethods
in interfaceServiceDesc
-
removeOperationDesc
- Specified by:
removeOperationDesc
in interfaceServiceDesc
-
addOperationDesc
- Specified by:
addOperationDesc
in 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:
getOperations
in interfaceServiceDesc
- Returns:
- reference to the operations array. This is not a copy
-
getOperationsByName
get all overloaded operations by name- Specified by:
getOperationsByName
in 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:
getOperationByName
in 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:
getOperationByElementQName
in interfaceServiceDesc
- Returns:
- null for no match
-
getOperationsByQName
Return all operations which match this QName (i.e. get all the overloads)- Specified by:
getOperationsByQName
in 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:
setNamespaceMappings
in interfaceServiceDesc
-
getDefaultNamespace
- Specified by:
getDefaultNamespace
in interfaceServiceDesc
-
setDefaultNamespace
- Specified by:
setDefaultNamespace
in interfaceServiceDesc
-
setProperty
- Specified by:
setProperty
in interfaceServiceDesc
-
getProperty
- Specified by:
getProperty
in interfaceServiceDesc
-
getEndpointURL
- Specified by:
getEndpointURL
in interfaceServiceDesc
-
setEndpointURL
- Specified by:
setEndpointURL
in interfaceServiceDesc
-
getTypeMappingRegistry
- Specified by:
getTypeMappingRegistry
in interfaceServiceDesc
-
setTypeMappingRegistry
- Specified by:
setTypeMappingRegistry
in interfaceServiceDesc
-
isInitialized
public boolean isInitialized()- Specified by:
isInitialized
in interfaceServiceDesc
-