|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ProxyHandler
ProxyHandler defines the methods needed to serialize and deserialize the
parameters an responses when making a remote web services invocation. The
interface requires details about the target web service operation, all of
which can be found in the service's WSDL. This information will allow the
handler to construct appropriate SOAP messages after serializing request
parameters.
This interface is used for sending outgoing messages on the
client-side. Receiving web service requests is handled by
MessageHandler.
Method Summary | |
---|---|
Object |
fromXML(Element xml)
Deserializes the given DOM Element into a POJO that can be returned to the invoker of the web service operation. |
String |
getAction()
|
QName |
getRequestName()
|
QName[] |
getRequestParameterNames()
|
QName[] |
getRequestParameterSchemaTypes()
|
Class[] |
getRequestParameterTypes()
|
QName |
getResponseName()
|
QName |
getReturnSchemaType()
|
Class |
getReturnType()
|
void |
setAction(String action)
|
void |
setRequestName(QName requestName)
|
void |
setRequestParameterNames(QName[] parameterNames)
|
void |
setRequestParameterSchemaTypes(QName[] parameterTypes)
This is an optional method. |
void |
setRequestParameterTypes(Class[] parameterTypes)
This is an optional method. |
void |
setResponseName(QName responseName)
|
void |
setReturnSchemaType(QName returnType)
|
void |
setReturnType(Class returnType)
|
Element |
toXML(Object[] parameters)
Serializes the given objects into a DOM Element that can used in a request SOAP Body. |
Method Detail |
---|
Object fromXML(Element xml) throws SoapFault
xml
- The contents of the response SOAP Body, where the root element
contains either a simple value or a single child element that
defines a complex type. Multiple return values will not be
parsed - they must be part of a single data structure.
SoapFault
- getReturnType()
,
Serializer.fromXML(Element)
String getAction()
QName getRequestName()
QName[] getRequestParameterNames()
QName[] getRequestParameterSchemaTypes()
Class[] getRequestParameterTypes()
QName getResponseName()
QName getReturnSchemaType()
Class getReturnType()
void setAction(String action)
action
- The WS-Addressing Action URI for the target operation. This
cannot be null.void setRequestName(QName requestName)
requestName
- The QName of the SOAP request element that deserializable
DOM Elements will be wrapped in.void setRequestParameterNames(QName[] parameterNames)
parameterNames
- The QNames for the individual parameters in the SOAP request
message, in the order they are defined by the target operation.
These are defined in the type (schema) definition of the WSDL
input message. This array cannot be null, but it can be empty.void setRequestParameterSchemaTypes(QName[] parameterTypes)
parameterTypes
- The XSD types that define the operation's parameters.void setRequestParameterTypes(Class[] parameterTypes)
parameterTypes
- The Java types that are expected by the serialization
framework for each of the operation's parameters.void setResponseName(QName responseName)
responseName
- The QName of the SOAP response element that deserializable
DOM Elements will be wrapped in.void setReturnSchemaType(QName returnType)
returnType
- The XSD type that defines the response value. If the operation
has no response value, the parameter should be null (as
opposed to xsd:any).void setReturnType(Class returnType)
returnType
- The type to which the response value should be deserialized.
If the operation has no response value, the parameter can be
null or Void.TYPE (null will be translated as Void.TYPE).Element toXML(Object[] parameters) throws SoapFault
parameters
- The parameters for the operation, which must be serialized
into XML.
SoapFault
- getRequestName()
,
getRequestParameterNames()
,
Serializer.toXML(Object, QName)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |