Module com.sun.xml.ws

Package com.sun.xml.ws.binding

Class WebServiceFeatureList

java.lang.Object

java.util.AbstractMap<Class<? extends WebServiceFeature>,WebServiceFeature>

com.sun.xml.ws.binding.WebServiceFeatureList

All Implemented Interfaces:

WSFeatureList, Iterable<WebServiceFeature>, Map<Class<? extends WebServiceFeature>,WebServiceFeature>

public final class WebServiceFeatureList
extends AbstractMap<Class<? extends WebServiceFeature>,WebServiceFeature>
implements WSFeatureList

Represents a list of WebServiceFeatures that has bunch of utility methods pertaining to web service features.

Author:

Rama Pulavarthi

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Constructor Summary

Constructors

Constructor	Description
WebServiceFeatureList()
WebServiceFeatureList(WebServiceFeatureList features)
WebServiceFeatureList(Class<?> endpointClass)	Creates a list by reading featuers from the annotation on a class.
WebServiceFeatureList(WebServiceFeature... features)

Method Summary

Modifier and Type	Method	Description
void	add(WebServiceFeature f)	Adds a feature to the list if it's not already added.
void	addAll(Iterable<WebServiceFeature> list)	Adds features to the list if it's not already added.
boolean	contains(Class<? extends WebServiceFeature> feature)
Set<Map.Entry<Class<? extends WebServiceFeature>,WebServiceFeature>>	entrySet()
boolean	equals(Object other)
<F extends WebServiceFeature> F	get(Class<F> featureType)	Gets a WebServiceFeature of the specific type.
static WebServiceFeature	getFeature(Annotation a)	Returns a corresponding feature for a feature annotation(i.e which has WebServiceFeatureAnnotation meta annotation)
static <F extends WebServiceFeature> F	getFeature(WebServiceFeature[] features, Class<F> featureType)
static SOAPVersion	getSoapVersion(WSFeatureList features)
boolean	isEnabled(Class<? extends WebServiceFeature> feature)	Checks if a particular WebServiceFeature is enabled.
static boolean	isFeatureEnabled(Class<? extends WebServiceFeature> type, WebServiceFeature[] features)
Iterator<WebServiceFeature>	iterator()
void	mergeFeatures(WSDLPort wsdlPort, boolean honorWsdlRequired, boolean reportConflicts)	Extracts features from WSDLFeaturedObject.getFeatures().
void	mergeFeatures(Iterable<WebServiceFeature> features, boolean reportConflicts)	Merges the extra features that are not already set on binding.
void	mergeFeatures(WebServiceFeature[] features, boolean reportConflicts)	Merges the extra features that are not already set on binding.
void	parseAnnotations(Class<?> endpointClass)
void	parseAnnotations(Iterable<Annotation> annIt)	Adds the corresponding features to the list for feature annotations(i.e which have WebServiceFeatureAnnotation meta annotation)
WebServiceFeature	put(Class<? extends WebServiceFeature> key, WebServiceFeature value)
void	setParentFeaturedObject(WSDLFeaturedObject parent)	Set the parent features.
WebServiceFeature[]	toArray()	Obtains all the features in the array.
static WebServiceFeature[]	toFeatureArray(WSBinding binding)
static WebServiceFeatureList	toList(Iterable<WebServiceFeature> features)
String	toString()
void	validate()

Methods inherited from class java.util.AbstractMap

clear, clone, containsKey, containsValue, get, hashCode, isEmpty, keySet, putAll, remove, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

WebServiceFeatureList

public WebServiceFeatureList()

WebServiceFeatureList

public WebServiceFeatureList(@NotNull
                             WebServiceFeature... features)

WebServiceFeatureList

public WebServiceFeatureList(WebServiceFeatureList features)

WebServiceFeatureList

public WebServiceFeatureList(@NotNull
                             Class<?> endpointClass)

Creates a list by reading featuers from the annotation on a class.

Method Detail

toList

public static WebServiceFeatureList toList(Iterable<WebServiceFeature> features)

validate

public void validate()

parseAnnotations

public void parseAnnotations(Iterable<Annotation> annIt)

Adds the corresponding features to the list for feature annotations(i.e which have WebServiceFeatureAnnotation meta annotation)

Parameters:

annIt - collection of annotations(that can have non-feature annotations)

getFeature

public static WebServiceFeature getFeature(Annotation a)

Returns a corresponding feature for a feature annotation(i.e which has WebServiceFeatureAnnotation meta annotation)

Returns:

corresponding feature for the annotation null, if the annotation is nota feature annotation

parseAnnotations

public void parseAnnotations(Class<?> endpointClass)

Parameters:

endpointClass - web service impl class

iterator

public Iterator<WebServiceFeature> iterator()

Specified by:

iterator in interface Iterable<WebServiceFeature>

