001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common Development
008: * and Distribution License("CDDL") (collectively, the "License"). You
009: * may not use this file except in compliance with the License. You can obtain
010: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
011: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
012: * language governing permissions and limitations under the License.
013: *
014: * When distributing the software, include this License Header Notice in each
015: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
016: * Sun designates this particular file as subject to the "Classpath" exception
017: * as provided by Sun in the GPL Version 2 section of the License file that
018: * accompanied this code. If applicable, add the following below the License
019: * Header, with the fields enclosed by brackets [] replaced by your own
020: * identifying information: "Portions Copyrighted [year]
021: * [name of copyright owner]"
022: *
023: * Contributor(s):
024: *
025: * If you wish your version of this file to be governed by only the CDDL or
026: * only the GPL Version 2, indicate your decision by adding "[Contributor]
027: * elects to include this software in this distribution under the [CDDL or GPL
028: * Version 2] license." If you don't indicate a single choice of license, a
029: * recipient has the option to distribute your version of this file under
030: * either the CDDL, the GPL Version 2 or to extend the choice of license to
031: * its licensees as provided above. However, if you add GPL Version 2 code
032: * and therefore, elected the GPL Version 2 license, then the option applies
033: * only if the new code is made subject to such option by the copyright
034: * holder.
035: */
036:
037: package com.sun.xml.ws.api.model.soap;
038:
039: import com.sun.xml.ws.api.SOAPVersion;
040: import com.sun.xml.ws.api.model.JavaMethod;
041:
042: import javax.jws.soap.SOAPBinding.Style;
043: import javax.jws.soap.SOAPBinding.Use;
044: import javax.jws.WebMethod;
045:
046: /**
047: * Models soap:binding in a WSDL document or a {@link javax.jws.soap.SOAPBinding} annotation. This
048: * can be the return of {@link JavaMethod#getBinding()}.
049: *
050: * @author Vivek Pandey
051: */
052: abstract public class SOAPBinding {
053: protected Use use = Use.LITERAL;
054: protected Style style = Style.DOCUMENT;
055: protected SOAPVersion soapVersion = SOAPVersion.SOAP_11;
056: protected String soapAction = "";
057:
058: /**
059: * Get {@link Use} such as <code>literal</code> or <code>encoded</code>.
060: */
061: public Use getUse() {
062: return use;
063: }
064:
065: /**
066: * Get {@link Style} - such as <code>document</code> or <code>rpc</code>.
067: */
068: public Style getStyle() {
069: return style;
070: }
071:
072: /**
073: * Get the {@link SOAPVersion}
074: */
075: public SOAPVersion getSOAPVersion() {
076: return soapVersion;
077: }
078:
079: /**
080: * Returns true if its document/literal
081: */
082: public boolean isDocLit() {
083: return style == Style.DOCUMENT && use == Use.LITERAL;
084: }
085:
086: /**
087: * Returns true if this is a rpc/literal binding
088: */
089: public boolean isRpcLit() {
090: return style == Style.RPC && use == Use.LITERAL;
091: }
092:
093: /**
094: * Value of <code>wsdl:binding/wsdl:operation/soap:operation@soapAction</code> attribute or
095: * {@link WebMethod#action()} annotation.
096: * <pre>
097: * For example:
098: * <wsdl:binding name="HelloBinding" type="tns:Hello">
099: * <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
100: * <wsdl:operation name="echoData">
101: * <soap12:operation soapAction=""/>
102: * ...
103: * </pre>
104: * It's always non-null. soap message serializer needs to generated SOAPAction HTTP header with
105: * the return of this method enclosed in quotes("").
106: *
107: * @see com.sun.xml.ws.api.message.Packet#soapAction
108: */
109: public String getSOAPAction() {
110: return soapAction;
111: }
112: }
|