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/model/wsdl/WSDLOperation.java	Tue Mar 06 16:09:35 2012 -0800
     1.3 @@ -0,0 +1,115 @@
     1.4 +/*
     1.5 + * Copyright (c) 1997, 2010, 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.model.wsdl;
    1.30 +
    1.31 +import com.sun.xml.internal.ws.api.model.wsdl.WSDLExtensible;
    1.32 +import com.sun.istack.internal.NotNull;
    1.33 +import com.sun.istack.internal.Nullable;
    1.34 +
    1.35 +import javax.xml.namespace.QName;
    1.36 +
    1.37 +/**
    1.38 + * Provides abstraction of wsdl:portType/wsdl:operation.
    1.39 + *
    1.40 + * @author Vivek Pandey
    1.41 + */
    1.42 +public interface WSDLOperation extends WSDLObject, WSDLExtensible {
    1.43 +    /**
    1.44 +     * Gets the name of the wsdl:portType/wsdl:operation@name attribute value as local name and wsdl:definitions@targetNamespace
    1.45 +     * as the namespace uri.
    1.46 +     */
    1.47 +    @NotNull QName getName();
    1.48 +
    1.49 +    /**
    1.50 +     * Gets the wsdl:input of this operation
    1.51 +     */
    1.52 +    @NotNull WSDLInput getInput();
    1.53 +
    1.54 +    /**
    1.55 +     * Gets the wsdl:output of this operation.
    1.56 +     *
    1.57 +     * @return
    1.58 +     *      null if this is an one-way operation.
    1.59 +     */
    1.60 +    @Nullable WSDLOutput getOutput();
    1.61 +
    1.62 +
    1.63 +
    1.64 +    /**
    1.65 +     * Returns true if this operation is an one-way operation.
    1.66 +     */
    1.67 +    boolean isOneWay();
    1.68 +
    1.69 +    /**
    1.70 +     * Gets the {@link WSDLFault} corresponding to wsdl:fault of this operation.
    1.71 +     */
    1.72 +    Iterable<? extends WSDLFault> getFaults();
    1.73 +
    1.74 +    /**
    1.75 +     * Gives {@link WSDLFault} for the given soap fault detail value.
    1.76 +     *
    1.77 +     * <pre>
    1.78 +     *
    1.79 +     * Given a wsdl fault:
    1.80 +     *
    1.81 +     * &lt;wsdl:message nae="faultMessage">
    1.82 +     *  &lt;wsdl:part name="fault" element="<b>ns:myException</b>/>
    1.83 +     * &lt;/wsdl:message>
    1.84 +     *
    1.85 +     * &lt;wsdl:portType>
    1.86 +     *  &lt;wsdl:operation ...>
    1.87 +     *      &lt;wsdl:fault name="aFault" message="faultMessage"/>
    1.88 +     *  &lt;/wsdl:operation>
    1.89 +     * &lt;wsdl:portType>
    1.90 +     *
    1.91 +     *
    1.92 +     * For example given a soap 11 soap message:
    1.93 +     *
    1.94 +     * &lt;soapenv:Fault>
    1.95 +     *      ...
    1.96 +     *      &lt;soapenv:detail>
    1.97 +     *          &lt;<b>ns:myException</b>>
    1.98 +     *              ...
    1.99 +     *          &lt;/ns:myException>
   1.100 +     *      &lt;/soapenv:detail>
   1.101 +     *
   1.102 +     * QName faultQName = new QName(ns, "myException");
   1.103 +     * WSDLFault wsdlFault  = getFault(faultQName);
   1.104 +     *
   1.105 +     * The above call will return a WSDLFault that abstracts wsdl:portType/wsdl:operation/wsdl:fault.
   1.106 +     *
   1.107 +     * </pre>
   1.108 +     *
   1.109 +     * @param faultDetailName tag name of the element inside soaenv:Fault/detail/, must be non-null.
   1.110 +     * @return returns null if a wsdl fault corresponding to the detail entry name not found.
   1.111 +     */
   1.112 +    @Nullable WSDLFault getFault(QName faultDetailName);
   1.113 +
   1.114 +    /**
   1.115 +     * Gives the enclosing wsdl:portType@name attribute value.
   1.116 +     */
   1.117 +    @NotNull QName getPortTypeName();
   1.118 +}