Interface TomcatPrincipal
-
- All Superinterfaces:
Principal
- All Known Implementing Classes:
GenericPrincipal,UserDatabaseRealm.UserDatabasePrincipal
public interface TomcatPrincipal extends Principal
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ObjectgetAttribute(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.Enumeration<String>getAttributeNames()Returns anEnumerationcontaining the names of the attributes available to this Principal.GSSCredentialgetGssCredential()PrincipalgetUserPrincipal()voidlogout()Calls logout, if necessary, on any associated JAASLoginContext and/or GSSContext.
-
-
-
Method Detail
-
getUserPrincipal
Principal getUserPrincipal()
- Returns:
- The authenticated Principal to be exposed to applications.
-
getGssCredential
GSSCredential getGssCredential()
- Returns:
- The user's delegated credentials.
-
logout
void logout() throws ExceptionCalls logout, if necessary, on any associated JAASLoginContext and/or GSSContext. May in the future be extended to cover other logout requirements.- 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
-
getAttribute
Object getAttribute(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.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.- Parameters:
name- aStringspecifying 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
-
getAttributeNames
Enumeration<String> getAttributeNames()
Returns anEnumerationcontaining the names of the attributes available to this Principal. This method returns an emptyEnumerationif the Principal has no attributes available to it.- Returns:
- an
Enumerationof strings containing the names of the Principal's attributes
-
-