/*

 * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package com.sun.xml.internal.ws.api.message;

import com.sun.istack.internal.NotNull;

import com.sun.istack.internal.Nullable;

import com.sun.xml.internal.bind.marshaller.SAX2DOMEx;

import com.sun.xml.internal.ws.addressing.WsaPropertyBag;

import com.sun.xml.internal.ws.addressing.WsaTubeHelper;

import com.sun.xml.internal.ws.addressing.model.InvalidAddressingHeaderException;

import com.sun.xml.internal.ws.api.*;

import com.sun.xml.internal.ws.api.addressing.AddressingVersion;

import com.sun.xml.internal.ws.api.addressing.WSEndpointReference;

import com.sun.xml.internal.ws.api.message.saaj.SAAJFactory;

import com.sun.xml.internal.ws.api.model.JavaMethod;

import com.sun.xml.internal.ws.api.model.SEIModel;

import com.sun.xml.internal.ws.api.model.wsdl.WSDLOperation;

import com.sun.xml.internal.ws.api.model.wsdl.WSDLPort;

import com.sun.xml.internal.ws.api.pipe.Codec;

import com.sun.xml.internal.ws.api.pipe.Tube;

import com.sun.xml.internal.ws.api.server.Adapter;

import com.sun.xml.internal.ws.api.server.TransportBackChannel;

import com.sun.xml.internal.ws.api.server.WSEndpoint;

import com.sun.xml.internal.ws.api.server.WebServiceContextDelegate;

import com.sun.xml.internal.ws.api.streaming.XMLStreamWriterFactory;

import com.sun.xml.internal.ws.client.*;

import com.sun.xml.internal.ws.developer.JAXWSProperties;

import com.sun.xml.internal.ws.message.RelatesToHeader;

import com.sun.xml.internal.ws.message.StringHeader;

import com.sun.xml.internal.ws.transport.http.WSHTTPConnection;

import com.sun.xml.internal.ws.message.saaj.SAAJMessage;

import com.sun.xml.internal.ws.server.WSEndpointImpl;

import com.sun.xml.internal.ws.util.DOMUtil;

import com.sun.xml.internal.ws.util.xml.XmlUtil;

import com.sun.xml.internal.ws.wsdl.DispatchException;

import com.sun.xml.internal.ws.wsdl.OperationDispatcher;

import com.sun.xml.internal.org.jvnet.ws.message.ContentType;

import org.w3c.dom.Document;

import org.w3c.dom.Element;

import org.xml.sax.SAXException;

import javax.xml.namespace.QName;

import javax.xml.soap.SOAPException;

import javax.xml.soap.SOAPMessage;

import javax.xml.stream.XMLStreamWriter;

import javax.xml.ws.BindingProvider;

import javax.xml.ws.Dispatch;

import javax.xml.ws.WebServiceContext;

import javax.xml.ws.WebServiceException;

import javax.xml.ws.handler.LogicalMessageContext;

import javax.xml.ws.handler.MessageContext;

import javax.xml.ws.handler.soap.SOAPMessageContext;

import java.util.*;

import java.util.logging.Logger;

import java.io.ByteArrayOutputStream;

import java.io.IOException;

import java.io.OutputStream;

import java.nio.ByteBuffer;

import java.nio.channels.WritableByteChannel;

/**

 * Represents a container of a {@link Message}.

 *

 * <h2>What is a {@link Packet}?</h2>

 * <p>

 * A packet can be thought of as a frame/envelope/package that wraps

 * a {@link Message}. A packet keeps track of optional metadata (properties)

 * about a {@link Message} that doesn't go across the wire.

 * This roughly corresponds to {@link MessageContext} in the JAX-WS API.

 *

 * <p>

 * Usually a packet contains a {@link Message} in it, but sometimes

 * (such as for a reply of an one-way operation), a packet may

 * float around without a {@link Message} in it.

 *

 *

 * <a name="properties"></a>

 * <h2>Properties</h2>

 * <p>

 * Information frequently used inside the JAX-WS RI

 * is stored in the strongly-typed fields. Other information is stored

 * in terms of a generic {@link Map} (see

 * {@link #invocationProperties}.)

 *

 * <p>

 * Some properties need to be retained between request and response,

 * some don't. For strongly typed fields, this characteristic is

 * statically known for each of them, and propagation happens accordingly.

 * For generic information stored in {@link Map}, {@link #invocationProperties}

 * stores per-invocation scope information (which carries over to

 * the response.)

 *

 * <p>

 * This object is used as the backing store of {@link MessageContext}, and

 * {@link LogicalMessageContext} and {@link SOAPMessageContext} will

 * be delegating to this object for storing/retrieving values.

 *

 *

 * <h3>Relationship to request/response context</h3>

 * <p>

 * {@link BindingProvider#getRequestContext() Request context} is used to

 * seed the initial values of {@link Packet}.

 * Some of those values go to strongly-typed fields, and others go to

 * {@link #invocationProperties}, as they need to be retained in the reply message.

 *

 * <p>

 * Similarly, {@link BindingProvider#getResponseContext() response context}

 * is constructed from {@link Packet} (or rather it's just a view of {@link Packet}.)

 * by using properties from {@link #invocationProperties},

 * modulo properties named explicitly in {@link #getHandlerScopePropertyNames(boolean)}.

 * IOW, properties added to {@link #invocationProperties}

 * are exposed to the response context by default.

 *

 *

 *

 * <h3>TODO</h3>

 * <ol>

 *  <li>this class needs to be cloneable since Message is copiable.

 *  <li>The three live views aren't implemented correctly. It will be

 *      more work to do so, although I'm sure it's possible.

 *  <li>{@link Property} annotation is to make it easy

 *      for {@link MessageContext} to export properties on this object,

 *      but it probably needs some clean up.

 * </ol>

 *

 * @author Kohsuke Kawaguchi

 */

