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;
038:
039: import com.sun.istack.NotNull;
040: import com.sun.istack.Nullable;
041: import com.sun.xml.ws.api.addressing.AddressingVersion;
042: import com.sun.xml.ws.api.message.Message;
043: import com.sun.xml.ws.api.pipe.Codec;
044: import com.sun.xml.ws.api.pipe.Tube;
045:
046: import javax.xml.ws.Binding;
047: import javax.xml.ws.WebServiceFeature;
048: import javax.xml.ws.handler.Handler;
049: import java.util.List;
050:
051: /**
052: * JAX-WS implementation of {@link Binding}.
053: *
054: * <p>
055: * This object can be created by {@link BindingID#createBinding()}.
056: *
057: * <p>
058: * Binding conceptually includes the on-the-wire format of the message,
059: * this this object owns {@link Codec}.
060: *
061: * @author Kohsuke Kawaguchi
062: */
063: public interface WSBinding extends Binding {
064: /**
065: * Gets the SOAP version of this binding.
066: *
067: * TODO: clarify what to do with XML/HTTP binding
068: *
069: * <p>
070: * This is just a shor-cut for {@code getBindingID().getSOAPVersion()}
071: *
072: * @return
073: * If the binding is using SOAP, this method returns
074: * a {@link SOAPVersion} constant.
075: *
076: * If the binding is not based on SOAP, this method
077: * returns null. See {@link Message} for how a non-SOAP
078: * binding shall be handled by {@link Tube}s.
079: */
080: SOAPVersion getSOAPVersion();
081:
082: /**
083: * Gets the WS-Addressing version of this binding.
084: * <p/>
085: * TODO: clarify what to do with XML/HTTP binding
086: *
087: * @return If the binding is using SOAP and WS-Addressing is enabled,
088: * this method returns a {@link AddressingVersion} constant.
089: * If binding is not using SOAP or WS-Addressing is not enabled,
090: * this method returns null.
091: *
092: * This might be little slow as it has to go over all the features on binding.
093: * Its advisable to cache the addressingVersion wherever possible and reuse it.
094: */
095: AddressingVersion getAddressingVersion();
096:
097: /**
098: * Gets the binding ID, which uniquely identifies the binding.
099: *
100: * <p>
101: * The relevant specs define the binding IDs and what they mean.
102: * The ID is used in many places to identify the kind of binding
103: * (such as SOAP1.1, SOAP1.2, REST, ...)
104: *
105: * @return
106: * Always non-null same value.
107: */
108: @NotNull
109: BindingID getBindingId();
110:
111: @NotNull
112: List<Handler> getHandlerChain();
113:
114: /**
115: * Checks if a particular {@link WebServiceFeature} is enabled.
116: *
117: * @return
118: * true if enabled.
119: */
120: boolean isFeatureEnabled(@NotNull
121: Class<? extends WebServiceFeature> feature);
122:
123: /**
124: * Gets a {@link WebServiceFeature} of the specific type.
125: *
126: * @param featureType
127: * The type of the feature to retrieve.
128: * @return
129: * If the feature is present and enabled, return a non-null instance.
130: * Otherwise null.
131: */
132: @Nullable
133: <F extends WebServiceFeature> F getFeature(@NotNull
134: Class<F> featureType);
135:
136: /**
137: * Returns a list of features associated with {@link WSBinding}.
138: */
139: @NotNull
140: WSFeatureList getFeatures();
141: }
|