• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/jaxws_classes/com/sun/xml/internal/ws/api/model/wsdl/WSDLBoundOperation.java@9c07ef4934dd (annotated)

src/share/jaxws_classes/com/sun/xml/internal/ws/api/model/wsdl/WSDLBoundOperation.java

Thu, 31 Aug 2017 15:18:52 +0800

author

aoqi

date

Thu, 31 Aug 2017 15:18:52 +0800

changeset 637

9c07ef4934dd

parent 408

b0610cd08440

parent 0

373ffda63c9a

permissions

-rw-r--r--

merge

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0	4	*
aoqi@0	5	* This code is free software; you can redistribute it and/or modify it
aoqi@0	6	* under the terms of the GNU General Public License version 2 only, as
aoqi@0	7	* published by the Free Software Foundation. Oracle designates this
aoqi@0	8	* particular file as subject to the "Classpath" exception as provided
aoqi@0	9	* by Oracle in the LICENSE file that accompanied this code.
aoqi@0	10	*
aoqi@0	11	* This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0	14	* version 2 for more details (a copy is included in the LICENSE file that
aoqi@0	15	* accompanied this code).
aoqi@0	16	*
aoqi@0	17	* You should have received a copy of the GNU General Public License version
aoqi@0	18	* 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0	19	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0	20	*
aoqi@0	21	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0	22	* or visit www.oracle.com if you need additional information or have any
aoqi@0	23	* questions.
aoqi@0	24	*/
aoqi@0	25
aoqi@0	26	package com.sun.xml.internal.ws.api.model.wsdl;
aoqi@0	27
aoqi@0	28	import com.sun.istack.internal.NotNull;
aoqi@0	29	import com.sun.istack.internal.Nullable;
aoqi@0	30	import com.sun.xml.internal.ws.api.model.ParameterBinding;
aoqi@0	31
aoqi@0	32	import javax.jws.WebParam.Mode;
aoqi@0	33	import javax.xml.namespace.QName;
aoqi@0	34
aoqi@0	35	import java.util.Map;
aoqi@0	36
aoqi@0	37	/**
aoqi@0	38	* Abstracts wsdl:binding/wsdl:operation. It can be used to determine the parts and their binding.
aoqi@0	39	*
aoqi@0	40	* @author Vivek Pandey
aoqi@0	41	*/
aoqi@0	42	public interface WSDLBoundOperation extends WSDLObject, WSDLExtensible {
aoqi@0	43	/**
aoqi@0	44	* Short-cut for {@code getOperation().getName()}
aoqi@0	45	*/
aoqi@0	46	@NotNull QName getName();
aoqi@0	47
aoqi@0	48	/**
aoqi@0	49	* Gives soapbinding:operation@soapAction value. soapbinding:operation@soapAction is optional attribute.
aoqi@0	50	* If not present an empty String is returned as per BP 1.1 R2745.
aoqi@0	51	*/
aoqi@0	52	@NotNull String getSOAPAction();
aoqi@0	53
aoqi@0	54	/**
aoqi@0	55	* Gets the wsdl:portType/wsdl:operation model - {@link WSDLOperation},
aoqi@0	56	* associated with this binding operation.
aoqi@0	57	*
aoqi@0	58	* @return always same {@link WSDLOperation}
aoqi@0	59	*/
aoqi@0	60	@NotNull WSDLOperation getOperation();
aoqi@0	61
aoqi@0	62	/**
aoqi@0	63	* Gives the owner {@link WSDLBoundPortType}
aoqi@0	64	*/
aoqi@0	65	@NotNull WSDLBoundPortType getBoundPortType();
aoqi@0	66
aoqi@0	67	/**
aoqi@0	68	* Gets the soapbinding:binding/operation/wsaw:Anonymous. A default value of OPTIONAL is returned.
aoqi@0	69	*
aoqi@0	70	* @return Anonymous value of the operation
aoqi@0	71	*/
aoqi@0	72	ANONYMOUS getAnonymous();
aoqi@0	73
aoqi@0	74	enum ANONYMOUS { optional, required, prohibited }
aoqi@0	75
aoqi@0	76	/**
aoqi@0	77	* Gets {@link WSDLPart} for the given wsdl:input or wsdl:output part
aoqi@0	78	*
aoqi@0	79	* @return null if no part is found
aoqi@0	80	*/
aoqi@0	81	@Nullable WSDLPart getPart(@NotNull String partName, @NotNull Mode mode);
aoqi@0	82
aoqi@0	83	/**
aoqi@0	84	* Gets {@link ParameterBinding} for a given wsdl part in wsdl:input
aoqi@0	85	*
aoqi@0	86	* @param part Name of wsdl:part, must be non-null
aoqi@0	87	* @return null if the part is not found.
aoqi@0	88	*/
aoqi@0	89	public ParameterBinding getInputBinding(String part);
aoqi@0	90
aoqi@0	91	/**
aoqi@0	92	* Gets {@link ParameterBinding} for a given wsdl part in wsdl:output
aoqi@0	93	*
aoqi@0	94	* @param part Name of wsdl:part, must be non-null
aoqi@0	95	* @return null if the part is not found.
aoqi@0	96	*/
aoqi@0	97	public ParameterBinding getOutputBinding(String part);
aoqi@0	98
aoqi@0	99	/**
aoqi@0	100	* Gets {@link ParameterBinding} for a given wsdl part in wsdl:fault
aoqi@0	101	*
aoqi@0	102	* @param part Name of wsdl:part, must be non-null
aoqi@0	103	* @return null if the part is not found.
aoqi@0	104	*/
aoqi@0	105	public ParameterBinding getFaultBinding(String part);
aoqi@0	106
aoqi@0	107	/**
aoqi@0	108	* Gets the MIME type for a given wsdl part in wsdl:input
aoqi@0	109	*
aoqi@0	110	* @param part Name of wsdl:part, must be non-null
aoqi@0	111	* @return null if the part is not found.
aoqi@0	112	*/
aoqi@0	113	public String getMimeTypeForInputPart(String part);
aoqi@0	114
aoqi@0	115	/**
aoqi@0	116	* Gets the MIME type for a given wsdl part in wsdl:output
aoqi@0	117	*
aoqi@0	118	* @param part Name of wsdl:part, must be non-null
aoqi@0	119	* @return null if the part is not found.
aoqi@0	120	*/
aoqi@0	121	public String getMimeTypeForOutputPart(String part);
aoqi@0	122
aoqi@0	123	/**
aoqi@0	124	* Gets the MIME type for a given wsdl part in wsdl:fault
aoqi@0	125	*
aoqi@0	126	* @param part Name of wsdl:part, must be non-null
aoqi@0	127	* @return null if the part is not found.
aoqi@0	128	*/
aoqi@0	129	public String getMimeTypeForFaultPart(String part);
aoqi@0	130
aoqi@0	131	/**
aoqi@0	132	* Gets all inbound {@link WSDLPart} by its {@link WSDLPart#getName() name}.
aoqi@0	133	*/
aoqi@0	134	@NotNull Map<String,? extends WSDLPart> getInParts();
aoqi@0	135
aoqi@0	136	/**
aoqi@0	137	* Gets all outbound {@link WSDLPart} by its {@link WSDLPart#getName() name}.
aoqi@0	138	*/
aoqi@0	139	@NotNull Map<String,? extends WSDLPart> getOutParts();
aoqi@0	140
aoqi@0	141	/**
aoqi@0	142	* Gets all the {@link WSDLFault} bound to this operation.
aoqi@0	143	*/
aoqi@0	144	@NotNull Iterable<? extends WSDLBoundFault> getFaults();
aoqi@0	145
aoqi@0	146	/**
aoqi@0	147	* Map of wsdl:input part name and the binding as {@link ParameterBinding}
aoqi@0	148	*
aoqi@0	149	* @return empty Map if there is no parts
aoqi@0	150	*/
aoqi@0	151	public Map<String, ParameterBinding> getInputParts();
aoqi@0	152
aoqi@0	153	/**
aoqi@0	154	* Map of wsdl:output part name and the binding as {@link ParameterBinding}
aoqi@0	155	*
aoqi@0	156	* @return empty Map if there is no parts
aoqi@0	157	*/
aoqi@0	158	public Map<String, ParameterBinding> getOutputParts();
aoqi@0	159
aoqi@0	160	/**
aoqi@0	161	* Map of wsdl:fault part name and the binding as {@link ParameterBinding}
aoqi@0	162	*
aoqi@0	163	* @return empty Map if there is no parts
aoqi@0	164	*/
aoqi@0	165	public Map<String, ParameterBinding> getFaultParts();
aoqi@0	166
aoqi@0	167	/**
aoqi@0	168	* Gets the payload QName of the request message.
aoqi@0	169	*
aoqi@0	170	* <p>
aoqi@0	171	* It's possible for an operation to define no body part, in which case
aoqi@0	172	* this method returns null.
aoqi@0	173	*/
aoqi@0	174	@Nullable QName getRequestPayloadName();
aoqi@0	175
aoqi@0	176	/**
aoqi@0	177	* Gets the payload QName of the response message.
aoqi@0	178	*
aoqi@0	179	* <p>
aoqi@0	180	* It's possible for an operation to define no body part, in which case
aoqi@0	181	* this method returns null.
aoqi@0	182	*/
aoqi@0	183	@Nullable QName getResponsePayloadName();
aoqi@0	184
aoqi@0	185	/**
aoqi@0	186	* Gets the namespace of request payload.
aoqi@0	187	*/
aoqi@0	188	String getRequestNamespace();
aoqi@0	189
aoqi@0	190	/**
aoqi@0	191	* Gets the namespace of response payload.
aoqi@0	192	*/
aoqi@0	193	String getResponseNamespace();
aoqi@0	194
aoqi@0	195	}