Class GenericPrincipal
- All Implemented Interfaces:
- Serializable,- Principal,- TomcatPrincipal
- Direct Known Subclasses:
- UserDatabaseRealm.UserDatabasePrincipal
Realm
 implementations.- Author:
- Craig R. McClanahan
- See Also:
- 
Field SummaryFieldsModifier and TypeFieldDescriptionThe additional attributes associated with this Principal.protected GSSCredentialThe user's delegated credentials.protected final LoginContextThe JAAS LoginContext, if any, used to authenticate this Principal.protected final StringThe username of the user represented by this Principal.protected final String[]The set of roles associated with this user.protected final PrincipalThe authenticated Principal to be exposed to applications.
- 
Constructor SummaryConstructorsConstructorDescriptionGenericPrincipal(String name) Construct a new Principal, associated with the specified Realm, for the specified username, with no roles.GenericPrincipal(String name, String password, List<String> roles) Deprecated.This method will be removed in Tomcat 11 onwardsDeprecated.This method will be removed in Tomcat 11 onwardsGenericPrincipal(String name, String password, List<String> roles, Principal userPrincipal, LoginContext loginContext) Deprecated.This method will be removed in Tomcat 11 onwardsGenericPrincipal(String name, String password, List<String> roles, Principal userPrincipal, LoginContext loginContext, GSSCredential gssCredential) Deprecated.This method will be removed in Tomcat 11 onwardsGenericPrincipal(String name, List<String> roles) Construct a new Principal, associated with the specified Realm, for the specified username, with the specified role names (as Strings).GenericPrincipal(String name, List<String> roles, Principal userPrincipal) Construct a new Principal, associated with the specified Realm, for the specified username, with the specified role names (as Strings).GenericPrincipal(String name, List<String> roles, Principal userPrincipal, LoginContext loginContext) Construct a new Principal, associated with the specified Realm, for the specified username, with the specified role names (as Strings).GenericPrincipal(String name, List<String> roles, Principal userPrincipal, LoginContext loginContext, GSSCredential gssCredential, Map<String, Object> attributes) Construct a new Principal, associated with the specified Realm, for the specified username, with the specified role names (as Strings).
- 
Method SummaryModifier and TypeMethodDescriptiongetAttribute(String name) Returns the value of the named attribute as anObject, ornullif no attribute of the given name exists, or ifnullhas been specified as the attribute's name.Returns anEnumerationcontaining the names of the attributes available to this Principal.getName()String[]getRoles()booleanDoes the user represented by this Principal possess the specified role?voidlogout()Calls logout, if necessary, on any associated JAASLoginContext and/or GSSContext.protected voidsetGssCredential(GSSCredential gssCredential) toString()Return a String representation of this object, which exposes only information that should be public.
- 
Field Details- 
nameThe username of the user represented by this Principal.
- 
rolesThe set of roles associated with this user.
- 
userPrincipalThe authenticated Principal to be exposed to applications.
- 
loginContextThe JAAS LoginContext, if any, used to authenticate this Principal. Kept so we can call logout().
- 
gssCredentialThe user's delegated credentials.
- 
attributesThe additional attributes associated with this Principal.
 
- 
- 
Constructor Details- 
GenericPrincipalConstruct a new Principal, associated with the specified Realm, for the specified username, with no roles.- Parameters:
- name- The username of the user represented by this Principal
 
- 
GenericPrincipalConstruct a new Principal, associated with the specified Realm, for the specified username, with the specified role names (as Strings).- Parameters:
- name- The username of the user represented by this Principal
- roles- List of roles (must be Strings) possessed by this user
 
- 
GenericPrincipalDeprecated.This method will be removed in Tomcat 11 onwardsConstruct a new Principal, associated with the specified Realm, for the specified username, with the specified role names (as Strings).- Parameters:
- name- The username of the user represented by this Principal
- password- Unused
- roles- List of roles (must be Strings) possessed by this user
 
- 
GenericPrincipalConstruct a new Principal, associated with the specified Realm, for the specified username, with the specified role names (as Strings).- Parameters:
- name- The username of the user represented by this Principal
- roles- List of roles (must be Strings) possessed by this user
- userPrincipal- - the principal to be returned from the request getUserPrincipal call if not null; if null, this will be returned
 
- 
GenericPrincipal@Deprecated public GenericPrincipal(String name, String password, List<String> roles, Principal userPrincipal) Deprecated.This method will be removed in Tomcat 11 onwardsConstruct a new Principal, associated with the specified Realm, for the specified username, with the specified role names (as Strings).- Parameters:
- name- The username of the user represented by this Principal
- password- Unused
- roles- List of roles (must be Strings) possessed by this user
- userPrincipal- - the principal to be returned from the request getUserPrincipal call if not null; if null, this will be returned
 
