- java.lang.Object
-
- javax.security.auth.message.MessagePolicy
-
public class MessagePolicy extends Object
This class defines a message authentication policy.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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static interfaceMessagePolicy.ProtectionPolicyThis interface is used to represent message authentication policy.static interfaceMessagePolicy.TargetThis interface is used to represent and perform message targeting.static classMessagePolicy.TargetPolicyThis class defines the message protection policies for specific Targets.
-
Constructor Summary
Constructors Constructor and Description MessagePolicy(MessagePolicy.TargetPolicy[] targetPolicies, boolean mandatory)Create a MessagePolicy instance with an array of target policies.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description MessagePolicy.TargetPolicy[]getTargetPolicies()Get the target policies that comprise the authentication policy.booleanisMandatory()Get the MessagePolicy modifier.
-
-
-
Constructor Detail
-
MessagePolicy
public MessagePolicy(MessagePolicy.TargetPolicy[] targetPolicies, boolean mandatory)
Create a MessagePolicy instance with an array of target policies.- Parameters:
targetPolicies- an array of target policies.mandatory- A boolean value indicating whether the MessagePolicy is mandatory or optional.- Throws:
IllegalArgumentException- if the specified targetPolicies is null.
-
-
Method Detail
-
isMandatory
public boolean isMandatory()
Get the MessagePolicy modifier.- Returns:
- A boolean indicating whether the MessagePolicy is optional(false) or required(true).
-
getTargetPolicies
public MessagePolicy.TargetPolicy[] getTargetPolicies()
Get the target policies that comprise the authentication policy.- Returns:
- An array of target authentication policies, where each element
describes an authentication policy and the parts of the message to which
the authentication policy applies. This method returns null to indicate
that no security operations should be performed on the messages to which
the policy applies. This method never returns a zero-length array.
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.
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/security/auth/message/MessagePolicy.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.