com.oracle.webservices.api.message.MessageContext Maven / Gradle / Ivy
/*
* Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package com.oracle.webservices.api.message;
import java.io.IOException;
import java.io.OutputStream;
import java.nio.ByteBuffer;
import java.nio.channels.WritableByteChannel;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
/**
* MessageContext represents a container of a SOAP message and all the properties
* including the transport headers.
*
* MessageContext is a composite {@link PropertySet} that combines properties exposed from multiple
* {@link PropertySet}s into one.
*
*
* This implementation allows one {@link PropertySet} to assemble
* all properties exposed from other "satellite" {@link PropertySet}s.
* (A satellite may itself be a {@link DistributedPropertySet}, so
* in general this can form a tree.)
*
* @author [email protected]
*/
public interface MessageContext extends DistributedPropertySet {
/**
* Gets the SAAJ SOAPMessage representation of the SOAP message.
*
* @return The SOAPMessage
*/
SOAPMessage getAsSOAPMessage() throws SOAPException;
/**
* Gets the SAAJ SOAPMessage representation of the SOAP message.
* @deprecated use getAsSOAPMessage
* @return The SOAPMessage
*/
SOAPMessage getSOAPMessage() throws SOAPException;
/**
* Writes the XML infoset portion of this MessageContext
* (from <soap:Envelope> to </soap:Envelope>).
*
* @param out
* Must not be null. The caller is responsible for closing the stream,
* not the callee.
*
* @return
* The MIME content type of the encoded message (such as "application/xml").
* This information is often ncessary by transport.
*
* @throws IOException
* if a {@link OutputStream} throws {@link IOException}.
*/
ContentType writeTo( OutputStream out ) throws IOException;
/**
* The version of {@link #writeTo(OutputStream)}
* that writes to NIO {@link ByteBuffer}.
*
*
* TODO: for the convenience of implementation, write
* an adapter that wraps {@link WritableByteChannel} to {@link OutputStream}.
*/
// ContentType writeTo( WritableByteChannel buffer );
/**
* Gets the Content-type of this message. For an out-bound message that this getContentType()
* method returns a null, the Content-Type can be determined only by calling the writeTo
* method to write the MessageContext to an OutputStream.
*
* @return The MIME content type of this message
*/
ContentType getContentType();
}