com.sun.xml.ws.policy

Class PolicyMap

java.lang.Object

com.sun.xml.ws.policy.PolicyMap

All Implemented Interfaces:

java.lang.Iterable<Policy>

public final class PolicyMap
extends java.lang.Object
implements java.lang.Iterable<Policy>

A PolicyMap holds all policies for a scope. This map is modeled around WSDL 1.1 policy scopes according to WS-PolicyAttachment. The map holds an information about every scope for service, endpoint, operation, and input/output/fault message. It also provide accessibility methods for computing and obtaining effective policy on each scope. TODO: rename createWsdlMessageScopeKey to createWsdlInputOutputMessageScopeKey

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	PolicyMap.ScopeMap
(package private) static class	PolicyMap.ScopeType

Field Summary

Fields

Modifier and Type	Field and Description
private static PolicyMapKeyHandler	endpointKeyHandler
private PolicyMap.ScopeMap	endpointMap
private static PolicyMapKeyHandler	faultMessageHandler
private PolicyMap.ScopeMap	faultMessageMap
private PolicyMap.ScopeMap	inputMessageMap
private static PolicyLogger	LOGGER
private static PolicyMerger	merger
private static PolicyMapKeyHandler	operationAndInputOutputMessageKeyHandler
private PolicyMap.ScopeMap	operationMap
private PolicyMap.ScopeMap	outputMessageMap
private static PolicyMapKeyHandler	serviceKeyHandler
private PolicyMap.ScopeMap	serviceMap

Constructor Summary

Constructors

Modifier	Constructor and Description
private	PolicyMap() This constructor is private to prevent direct instantiation from outside of the class

Method Summary

Modifier and Type	Method and Description
private void	addSubjects(java.util.Collection<PolicySubject> subjects, PolicyMap.ScopeMap scopeMap) Add all subjects in the given map to the collection
private static PolicyMapKey	createOperationOrInputOutputMessageKey(javax.xml.namespace.QName service, javax.xml.namespace.QName port, javax.xml.namespace.QName operation)
static PolicyMap	createPolicyMap(java.util.Collection<? extends PolicyMapMutator> mutators) Creates new policy map instance and connects provided collection of policy map mutators to the created policy map.
static PolicyMapKey	createWsdlEndpointScopeKey(javax.xml.namespace.QName service, javax.xml.namespace.QName port) Creates an endpoint policy scope locator object, that serves as a access key into a PolicyMap where actual endpoint policy scope for given endpoint can be retrieved.
static PolicyMapKey	createWsdlFaultMessageScopeKey(javax.xml.namespace.QName service, javax.xml.namespace.QName port, javax.xml.namespace.QName operation, javax.xml.namespace.QName fault) Creates a fault message policy scope locator object identified by a bound operation, that serves as a access key into PolicyMap where the actual fault message policy scope for one of the faults of a bound operation can be retrieved.
static PolicyMapKey	createWsdlMessageScopeKey(javax.xml.namespace.QName service, javax.xml.namespace.QName port, javax.xml.namespace.QName operation) Creates an input/output message policy scope locator object identified by a bound operation, that serves as a access key into PolicyMap where actual input/output message policy scope for given input message of a bound operation can be retrieved.
static PolicyMapKey	createWsdlOperationScopeKey(javax.xml.namespace.QName service, javax.xml.namespace.QName port, javax.xml.namespace.QName operation) Creates an operation policy scope locator object, that serves as a access key into a PolicyMap where actual operation policy scope for given bound operation can be retrieved.
static PolicyMapKey	createWsdlServiceScopeKey(javax.xml.namespace.QName service) Creates a service policy scope locator object, that serves as a access key into a PolicyMap where actual service policy scope for given service can be retrieved.
java.util.Collection<PolicyMapKey>	getAllEndpointScopeKeys() Returns all endpoint scope keys stored in this policy map
java.util.Collection<PolicyMapKey>	getAllFaultMessageScopeKeys() Returns all fault message scope keys stored in this policy map
java.util.Collection<PolicyMapKey>	getAllInputMessageScopeKeys() Returns all input message scope keys stored in this policy map
java.util.Collection<PolicyMapKey>	getAllOperationScopeKeys() Returns all operation scope keys stored in this policy map
java.util.Collection<PolicyMapKey>	getAllOutputMessageScopeKeys() Returns all output message scope keys stored in this policy map
java.util.Collection<PolicyMapKey>	getAllServiceScopeKeys() Returns all service scope keys stored in this policy map
Policy	getEndpointEffectivePolicy(PolicyMapKey key)
Policy	getFaultMessageEffectivePolicy(PolicyMapKey key)
Policy	getInputMessageEffectivePolicy(PolicyMapKey key)
Policy	getOperationEffectivePolicy(PolicyMapKey key)
Policy	getOutputMessageEffectivePolicy(PolicyMapKey key)
java.util.Collection<PolicySubject>	getPolicySubjects() Returns all policy subjects contained by this map.
Policy	getServiceEffectivePolicy(PolicyMapKey key)
boolean	isEmpty() Returns true if this map contains no key - policy pairs A null object key or policy constitutes a non-empty map.
boolean	isFaultMessageSubject(PolicySubject subject)
boolean	isInputMessageSubject(PolicySubject subject)
boolean	isOutputMessageSubject(PolicySubject subject)
java.util.Iterator<Policy>	iterator()
(package private) void	putSubject(PolicyMap.ScopeType scopeType, PolicyMapKey key, PolicySubject subject) Places new subject into policy map under the scope identified by it's type and policy map key.
(package private) void	setNewEffectivePolicyForScope(PolicyMap.ScopeType scopeType, PolicyMapKey key, Policy newEffectivePolicy) Replaces current effective policy on given scope (identified by a key parameter) with the new efective policy provided as a second input parameter.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

