public class MessagePolicy extends Object
A ClientAuthContext uses this class to communicate (at module initialization time) request and response message protection policies to its ClientAuthModule objects. A ServerAuthContext uses this class to communicate request and response message protection policies to its ServerAuthModule objects.
Modifier and Type | Class and Description |
---|---|
static interface |
MessagePolicy.ProtectionPolicy
This interface is used to represent message authentication policy.
|
static interface |
MessagePolicy.Target
This interface is used to represent and perform message targeting.
|
static class |
MessagePolicy.TargetPolicy
This class defines the message protection policies for specific Targets.
|
Constructor and Description |
---|
MessagePolicy(MessagePolicy.TargetPolicy[] targetPolicies,
boolean mandatory)
Create a MessagePolicy instance with an array of target policies.
|
Modifier and Type | Method and Description |
---|---|
MessagePolicy.TargetPolicy[] |
getTargetPolicies()
Get the target policies that comprise the authentication policy.
|
boolean |
isMandatory()
Get the MessagePolicy modifier.
|
public MessagePolicy(MessagePolicy.TargetPolicy[] targetPolicies, boolean mandatory)
targetPolicies
- an array of target policies.mandatory
- A boolean value indicating whether the MessagePolicy is mandatory or optional.IllegalArgumentException
- if the specified targetPolicies is null.public boolean isMandatory()
public MessagePolicy.TargetPolicy[] getTargetPolicies()
When this method returns an array of target policies, the order of elements in the array represents the order that the corresponding message transformations or validations described by the target policies are to be performed by the authentication module.
Copyright © 2021 JBoss by Red Hat. All rights reserved.