Interface MethodMarshaller
-
- All Known Implementing Classes:
DocLitBareMethodMarshaller
,DocLitBareMinimalMethodMarshaller
,DocLitWrappedMethodMarshaller
,DocLitWrappedMinimalMethodMarshaller
,DocLitWrappedPlusMethodMarshaller
,RPCLitMethodMarshaller
public interface MethodMarshaller
This class marshals and unmarshals method invocations. Here is the high-level view of marshalling: SIGNATURE_ARGS ---> Type Enabled Object -----> Element Enabled Object ---> MESSAGE (XML) The Signature objects are the objects from the SEI method signature. They may be values or holders of values. The values are "type enabled objects" (i.e. String), which means that they cannot be marshalled or unmarshalled.- See Also:
for details on Type Enabled and Element Enabled objects. The values are enhanced (if necessary) into Element Enabled Objects. These can be marshalled or unmarshalled using JAXB.
,The element enabled objects are put onto the message. The high-level view of unmarshalling is the reverse. SIGNATURE_ARGS ---- Type Enabled Object ----- Element Enabled Object ---- MESSAGE (XML) See the specific MethodMarshaller implementations to see how doc/lit wrapped, doc/lit bare and rpc/lit affect the process of going from SIGNATURE_ARGS to the element enabled objects. If there are any problems, a WebServiceException is thrown. (Each of the methods is guranteed to catch any unchecked exception and wrap it in a WebServiceException).
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Throwable
demarshalFaultResponse(Message message, OperationDescription opDesc)
This method converts a Message (containing a fault) into a JAX-WS Service or WebServiceException.Object[]
demarshalRequest(Message message, OperationDescription opDesc)
This method converts the Message into a SIGNATURE_ARGS It is used on the serverObject
demarshalResponse(Message message, Object[] signatureArgs, OperationDescription opDesc)
This method gets the objects from the Message and sets them onto the SIGNATURE_ARGS It also returns the RETURN object.Message
marshalFaultResponse(Throwable throwable, OperationDescription opDesc, Protocol protocol)
This method creates a Message from a Throwable input parameter.Message
marshalRequest(Object[] signatureArgs, OperationDescription opDesc, Map<String,Object> requestContext)
This method converts SIGNATURE_ARGS into a Message.Message
marshalResponse(Object returnObject, Object[] signatureArgs, OperationDescription opDesc, Protocol protocol)
This method converts the SIGNATURE_ARGS and RETURN object into a Message.
-
-
-
Method Detail
-
marshalRequest
Message marshalRequest(Object[] signatureArgs, OperationDescription opDesc, Map<String,Object> requestContext) throws WebServiceException
This method converts SIGNATURE_ARGS into a Message. It is used on the client- Parameters:
signatureArgs
-opDesc
-requestContext
-- Returns:
- Message
- Throws:
WebServiceException
-
marshalResponse
Message marshalResponse(Object returnObject, Object[] signatureArgs, OperationDescription opDesc, Protocol protocol) throws WebServiceException
This method converts the SIGNATURE_ARGS and RETURN object into a Message. It is used on the server- Parameters:
returnObject
-signatureArgs
-OperationDesc
-Protocol
- for response- Returns:
- Message
- Throws:
WebServiceException
-
demarshalRequest
Object[] demarshalRequest(Message message, OperationDescription opDesc) throws WebServiceException
This method converts the Message into a SIGNATURE_ARGS It is used on the server- Parameters:
message
-- Returns:
- signature args
- Throws:
WebServiceException
-
demarshalResponse
Object demarshalResponse(Message message, Object[] signatureArgs, OperationDescription opDesc) throws WebServiceException
This method gets the objects from the Message and sets them onto the SIGNATURE_ARGS It also returns the RETURN object. Called on client- Parameters:
message
-signatureAgs
- (same array of args that were used for marshalRequest. The out/inout holders are populated with new values)OperationDesc
-- Returns:
- returnObject
- Throws:
WebServiceException
-
demarshalFaultResponse
Throwable demarshalFaultResponse(Message message, OperationDescription opDesc) throws WebServiceException
This method converts a Message (containing a fault) into a JAX-WS Service or WebServiceException. Used on the client.- Parameters:
message
-Message
-- Returns:
- Throwable
- Throws:
WebServiceException
-
marshalFaultResponse
Message marshalFaultResponse(Throwable throwable, OperationDescription opDesc, Protocol protocol) throws WebServiceException
This method creates a Message from a Throwable input parameter. Used on the server.- Parameters:
Throwable
-OperationDesc
-Protocol
- for response- Returns:
- Throws:
WebServiceException
-
-