|
Keel 2.1RC2 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
This is the interface implemented by services that contain the environment for the logged-in user. A DefaultUserEnvironment object is normally stored in the Context passed to Model objects, and may be used by the Model to provide environment information to other factories and services that it requires. It's purpose is to store information about the current user session (if there is one), including the currently selected database, the ID of the current user, and so forth.
| Field Summary | |
static java.lang.String |
ANONYMOUS_DOMAIN |
static java.lang.String |
ANONYMOUS_GROUPNAME |
static java.lang.String |
ANONYMOUS_LOGINNAME |
static int |
ANONYMOUS_UIDConstants identifying the "unknown" user in the not-logged-in state |
static java.lang.String |
ANONYMOUS_USERDESC |
static java.lang.String |
CONTEXT_KEYThe key used to store the user env. |
| Method Summary | |
java.lang.Object |
getAttribute(java.lang.String attributeName) |
java.lang.String |
getDomain()Get the DomainPrincipal |
java.util.List |
getGroups()Get the GroupPrincipals |
javax.security.auth.login.LoginContext |
getLoginContext()The login context in this env. |
java.lang.String |
getLoginName()Get the LoginPrincipal |
javax.security.auth.Subject |
getSubject()The JAAS subject from the login context |
int |
getUid()Get the UidPrincipal |
java.lang.String |
getUserDescrip()Get the UserDescripPrincipal |
void |
reset()Used by logout functions to reset the SUbject back to "anonymous" |
void |
setAttribute(java.lang.String attributeName, java.lang.Object attributeContents) |
void |
setLoginContext(javax.security.auth.login.LoginContext lc)After succsful login, store the login context for later use by at least the logout function. |
| Field Detail |
public static final java.lang.String CONTEXT_KEY
public static final int ANONYMOUS_UID
public static final java.lang.String ANONYMOUS_LOGINNAME
public static final java.lang.String ANONYMOUS_GROUPNAME
public static final java.lang.String ANONYMOUS_USERDESC
public static final java.lang.String ANONYMOUS_DOMAIN
| Method Detail |
public void setLoginContext(javax.security.auth.login.LoginContext lc)
throws AuthorizationException
lc - The user's JAAS login contextAuthorizationException
public javax.security.auth.login.LoginContext getLoginContext()
throws AuthorizationException
AuthorizationException
public javax.security.auth.Subject getSubject()
throws AuthorizationException
AuthorizationException
public java.lang.String getLoginName()
throws AuthorizationException
AuthorizationException
public java.lang.String getDomain()
throws AuthorizationException
AuthorizationException
public java.lang.String getUserDescrip()
throws AuthorizationException
AuthorizationException
public int getUid()
throws AuthorizationException
AuthorizationException
public java.util.List getGroups()
throws AuthorizationException
AuthorizationException
public void reset()
throws AuthorizationException
AuthorizationException
public void setAttribute(java.lang.String attributeName,
java.lang.Object attributeContents)
public java.lang.Object getAttribute(java.lang.String attributeName)
|
Keel 2.1RC2 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||