|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
User Realm. This interface should be specialized to provide specific user lookup and authentication using arbitrary methods.
Field Summary | |
static java.lang.String |
__UserRole
|
Method Summary | |
UserPrincipal |
authenticate(java.lang.String username,
java.lang.Object credentials,
HttpRequest request)
Authenticate a users credentials. |
void |
disassociate(UserPrincipal user)
Dissassociate the calling context with a Principal. |
java.lang.String |
getName()
|
UserPrincipal |
popRole(UserPrincipal user)
Pop role from a Principal. |
UserPrincipal |
pushRole(UserPrincipal user,
java.lang.String role)
Push role onto a Principal. |
Field Detail |
public static final java.lang.String __UserRole
Method Detail |
public java.lang.String getName()
public UserPrincipal authenticate(java.lang.String username, java.lang.Object credentials, HttpRequest request)
username
- The username.credentials
- The user credentials, normally a String password.request
- The request to be authenticated. Additional
parameters may be extracted or set on this request as needed
for the authentication mechanism (none required for BASIC and
FORM authentication).
public void disassociate(UserPrincipal user)
user
- A UserPrincipal allocated from this realm.public UserPrincipal pushRole(UserPrincipal user, java.lang.String role)
user
- An existing UserPrincipal or null for an anonymous user.role
- The role to add.
public UserPrincipal popRole(UserPrincipal user)
user
- A UserPrincipal previously returned from pushRole
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |