|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.sun.xml.ws.policy.PolicyMap
public final class PolicyMap
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
| Method Summary | |
|---|---|
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. |
static PolicyMapKey |
createWsdlEndpointScopeKey(QName service,
QName port)
Creates an endpoint policy scope PolicyMap where actual endpoint policy scope for given endpoint can be retrieved. |
static PolicyMapKey |
createWsdlFaultMessageScopeKey(QName service,
QName port,
QName operation,
QName fault)
Creates a fault message policy scope PolicyMap where the actual fault message policy scope for one of the faults of a bound operation
can be retrieved. |
static PolicyMapKey |
createWsdlMessageScopeKey(QName service,
QName port,
QName operation)
Creates an input/output message policy scope PolicyMap where actual input/output message policy scope for given input message of a bound operation
can be retrieved. |
static PolicyMapKey |
createWsdlOperationScopeKey(QName service,
QName port,
QName operation)
Creates an operation policy scope PolicyMap where actual operation policy scope for given bound operation can be retrieved. |
static PolicyMapKey |
createWsdlServiceScopeKey(QName service)
Creates a service policy scope PolicyMap where actual service policy scope for given service can be retrieved. |
Collection<PolicyMapKey> |
getAllEndpointScopeKeys()
Returns all endpoint scope keys stored in this policy map |
Collection<PolicyMapKey> |
getAllFaultMessageScopeKeys()
Returns all fault message scope keys stored in this policy map |
Collection<PolicyMapKey> |
getAllInputMessageScopeKeys()
Returns all input message scope keys stored in this policy map |
Collection<PolicyMapKey> |
getAllOperationScopeKeys()
Returns all operation scope keys stored in this policy map |
Collection<PolicyMapKey> |
getAllOutputMessageScopeKeys()
Returns all output message scope keys stored in this policy map |
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)
|
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)
|
Iterator<Policy> |
iterator()
|
String |
toString()
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Method Detail |
|---|
public static PolicyMap createPolicyMap(Collection<? extends PolicyMapMutator> mutators)
mutators - collection of mutators that should be connected to the newly created map.
public Policy getServiceEffectivePolicy(PolicyMapKey key)
throws PolicyException
PolicyException
public Policy getEndpointEffectivePolicy(PolicyMapKey key)
throws PolicyException
PolicyException
public Policy getOperationEffectivePolicy(PolicyMapKey key)
throws PolicyException
PolicyException
public Policy getInputMessageEffectivePolicy(PolicyMapKey key)
throws PolicyException
PolicyException
public Policy getOutputMessageEffectivePolicy(PolicyMapKey key)
throws PolicyException
PolicyException
public Policy getFaultMessageEffectivePolicy(PolicyMapKey key)
throws PolicyException
PolicyExceptionpublic Collection<PolicyMapKey> getAllServiceScopeKeys()
public Collection<PolicyMapKey> getAllEndpointScopeKeys()
public Collection<PolicyMapKey> getAllOperationScopeKeys()
public Collection<PolicyMapKey> getAllInputMessageScopeKeys()
public Collection<PolicyMapKey> getAllOutputMessageScopeKeys()
public Collection<PolicyMapKey> getAllFaultMessageScopeKeys()
public Collection<PolicySubject> getPolicySubjects()
public boolean isInputMessageSubject(PolicySubject subject)
public boolean isOutputMessageSubject(PolicySubject subject)
public boolean isFaultMessageSubject(PolicySubject subject)
public boolean isEmpty()
public static PolicyMapKey createWsdlServiceScopeKey(QName service)
throws IllegalArgumentException
PolicyMap where actual service policy scope for given service can be retrieved.
service - qualified name of the service. Must not be null.
IllegalArgumentException - in case service, port or operation parameter is null.
public static PolicyMapKey createWsdlEndpointScopeKey(QName service,
QName port)
throws IllegalArgumentException
PolicyMap where actual endpoint policy scope for given endpoint can be retrieved.
service - qualified name of the service. Must not be null.port - qualified name of the endpoint. Must not be null.
IllegalArgumentException - in case service, port or operation parameter is null.
public static PolicyMapKey createWsdlOperationScopeKey(QName service,
QName port,
QName operation)
throws IllegalArgumentException
PolicyMap where actual operation policy scope for given bound operation can be retrieved.
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.
IllegalArgumentException - in case service, port or operation parameter is null.
public static PolicyMapKey createWsdlMessageScopeKey(QName service,
QName port,
QName operation)
throws IllegalArgumentException
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
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.
IllegalArgumentException - in case service, port or operation parameter is null.
public static PolicyMapKey createWsdlFaultMessageScopeKey(QName service,
QName port,
QName operation,
QName fault)
throws IllegalArgumentException
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
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.
IllegalArgumentException - in case service, port or operation parameter is null.public String toString()
toString in class Objectpublic Iterator<Policy> iterator()
iterator in interface Iterable<Policy>
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||