- 
GenericPrincipalpublic GenericPrincipal(String name, List<String> roles, Principal userPrincipal, LoginContext loginContext) Construct a new Principal, associated with the specified Realm, for the specified username, with the specified role names (as Strings).- Parameters:
- name- The username of the user represented by this Principal
- roles- List of roles (must be Strings) possessed by this user
- userPrincipal- - the principal to be returned from the request getUserPrincipal call if not null; if null, this will be returned
- loginContext- - If provided, this will be used to log out the user at the appropriate time
 
- 
GenericPrincipal@Deprecated public GenericPrincipal(String name, String password, List<String> roles, Principal userPrincipal, LoginContext loginContext) Deprecated.This method will be removed in Tomcat 11 onwardsConstruct a new Principal, associated with the specified Realm, for the specified username, with the specified role names (as Strings).- Parameters:
- name- The username of the user represented by this Principal
- password- Unused
- roles- List of roles (must be Strings) possessed by this user
- userPrincipal- - the principal to be returned from the request getUserPrincipal call if not null; if null, this will be returned
- loginContext- - If provided, this will be used to log out the user at the appropriate time
 
- 
GenericPrincipalpublic GenericPrincipal(String name, List<String> roles, Principal userPrincipal, LoginContext loginContext, GSSCredential gssCredential, Map<String, Object> attributes) Construct a new Principal, associated with the specified Realm, for the specified username, with the specified role names (as Strings).- Parameters:
- name- The username of the user represented by this Principal
- roles- List of roles (must be Strings) possessed by this user
- userPrincipal- - the principal to be returned from the request getUserPrincipal call if not null; if null, this will be returned
- loginContext- - If provided, this will be used to log out the user at the appropriate time
- gssCredential- - If provided, the user's delegated credentials
- attributes- - If provided, additional attributes associated with this Principal
 
- 
GenericPrincipal@Deprecated public GenericPrincipal(String name, String password, List<String> roles, Principal userPrincipal, LoginContext loginContext, GSSCredential gssCredential) Deprecated.This method will be removed in Tomcat 11 onwardsConstruct a new Principal, associated with the specified Realm, for the specified username, with the specified role names (as Strings).- Parameters:
- name- The username of the user represented by this Principal
- password- Unused
- roles- List of roles (must be Strings) possessed by this user
- userPrincipal- - the principal to be returned from the request getUserPrincipal call if not null; if null, this will be returned
- loginContext- - If provided, this will be used to log out the user at the appropriate time
- gssCredential- - If provided, the user's delegated credentials
 
 
- 
- 
Method Details- 
getName
- 
getRoles
- 
getUserPrincipal- Specified by:
- getUserPrincipalin interface- TomcatPrincipal
- Returns:
- The authenticated Principal to be exposed to applications.
 
- 
getGssCredential- Specified by:
- getGssCredentialin interface- TomcatPrincipal
- Returns:
- The user's delegated credentials.
 
- 
setGssCredential
- 
hasRoleDoes the user represented by this Principal possess the specified role?- Parameters:
- role- Role to be tested
- Returns:
- trueif this Principal has been assigned the given role, otherwise- false
 
- 
toStringReturn a String representation of this object, which exposes only information that should be public.
- 
logoutDescription copied from interface:TomcatPrincipalCalls logout, if necessary, on any associated JAASLoginContext and/or GSSContext. May in the future be extended to cover other logout requirements.- Specified by:
- logoutin interface- TomcatPrincipal
- Throws:
- Exception- If something goes wrong with the logout. Uses Exception to allow for future expansion of this method to cover other logout mechanisms that might throw a different exception to LoginContext
 
- 
getAttributeDescription copied from interface:TomcatPrincipalReturns the value of the named attribute as anObject, ornullif no attribute of the given name exists, or ifnullhas been specified as the attribute's name.Only the servlet container may set attributes to make available custom information about a Principal or the user it represents. The purpose of the method is to implement read only access to attributes which may be stored in the Realmimplementation's backend due to its inherent design.As using this method from application code will make it non portable to other EE compliant containers, it is advised this should never be used as an object storage facility tied to the Principal, but rather as simple extra additional metadata. It is recommended that a container level object is used to further process the attributes that may be associated with thePrincipal.Realmimplementations that are provided by Tomcat will not provide complex type mapping, but will in most cases always return a result as aStringobject which may need custom decoding.Realmimplementations that are provided by Tomcat will not provide an implementation for this facility unless it is inherent to the storage backend of theRealmitself and metadata is available without additional user intervention or configuration.- Specified by:
- getAttributein interface- TomcatPrincipal
- Parameters:
- name- a- Stringspecifying the name of the attribute
- Returns:
- an Objectcontaining the value of the attribute, ornullif the attribute does not exist, or ifnullhas been specified as the attribute's name
 
- 
getAttributeNamesDescription copied from interface:TomcatPrincipalReturns anEnumerationcontaining the names of the attributes available to this Principal. This method returns an emptyEnumerationif the Principal has no attributes available to it.- Specified by:
- getAttributeNamesin interface- TomcatPrincipal
- Returns:
- an Enumerationof strings containing the names of the Principal's attributes
 
 
-