ohair@286: /*
alanb@368:  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
ohair@286:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286:  *
ohair@286:  * This code is free software; you can redistribute it and/or modify it
ohair@286:  * under the terms of the GNU General Public License version 2 only, as
ohair@286:  * published by the Free Software Foundation.  Oracle designates this
ohair@286:  * particular file as subject to the "Classpath" exception as provided
ohair@286:  * by Oracle in the LICENSE file that accompanied this code.
ohair@286:  *
ohair@286:  * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
ohair@286:  * version 2 for more details (a copy is included in the LICENSE file that
ohair@286:  * accompanied this code).
ohair@286:  *
ohair@286:  * You should have received a copy of the GNU General Public License version
ohair@286:  * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286:  *
ohair@286:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286:  * or visit www.oracle.com if you need additional information or have any
ohair@286:  * questions.
ohair@286:  */
ohair@286: 
ohair@286: package com.sun.xml.internal.ws.api;import com.sun.istack.internal.NotNull;
ohair@286: import com.sun.istack.internal.Nullable;
ohair@286: 
ohair@286: import javax.xml.ws.WebServiceFeature;
ohair@286: 
ohair@286: /**
ohair@286:  * Read-only list of {@link WebServiceFeature}s.
ohair@286:  *
ohair@286:  * @author Kohsuke Kawaguchi
ohair@286:  */
ohair@286: public interface WSFeatureList extends Iterable<WebServiceFeature> {
ohair@286:     /**
ohair@286:      * Checks if a particular {@link WebServiceFeature} is enabled.
ohair@286:      *
ohair@286:      * @return
ohair@286:      *      true if enabled.
ohair@286:      */
ohair@286:     boolean isEnabled(@NotNull Class<? extends WebServiceFeature> feature);
ohair@286: 
ohair@286:     /**
ohair@286:      * Gets a {@link WebServiceFeature} of the specific type.
ohair@286:      *
ohair@286:      * @param featureType
ohair@286:      *      The type of the feature to retrieve.
ohair@286:      * @return
ohair@286:      *      If the feature is present and enabled, return a non-null instance.
ohair@286:      *      Otherwise null.
ohair@286:      */
ohair@286:     @Nullable <F extends WebServiceFeature> F get(@NotNull Class<F> featureType);
ohair@286: 
ohair@286:     /**
ohair@286:      * Obtains all the features in the array.
ohair@286:       */
ohair@286:     @NotNull WebServiceFeature[] toArray();
ohair@286: 
ohair@286:     /**
ohair@286:      * Merges the extra features that are not already set on binding.
ohair@286:      * i.e, if a feature is set already on binding through some other API
ohair@286:      * the corresponding wsdlFeature is not set.
ohair@286:      *
ohair@286:      * @param features          Web Service features that need to be merged with already configured features.
ohair@286:      * @param reportConflicts   If true, checks if the feature setting in WSDL (wsdl extension or
ohair@286:      *                          policy configuration) conflicts with feature setting in Deployed Service and
ohair@286:      *                          logs warning if there are any conflicts.
ohair@286:      */
ohair@286:     void mergeFeatures(@NotNull WebServiceFeature[] features, boolean reportConflicts);
ohair@286: 
ohair@286:    /**
ohair@286:     * Merges the extra features that are not already set on binding.
ohair@286:     * i.e, if a feature is set already on binding through some other API
ohair@286:     * the corresponding wsdlFeature is not set.
ohair@286:     *
ohair@286:     * @param features          Web Service features that need to be merged with already configured features.
ohair@286:     * @param reportConflicts   If true, checks if the feature setting in WSDL (wsdl extension or
ohair@286:     *                          policy configuration) conflicts with feature setting in Deployed Service and
ohair@286:     *                          logs warning if there are any conflicts.
ohair@286:     */
ohair@286:    void mergeFeatures(@NotNull Iterable<WebServiceFeature> features, boolean reportConflicts);
ohair@286: }