org.idoox.wasp.wsdl
Class SOAPMethodInfo

java.lang.Object
  org.idoox.wasp.wsdl.SOAPMethodInfo

All Implemented Interfaces:

java.io.Serializable

public class SOAPMethodInfo

extends java.lang.Object

implements java.io.Serializable

This class contains information about java method from the view of soap message. It is used for compiling wsdl into java code and serialization/deserialization.

Since:

4.0

See Also:

Serialized Form

Component:

Core

Nested Class Summary

static class	SOAPMethodInfo.FaultPartInfo Represents fault of the operation - information about one fault part.
static class	SOAPMethodInfo.FaultPartInfos This class represents container for information about faults of an operation.
static class	SOAPMethodInfo.PartInfo This class contains information about one WSDL part.
static class	SOAPMethodInfo.RequiredElements

Field Summary

boolean	containsRequestAttachment if request contains message attachment (there is a MIME attachment part or it is marked as dime:message)
boolean	containsResponseAttachment if the response can contain an attachment (there is a MIME attachment part or it is marked as dime:message)
static int	DIR_IN incoming part
static int	DIR_INOUT in/out part
static int	DIR_OUT outgoing part
java.lang.String	documentation documentation
com.idoox.soap.EnvelopeOutCache	envelopeOutCache undocumented
com.idoox.soap.EnvelopeOutCache	envelopeOutCache1
SOAPMethodInfo.FaultPartInfos	faultsInfo This field contains information about faults of an operation.
SOAPMethodInfo.PartInfo[]	headerParts all header parts
java.lang.String	httpLocationURI In the case of HTTP GET binding, the value of "location URI".
QName	httpUriEncoding In the case of HTTP GET binding say the HTTP URI encoding.
java.lang.String	inputName the name of 'input'
QName	inWrapperQName Name of the wrapper element referenced from input message when the binding style is "document-wrapped".
java.lang.String[]	javaExceptions Deprecated. use faultsInfo instead
java.lang.String	javaMethodName
java.lang.String[]	nonJavaFaults Deprecated. use faultsInfo instead
static int	OPERATION_NOTIFICATION
static int	OPERATION_ONEWAY
static int	OPERATION_REQUEST_RESPONSE
static int	OPERATION_SOLICIT_RESPONSE
java.lang.String	operationName the name of the operation
int	operationType one of the OPERATION_XXXX constants.
java.lang.String	outputName the name of 'output'
QName	outWrapperQName Name of the wrapper element referenced from output message when the binding style is "document-wrapped".
SOAPMethodInfo.PartInfo[]	parts all parts except for the "return value" and header parts
boolean	requestContainsBase64Element if the request contains base64Binary element definition in schema
java.lang.String	requestMessageEncodingURI encoding of the request message
QName	requestName name of the request message
boolean	responseContainsBase64Element if the response contains base64Binary element definition in schema
java.lang.String	responseMessageEncodingURI encoding of the response message
QName	responseName name of the response message
SOAPMethodInfo.PartInfo	returnValuePart the return part
boolean	rpcOperation true if the operation is RPC
java.lang.Boolean	schemaSettedUp
java.lang.String	signature the signature of the java method, as given from the mapping contained in the wsdl file.
java.lang.String	soapAction the soap action for the method
boolean	useDime if method uses DIME encapsulation (there is a dime input or output message)
boolean	useHrefInBody Applies to MIME attachments (all in the operation).

Constructor Summary

SOAPMethodInfo()

Method Summary

void	addFault(java.lang.String faultName, java.lang.String javaType)
void	dump(com.idoox.debug.IndentCategory cat)
void	fillFaultPartInfos(BindingOperation operation, Schema schema) Fills faultsInfo with information from WSDL.
SOAPMethodInfo.RequiredElements	getRequiredInElements()
SOAPMethodInfo.RequiredElements	getRequiredOutElements()
boolean	isSchemaCorrect()
boolean	isVoid()
void	setCorrectSchema(Schema schema)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DIR_IN

public static final int DIR_IN

incoming part

See Also:

Constant Field Values

DIR_OUT

public static final int DIR_OUT

outgoing part

See Also:

Constant Field Values

DIR_INOUT

public static final int DIR_INOUT

in/out part

See Also:

Constant Field Values

parts

public SOAPMethodInfo.PartInfo[] parts

all parts except for the "return value" and header parts

schemaSettedUp

public java.lang.Boolean schemaSettedUp

headerParts

public SOAPMethodInfo.PartInfo[] headerParts

all header parts

containsRequestAttachment

public boolean containsRequestAttachment

