Examples of com.sun.xml.ws.api.message.Message

com.sun.xml.ws.api.message.Message
Represents a SOAP message.
What is a message?

A {@link Message} consists of the following:
1. Random-accessible list of headers. a header is a representation of an element inside <soap:Header>. It can be read multiple times, can be added or removed, but it is not modifiable. See {@link HeaderList} for more about headers.
2. The payload of the message, which is a representation of an element inside <soap:Body>. the payload is streamed, and therefore it can be only read once (or can be only written to something once.) once a payload is used, a message is said to be consumed. A message {@link #hasPayload() may not have any payload.}
3. Attachments. TODO: can attachments be streamed? I suspect so. does anyone need to read attachment twice?
How does this abstraction work?

The basic idea behind the {@link Message} is to hide the actualdata representation. For example, a {@link Message} might beconstructed on top of an {@link InputStream} from the accepted HTTP connection,or it might be constructed on top of a JAXB object as a result of the method invocation through {@link Proxy}. There will be a {@link Message} implementation for each of those cases.
This interface provides a lot of methods that access the payload in many different forms, and implementations can implement those methods in the best possible way.
A particular attention is paid to make sure that a {@link Message}object can be constructed on a stream that is not fully read yet. We believe this improves the turn-around time on the server side.
It is often useful to wrap a {@link Message} into another {@link Message}, for example to encrypt the body, or to verify the signature as the body is read.
This representation is also used for a REST-ful XML message. In such case we'll construct a {@link Message} with emptyattachments and headers, and when serializing all headers and attachments will be ignored.
Message and XOP

XOP is considered as an {@link Codec}, and therefore when you are looking at {@link Message}, you'll never see <xop:Include> or any such elements (instead you'll see the base64 data inlined.) If a consumer of infoset isn't interested in handling XOP by himself, this allows him to work with XOP correctly even without noticing it.
For producers and consumers that are interested in accessing the binary data more efficiently, they can use {@link XMLStreamReaderEx} and{@link XMLStreamWriterEx}.
Message lifespan

Often {@link Packet} include information local to a particularinvocaion (such as {@code HttpServletRequest}, from this angle, it makes sense to tie a lifespan of a message to one pipeline invocation.
On the other hand, if you think about WS-RM, it often needs to hold on to a message longer than a pipeline invocation (you might get an HTTP request, get a message X, get a second HTTP request, get another message Y, and only then you might want to process X.)
TODO: what do we do about this?
```
 TODO: can body element have foreign attributes? maybe ID for security? Yes, when the SOAP body is signed there will be an ID attribute present But in this case any security based impl may need access to the concrete representation. TODO: HTTP headers? Yes. Abstracted as transport-based properties. TODO: who handles SOAP 1.1 and SOAP 1.2 difference? As separate channel implementations responsible for the creation of the message? TODO: session? TODO: Do we need to expose SOAPMessage explicitly? SOAPMessage could be the concrete representation but is it necessary to transform between different concrete representations? Perhaps this comes down to how use channels for creation and processing. TODO: Do we need to distinguish better between creation and processing? Do we really need the requirement that a created message can be resused for processing. Shall we bifurcate? TODO: SOAP version issue SOAP version is determined by the context, so message itself doesn't carry it around (?) TODO: wrapping message needs easier. in particular properties and attachments. 
```
@author Kohsuke Kawaguchi


        //Don't fill the stacktrace for Service specific exceptions.
        if(ce == null) {
            soap12Fault.captureStackTrace(e);
        }
        Message msg = JAXBMessage.create(JAXB_CONTEXT, soap12Fault, soapVersion);
        return new FaultMessage(msg, firstEntry);
    }

View Full Code Here

            // WS-A fault processing for one-way methods
            if ((wsdlPort !=null)  && packet.getMessage().isOneWay(wsdlPort)) {
                return packet.createServerResponse(null, wsdlPort, null, binding);
            }


            Message m = Messages.create(soapFault);
            if (soapVersion == SOAPVersion.SOAP_11) {
                m.getHeaders().add(s11FaultDetailHeader);
            }


            return packet.createServerResponse(m, wsdlPort, null,  binding);
        }

View Full Code Here


    /**
     * Creates {@link Message} from method invocation's return value
     */
    protected Packet getResponse(Packet request, Exception e, WSDLPort port, WSBinding binding) {
        Message message = getResponseMessage(e);
        Packet response = request.createServerResponse(message,port,null,binding);
        return response;
    }

View Full Code Here


    /**
     * Creates {@link Packet} from method invocation's return value
     */
    protected Packet getResponse(Packet request, @Nullable T returnValue, WSDLPort port, WSBinding binding) {
        Message message = null;
        if (returnValue != null) {
            message = getResponseMessage(returnValue);
        }
        Packet response = request.createServerResponse(message,port,null,binding);
        return response;

View Full Code Here

     * <li>WS-Addressing is required and no headers are found in the {@link Message}</li>
     * <li>an uknown WS-Addressing header is present</li>
     * </ul>
     */
    protected void checkCardinality(Packet packet) {
        Message message = packet.getMessage();
        if (message == null) {
            if (addressingRequired)
                throw new WebServiceException(AddressingMessages.NULL_MESSAGE());
            else
                return;
        }


        Iterator<Header> hIter = message.getHeaders().getHeaders(addressingVersion.nsUri, true);


        if (!hIter.hasNext()) {
            // no WS-A headers are found
            if (addressingRequired)
                // if WS-A is required, then throw an exception looking for wsa:Action header

View Full Code Here

        return new WsaServerTube(this, cloner);
    }


    @Override
    public @NotNull NextAction processRequest(Packet request) {
        Message msg = request.getMessage();
        if(msg==null)   return doInvoke(next,request); // hmm?


        // expose bunch of addressing related properties for advanced applications 
        request.addSatellite(new WsaPropertyBag(addressingVersion,soapVersion,request));


        // Store request ReplyTo and FaultTo in requestPacket.invocationProperties
        // so that they can be used after responsePacket is received.
        // These properties are used if a fault is thrown from the subsequent Pipe/Tubes.


        HeaderList hl = request.getMessage().getHeaders();
        try {
            replyTo = hl.getReplyTo(addressingVersion, soapVersion);
            faultTo = hl.getFaultTo(addressingVersion, soapVersion);
        } catch (InvalidAddressingHeaderException e) {
            LOGGER.log(Level.WARNING,
                    addressingVersion.getInvalidMapText()+", Problem header:" + e.getProblemHeader()+ ", Reason: "+ e.getSubsubcode(),e);
            SOAPFault soapFault = helper.createInvalidAddressingHeaderFault(e, addressingVersion);
            // WS-A fault processing for one-way methods
            if ((wsdlPort!=null) && request.getMessage().isOneWay(wsdlPort)) {
                Packet response = request.createServerResponse(null, wsdlPort, null, binding);
                return doReturnWith(response);
            }


            Message m = Messages.create(soapFault);
            if (soapVersion == SOAPVersion.SOAP_11) {
                FaultDetailHeader s11FaultDetailHeader = new FaultDetailHeader(addressingVersion, addressingVersion.problemHeaderQNameTag.getLocalPart(), e.getProblemHeader());
                m.getHeaders().add(s11FaultDetailHeader);
            }


            Packet response = request.createServerResponse(m, wsdlPort, null, binding);
            return doReturnWith(response);
        }

View Full Code Here

        //this requirement can only be specified in W3C case, Override this in W3C case.
    }


    @Override
    public @NotNull NextAction processResponse(Packet response) {
        Message msg = response.getMessage();
        if (msg ==null)
            return doReturnWith(response);  // one way message. Nothing to see here. Move on.


        WSEndpointReference target = msg.isFault()?faultTo:replyTo;


        if(target.isAnonymous() || isAnonymousRequired )
            // the response will go back the back channel. most common case
            return doReturnWith(response);

View Full Code Here

    public ContentType getStaticContentType(Packet packet) {
        return _contentType;
    }
    
    public ContentType encode(Packet packet, OutputStream out) {
        Message message = packet.getMessage();
        if (message != null && message.hasPayload()) {
            final XMLStreamWriter writer = getXMLStreamWriter(out);
            try {
                writer.writeStartDocument();
                packet.getMessage().writePayloadTo(writer);
                writer.writeEndDocument();

View Full Code Here

    }
    
    public void decode(InputStream in, String contentType, Packet packet) throws IOException {
        /* Implements similar logic as the XMLMessage.create(String, InputStream).
         * But it's faster, as we know the InputStream has FastInfoset content*/
        Message message = null;
        in = hasSomeData(in);
        if (in != null) {
            message = Messages.createUsingPayload(new FastInfosetSource(in),
                    SOAPVersion.SOAP_11);
        } else {

View Full Code Here

        //If LogicalMessage is not acccessed, its not modified.
        if(lm != null) {
            //Check if LogicalMessageImpl has changed, if so construct new one
            // Packet are handled through MessageContext
            if(lm.isPayloadModifed()){
                Message msg = packet.getMessage();
                Message updatedMsg = lm.getMessage(msg.getHeaders(),msg.getAttachments(),binding);
                packet.setMessage(updatedMsg);
            }
            lm = null;
        }

View Full Code Here

0 1 2 3 4 5 6 7 8 9

TOP

Related Classes of com.sun.xml.ws.api.message.Message

com.jaxws.json.codec.encode.JSONEncoder

com.jaxws.json.codec.JSONCodec

com.jaxws.json.codec.MessageBodyBuilder

com.sun.enterprise.jbi.serviceengine.bridge.transport.NMRClientConnection

com.sun.enterprise.jbi.serviceengine.bridge.transport.NMRServerConnection

com.sun.enterprise.jbi.serviceengine.comm.ConsumerInOnly

com.sun.enterprise.jbi.serviceengine.comm.ConsumerInOut

com.sun.enterprise.jbi.serviceengine.comm.ProviderInOnly

com.sun.enterprise.jbi.serviceengine.comm.ProviderInOut

com.sun.enterprise.security.jauth.SOAPAuthParam

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.

Examples of com.sun.xml.ws.api.message.Message

What is a message?

How does this abstraction work?

Message and XOP

Message lifespan

Related Classes of com.sun.xml.ws.api.message.Message