public final class Packet

    extends DistributedPropertySet

    implements com.sun.xml.internal.org.jvnet.ws.message.MessageContext

{

    /**

     * Creates a {@link Packet} that wraps a given {@link Message}.

     *

     * <p>

     * This method should be only used to create a fresh {@link Packet}.

     * To create a {@link Packet} for a reply, use {@link #createResponse(Message)}.

     *

     * @param request

     *      The request {@link Message}. Can be null.

     */

    public Packet(Message request) {

        this();

        this.message = request;

    }

    /**

     * Creates an empty {@link Packet} that doesn't have any {@link Message}.

     */

    public Packet() {

        this.invocationProperties = new HashMap<String, Object>();

    }

    /**

     * Used by {@link #createResponse(Message)} and {@link #copy(boolean)}.

     */

    private Packet(Packet that) {

        that.copySatelliteInto((DistributedPropertySet) this);

        this.handlerConfig = that.handlerConfig;

        this.invocationProperties = that.invocationProperties;

        this.handlerScopePropertyNames = that.handlerScopePropertyNames;

        this.contentNegotiation = that.contentNegotiation;

        this.wasTransportSecure = that.wasTransportSecure;

        this.transportBackChannel = that.transportBackChannel;

        this.endpointAddress = that.endpointAddress;

        this.isAdapterDeliversNonAnonymousResponse = that.isAdapterDeliversNonAnonymousResponse;

        this.wsdlOperation = that.wsdlOperation;

        this.acceptableMimeTypes = that.acceptableMimeTypes;

        this.endpoint = that.endpoint;

        this.proxy = that.proxy;

        this.webServiceContextDelegate = that.webServiceContextDelegate;

        this.soapAction = that.soapAction;

        this.expectReply = that.expectReply;

        this.component = that.component;

        // copy other properties that need to be copied. is there any?

    }

    /**

     * Creates a copy of this {@link Packet}.

     *

     * @param copyMessage determines whether the {@link Message} from the original {@link Packet} should be copied as

     *        well, or not. If the value is {@code false}, the {@link Message} in the copy of the {@link Packet} is {@code null}.

     * @return copy of the original packet

     */

    public Packet copy(boolean copyMessage) {

        // the copy constructor is originally designed for creating a response packet,

        // but so far the implementation is usable for this purpose as well, so calling the copy constructor

        // to avoid code dupliation.

        Packet copy = new Packet(this);

        if (copyMessage && this.message != null) {

            copy.message = this.message.copy();

        }

        return copy;

    }

    private Message message;

    /**

     * Gets the last {@link Message} set through {@link #setMessage(Message)}.

     *

     * @return may null. See the class javadoc for when it's null.

     */

    public Message getMessage() {

        return message;

    }

    public WSBinding getBinding() {

        if (endpoint != null)

                return endpoint.getBinding();

        if (proxy != null)

                return (WSBinding) proxy.getBinding();

        return null;

    }

    /**

     * Sets a {@link Message} to this packet.

     *

     * @param message Can be null.

     */

    public void setMessage(Message message) {

        this.message = message;

    }

    private QName wsdlOperation;

    /**

     * Returns the QName of the wsdl operation associated with this packet.

     * <p/>

     * Information such as Payload QName, wsa:Action header, SOAPAction HTTP header are used depending on the features

     * enabled on the particular port.

     *

     * @return null if there is no WSDL model or

     *         runtime cannot uniquely identify the wsdl operation from the information in the packet.

     */

    @com.sun.xml.internal.ws.api.PropertySet.Property(MessageContext.WSDL_OPERATION)

    public final

    @Nullable

    QName getWSDLOperation() {

        if (wsdlOperation != null)

            return wsdlOperation;

        OperationDispatcher opDispatcher = null;

        if (endpoint != null) {

            opDispatcher = ((WSEndpointImpl) endpoint).getOperationDispatcher();

        } else if (proxy != null) {

            opDispatcher = ((Stub) proxy).getOperationDispatcher();

        }

        //OpDispatcher is null when there is no WSDLModel

        if (opDispatcher != null) {

            try {

                wsdlOperation = opDispatcher.getWSDLOperationQName(this);

            } catch (DispatchException e) {

                //Ignore, this might be a protocol message which may not have a wsdl operation

                //LOGGER.info("Cannot resolve wsdl operation that this Packet is targeted for.");

            }

        }

        return wsdlOperation;

    }

    /**

     * Set the wsdl operation to avoid lookup from other data.

     * This is useful in SEI based clients, where the WSDL operation can be known

     * from the associated {@link JavaMethod}

     *

     * @param wsdlOp QName

     */

    public void setWSDLOperation(QName wsdlOp) {

        this.wsdlOperation = wsdlOp;

    }

    /**

     * True if this message came from a transport (IOW inbound),

     * and in paricular from a "secure" transport. A transport

     * needs to set this flag appropriately.

     *

     * <p>

     * This is a requirement from the security team.

     */

    // TODO: expose this as a property

    public boolean wasTransportSecure;

    /**

     * Inbound transport headers are captured in a transport neutral way.

     * Transports are expected to fill this data after creating a Packet.

     * <p>

     * {@link SOAPMessage#getMimeHeaders()} would return these headers.

     */

    public static final String INBOUND_TRANSPORT_HEADERS = "com.sun.xml.internal.ws.api.message.packet.inbound.transport.headers";

    /**

     * Outbound transport headers are captured in a transport neutral way.

     *

     * <p>

     * Transports may choose to ignore certain headers that interfere with

     * its correct operation, such as

     * <tt>Content-Type</tt> and <tt>Content-Length</tt>.

     */

    public static final String OUTBOUND_TRANSPORT_HEADERS = "com.sun.xml.internal.ws.api.message.packet.outbound.transport.headers";

    /**

     *

     */

    public static final String HA_INFO = "com.sun.xml.internal.ws.api.message.packet.hainfo";

    /**

     * This property holds the snapshot of HandlerConfiguration

     * at the time of invocation.

     * This property is used by MUPipe and HandlerPipe implementations.

     */

    @com.sun.xml.internal.ws.api.PropertySet.Property(BindingProviderProperties.JAXWS_HANDLER_CONFIG)

    public HandlerConfiguration handlerConfig;

    /**

     * If a message originates from a proxy stub that implements

     * a port interface, this field is set to point to that object.

     *

     * TODO: who's using this property?

     */

    @com.sun.xml.internal.ws.api.PropertySet.Property(BindingProviderProperties.JAXWS_CLIENT_HANDLE_PROPERTY)

    public BindingProvider proxy;

    /**

     * Determines if the governing {@link Adapter} or {@link Fiber.CompletionCallback} will handle delivering

     * response messages targeted at non-anonymous endpoint addresses.  Prior to the introduction of this

     * flag the {@link WsaServerTube} would deliver non-anonymous responses.

     */

    public boolean isAdapterDeliversNonAnonymousResponse;

    /**

     * The endpoint address to which this message is sent to.

     *

     * <p>

     * The JAX-WS spec allows this to be changed for each message,

     * so it's designed to be a property.

     *

     * <p>

     * Must not be null for a request message on the client. Otherwise

     * it's null.

     */

    public EndpointAddress endpointAddress;

    /**

     * @deprecated

     *      The programatic acccess should be done via

     *      {@link #endpointAddress}. This is for JAX-WS client applications

     *      that access this property via {@link BindingProvider#ENDPOINT_ADDRESS_PROPERTY}.

     */

    @com.sun.xml.internal.ws.api.PropertySet.Property(BindingProvider.ENDPOINT_ADDRESS_PROPERTY)

    public String getEndPointAddressString() {

        if (endpointAddress == null)

            return null;

        else

            return endpointAddress.toString();

    }

    public void setEndPointAddressString(String s) {

        if (s == null)

            this.endpointAddress = null;

        else

            this.endpointAddress = EndpointAddress.create(s);

    }

    /**

     * The value of {@link ContentNegotiation#PROPERTY}

     * property.

     * <p/>

     * This property is used only on the client side.

     */

    public ContentNegotiation contentNegotiation;

    @com.sun.xml.internal.ws.api.PropertySet.Property(ContentNegotiation.PROPERTY)

    public String getContentNegotiationString() {

        return (contentNegotiation != null) ? contentNegotiation.toString() : null;

    }

    public void setContentNegotiationString(String s) {

        if (s == null)

            contentNegotiation = null;

        else {

            try {

                contentNegotiation = ContentNegotiation.valueOf(s);

            } catch (IllegalArgumentException e) {

                // If the value is not recognized default to none

                contentNegotiation = ContentNegotiation.none;

            }

        }

    }

    /**

     * Gives a list of Reference Parameters in the Message

     * <p>

     * Headers which have attribute wsa:IsReferenceParameter="true"

     * This is not cached as one may reset the Message.

     *<p>

     */

    @com.sun.xml.internal.ws.api.PropertySet.Property(MessageContext.REFERENCE_PARAMETERS)

    public

    @NotNull

    List<Element> getReferenceParameters() {

        List<Element> refParams = new ArrayList<Element>();

        if (message == null) {

            return refParams;

        }

        HeaderList hl = message.getHeaders();

        for (Header h : hl) {

            String attr = h.getAttribute(AddressingVersion.W3C.nsUri, "IsReferenceParameter");

            if (attr != null && (attr.equals("true") || attr.equals("1"))) {

                Document d = DOMUtil.createDom();

                SAX2DOMEx s2d = new SAX2DOMEx(d);

                try {

                    h.writeTo(s2d, XmlUtil.DRACONIAN_ERROR_HANDLER);

                    refParams.add((Element) d.getLastChild());

                } catch (SAXException e) {

                    throw new WebServiceException(e);

                }

                /*

                DOMResult result = new DOMResult(d);

                XMLDOMWriterImpl domwriter = new XMLDOMWriterImpl(result);

                try {

                    h.writeTo(domwriter);

                    refParams.add((Element) result.getNode().getLastChild());

                } catch (XMLStreamException e) {

                    throw new WebServiceException(e);

                }

                */

            }

        }

        return refParams;

    }

    /**

     * @deprecated

     *      This method is for exposing header list through {@link PropertySet#get(Object)},

     *      for user applications, and should never be invoked directly from within the JAX-WS RI.

     */

    @com.sun.xml.internal.ws.api.PropertySet.Property(JAXWSProperties.INBOUND_HEADER_LIST_PROPERTY)

    /*package*/ HeaderList getHeaderList() {

        if (message == null) return null;

        return message.getHeaders();

    }

    /**

     * The list of MIME types that are acceptable to a receiver

     * of an outbound message.

     *

     * This property is used only on the server side.

     *

     * <p>The representation shall be that specified by the HTTP Accept

     * request-header field.

     *

     * <p>The list of content types will be obtained from the transport

     * meta-data of a inbound message in a request/response message exchange.

     * Hence this property will be set by the service-side transport pipe.

     */

    public String acceptableMimeTypes;

    /**

     * When non-null, this object is consulted to

     * implement {@link WebServiceContext} methods

     * exposed to the user application.

     *

     * Used only on the server side.

     *

     * <p>

     * This property is set from the parameter

     * of {@link WSEndpoint.PipeHead#process}.

     */

    public WebServiceContextDelegate webServiceContextDelegate;

    /**

     * Used only on the server side so that the transport

     * can close the connection early.

     *

     * <p>

     * This field can be null. While a message is being processed,

     * this field can be set explicitly to null, to prevent

     * future pipes from closing a transport (see {@link #keepTransportBackChannelOpen()})

     *

     * <p>

     * This property is set from the parameter

     * of {@link WSEndpoint.PipeHead#process}.

     */

    public

    @Nullable

    TransportBackChannel transportBackChannel;

    /**

     * Keeps the transport back channel open (by seeting {@link #transportBackChannel} to null.)

     *

     * @return

     *      The previous value of {@link #transportBackChannel}.

     */

    public TransportBackChannel keepTransportBackChannelOpen() {

        TransportBackChannel r = transportBackChannel;

        transportBackChannel = null;

        return r;

    }

    /**

      * The governing owner of this packet.  On the service-side this is the {@link Adapter} and on the client it is the {@link Stub}.

      *

      */

     public Component component;