if request contains message attachment (there is a MIME attachment part or it is marked as dime:message)

containsResponseAttachment

public boolean containsResponseAttachment

if the response can contain an attachment (there is a MIME attachment part or it is marked as dime:message)

requestContainsBase64Element

public boolean requestContainsBase64Element

if the request contains base64Binary element definition in schema

responseContainsBase64Element

public boolean responseContainsBase64Element

if the response contains base64Binary element definition in schema

useDime

public boolean useDime

if method uses DIME encapsulation (there is a dime input or output message)

useHrefInBody

public boolean useHrefInBody

Applies to MIME attachments (all in the operation). true = backward compatible href attachment, false = WS-I AP 1.0 attachment referenced via part name in MIME part's Content-Id

soapAction

public java.lang.String soapAction

the soap action for the method

rpcOperation

public boolean rpcOperation

true if the operation is RPC

documentation

public java.lang.String documentation

documentation

requestMessageEncodingURI

public java.lang.String requestMessageEncodingURI

encoding of the request message

requestName

public QName requestName

name of the request message

responseMessageEncodingURI

public java.lang.String responseMessageEncodingURI

encoding of the response message

responseName

public QName responseName

name of the response message

operationName

public java.lang.String operationName

the name of the operation

inputName

public java.lang.String inputName

the name of 'input'

outputName

public java.lang.String outputName

the name of 'output'

returnValuePart

public SOAPMethodInfo.PartInfo returnValuePart

the return part

OPERATION_REQUEST_RESPONSE

public static final int OPERATION_REQUEST_RESPONSE

See Also:

Constant Field Values

OPERATION_ONEWAY

public static final int OPERATION_ONEWAY

See Also:

Constant Field Values

OPERATION_SOLICIT_RESPONSE

public static final int OPERATION_SOLICIT_RESPONSE

See Also:

Constant Field Values

OPERATION_NOTIFICATION

public static final int OPERATION_NOTIFICATION

See Also:

Constant Field Values

operationType

public int operationType

one of the OPERATION_XXXX constants.

envelopeOutCache

public com.idoox.soap.EnvelopeOutCache envelopeOutCache

undocumented

envelopeOutCache1

public com.idoox.soap.EnvelopeOutCache envelopeOutCache1

signature

public java.lang.String signature

the signature of the java method, as given from the mapping contained in the wsdl file.

javaMethodName

public java.lang.String javaMethodName

javaExceptions

public java.lang.String[] javaExceptions

Deprecated. use faultsInfo instead

nonJavaFaults

public java.lang.String[] nonJavaFaults

Deprecated. use faultsInfo instead

httpLocationURI

public java.lang.String httpLocationURI

In the case of HTTP GET binding, the value of "location URI". For <http:operation location="/foo" /> the value is "/foo".

httpUriEncoding

public QName httpUriEncoding

In the case of HTTP GET binding say the HTTP URI encoding. Either http:urlEncoded ExtensibilityElement.getElementType() or http:urlReplacement ExtensibilityElement.getElementType()

inWrapperQName

public QName inWrapperQName

Name of the wrapper element referenced from input message when the binding style is "document-wrapped". Otherwise is null.

outWrapperQName

public QName outWrapperQName

Name of the wrapper element referenced from output message when the binding style is "document-wrapped".

faultsInfo

public SOAPMethodInfo.FaultPartInfos faultsInfo

This field contains information about faults of an operation.

Constructor Detail

SOAPMethodInfo

public SOAPMethodInfo()

Method Detail

toString

public java.lang.String toString()

isSchemaCorrect

public boolean isSchemaCorrect()

setCorrectSchema

public void setCorrectSchema(Schema schema)
                      throws SchemaException

Throws:

SchemaException

addFault

public void addFault(java.lang.String faultName,
                     java.lang.String javaType)

dump

public void dump(com.idoox.debug.IndentCategory cat)

isVoid

public boolean isVoid()

Returns:

true if void - no return and no out or in/out part

fillFaultPartInfos

public void fillFaultPartInfos(BindingOperation operation,
                               Schema schema)
                        throws WSDLException,
                               SchemaException

Fills faultsInfo with information from WSDL.

Parameters:

operation - WSDLs operation in binding

schema - schema that contains types and elements referenced from WSDL

Throws:

WSDLException - if there is a problem in reading WSDL

SchemaException - if manipulation with supplied schema causes exception

getRequiredInElements

public SOAPMethodInfo.RequiredElements getRequiredInElements()

getRequiredOutElements

public SOAPMethodInfo.RequiredElements getRequiredOutElements()