View Javadoc
1   /*
2    * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
3    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4    *
5    * This code is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU General Public License version 2 only, as
7    * published by the Free Software Foundation.  Oracle designates this
8    * particular file as subject to the "Classpath" exception as provided
9    * by Oracle in the LICENSE file that accompanied this code.
10   *
11   * This code is distributed in the hope that it will be useful, but WITHOUT
12   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13   * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14   * version 2 for more details (a copy is included in the LICENSE file that
15   * accompanied this code).
16   *
17   * You should have received a copy of the GNU General Public License version
18   * 2 along with this work; if not, write to the Free Software Foundation,
19   * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20   *
21   * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22   * or visit www.oracle.com if you need additional information or have any
23   * questions.
24   */
25  
26  package com.sun.xml.internal.ws.api;import com.sun.istack.internal.NotNull;
27  import com.sun.istack.internal.Nullable;
28  
29  import javax.xml.ws.WebServiceFeature;
30  
31  /**
32   * Read-only list of {@link WebServiceFeature}s.
33   *
34   * @author Kohsuke Kawaguchi
35   */
36  public interface WSFeatureList extends Iterable<WebServiceFeature> {
37      /**
38       * Checks if a particular {@link WebServiceFeature} is enabled.
39       *
40       * @return
41       *      true if enabled.
42       */
43      boolean isEnabled(@NotNull Class<? extends WebServiceFeature> feature);
44  
45      /**
46       * Gets a {@link WebServiceFeature} of the specific type.
47       *
48       * @param featureType
49       *      The type of the feature to retrieve.
50       * @return
51       *      If the feature is present and enabled, return a non-null instance.
52       *      Otherwise null.
53       */
54      @Nullable <F extends WebServiceFeature> F get(@NotNull Class<F> featureType);
55  
56      /**
57       * Obtains all the features in the array.
58        */
59      @NotNull WebServiceFeature[] toArray();
60  
61      /**
62       * Merges the extra features that are not already set on binding.
63       * i.e, if a feature is set already on binding through some other API
64       * the corresponding wsdlFeature is not set.
65       *
66       * @param features          Web Service features that need to be merged with already configured features.
67       * @param reportConflicts   If true, checks if the feature setting in WSDL (wsdl extension or
68       *                          policy configuration) conflicts with feature setting in Deployed Service and
69       *                          logs warning if there are any conflicts.
70       */
71      void mergeFeatures(@NotNull WebServiceFeature[] features, boolean reportConflicts);
72  
73     /**
74      * Merges the extra features that are not already set on binding.
75      * i.e, if a feature is set already on binding through some other API
76      * the corresponding wsdlFeature is not set.
77      *
78      * @param features          Web Service features that need to be merged with already configured features.
79      * @param reportConflicts   If true, checks if the feature setting in WSDL (wsdl extension or
80      *                          policy configuration) conflicts with feature setting in Deployed Service and
81      *                          logs warning if there are any conflicts.
82      */
83     void mergeFeatures(@NotNull Iterable<WebServiceFeature> features, boolean reportConflicts);
84  }