LOGGER

private static final PolicyLogger LOGGER

serviceKeyHandler

private static final PolicyMapKeyHandler serviceKeyHandler

endpointKeyHandler

private static final PolicyMapKeyHandler endpointKeyHandler

operationAndInputOutputMessageKeyHandler

private static final PolicyMapKeyHandler operationAndInputOutputMessageKeyHandler

faultMessageHandler

private static final PolicyMapKeyHandler faultMessageHandler

merger

private static final PolicyMerger merger

serviceMap

private final PolicyMap.ScopeMap serviceMap

endpointMap

private final PolicyMap.ScopeMap endpointMap

operationMap

private final PolicyMap.ScopeMap operationMap

inputMessageMap

private final PolicyMap.ScopeMap inputMessageMap

outputMessageMap

private final PolicyMap.ScopeMap outputMessageMap

faultMessageMap

private final PolicyMap.ScopeMap faultMessageMap

Constructor Detail

PolicyMap

private PolicyMap()

This constructor is private to prevent direct instantiation from outside of the class

Method Detail

createPolicyMap

public static PolicyMap createPolicyMap(java.util.Collection<? extends PolicyMapMutator> mutators)

Creates new policy map instance and connects provided collection of policy map mutators to the created policy map.

Parameters:

mutators - collection of mutators that should be connected to the newly created map.

Returns:

new policy map instance (mutable via provided collection of mutators).

getServiceEffectivePolicy

public Policy getServiceEffectivePolicy(PolicyMapKey key)
                                 throws PolicyException

Throws:

PolicyException

getEndpointEffectivePolicy

public Policy getEndpointEffectivePolicy(PolicyMapKey key)
                                  throws PolicyException

Throws:

PolicyException

getOperationEffectivePolicy

public Policy getOperationEffectivePolicy(PolicyMapKey key)
                                   throws PolicyException

Throws:

PolicyException

getInputMessageEffectivePolicy

public Policy getInputMessageEffectivePolicy(PolicyMapKey key)
                                      throws PolicyException

