public class CallerPrincipalCallback
extends java.lang.Object
implements javax.security.auth.callback.Callback
This callback is intended to be called by a serverAuthModule
during its validateRequest
processing.
Constructor and Description |
---|
CallerPrincipalCallback(javax.security.auth.Subject subject,
java.security.Principal principal)
Create a CallerPrincipalCallback to set the container's representation of the caller principal
|
CallerPrincipalCallback(javax.security.auth.Subject subject,
java.lang.String name)
Create a CallerPrincipalCallback to set the container's representation of the caller principal.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getName()
Get the caller principal name.
|
java.security.Principal |
getPrincipal()
Get the caller principal.
|
javax.security.auth.Subject |
getSubject()
Get the Subject in which the handler will distinguish the caller principal
|
public CallerPrincipalCallback(javax.security.auth.Subject subject, java.security.Principal principal)
The CallbackHandler must use the argument Principal
to establish the caller principal associated with
the invocation being processed by the container. When the argument Principal
is null, the handler must
establish the container's representation of the unauthenticated caller principal.
The handler may perform principal mapping of non-null argument Principal
values, but it must be possible
to configure the handler such that it establishes the non-null argument Principal
as the caller
principal.
subject
- The Subject in which the container will distinguish the caller identity.principal
- The Principal that will be distinguished as the caller principal. This value may be null.public CallerPrincipalCallback(javax.security.auth.Subject subject, java.lang.String name)
The CallbackHandler must use the name
argument to establish the caller principal associated with the
invocation being processed by the container. When the name
argument is null, the handler must establish
the container's representation of the unauthenticated caller principal (which may or may not be equal to null,
depending on the requirements of the container type).
The handler may perform principal mapping of non-null values of name
, but it must be possible to
configure the handler such that it establishes the non-null argument value as the value returned when
getName
is called on the established principal.
subject
- The Subject in which the container will distinguish the caller identity.name
- The String value that will be returned when getName()
is called on the principal established
as the caller principal or null.public javax.security.auth.Subject getSubject()
public java.security.Principal getPrincipal()
When the values returned by this method and the getName methods are null, the handler must establish the container's representation of the unauthenticated caller principal within the Subject.
public java.lang.String getName()
When the values returned by this method and the getPrincipal methods are null, the handler must establish the container's representation of the unauthenticated caller principal within the Subject.