FileDocCategorySizeDatePackage
GroupPrincipalCallback.javaAPI DocGlassfish v2 API4322Fri May 04 22:36:10 BST 2007javax.security.auth.message.callback

GroupPrincipalCallback

public class GroupPrincipalCallback extends Object implements Callback
Callback establishing group principals within the argument subject. This callback is intended to be called by a serverAuthModule during its validateRequest processing.
version
%I%, %G%

Fields Summary
private Subject
subject
private String[]
groups
Constructors Summary
public GroupPrincipalCallback(Subject s, String[] g)
Create a GroupPrincipalCallback to establish the container's representation of the corresponding group principals within the Subject.

param
s The Subject in which the container will create group principals.
param
g An array of Strings, where each element contains the name of a group that will be used to create a corresponding group principal within the Subject.

When a null value is passed to the g argument, the handler will establish the container's representation of no group principals within the Subject. Otherwise, the handler's processing of this callback is additive, yielding the union (without duplicates) of the principals existing within the Subject, and those created with the names occuring within the argument array. The CallbackHandler will define the type of the created principals.

	subject = s;
	groups = g;
    
Methods Summary
public java.lang.String[]getGroups()
Get the array of group names.

return
Null, or an array containing 0 or more String group names.

When the return value is null, the handler will establish the container's representation of no group principals within the Subject. Otherwise, the handler's processing of this callback is additive, yielding the union (without duplicates) of the principals created with the names in the returned array and those existing within the Subject.

	return groups;
    
public javax.security.auth.SubjectgetSubject()
Get the Subject in which the handler will establish the group principals.

return
The subject.

	return subject;