FileDocCategorySizeDatePackage
EffectivePolicyModifier.javaAPI DocExample8095Tue May 29 16:56:34 BST 2007com.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)

Fields Summary
Constructors Summary
private EffectivePolicyModifier()
Ensures that direct instantiation is not possible from outside of the class

        // no initialization required
    
Methods Summary
public static com.sun.xml.ws.policy.EffectivePolicyModifiercreateEffectivePolicyModifier()

        return new EffectivePolicyModifier();
    
public voidsetNewEffectivePolicyForEndpointScope(PolicyMapKey key, Policy newEffectivePolicy)
Replaces current effective policy on the endpoint scope (identified by a {@code key} parameter) with the new efective policy provided as a second input parameter.

param
key identifier of the scope the effective policy should be replaced with the new one. Must not be {@code null}.
param
newEffectivePolicy the new policy to replace the old effective policy of the scope. Must not be {@code null}.
throws
IllegalArgumentException in case any of the input parameters is {@code null}

        getMap().setNewEffectivePolicyForScope(PolicyMap.ScopeType.ENDPOINT, key, newEffectivePolicy);
    
public voidsetNewEffectivePolicyForFaultMessageScope(PolicyMapKey key, Policy newEffectivePolicy)
Replaces current effective policy on the fault message scope (identified by a {@code 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.

param
key identifier of the scope the effective policy should be replaced with the new one. Must not be {@code null}.
param
newEffectivePolicy the new policy to replace the old effective policy of the scope. Must not be {@code null}.
throws
IllegalArgumentException in case any of the input parameters is {@code null}

        getMap().setNewEffectivePolicyForScope(PolicyMap.ScopeType.FAULT_MESSAGE, key, newEffectivePolicy);
    
public voidsetNewEffectivePolicyForInputMessageScope(PolicyMapKey key, Policy newEffectivePolicy)
Replaces current effective policy on the input message scope (identified by a {@code 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.

param
key identifier of the scope the effective policy should be replaced with the new one. Must not be {@code null}.
param
newEffectivePolicy the new policy to replace the old effective policy of the scope. Must not be {@code null}.
throws
IllegalArgumentException in case any of the input parameters is {@code null}

        getMap().setNewEffectivePolicyForScope(PolicyMap.ScopeType.INPUT_MESSAGE, key, newEffectivePolicy);
    
public voidsetNewEffectivePolicyForOperationScope(PolicyMapKey key, Policy newEffectivePolicy)
Replaces current effective policy on the operation scope (identified by a {@code 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.

param
key identifier of the scope the effective policy should be replaced with the new one. Must not be {@code null}.
param
newEffectivePolicy the new policy to replace the old effective policy of the scope. Must not be {@code null}.
throws
IllegalArgumentException in case any of the input parameters is {@code null}

        getMap().setNewEffectivePolicyForScope(PolicyMap.ScopeType.OPERATION, key, newEffectivePolicy);
    
public voidsetNewEffectivePolicyForOutputMessageScope(PolicyMapKey key, Policy newEffectivePolicy)
Replaces current effective policy on the output message scope (identified by a {@code 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.

param
key identifier of the scope the effective policy should be replaced with the new one. Must not be {@code null}.
param
newEffectivePolicy the new policy to replace the old effective policy of the scope. Must not be {@code null}.
throws
IllegalArgumentException in case any of the input parameters is {@code null}

        getMap().setNewEffectivePolicyForScope(PolicyMap.ScopeType.OUTPUT_MESSAGE, key, newEffectivePolicy);
    
public voidsetNewEffectivePolicyForServiceScope(PolicyMapKey key, Policy newEffectivePolicy)
Replaces current effective policy on the service scope (identified by a {@code 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.

param
key identifier of the scope the effective policy should be replaced with the new one. Must not be {@code null}.
param
newEffectivePolicy the new policy to replace the old effective policy of the scope. Must not be {@code null}.
throws
IllegalArgumentException in case any of the input parameters is {@code null}

        getMap().setNewEffectivePolicyForScope(PolicyMap.ScopeType.SERVICE, key, newEffectivePolicy);