Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> axis >> [ description overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.apache.axis.description
Class OperationDesc  

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

All Implemented Interfaces:

java.io.Serializable

---

public class OperationDesc

extends java.lang.Object

implements java.io.Serializable

An OperationDesc is an abstract description of an operation on a service. !!! WORK IN PROGRESS

---

Field Summary
private  java.lang.String	documentation           The documentation for the operation
private  javax.xml.namespace.QName	elementQName           An XML QName which should dispatch to this method
private  java.util.ArrayList	faults           Faults for this operation
protected static org.apache.commons.logging.Log	log
private  OperationType	mep           The MEP for this Operation - uses the WSDL4J OperationType for now but we might want to have our own extensible enum for WSDL 2.0
static java.util.Map	mepStrings
private  int	messageOperationStyle           If we're a message-style operation, what's our signature?
private  java.lang.reflect.Method	method           The actual Java method associated with this operation, if known
static int	MSG_METHOD_BODYARRAY
static int	MSG_METHOD_DOCUMENT
static int	MSG_METHOD_ELEMENTARRAY
static int	MSG_METHOD_NONCONFORMING
static int	MSG_METHOD_SOAPENVELOPE
private  java.lang.String	name           The operation name (String, or QName?)
private  int	numInParams           The number of "in" params (i.e.
private  int	numOutParams           The number of "out" params (i.e.
private  java.util.ArrayList	parameters           Parameter list
private  ServiceDesc	parent           The service we're a part of
private  ParameterDesc	returnDesc
private  java.lang.String	soapAction           A unique SOAPAction value for this operation
private  org.apache.axis.constants.Style	style           This operation's style/use.
private  org.apache.axis.constants.Use	use

 

Constructor Summary

OperationDesc()           Default constructor.

OperationDesc(java.lang.String name, ParameterDesc[] parameters, javax.xml.namespace.QName returnQName)           "Complete" constructor

 

Method Summary
void	addFault(FaultDesc fault)
void	addParameter(ParameterDesc param)
void	addParameter(javax.xml.namespace.QName paramName, javax.xml.namespace.QName xmlType, java.lang.Class javaType, byte parameterMode, boolean inHeader, boolean outHeader)
java.util.ArrayList	getAllInParams()           Return a list of ALL "in" params (including INOUTs) Note: if we were sure the order went IN->INOUT->OUT, we could optimize this.
java.util.ArrayList	getAllOutParams()           Return a list of ALL "out" params (including INOUTs) Note: if we were sure the order went IN->INOUT->OUT, we could optimize this.
java.lang.String	getDocumentation()           get the documentation for the operation
javax.xml.namespace.QName	getElementQName()
FaultDesc	getFaultByClass(java.lang.Class cls)           Returns the FaultDesc for the fault class given.
FaultDesc	getFaultByClass(java.lang.Class cls, boolean checkParents)           Returns the FaultDesc for the fault class given.
FaultDesc	getFaultByQName(javax.xml.namespace.QName qname)           Returns the FaultDesc for a QName (which is typically found in the details element of a SOAP fault).
FaultDesc	getFaultByXmlType(javax.xml.namespace.QName xmlType)           Returns the FaultDesc for an XMLType.
java.util.ArrayList	getFaults()
ParameterDesc	getInputParamByQName(javax.xml.namespace.QName qname)
OperationType	getMep()
int	getMessageOperationStyle()
java.lang.reflect.Method	getMethod()
java.lang.String	getName()           Return the operation's name
int	getNumInParams()
int	getNumOutParams()
int	getNumParams()
java.util.ArrayList	getOutParams()           Returns an ordered list of out params (NOT inouts)
ParameterDesc	getOutputParamByQName(javax.xml.namespace.QName qname)
ParameterDesc	getParamByQName(javax.xml.namespace.QName qname)
ParameterDesc	getParameter(int i)
java.util.ArrayList	getParameters()
ServiceDesc	getParent()
java.lang.Class	getReturnClass()
ParameterDesc	getReturnParamDesc()
javax.xml.namespace.QName	getReturnQName()
javax.xml.namespace.QName	getReturnType()
java.lang.String	getSoapAction()
org.apache.axis.constants.Style	getStyle()           Return the style of the operation, defaulting to the parent ServiceDesc's style if we don't have one explicitly set.
org.apache.axis.constants.Use	getUse()           Return the use of the operation, defaulting to the parent ServiceDesc's use if we don't have one explicitly set.
boolean	isReturnHeader()           Is the return value in the header of the response message?
private  void	readObject(java.io.ObjectInputStream in)
void	setDocumentation(java.lang.String documentation)           set the documentation for the operation
void	setElementQName(javax.xml.namespace.QName elementQName)
void	setMep(OperationType mep)
void	setMessageOperationStyle(int messageOperationStyle)
void	setMethod(java.lang.reflect.Method method)
void	setName(java.lang.String name)           Set the operation's name
void	setParameters(java.util.ArrayList newParameters)           Set the parameters wholesale.
void	setParent(ServiceDesc parent)
void	setReturnClass(java.lang.Class returnClass)
void	setReturnHeader(boolean value)           Set whether the return value is in the response message.
void	setReturnQName(javax.xml.namespace.QName returnQName)
void	setReturnType(javax.xml.namespace.QName returnType)
void	setSoapAction(java.lang.String soapAction)
void	setStyle(org.apache.axis.constants.Style style)
void	setUse(org.apache.axis.constants.Use use)
java.lang.String	toString()           Convert this Object to a human-readable String.
java.lang.String	toString(java.lang.String indent)
private  void	writeObject(java.io.ObjectOutputStream out)

 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Field Detail

MSG_METHOD_BODYARRAY

public static final int MSG_METHOD_BODYARRAY

See Also:

Constant Field Values

---

MSG_METHOD_SOAPENVELOPE

public static final int MSG_METHOD_SOAPENVELOPE

See Also:

Constant Field Values

---

MSG_METHOD_ELEMENTARRAY

public static final int MSG_METHOD_ELEMENTARRAY

See Also:

Constant Field Values

---

MSG_METHOD_DOCUMENT

public static final int MSG_METHOD_DOCUMENT

See Also:

Constant Field Values

---

MSG_METHOD_NONCONFORMING

public static final int MSG_METHOD_NONCONFORMING

See Also:

Constant Field Values

---

mepStrings

public static java.util.Map mepStrings

---

log

protected static org.apache.commons.logging.Log log

---

parent

private ServiceDesc parent

The service we're a part of

---

parameters

private java.util.ArrayList parameters

Parameter list

---

name

private java.lang.String name

The operation name (String, or QName?)

---

elementQName

private javax.xml.namespace.QName elementQName

An XML QName which should dispatch to this method

---

method

private transient java.lang.reflect.Method method

The actual Java method associated with this operation, if known

---

style

private org.apache.axis.constants.Style style

This operation's style/use. If null, we default to our parent's

---

use

private org.apache.axis.constants.Use use

---

numInParams

private int numInParams

The number of "in" params (i.e. IN or INOUT) for this operation

---

numOutParams

private int numOutParams

The number of "out" params (i.e. OUT or INOUT) for this operation

---

soapAction

private java.lang.String soapAction

A unique SOAPAction value for this operation

---

faults

private java.util.ArrayList faults

Faults for this operation

---

returnDesc

private ParameterDesc returnDesc

---

messageOperationStyle

private int messageOperationStyle

If we're a message-style operation, what's our signature?

---

documentation

private java.lang.String documentation

The documentation for the operation

---

mep

private OperationType mep

The MEP for this Operation - uses the WSDL4J OperationType for now but we might want to have our own extensible enum for WSDL 2.0

Constructor Detail

OperationDesc

public OperationDesc()

Default constructor.

---

OperationDesc

public OperationDesc(java.lang.String name,
                     ParameterDesc[] parameters,
                     javax.xml.namespace.QName returnQName)

"Complete" constructor

Method Detail

getName

public java.lang.String getName()

Return the operation's name

---

setName

public void setName(java.lang.String name)

Set the operation's name

---

getDocumentation

public java.lang.String getDocumentation()

get the documentation for the operation

---

setDocumentation

public void setDocumentation(java.lang.String documentation)

set the documentation for the operation

---

getReturnQName

public javax.xml.namespace.QName getReturnQName()

---

setReturnQName

public void setReturnQName(javax.xml.namespace.QName returnQName)

---

getReturnType

public javax.xml.namespace.QName getReturnType()

---

setReturnType

public void setReturnType(javax.xml.namespace.QName returnType)

---

getReturnClass

public java.lang.Class getReturnClass()

---

setReturnClass

public void setReturnClass(java.lang.Class returnClass)

---

getElementQName

public javax.xml.namespace.QName getElementQName()

---

setElementQName

public void setElementQName(javax.xml.namespace.QName elementQName)

---

getParent

public ServiceDesc getParent()

---

setParent

public void setParent(ServiceDesc parent)

---

getSoapAction

public java.lang.String getSoapAction()

---

setSoapAction

public void setSoapAction(java.lang.String soapAction)

---

setStyle

public void setStyle(org.apache.axis.constants.Style style)

---

getStyle

public org.apache.axis.constants.Style getStyle()

Return the style of the operation, defaulting to the parent ServiceDesc's style if we don't have one explicitly set.

---

setUse

public void setUse(org.apache.axis.constants.Use use)

---

getUse

public org.apache.axis.constants.Use getUse()

Return the use of the operation, defaulting to the parent ServiceDesc's use if we don't have one explicitly set.

---

addParameter

public void addParameter(ParameterDesc param)

---

addParameter

public void addParameter(javax.xml.namespace.QName paramName,
                         javax.xml.namespace.QName xmlType,
                         java.lang.Class javaType,
                         byte parameterMode,
                         boolean inHeader,
                         boolean outHeader)

---

getParameter

public ParameterDesc getParameter(int i)

---

getParameters

public java.util.ArrayList getParameters()

---

setParameters

public void setParameters(java.util.ArrayList newParameters)

Set the parameters wholesale.

---

getNumInParams

public int getNumInParams()

---

getNumOutParams

public int getNumOutParams()

---

getNumParams

public int getNumParams()

---

getMethod

public java.lang.reflect.Method getMethod()

---

setMethod

public void setMethod(java.lang.reflect.Method method)

---

isReturnHeader

public boolean isReturnHeader()

Is the return value in the header of the response message?

---

setReturnHeader

public void setReturnHeader(boolean value)

Set whether the return value is in the response message.

---

getParamByQName

public ParameterDesc getParamByQName(javax.xml.namespace.QName qname)

---

getInputParamByQName

public ParameterDesc getInputParamByQName(javax.xml.namespace.QName qname)

---

getOutputParamByQName

public ParameterDesc getOutputParamByQName(javax.xml.namespace.QName qname)

---

getAllInParams

public java.util.ArrayList getAllInParams()

Return a list of ALL "in" params (including INOUTs) Note: if we were sure the order went IN->INOUT->OUT, we could optimize this.

---

getAllOutParams

public java.util.ArrayList getAllOutParams()

Return a list of ALL "out" params (including INOUTs) Note: if we were sure the order went IN->INOUT->OUT, we could optimize this.

---

getOutParams

public java.util.ArrayList getOutParams()

Returns an ordered list of out params (NOT inouts)

---

addFault

public void addFault(FaultDesc fault)

---

getFaults

public java.util.ArrayList getFaults()

---

getFaultByClass

public FaultDesc getFaultByClass(java.lang.Class cls)

Returns the FaultDesc for the fault class given. Returns null if not found.

---

getFaultByClass

public FaultDesc getFaultByClass(java.lang.Class cls,
                                 boolean checkParents)

Returns the FaultDesc for the fault class given. Returns null if not found.

---

getFaultByQName

public FaultDesc getFaultByQName(javax.xml.namespace.QName qname)

Returns the FaultDesc for a QName (which is typically found in the details element of a SOAP fault). Returns null if not found.

---

getFaultByXmlType

public FaultDesc getFaultByXmlType(javax.xml.namespace.QName xmlType)

Returns the FaultDesc for an XMLType. Returns null if not found.

---

getReturnParamDesc

public ParameterDesc getReturnParamDesc()

---

toString

public java.lang.String toString()

Description copied from class: java.lang.Object

Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() 55 and such.

It is typical, but not required, to ensure that this method never completes abruptly with a java.lang.RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).

---

toString

public java.lang.String toString(java.lang.String indent)

---

getMessageOperationStyle

public int getMessageOperationStyle()

---

setMessageOperationStyle

public void setMessageOperationStyle(int messageOperationStyle)

---

getMep

public OperationType getMep()

---

setMep

public void setMep(OperationType mep)

---

writeObject

private void writeObject(java.io.ObjectOutputStream out)
                  throws java.io.IOException

---

readObject

private void readObject(java.io.ObjectInputStream in)
                 throws java.io.IOException,
                        java.lang.ClassNotFoundException

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> axis >> [ description overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---