Mercurial > jdk8-mips64-public > jaxws / file diff

     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/src/share/jaxws_classes/com/sun/xml/internal/ws/api/message/MessageWritable.java	Tue Apr 09 14:51:13 2013 +0100
     1.3 @@ -0,0 +1,77 @@
     1.4 +/*
     1.5 + * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.
     1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     1.7 + *
     1.8 + * This code is free software; you can redistribute it and/or modify it
     1.9 + * under the terms of the GNU General Public License version 2 only, as
    1.10 + * published by the Free Software Foundation.  Oracle designates this
    1.11 + * particular file as subject to the "Classpath" exception as provided
    1.12 + * by Oracle in the LICENSE file that accompanied this code.
    1.13 + *
    1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
    1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    1.16 + * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    1.17 + * version 2 for more details (a copy is included in the LICENSE file that
    1.18 + * accompanied this code).
    1.19 + *
    1.20 + * You should have received a copy of the GNU General Public License version
    1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
    1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    1.23 + *
    1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    1.25 + * or visit www.oracle.com if you need additional information or have any
    1.26 + * questions.
    1.27 + */
    1.28 +
    1.29 +package com.sun.xml.internal.ws.api.message;
    1.30 +
    1.31 +import java.io.IOException;
    1.32 +import java.io.OutputStream;
    1.33 +
    1.34 +import javax.xml.ws.soap.MTOMFeature;
    1.35 +
    1.36 +import com.oracle.webservices.internal.api.message.ContentType;
    1.37 +
    1.38 +/**
    1.39 + * A Message implementation may implement this interface as an alternative way to write the
    1.40 + * message into the OutputStream.
    1.41 + *
    1.42 + * @author shih-chang.chen@oracle.com
    1.43 + */
    1.44 +public interface MessageWritable {
    1.45 +
    1.46 +    /**
    1.47 +     * Gets the Content-type of this message.
    1.48 +     *
    1.49 +     * @return The MIME content type of this message
    1.50 +     */
    1.51 +    ContentType getContentType();
    1.52 +
    1.53 +    /**
    1.54 +     * Writes the XML infoset portion of this MessageContext
    1.55 +     * (from <soap:Envelope> to </soap:Envelope>).
    1.56 +     *
    1.57 +     * @param out
    1.58 +     *      Must not be null. The caller is responsible for closing the stream,
    1.59 +     *      not the callee.
    1.60 +     *
    1.61 +     * @return
    1.62 +     *      The MIME content type of this message (such as "application/xml").
    1.63 +     *      This information is often ncessary by transport.
    1.64 +     *
    1.65 +     * @throws IOException
    1.66 +     *      if a {@link OutputStream} throws {@link IOException}.
    1.67 +     */
    1.68 +    ContentType writeTo( OutputStream out ) throws IOException;
    1.69 +
    1.70 +    /**
    1.71 +     * Passes configuration information to this message to ensure the proper
    1.72 +     * wire format is created. (from <soap:Envelope> to </soap:Envelope>).
    1.73 +     *
    1.74 +     * @param mtomFeature
    1.75 +     *            The standard <code>WebServicesFeature</code> for specifying
    1.76 +     *            the MTOM enablement and possibly threshold for the endpoint.
    1.77 +     *            This value may be <code>null</code>.
    1.78 +     */
    1.79 +    void setMTOMConfiguration(final MTOMFeature mtomFeature);
    1.80 +}