JBoss Java Authentication SPI for Containers 1.0 API 1.0.0.Final

javax.security.auth.message
Class MessagePolicy

java.lang.Object
  extended by 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.

Since:
May 11, 2006
Version:
$Revision: 109051 $
Author:
Anil Saldhana@jboss.org, Charlie Lai, Ron Monzillo (Javadoc for JSR-196)

Nested Class Summary
static interface MessagePolicy.ProtectionPolicy
          This interface is used to represent message authentication policy.
static interface MessagePolicy.Target
          This interface is implemented by objects that represent and perform message targeting on behalf of authentication modules.
static class MessagePolicy.TargetPolicy
           
 
Constructor Summary
MessagePolicy(MessagePolicy.TargetPolicy[] targetPolicies, boolean mandatory)
          Create a MessagePolicy instance with an array of target policies.
 
Method Summary
 MessagePolicy.TargetPolicy[] getTargetPolicies()
          Get the target policies that comprise the authentication policy.
 boolean isMandatory()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

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

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.

isMandatory

public boolean isMandatory()

JBoss Java Authentication SPI for Containers 1.0 API 1.0.0.Final

Copyright © 2011 JBoss, a division of Red Hat, Inc.. All Rights Reserved.