org.apache.axis.description
Class ServiceDesc

java.lang.Object
  |
  +--org.apache.axis.description.ServiceDesc

public class ServiceDesc
extends java.lang.Object

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)

Field Summary
static int STYLE_DOCUMENT
           
static int STYLE_MESSAGE
           
static int STYLE_RPC
           
static int STYLE_WRAPPED
           
 
Constructor Summary
ServiceDesc()
          Default constructor
 
Method Summary
 void addOperationDesc(OperationDesc operation)
           
 java.util.List getAllowedMethods()
           
 java.util.List getDisallowedMethods()
           
 java.lang.Class getImplClass()
           
 java.lang.String getName()
           
 OperationDesc getOperationByElementQName(QName qname)
          Map an XML QName to an operation.
 OperationDesc getOperationByName(java.lang.String methodName)
          Return an operation matching the given method name.
 java.util.ArrayList getOperations()
           
 OperationDesc[] getOperationsByName(java.lang.String methodName)
           
 OperationDesc[] getOperationsByQName(QName qname)
          Return all operations which match this QName (i.e.
 java.util.ArrayList getStopClasses()
           
 int getStyle()
           
 TypeMapping getTypeMapping()
           
 java.lang.String getWSDLFile()
           
 boolean isWrapped()
          Determine whether or not this is a "wrapped" invocation, i.e.
 void loadServiceDescByIntrospection()
          Fill in a service description by introspecting the implementation class.
 void loadServiceDescByIntrospection(java.lang.Class implClass, boolean searchParents)
          Fill in a service description by introspecting the implementation class.
 void loadServiceDescByIntrospection(java.lang.Class cls, TypeMapping tm)
          Fill in a service description by introspecting the implementation class.
 void setAllowedMethods(java.util.List allowedMethods)
           
 void setDefaultNamespace(java.lang.String namespace)
           
 void setDisallowedMethods(java.util.List disallowedMethods)
           
 void setImplClass(java.lang.Class implClass)
           
 void setName(java.lang.String name)
           
 void setNamespaceMappings(java.util.List namespaces)
           
 void setStopClasses(java.util.ArrayList stopClasses)
           
 void setStyle(int style)
           
 void setTypeMapping(TypeMapping tm)
           
 void setWSDLFile(java.lang.String wsdlFileName)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

STYLE_RPC

public static final int STYLE_RPC

STYLE_DOCUMENT

public static final int STYLE_DOCUMENT

STYLE_WRAPPED

public static final int STYLE_WRAPPED

STYLE_MESSAGE

public static final int STYLE_MESSAGE
Constructor Detail

ServiceDesc

public ServiceDesc()
Default constructor
Method Detail

getStyle

public int getStyle()

setStyle

public void setStyle(int style)

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

getWSDLFile

public java.lang.String getWSDLFile()

setWSDLFile

public void setWSDLFile(java.lang.String wsdlFileName)

getAllowedMethods

public java.util.List getAllowedMethods()

setAllowedMethods

public void setAllowedMethods(java.util.List allowedMethods)

getImplClass

public java.lang.Class getImplClass()

setImplClass

public void setImplClass(java.lang.Class implClass)

getTypeMapping

public TypeMapping getTypeMapping()

setTypeMapping

public void setTypeMapping(TypeMapping tm)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getStopClasses

public java.util.ArrayList getStopClasses()

setStopClasses

public void setStopClasses(java.util.ArrayList stopClasses)

getDisallowedMethods

public java.util.List getDisallowedMethods()

setDisallowedMethods

public void setDisallowedMethods(java.util.List disallowedMethods)

addOperationDesc

public void addOperationDesc(OperationDesc operation)

getOperations

public java.util.ArrayList getOperations()

getOperationsByName

public OperationDesc[] getOperationsByName(java.lang.String methodName)

getOperationByName

public OperationDesc getOperationByName(java.lang.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.

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.

getOperationsByQName

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

loadServiceDescByIntrospection

public void loadServiceDescByIntrospection()
Fill in a service description by introspecting the implementation class.

loadServiceDescByIntrospection

public void loadServiceDescByIntrospection(java.lang.Class implClass,
                                           boolean searchParents)
Fill in a service description by introspecting the implementation class.

loadServiceDescByIntrospection

public void loadServiceDescByIntrospection(java.lang.Class cls,
                                           TypeMapping tm)
Fill in a service description by introspecting the implementation class. This version takes the implementation class and the in-scope TypeMapping.

setNamespaceMappings

public void setNamespaceMappings(java.util.List namespaces)

setDefaultNamespace

public void setDefaultNamespace(java.lang.String namespace)


Copyright © 2001 Apache XML Project. All Rights Reserved.