| java.lang.Object
 com.sun.xml.ws.policy.PolicyMap
| PolicyMap | | final public class PolicyMap implements Iterable<Policy>(Code) | | 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
|
| Inner Class :static enum ScopeType | |
| Method Summary | |
| public static PolicyMap | createPolicyMap(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. | | public static PolicyMapKey | createWsdlEndpointScopeKey(QName service, 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.
Parameters:
service - qualified name of the service. | | public static PolicyMapKey | createWsdlFaultMessageScopeKey(QName service, QName port, QName operation, 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.
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. | | public static PolicyMapKey | createWsdlMessageScopeKey(QName service, QName port, 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.
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. | | public static PolicyMapKey | createWsdlOperationScopeKey(QName service, QName port, 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.
Parameters:
service - qualified name of the service. | | public static PolicyMapKey | createWsdlServiceScopeKey(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.
Parameters:
service - qualified name of the service. | | public Collection<PolicyMapKey> | getAllEndpointScopeKeys()
| | public Collection<PolicyMapKey> | getAllFaultMessageScopeKeys()
| | public Collection<PolicyMapKey> | getAllInputMessageScopeKeys()
| | public Collection<PolicyMapKey> | getAllOperationScopeKeys()
| | public Collection<PolicyMapKey> | getAllOutputMessageScopeKeys()
| | public Collection<PolicyMapKey> | getAllServiceScopeKeys()
| | public Policy | getEndpointEffectivePolicy(PolicyMapKey key)
| | public Policy | getEndpointEffectivePolicy(PolicyMapKey key, Collection<String> namespaces)
| | public Policy | getFaultMessageEffectivePolicy(PolicyMapKey key)
| | public Policy | getFaultMessageEffectivePolicy(PolicyMapKey key, Collection<String> namespaces)
| | public Policy | getInputMessageEffectivePolicy(PolicyMapKey key)
| | public Policy | getInputMessageEffectivePolicy(PolicyMapKey key, Collection<String> namespaces)
| | public Policy | getOperationEffectivePolicy(PolicyMapKey key)
| | public Policy | getOperationEffectivePolicy(PolicyMapKey key, Collection<String> namespaces)
| | public Policy | getOutputMessageEffectivePolicy(PolicyMapKey key)
| | public Policy | getOutputMessageEffectivePolicy(PolicyMapKey key, Collection<String> namespaces)
| | public Collection<PolicySubject> | getPolicySubjects()
Returns all policy subjects contained by this map. | | public Policy | getServiceEffectivePolicy(PolicyMapKey key)
| | public Policy | getServiceEffectivePolicy(PolicyMapKey key, Collection<String> namespaces)
| | public boolean | isEmpty()
Returns true if this map contains no key - policy pairs
A null object key or policy constitutes a non-empty map. | | public boolean | isFaultMessageSubject(PolicySubject subject)
| | public boolean | isInputMessageSubject(PolicySubject subject)
| | public boolean | isOutputMessageSubject(PolicySubject subject)
| | public Iterator<Policy> | iterator()
| | void | putSubject(ScopeType scopeType, PolicyMapKey key, PolicySubject subject)
Places new subject into policy map under the scope identified by it's type and policy map key. | | void | setNewEffectivePolicyForScope(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. | | public String | toString()
|
| createPolicyMap | | public static PolicyMap createPolicyMap(Collection<? extends PolicyMapMutator> mutators)(Code) | | 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. new policy map instance (mutable via provided collection of mutators). |
| createWsdlEndpointScopeKey | | public static PolicyMapKey createWsdlEndpointScopeKey(QName service, QName port) throws IllegalArgumentException(Code) | | 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 .
Parameters:
port - qualified name of the endpoint. Must not be null .
throws:
IllegalArgumentException - in case service, port or operation parameter is null . |
| createWsdlFaultMessageScopeKey | | public static PolicyMapKey createWsdlFaultMessageScopeKey(QName service, QName port, QName operation, QName fault) throws IllegalArgumentException(Code) | | 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 .
Parameters:
port - qualified name of the endpoint. Must not be null .
Parameters:
operation - qualified name of the operation. Must not be null .
Parameters:
fault - qualified name of the fault. Do not confuse this with the name of the actual message. This parametertakes the wsdl:binding/wsdl:operation/wsdl:fault name and not the wsdl:message name. Must not be null .
throws:
IllegalArgumentException - in case service, port or operation parameter is null . |
| createWsdlMessageScopeKey | | public static PolicyMapKey createWsdlMessageScopeKey(QName service, QName port, QName operation) throws IllegalArgumentException(Code) | | 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 .
Parameters:
port - qualified name of the endpoint. Must not be null .
Parameters:
operation - qualified name of the operation. Must not be null .
throws:
IllegalArgumentException - in case service, port or operation parameter is null . |
| createWsdlOperationScopeKey | | public static PolicyMapKey createWsdlOperationScopeKey(QName service, QName port, QName operation) throws IllegalArgumentException(Code) | | 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 .
Parameters:
port - qualified name of the endpoint. Must not be null .
Parameters:
operation - qualified name of the operation. Must not be null .
throws:
IllegalArgumentException - in case service, port or operation parameter is null . |
| createWsdlServiceScopeKey | | public static PolicyMapKey createWsdlServiceScopeKey(QName service) throws IllegalArgumentException(Code) | | 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:
IllegalArgumentException - in case service, port or operation parameter is null . |
| getAllEndpointScopeKeys | | public Collection<PolicyMapKey> getAllEndpointScopeKeys()(Code) | | Returns all endpoint scope keys stored in this policy map
collection of endpoint scope policy map keys stored in the map. |
| getAllFaultMessageScopeKeys | | public Collection<PolicyMapKey> getAllFaultMessageScopeKeys()(Code) | | Returns all fault message scope keys stored in this policy map
collection of input message scope policy map keys stored in the map. |
| getAllInputMessageScopeKeys | | public Collection<PolicyMapKey> getAllInputMessageScopeKeys()(Code) | | Returns all input message scope keys stored in this policy map
collection of input message scope policy map keys stored in the map. |
| getAllOperationScopeKeys | | public Collection<PolicyMapKey> getAllOperationScopeKeys()(Code) | | Returns all operation scope keys stored in this policy map
collection of operation scope policy map keys stored in the map. |
| getAllOutputMessageScopeKeys | | public Collection<PolicyMapKey> getAllOutputMessageScopeKeys()(Code) | | Returns all output message scope keys stored in this policy map
collection of output message scope policy map keys stored in the map. |
| getAllServiceScopeKeys | | public Collection<PolicyMapKey> getAllServiceScopeKeys()(Code) | | Returns all service scope keys stored in this policy map
collection of service scope policy map keys stored in the map. |
| getPolicySubjects | | public Collection<PolicySubject> getPolicySubjects()(Code) | | Returns all policy subjects contained by this map.
All policy subjects contained by this map |
| isEmpty | | public boolean isEmpty()(Code) | | Returns true if this map contains no key - policy pairs
A null object key or policy constitutes a non-empty map.
true if this map contains no key - policy pairs |
| putSubject | | void putSubject(ScopeType scopeType, PolicyMapKey key, PolicySubject subject)(Code) | | 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
Parameters:
key - a policy map key to be used to store the subject
Parameters:
subject - actual policy subject to be stored in the policy map |
| setNewEffectivePolicyForScope | | void setNewEffectivePolicyForScope(ScopeType scopeType, PolicyMapKey key, Policy newEffectivePolicy) throws IllegalArgumentException(Code) | | 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 .
Parameters:
key - identifier of the scope the effective policy should be replaced with the new one. Must not be null .
Parameters:
newEffectivePolicy - the new policy to replace the old effective policy of the scope. Must not be null . null |
|
|