toArray

@NotNull
public WebServiceFeature[] toArray()

Description copied from interface: WSFeatureList

Obtains all the features in the array.

Specified by:

toArray in interface WSFeatureList

isEnabled

public boolean isEnabled(@NotNull
                         Class<? extends WebServiceFeature> feature)

Description copied from interface: WSFeatureList

Checks if a particular WebServiceFeature is enabled.

Specified by:

isEnabled in interface WSFeatureList

Returns:

true if enabled.

contains

public boolean contains(@NotNull
                        Class<? extends WebServiceFeature> feature)

get

@Nullable
public <F extends WebServiceFeature> F get(@NotNull
                                           Class<F> featureType)

Description copied from interface: WSFeatureList

Gets a WebServiceFeature of the specific type.

Specified by:

get in interface WSFeatureList

Parameters:

featureType - The type of the feature to retrieve.

Returns:

If the feature is present and enabled, return a non-null instance. Otherwise null.

add

public void add(@NotNull
                WebServiceFeature f)

Adds a feature to the list if it's not already added.

addAll

public void addAll(@NotNull
                   Iterable<WebServiceFeature> list)

Adds features to the list if it's not already added.

equals

public boolean equals(Object other)

Specified by:

equals in interface Map<Class<? extends WebServiceFeature>,WebServiceFeature>

Overrides:

equals in class AbstractMap<Class<? extends WebServiceFeature>,WebServiceFeature>

toString

public String toString()

Overrides:

toString in class AbstractMap<Class<? extends WebServiceFeature>,WebServiceFeature>

mergeFeatures

public void mergeFeatures(@NotNull
                          Iterable<WebServiceFeature> features,
                          boolean reportConflicts)

Merges the extra features that are not already set on binding. i.e, if a feature is set already on binding through some other API the corresponding wsdlFeature is not set.

Specified by:

mergeFeatures in interface WSFeatureList

Parameters:

features - Web Service features that need to be merged with already configured features.

reportConflicts - If true, checks if the feature setting in WSDL (wsdl extension or policy configuration) conflicts with feature setting in Deployed Service and logs warning if there are any conflicts.

mergeFeatures

public void mergeFeatures(WebServiceFeature[] features,
                          boolean reportConflicts)

Description copied from interface: WSFeatureList

Merges the extra features that are not already set on binding. i.e, if a feature is set already on binding through some other API the corresponding wsdlFeature is not set.

Specified by:

mergeFeatures in interface WSFeatureList

Parameters:

features - Web Service features that need to be merged with already configured features.

reportConflicts - If true, checks if the feature setting in WSDL (wsdl extension or policy configuration) conflicts with feature setting in Deployed Service and logs warning if there are any conflicts.

mergeFeatures

public void mergeFeatures(@NotNull
                          WSDLPort wsdlPort,
                          boolean honorWsdlRequired,
                          boolean reportConflicts)

Extracts features from WSDLFeaturedObject.getFeatures(). Extra features that are not already set on binding. i.e, if a feature is set already on binding through some other API the corresponding wsdlFeature is not set.

Parameters:

wsdlPort - WSDLPort model

honorWsdlRequired - If this is true add WSDL Feature only if wsd:Required=true In SEI case, it should be false In Provider case, it should be true

reportConflicts - If true, checks if the feature setting in WSDL (wsdl extension or policy configuration) conflicts with feature setting in Deployed Service and logs warning if there are any conflicts.

setParentFeaturedObject

public void setParentFeaturedObject(@NotNull
                                    WSDLFeaturedObject parent)

Set the parent features. Basically the parent feature list will be overriden by this feature list.

getFeature

@Nullable
public static <F extends WebServiceFeature> F getFeature(@NotNull
                                                         WebServiceFeature[] features,
                                                         @NotNull
                                                         Class<F> featureType)

entrySet

public Set<Map.Entry<Class<? extends WebServiceFeature>,WebServiceFeature>> entrySet()

Specified by:

entrySet in interface Map<Class<? extends WebServiceFeature>,WebServiceFeature>

Specified by:

entrySet in class AbstractMap<Class<? extends WebServiceFeature>,WebServiceFeature>

put

public WebServiceFeature put(Class<? extends WebServiceFeature> key,
                             WebServiceFeature value)

Specified by:

put in interface Map<Class<? extends WebServiceFeature>,WebServiceFeature>

Overrides:

put in class AbstractMap<Class<? extends WebServiceFeature>,WebServiceFeature>

getSoapVersion

public static SOAPVersion getSoapVersion(WSFeatureList features)

isFeatureEnabled

public static boolean isFeatureEnabled(Class<? extends WebServiceFeature> type,
                                       WebServiceFeature[] features)

toFeatureArray

public static WebServiceFeature[] toFeatureArray(WSBinding binding)