Throws:

PolicyException

getOutputMessageEffectivePolicy

public Policy getOutputMessageEffectivePolicy(PolicyMapKey key)
                                       throws PolicyException

Throws:

PolicyException

getFaultMessageEffectivePolicy

public Policy getFaultMessageEffectivePolicy(PolicyMapKey key)
                                      throws PolicyException

Throws:

PolicyException

getAllServiceScopeKeys

public java.util.Collection<PolicyMapKey> getAllServiceScopeKeys()

Returns all service scope keys stored in this policy map

Returns:

collection of service scope policy map keys stored in the map.

getAllEndpointScopeKeys

public java.util.Collection<PolicyMapKey> getAllEndpointScopeKeys()

Returns all endpoint scope keys stored in this policy map

Returns:

collection of endpoint scope policy map keys stored in the map.

getAllOperationScopeKeys

public java.util.Collection<PolicyMapKey> getAllOperationScopeKeys()

Returns all operation scope keys stored in this policy map

Returns:

collection of operation scope policy map keys stored in the map.

getAllInputMessageScopeKeys

public java.util.Collection<PolicyMapKey> getAllInputMessageScopeKeys()

Returns all input message scope keys stored in this policy map

Returns:

collection of input message scope policy map keys stored in the map.

getAllOutputMessageScopeKeys

public java.util.Collection<PolicyMapKey> getAllOutputMessageScopeKeys()

Returns all output message scope keys stored in this policy map

Returns:

collection of output message scope policy map keys stored in the map.

getAllFaultMessageScopeKeys

public java.util.Collection<PolicyMapKey> getAllFaultMessageScopeKeys()

Returns all fault message scope keys stored in this policy map

Returns:

collection of input message scope policy map keys stored in the map.

putSubject

void putSubject(PolicyMap.ScopeType scopeType,
                PolicyMapKey key,
                PolicySubject subject)

Places new subject into policy map under the scope identified by it's type and policy map key.

Parameters:

scopeType - the type of the scope the subject belongs to

key - a policy map key to be used to store the subject

subject - actual policy subject to be stored in the policy map

setNewEffectivePolicyForScope

void setNewEffectivePolicyForScope(PolicyMap.ScopeType scopeType,
                                   PolicyMapKey key,
                                   Policy newEffectivePolicy)
                            throws java.lang.IllegalArgumentException

Replaces current effective policy on given scope (identified by a key parameter) with the new efective policy provided as a second input parameter. If no policy was defined for the presented key, the new policy is simply stored with the key.

Parameters:

scopeType - the type of the scope the subject belongs to. Must not be null.

key - identifier of the scope the effective policy should be replaced with the new one. Must not be null.

newEffectivePolicy - the new policy to replace the old effective policy of the scope. Must not be null.

Throws:

java.lang.IllegalArgumentException

getPolicySubjects

public java.util.Collection<PolicySubject> getPolicySubjects()

Returns all policy subjects contained by this map.

Returns:

All policy subjects contained by this map

isInputMessageSubject

public boolean isInputMessageSubject(PolicySubject subject)

isOutputMessageSubject

public boolean isOutputMessageSubject(PolicySubject subject)

isFaultMessageSubject

public boolean isFaultMessageSubject(PolicySubject subject)

isEmpty

public boolean isEmpty()

Returns true if this map contains no key - policy pairs A null object key or policy constitutes a non-empty map.

Returns:

true if this map contains no key - policy pairs

addSubjects

private void addSubjects(java.util.Collection<PolicySubject> subjects,
                         PolicyMap.ScopeMap scopeMap)

Add all subjects in the given map to the collection

Parameters:

subjects - A collection that should hold subjects. The new subjects are added to the collection. Must not be null.

scopeMap - A scope map that holds policy scopes. The subjects are retrieved from the scope objects.

createWsdlServiceScopeKey

