Module com.sun.xml.ws.policy

Package com.sun.xml.ws.policy

Class EffectivePolicyModifier

java.lang.Object

com.sun.xml.ws.policy.PolicyMapMutator

com.sun.xml.ws.policy.EffectivePolicyModifier

public final class EffectivePolicyModifier
extends PolicyMapMutator

The class serves as a policy map mutator that allows for replacement of current effective policies stored in the policy map with new effective policy provided by the mutator user.

Author:

Marek Potociar (marek.potociar@sun.com)

Method Summary

Modifier and Type	Method	Description
static EffectivePolicyModifier	createEffectivePolicyModifier()
void	setNewEffectivePolicyForEndpointScope(PolicyMapKey key, Policy newEffectivePolicy)	Replaces current effective policy on the endpoint scope (identified by a key parameter) with the new efective policy provided as a second input parameter.
void	setNewEffectivePolicyForFaultMessageScope(PolicyMapKey key, Policy newEffectivePolicy)	Replaces current effective policy on the fault message scope (identified by a key parameter) with the new efective policy provided as a second input parameter.
void	setNewEffectivePolicyForInputMessageScope(PolicyMapKey key, Policy newEffectivePolicy)	Replaces current effective policy on the input message scope (identified by a key parameter) with the new efective policy provided as a second input parameter.
void	setNewEffectivePolicyForOperationScope(PolicyMapKey key, Policy newEffectivePolicy)	Replaces current effective policy on the operation scope (identified by a key parameter) with the new efective policy provided as a second input parameter.
void	setNewEffectivePolicyForOutputMessageScope(PolicyMapKey key, Policy newEffectivePolicy)	Replaces current effective policy on the output message scope (identified by a key parameter) with the new efective policy provided as a second input parameter.
void	setNewEffectivePolicyForServiceScope(PolicyMapKey key, Policy newEffectivePolicy)	Replaces current effective policy on the service scope (identified by a key parameter) with the new efective policy provided as a second input parameter.

Methods inherited from class java.lang.Object

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

Methods inherited from class com.sun.xml.ws.policy.PolicyMapMutator

connect, disconnect, getMap, isConnected

Method Detail

createEffectivePolicyModifier

public static EffectivePolicyModifier createEffectivePolicyModifier()

setNewEffectivePolicyForServiceScope

public void setNewEffectivePolicyForServiceScope(PolicyMapKey key,
                                                 Policy newEffectivePolicy)

Replaces current effective policy on the service 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:

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:

IllegalArgumentException - in case any of the input parameters is null

setNewEffectivePolicyForEndpointScope

public void setNewEffectivePolicyForEndpointScope(PolicyMapKey key,
                                                  Policy newEffectivePolicy)

Replaces current effective policy on the endpoint scope (identified by a key parameter) with the new efective policy provided as a second input parameter.

Parameters:

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:

IllegalArgumentException - in case any of the input parameters is null

setNewEffectivePolicyForOperationScope

public void setNewEffectivePolicyForOperationScope(PolicyMapKey key,
                                                   Policy newEffectivePolicy)

Replaces current effective policy on the operation 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:

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:

IllegalArgumentException - in case any of the input parameters is null

setNewEffectivePolicyForInputMessageScope

public void setNewEffectivePolicyForInputMessageScope(PolicyMapKey key,
                                                      Policy newEffectivePolicy)

Replaces current effective policy on the input message 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:

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:

IllegalArgumentException - in case any of the input parameters is null

setNewEffectivePolicyForOutputMessageScope

public void setNewEffectivePolicyForOutputMessageScope(PolicyMapKey key,
                                                       Policy newEffectivePolicy)

Replaces current effective policy on the output message 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:

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:

IllegalArgumentException - in case any of the input parameters is null

setNewEffectivePolicyForFaultMessageScope

public void setNewEffectivePolicyForFaultMessageScope(PolicyMapKey key,
                                                      Policy newEffectivePolicy)

Replaces current effective policy on the fault message 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:

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:

IllegalArgumentException - in case any of the input parameters is null