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

    }


    // TODO: preencode String literals to byte[] so that they don't have to
    // go through char[]->byte[] conversion at runtime.
    public ContentType encode(Packet packet, OutputStream out) throws IOException {
        Message msg = packet.getMessage();
        if (msg == null) {
            return null;
        }
        ContentTypeImpl ctImpl = (ContentTypeImpl)getStaticContentType(packet);
        String boundary = ctImpl.getBoundary();
        String rootId = ctImpl.getRootId();
        boolean hasAttachments = (boundary != null);
        Codec rootCodec = getMimeRootCodec(packet);
        if (hasAttachments) {
            writeln("--"+boundary, out);
            ContentType ct = rootCodec.getStaticContentType(packet);
            String ctStr = (ct != null) ? ct.getContentType() : rootCodec.getMimeType();
            if (rootId != null) writeln("Content-ID: " + rootId, out);
            writeln("Content-Type: " + ctStr, out);
            writeln(out);
        }
        ContentType primaryCt = rootCodec.encode(packet, out);


        if (hasAttachments) {
            writeln(out);
            // Encode all the attchments
            for (Attachment att : msg.getAttachments()) {
                writeln("--"+boundary, out);
                //SAAJ's AttachmentPart.getContentId() returns content id already enclosed with
                //angle brackets. For now put angle bracket only if its not there
                String cid = att.getContentId();
                if(cid != null && cid.length() >0 && cid.charAt(0) != '<')

View Full Code Here

    }


    public ContentType getStaticContentType(Packet packet) {
        ContentType ct = (ContentType) packet.getInternalContentType();
        if ( ct != null ) return ct;
        Message msg = packet.getMessage();
        boolean hasAttachments = !msg.getAttachments().isEmpty();
        Codec rootCodec = getMimeRootCodec(packet);


        if (hasAttachments) {
            String boundary = "uuid:" + UUID.randomUUID().toString();
            String boundaryParameter = "boundary=\"" + boundary + "\"";

View Full Code Here

        String username = null;
        String password = null;


        try {
            // read the header
            Message msg = context.getMessage();
            HeaderList hl = msg.getHeaders();
            Header securityHeader = hl.get(WSSE_SECURITY, true);


            JAXBElement<SecurityHeaderType> sht = securityHeader.readAsJAXB(WSSE_CONTEXT.createUnmarshaller());


            for (Object uno : sht.getValue().getAny()) {

View Full Code Here

   return response.createResponse(Messages.create(t, this.soapVersion));
    }
    
    public boolean isTwoWay(boolean twoWayIsDefault, Packet request) { 
   boolean twoWay = twoWayIsDefault;
   Message m = request.getMessage();
   if (m != null) {
      WSDLPort wsdlModel =
    (WSDLPort) getProperty(PipeConstants.WSDL_MODEL);
      if (wsdlModel != null) {
    twoWay = (m.isOneWay(wsdlModel) ? false : true);
      }
  }
   return twoWay;
    }

View Full Code Here

            }
        } catch (XMLStreamException xse) {
            throw new XWSSecurityException(xse);
        }


        Message streamMsg = null;
        AttachmentSet as = securityContext.getDecryptedAttachmentSet();
        if (as == null || as.isEmpty()) {
            as = securityContext.getAttachmentSet();
        }        
        if (!context.getDisablePayloadBuffering() && (!context.isSecure() || "Fault".equals(message.getLocalName()))) {
            if (logger.isLoggable(Level.FINE)) {
                logger.log(Level.FINE, "Buffering Payload from incomming message");
            }
            VerifiedMessageXMLStreamReader verifiedReader = new VerifiedMessageXMLStreamReader(message, bodyENVNS);
            streamMsg = new VerifiedStreamMessage(envelopeTag, headerTag, as, headers, bodyTag, verifiedReader, soapVersion, this.bodyENVNS);
        } else {
            if (logger.isLoggable(Level.FINE)) {
                logger.log(Level.FINE, "Not Buffering Payload from incomming message");
            }
            // FIXME: RJE -- remove cast once StreamMessage constr can take MessageHeaders
            streamMsg = new StreamMessage(envelopeTag, headerTag, as, (HeaderList) headers, bodyTag, message, soapVersion);
        }
        context.setMessage(streamMsg);
        boolean scCancel = false;
        /*if(streamMsg.isFault())
        return streamMsg;*/
        if (context.getAddressingVersion() != null) {
            String action = AddressingUtils.getAction(streamMsg.getHeaders(), context.getAddressingVersion(), context.getSOAPVersion());


            if (MessageConstants.MEX_GET.equals(action)) {
                return streamMsg;
            }
            if (MessageConstants.CANCEL_SECURITY_CONTEXT_TOKEN_ACTION.equals(action) ||

View Full Code Here


        if (bodyTag == null) {
            bodyTag = new TagInfoset(rdr);
        }
        // FIXME: RJE -- remove cast once StreamMessage constr can take MessageHeaders
        Message msg = new StreamMessage(envelopeTag, headerTag, new AttachmentSetImpl(), (HeaderList) headers, bodyTag, rdr, soapVersion);
        ctx.setPVMessage(msg);
    }

View Full Code Here

        return new WssTube(this, cloner);
    }


    @Override
    public NextAction processResponse(Packet packet) {
        Message message = packet.getMessage();
        if (message == null) {
            return super.processResponse(packet);
        }


        try {
            SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'");
            sdf.setTimeZone(TimeZone.getTimeZone("UTC"));
            long created = System.currentTimeMillis();
            long expires = created + 24 * 60 * 60 * 1000; // 24 hours


            Document document = DocumentBuilderFactory.newInstance().newDocumentBuilder().newDocument();


            Element wsseSecurityElement = document.createElementNS(WSSE_NAMESPACE, "Security");


            Element wsuTimestampElement = document.createElementNS(WSU_NAMESPACE, "Timestamp");
            wsseSecurityElement.appendChild(wsuTimestampElement);


            Element tsCreatedElement = document.createElementNS(WSU_NAMESPACE, "Created");
            tsCreatedElement.setTextContent(sdf.format(created));
            wsuTimestampElement.appendChild(tsCreatedElement);


            Element tsExpiresElement = document.createElementNS(WSU_NAMESPACE, "Expires");
            tsExpiresElement.setTextContent(sdf.format(expires));
            wsuTimestampElement.appendChild(tsExpiresElement);


            HeaderList headers = message.getHeaders();
            headers.add(Headers.create(wsseSecurityElement));
        } catch (Exception e) {
            e.printStackTrace();
        }

View Full Code Here

        String username = null;
        String password = null;


        try {
            // read the header
            Message msg = context.getMessage();
            HeaderList hl = msg.getHeaders();
            Header securityHeader = hl.get(WSSE_SECURITY, true);


            JAXBElement<SecurityHeaderType> sht = securityHeader.readAsJAXB(WSSE_CONTEXT.createUnmarshaller());


            for (Object uno : sht.getValue().getAny()) {

View Full Code Here

            out.println("\nOutbound message:");
        } else {
            out.println("\nInbound message:");
        }


        Message m = mhc.getMessage().copy();
        XMLStreamWriter writer = XMLStreamWriterFactory.create(System.out);
        try {
            m.writeTo(createIndenter(writer));
        } catch (XMLStreamException e) {
            e.printStackTrace();
        }
        out.println("");

View Full Code Here

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

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