public static PolicyMapKey createWsdlServiceScopeKey(javax.xml.namespace.QName service)
                                              throws java.lang.IllegalArgumentException

Creates a service policy scope locator object, that serves as a access key into a PolicyMap where actual service policy scope for given service can be retrieved.

Parameters:

service - qualified name of the service. Must not be null.

Throws:

java.lang.IllegalArgumentException - in case service, port or operation parameter is null.

createWsdlEndpointScopeKey

public static PolicyMapKey createWsdlEndpointScopeKey(javax.xml.namespace.QName service,
                                                      javax.xml.namespace.QName port)
                                               throws java.lang.IllegalArgumentException

Creates an endpoint policy scope locator object, that serves as a access key into a PolicyMap where actual endpoint policy scope for given endpoint can be retrieved.

Parameters:

service - qualified name of the service. Must not be null.

port - qualified name of the endpoint. Must not be null.

Throws:

java.lang.IllegalArgumentException - in case service, port or operation parameter is null.

createWsdlOperationScopeKey

public static PolicyMapKey createWsdlOperationScopeKey(javax.xml.namespace.QName service,
                                                       javax.xml.namespace.QName port,
                                                       javax.xml.namespace.QName operation)
                                                throws java.lang.IllegalArgumentException

Creates an operation policy scope locator object, that serves as a access key into a PolicyMap where actual operation policy scope for given bound operation can be retrieved.

Parameters:

service - qualified name of the service. Must not be null.

port - qualified name of the endpoint. Must not be null.

operation - qualified name of the operation. Must not be null.

Throws:

java.lang.IllegalArgumentException - in case service, port or operation parameter is null.

createWsdlMessageScopeKey

public static PolicyMapKey createWsdlMessageScopeKey(javax.xml.namespace.QName service,
                                                     javax.xml.namespace.QName port,
                                                     javax.xml.namespace.QName operation)
                                              throws java.lang.IllegalArgumentException

Creates an input/output message policy scope locator object identified by a bound operation, that serves as a access key into PolicyMap where actual input/output message policy scope for given input message of a bound operation can be retrieved.

The method returns a key that is compliant with WSDL 1.1 Basic Profile Specification, according to which there should be no two operations with the same name in a single port type definition.

Parameters:

service - qualified name of the service. Must not be null.

port - qualified name of the endpoint. Must not be null.

operation - qualified name of the operation. Must not be null.

Throws:

java.lang.IllegalArgumentException - in case service, port or operation parameter is null.

createWsdlFaultMessageScopeKey

public static PolicyMapKey createWsdlFaultMessageScopeKey(javax.xml.namespace.QName service,
                                                          javax.xml.namespace.QName port,
                                                          javax.xml.namespace.QName operation,
                                                          javax.xml.namespace.QName fault)
                                                   throws java.lang.IllegalArgumentException

Creates a fault message policy scope locator object identified by a bound operation, that serves as a access key into PolicyMap where the actual fault message policy scope for one of the faults of a bound operation can be retrieved.

The method returns a key that is compliant with the WSDL 1.1 Basic Profile Specification, according to which there should be no two operations with the same name in a single port type definition.

Parameters:

service - qualified name of the service. Must not be null.

port - qualified name of the endpoint. Must not be null.

operation - qualified name of the operation. Must not be null.

fault - qualified name of the fault. Do not confuse this with the name of the actual message. This parameter takes the wsdl:binding/wsdl:operation/wsdl:fault name and not the wsdl:message name. Must not be null.

Throws:

java.lang.IllegalArgumentException - in case service, port or operation parameter is null.

createOperationOrInputOutputMessageKey

private static PolicyMapKey createOperationOrInputOutputMessageKey(javax.xml.namespace.QName service,
                                                                   javax.xml.namespace.QName port,
                                                                   javax.xml.namespace.QName operation)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

iterator

public java.util.Iterator<Policy> iterator()

Specified by:

iterator in interface java.lang.Iterable<Policy>