org.apache.axis.description

Interface ServiceDesc

All Superinterfaces:
Serializable
Known Implementing Classes:
JavaServiceDesc

public interface ServiceDesc
extends Serializable

Method Summary

void
addOperationDesc(OperationDesc operation)
List
getAllowedMethods()
String
getDefaultNamespace()
List
getDisallowedMethods()
String
getDocumentation()
get the documentation for the service
String
getEndpointURL()
String
getName()
the name of the service
OperationDesc
getOperationByElementQName(QName qname)
Map an XML QName to an operation.
OperationDesc
getOperationByName(String methodName)
Return an operation matching the given method name.
ArrayList
getOperations()
get all the operations as a list of OperationDescs.
OperationDesc[]
getOperationsByName(String methodName)
get all overloaded operations by name
OperationDesc[]
getOperationsByQName(QName qname)
Return all operations which match this QName (i.e.
Object
getProperty(String name)
Style
getStyle()
What kind of service is this?
TypeMapping
getTypeMapping()
TypeMappingRegistry
getTypeMappingRegistry()
Use
getUse()
What kind of use is this?
String
getWSDLFile()
the wsdl file of the service.
boolean
isInitialized()
boolean
isWrapped()
Determine whether or not this is a "wrapped" invocation, i.e.
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 service
void
setEndpointURL(String endpointURL)
void
setName(String name)
the name of the service
void
setNamespaceMappings(List namespaces)
void
setProperty(String name, Object value)
void
setStyle(Style style)
void
setTypeMapping(TypeMapping tm)
void
setTypeMappingRegistry(TypeMappingRegistry tmr)
void
setUse(Use use)
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.

Method Details

addOperationDesc

public void addOperationDesc(OperationDesc operation)

getAllowedMethods

public List getAllowedMethods()

getDefaultNamespace

public String getDefaultNamespace()

getDisallowedMethods

public List getDisallowedMethods()

getDocumentation

public String getDocumentation()
get the documentation for the service

getEndpointURL

public String getEndpointURL()

getName

public String getName()
the name of the service

getOperationByElementQName

public OperationDesc getOperationByElementQName(QName qname)
Map an XML QName to an operation. Returns the first one it finds in the case of mulitple matches.
Returns:
null for no match

getOperationByName

public OperationDesc getOperationByName(String methodName)
Return an operation matching the given method name. Note that if we have multiple overloads for this method, we will return the first one.
Returns:
null for no match

getOperations

public ArrayList getOperations()
get all the operations as a list of OperationDescs. this method triggers an evaluation of the valid operations by introspection, so use sparingly
Returns:
reference to the operations array. This is not a copy

getOperationsByName

public OperationDesc[] getOperationsByName(String methodName)
get all overloaded operations by name
Parameters:
methodName -
Returns:
null for no match, or an array of OperationDesc objects

getOperationsByQName

public OperationDesc[] getOperationsByQName(QName qname)
Return all operations which match this QName (i.e. get all the overloads)
Returns:
null for no match

getProperty

public Object getProperty(String name)

getStyle

public Style getStyle()
What kind of service is this?
Returns:

getTypeMapping

public TypeMapping getTypeMapping()

getTypeMappingRegistry

public TypeMappingRegistry getTypeMappingRegistry()

getUse

public Use getUse()
What kind of use is this?
Returns:

getWSDLFile

public String getWSDLFile()
the wsdl file of the service. When null, it means that the wsdl should be autogenerated
Returns:
filename or null

isInitialized

public boolean isInitialized()

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.
Returns:
true if this is wrapped (i.e. RPC or WRAPPED style), false otherwise

removeOperationDesc

public void removeOperationDesc(OperationDesc operation)

setAllowedMethods

public void setAllowedMethods(List allowedMethods)

setDefaultNamespace

public void setDefaultNamespace(String namespace)

setDisallowedMethods

public void setDisallowedMethods(List disallowedMethods)

setDocumentation

public void setDocumentation(String documentation)
set the documentation for the service

setEndpointURL

public void setEndpointURL(String endpointURL)

setName

public void setName(String name)
the name of the service
Parameters:
name -

setNamespaceMappings

public void setNamespaceMappings(List namespaces)

setProperty

public void setProperty(String name,
                        Object value)

setStyle

public void setStyle(Style style)

setTypeMapping

public void setTypeMapping(TypeMapping tm)

setTypeMappingRegistry

public void setTypeMappingRegistry(TypeMappingRegistry tmr)

setUse

public void setUse(Use use)

setWSDLFile

public 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.
Parameters:
wsdlFileName - filename or null to re-enable introspection

Copyright © 2005 Apache Web Services Project. All Rights Reserved.