javax.security.auth.message
Interface MessagePolicy.Target

Enclosing class:

MessagePolicy

public static interface MessagePolicy.Target

This interface is implemented by objects that represent and perform message targeting on behalf of authentication modules.

The internal state of a Target indicates whether it applies to the request or response message of an AuthParam and to which components it applies within the identified message.

Method Summary

Object	get(MessageInfo messageInfo) Get the Object identified by the Target from the AuthParam.
void	put(MessageInfo messageInfo, Object data) Put the Object into the AuthParam at the location identified by the target.
void	remove(MessageInfo messageInfo) Remove the Object identified by the Target from the AuthParam.

Method Detail

get

Object get(MessageInfo messageInfo)

Get the Object identified by the Target from the AuthParam.

Parameters:

authParam - the AuthParam containing the request or response message from which the target is to be obtained.

Returns:

an Object representing the target, or null when the target could not be found in the AuthParam.

put

void put(MessageInfo messageInfo,
         Object data)

Put the Object into the AuthParam at the location identified by the target.

Parameters:

authParam - the AuthParam containing the request or response message into which the object is to be put.

data -

remove

void remove(MessageInfo messageInfo)

Remove the Object identified by the Target from the AuthParam.

Parameters:

authParam - the AuthParam containing the request or response message from which the target is to be removed.