Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.axis.description
Class ServiceDesc

    java.lang.Object
      org.apache.axis.description.ServiceDesc

public class ServiceDesc
extends 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)

Constructor Summary
`ServiceDesc()` Default constructor

Method Summary
`void` | `addOperationDesc(OperationDesc operation)`
`List` | `getAllowedMethods()`
`String` | `getDefaultNamespace()`
`List` | `getDisallowedMethods()`
`String` | `getEndpointURL()`
`Class` | `getImplClass()`
`String` | `getName()` the name of the service
`OperationDesc` | `getOperationByElementQName(javax.xml.namespace.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(javax.xml.namespace.QName qname)` Return all operations which match this QName (i.e.
`Object` | `getProperty(String name)`
`ArrayList` | `getStopClasses()`
`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` | `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(Class implClass)` Fill in a service description by introspecting the implementation class.
`void` | `loadServiceDescByIntrospection(Class cls, TypeMapping tm)` Fill in a service description by introspecting the implementation class.
`void` | `setAllowedMethods(List allowedMethods)`
`void` | `setDefaultNamespace(String namespace)`
`void` | `setDisallowedMethods(List disallowedMethods)`
`void` | `setEndpointURL(String endpointURL)`
`void` | `setImplClass(Class implClass)` set the implementation class Warning: You cannot call getInitializedServiceDesc() after setting this as it uses this to indicate its work has already been done.
`void` | `setName(String name)` the name of the service
`void` | `setNamespaceMappings(List namespaces)`
`void` | `setProperty(String name, Object value)`
`void` | `setStopClasses(ArrayList stopClasses)`
`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.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### ServiceDesc

    public ServiceDesc()

  Default constructor

Method Detail

### getStyle

    public Style getStyle()

  What kind of service is this?

  Returns:

### setStyle

    public void setStyle(Style style)

### getUse

    public Use getUse()

  What kind of use is this?

  Returns:

### setUse

    public void setUse(Use use)

### 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 String getWSDLFile()

  the wsdl file of the service. When null, it means that the wsdl should be autogenerated

  Returns:
    filename or null

### 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

### getAllowedMethods

    public List getAllowedMethods()

### setAllowedMethods

    public void setAllowedMethods(List allowedMethods)

### getImplClass

    public Class getImplClass()

### setImplClass

    public void setImplClass(Class implClass)

  set the implementation class

  Warning: 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

    public TypeMapping getTypeMapping()

### setTypeMapping

    public void setTypeMapping(TypeMapping tm)

### getName

    public String getName()

  the name of the service

### setName

    public void setName(String name)

  the name of the service

  Parameters:
    `name` -

### getStopClasses

    public ArrayList getStopClasses()

### setStopClasses

    public void setStopClasses(ArrayList stopClasses)

### getDisallowedMethods

    public List getDisallowedMethods()

### setDisallowedMethods

    public void setDisallowedMethods(List disallowedMethods)

### addOperationDesc

    public void addOperationDesc(OperationDesc operation)

### 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

### 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

### getOperationByElementQName

    public OperationDesc getOperationByElementQName(javax.xml.namespace.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

### getOperationsByQName

    public OperationDesc[] getOperationsByQName(javax.xml.namespace.QName qname)

  Return all operations which match this QName (i.e. get all the overloads)

  Returns:
    null for no match

### loadServiceDescByIntrospection

    public void loadServiceDescByIntrospection()

  Fill in a service description by introspecting the implementation class.

### loadServiceDescByIntrospection

    public void loadServiceDescByIntrospection(Class implClass)

  Fill in a service description by introspecting the implementation class.

### loadServiceDescByIntrospection

    public void loadServiceDescByIntrospection(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(List namespaces)

### getDefaultNamespace

    public String getDefaultNamespace()

### setDefaultNamespace

    public void setDefaultNamespace(String namespace)

### setProperty

    public void setProperty(String name,
                            Object value)

### getProperty

    public Object getProperty(String name)

### getEndpointURL

    public String getEndpointURL()

### setEndpointURL

    public void setEndpointURL(String endpointURL)

### getTypeMappingRegistry

    public TypeMappingRegistry getTypeMappingRegistry()

### setTypeMappingRegistry

    public void setTypeMappingRegistry(TypeMappingRegistry tmr)

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2002 JBoss Group, LLC. All Rights Reserved.