Modifier and Type	Class and Description
private static class	GenericPrincipal.SerializablePrincipal

Modifier and Type	Field and Description
protected final Map<String, Object>	attributes The additional attributes associated with this Principal.
protected transient GSSCredential	gssCredential The user's delegated credentials.
protected final transient LoginContext	loginContext The JAAS LoginContext, if any, used to authenticate this Principal.
protected final String	name The username of the user represented by this Principal.
protected final String[]	roles The set of roles associated with this user.
private static final long	serialVersionUID
protected final Principal	userPrincipal The authenticated Principal to be exposed to applications.

Constructor Summary

Access	Constructor and Description
public	GenericPrincipal(String The username of the user represented by this Principal name) Construct a new Principal, associated with the specified Realm, for the specified username, with no roles.
public	GenericPrincipal(String The username of the user represented by this Principal name, List<String> List of roles (must be Strings) possessed by this user roles) Construct a new Principal, associated with the specified Realm, for the specified username, with the specified role names (as Strings).
public	GenericPrincipal(String The username of the user represented by this Principal name, String Unused password, List<String> List of roles (must be Strings) possessed by this user roles) Deprecated This method will be removed in Tomcat 11 onwards Construct a new Principal, associated with the specified Realm, for the specified username, with the specified role names (as Strings).
public	GenericPrincipal(String The username of the user represented by this Principal name, List<String> List of roles (must be Strings) possessed by this user roles, Principal - the principal to be returned from the request getUserPrincipal call if not null; if null, this will be returned userPrincipal) Construct a new Principal, associated with the specified Realm, for the specified username, with the specified role names (as Strings).
public	GenericPrincipal(String The username of the user represented by this Principal name, String Unused password, List<String> List of roles (must be Strings) possessed by this user roles, Principal - the principal to be returned from the request getUserPrincipal call if not null; if null, this will be returned userPrincipal) Deprecated This method will be removed in Tomcat 11 onwards Construct a new Principal, associated with the specified Realm, for the specified username, with the specified role names (as Strings).
public	GenericPrincipal(String The username of the user represented by this Principal name, List<String> List of roles (must be Strings) possessed by this user roles, Principal - the principal to be returned from the request getUserPrincipal call if not null; if null, this will be returned userPrincipal, LoginContext - If provided, this will be used to log out the user at the appropriate time loginContext) Construct a new Principal, associated with the specified Realm, for the specified username, with the specified role names (as Strings).
public	GenericPrincipal(String The username of the user represented by this Principal name, String Unused password, List<String> List of roles (must be Strings) possessed by this user roles, Principal - the principal to be returned from the request getUserPrincipal call if not null; if null, this will be returned userPrincipal, LoginContext - If provided, this will be used to log out the user at the appropriate time loginContext) Deprecated This method will be removed in Tomcat 11 onwards Construct a new Principal, associated with the specified Realm, for the specified username, with the specified role names (as Strings).
public	GenericPrincipal(String The username of the user represented by this Principal name, List<String> List of roles (must be Strings) possessed by this user roles, Principal - the principal to be returned from the request getUserPrincipal call if not null; if null, this will be returned userPrincipal, LoginContext - If provided, this will be used to log out the user at the appropriate time loginContext, GSSCredential - If provided, the user's delegated credentials gssCredential, Map<String, Object> - If provided, additional attributes associated with this Principal attributes) Construct a new Principal, associated with the specified Realm, for the specified username, with the specified role names (as Strings).
public	GenericPrincipal(String The username of the user represented by this Principal name, String Unused password, List<String> List of roles (must be Strings) possessed by this user roles, Principal - the principal to be returned from the request getUserPrincipal call if not null; if null, this will be returned userPrincipal, LoginContext - If provided, this will be used to log out the user at the appropriate time loginContext, GSSCredential - If provided, the user's delegated credentials gssCredential) Deprecated This method will be removed in Tomcat 11 onwards Construct a new Principal, associated with the specified Realm, for the specified username, with the specified role names (as Strings).

Method Summary

Modifier and Type	Method and Description
public Object	getAttribute(String a `String` specifying the name of the attribute name) Implements org.apache.catalina.TomcatPrincipal.getAttribute. Returns the value of the named attribute as an `Object`, or `null` if no attribute of the given name exists, or if `null` has been specified as the attribute's name.
public Enumeration<String>	getAttributeNames() Implements org.apache.catalina.TomcatPrincipal.getAttributeNames. Returns an `Enumeration` containing the names of the attributes available to this Principal.
public GSSCredential	getGssCredential() Implements org.apache.catalina.TomcatPrincipal.getGssCredential.
public String	getName() Implements java.security.Principal.getName. Returns the name of this `Principal`.
public String[]	getRoles()
public Principal	getUserPrincipal() Implements org.apache.catalina.TomcatPrincipal.getUserPrincipal.
public boolean	Returns: `true` if this Principal has been assigned the given role, otherwise `false` hasRole(String Role to be tested role) Does the user represented by this Principal possess the specified role?
public void	logout() Implements org.apache.catalina.TomcatPrincipal.logout. Calls logout, if necessary, on any associated JAASLoginContext and/or GSSContext.
protected void	setGssCredential(GSSCredential gssCredential)
public String	toString() Overrides java.lang.Object.toString. Implements java.security.Principal.toString. Return a String representation of this object, which exposes only information that should be public.
private Object	writeReplace()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

attributes	back to summary
protected final Map<String, Object> attributes The additional attributes associated with this Principal.

gssCredential	back to summary
protected transient GSSCredential gssCredential The user's delegated credentials.

loginContext	back to summary
protected final transient LoginContext loginContext The JAAS LoginContext, if any, used to authenticate this Principal. Kept so we can call logout().

name	back to summary
protected final String name The username of the user represented by this Principal.

roles	back to summary
protected final String[] roles The set of roles associated with this user.

serialVersionUID	back to summary
private static final long serialVersionUID

userPrincipal	back to summary
protected final Principal userPrincipal The authenticated Principal to be exposed to applications.

Constructor Detail

GenericPrincipal	back to summary
public GenericPrincipal(String name) Construct a new Principal, associated with the specified Realm, for the specified username, with no roles. Parameters name:String The username of the user represented by this Principal

GenericPrincipal

back to summary

public GenericPrincipal(String name)

Construct a new Principal, associated with the specified Realm, for the specified username, with no roles.

Parameters

name:String: The username of the user represented by this Principal

GenericPrincipal	back to summary
public GenericPrincipal(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). Parameters name:String The username of the user represented by this Principal roles:List<String> List of roles (must be Strings) possessed by this user

GenericPrincipal

back to summary

public GenericPrincipal(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).

Parameters

name:String: The username of the user represented by this Principal
roles:List<String>: List of roles (must be Strings) possessed by this user

GenericPrincipal	back to summary
public GenericPrincipal(String name, String password, List<String> roles) Deprecated This method will be removed in Tomcat 11 onwards Construct a new Principal, associated with the specified Realm, for the specified username, with the specified role names (as Strings). Parameters name:String The username of the user represented by this Principal password:String Unused roles:List<String> List of roles (must be Strings) possessed by this user Annotations @Deprecated

GenericPrincipal

back to summary

public GenericPrincipal(String name, String password, List<String> roles)

Deprecated

This method will be removed in Tomcat 11 onwards

Construct a new Principal, associated with the specified Realm, for the specified username, with the specified role names (as Strings).

Parameters

name:String: The username of the user represented by this Principal
password:String: Unused
roles:List<String>: List of roles (must be Strings) possessed by this user

Annotations

@Deprecated

GenericPrincipal	back to summary
public 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). Parameters name:String The username of the user represented by this Principal roles:List<String> List of roles (must be Strings) possessed by this user userPrincipal:Principal - the principal to be returned from the request getUserPrincipal call if not null; if null, this will be returned

GenericPrincipal

back to summary

public 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).

Parameters

name:String: The username of the user represented by this Principal
roles:List<String>: List of roles (must be Strings) possessed by this user
userPrincipal:Principal: - the principal to be returned from the request getUserPrincipal call if not null; if null, this will be returned

GenericPrincipal	back to summary
public GenericPrincipal(String name, String password, List<String> roles, Principal userPrincipal) Deprecated This method will be removed in Tomcat 11 onwards Construct a new Principal, associated with the specified Realm, for the specified username, with the specified role names (as Strings). Parameters name:String The username of the user represented by this Principal password:String Unused roles:List<String> List of roles (must be Strings) possessed by this user userPrincipal:Principal - the principal to be returned from the request getUserPrincipal call if not null; if null, this will be returned Annotations @Deprecated

GenericPrincipal

back to summary

public GenericPrincipal(String name, String password, List<String> roles, Principal userPrincipal)

Deprecated

This method will be removed in Tomcat 11 onwards

Construct a new Principal, associated with the specified Realm, for the specified username, with the specified role names (as Strings).

Parameters

name:String: The username of the user represented by this Principal
password:String: Unused
roles:List<String>: List of roles (must be Strings) possessed by this user
userPrincipal:Principal: - the principal to be returned from the request getUserPrincipal call if not null; if null, this will be returned

Annotations

@Deprecated

GenericPrincipal	back to summary
public 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:String The username of the user represented by this Principal roles:List<String> List of roles (must be Strings) possessed by this user userPrincipal:Principal - the principal to be returned from the request getUserPrincipal call if not null; if null, this will be returned loginContext:LoginContext - If provided, this will be used to log out the user at the appropriate time

GenericPrincipal

back to summary

public 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:String: The username of the user represented by this Principal
roles:List<String>: List of roles (must be Strings) possessed by this user
userPrincipal:Principal: - the principal to be returned from the request getUserPrincipal call if not null; if null, this will be returned
loginContext:LoginContext: - If provided, this will be used to log out the user at the appropriate time

GenericPrincipal	back to summary
public GenericPrincipal(String name, String password, List<String> roles, Principal userPrincipal, LoginContext loginContext) Deprecated This method will be removed in Tomcat 11 onwards Construct a new Principal, associated with the specified Realm, for the specified username, with the specified role names (as Strings). Parameters name:String The username of the user represented by this Principal password:String Unused roles:List<String> List of roles (must be Strings) possessed by this user userPrincipal:Principal - the principal to be returned from the request getUserPrincipal call if not null; if null, this will be returned loginContext:LoginContext - If provided, this will be used to log out the user at the appropriate time Annotations @Deprecated

GenericPrincipal

back to summary

public GenericPrincipal(String name, String password, List<String> roles, Principal userPrincipal, LoginContext loginContext)

Deprecated

This method will be removed in Tomcat 11 onwards

Construct a new Principal, associated with the specified Realm, for the specified username, with the specified role names (as Strings).

Parameters

name:String: The username of the user represented by this Principal
password:String: Unused
roles:List<String>: List of roles (must be Strings) possessed by this user
userPrincipal:Principal: - the principal to be returned from the request getUserPrincipal call if not null; if null, this will be returned
loginContext:LoginContext: - If provided, this will be used to log out the user at the appropriate time

Annotations

@Deprecated

GenericPrincipal	back to summary
public 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:String The username of the user represented by this Principal roles:List<String> List of roles (must be Strings) possessed by this user userPrincipal:Principal - the principal to be returned from the request getUserPrincipal call if not null; if null, this will be returned loginContext:LoginContext - If provided, this will be used to log out the user at the appropriate time gssCredential:GSSCredential - If provided, the user's delegated credentials attributes:Map<String, Object> - If provided, additional attributes associated with this Principal

GenericPrincipal

back to summary

public 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:String: The username of the user represented by this Principal
roles:List<String>: List of roles (must be Strings) possessed by this user
userPrincipal:Principal: - the principal to be returned from the request getUserPrincipal call if not null; if null, this will be returned
loginContext:LoginContext: - If provided, this will be used to log out the user at the appropriate time
gssCredential:GSSCredential: - If provided, the user's delegated credentials
attributes:Map<String, Object>: - If provided, additional attributes associated with this Principal

GenericPrincipal	back to summary
public GenericPrincipal(String name, String password, List<String> roles, Principal userPrincipal, LoginContext loginContext, GSSCredential gssCredential) Deprecated This method will be removed in Tomcat 11 onwards Construct a new Principal, associated with the specified Realm, for the specified username, with the specified role names (as Strings). Parameters name:String The username of the user represented by this Principal password:String Unused roles:List<String> List of roles (must be Strings) possessed by this user userPrincipal:Principal - the principal to be returned from the request getUserPrincipal call if not null; if null, this will be returned loginContext:LoginContext - If provided, this will be used to log out the user at the appropriate time gssCredential:GSSCredential - If provided, the user's delegated credentials Annotations @Deprecated

GenericPrincipal

back to summary

public GenericPrincipal(String name, String password, List<String> roles, Principal userPrincipal, LoginContext loginContext, GSSCredential gssCredential)

Deprecated

This method will be removed in Tomcat 11 onwards

Construct a new Principal, associated with the specified Realm, for the specified username, with the specified role names (as Strings).

Parameters

name:String: The username of the user represented by this Principal
password:String: Unused
roles:List<String>: List of roles (must be Strings) possessed by this user
userPrincipal:Principal: - the principal to be returned from the request getUserPrincipal call if not null; if null, this will be returned
loginContext:LoginContext: - If provided, this will be used to log out the user at the appropriate time
gssCredential:GSSCredential: - If provided, the user's delegated credentials

Annotations

@Deprecated

Method Detail

getAttribute back to summary

getAttribute	back to summary
public Object getAttribute(String name) Implements org.apache.catalina.TomcatPrincipal.getAttribute. Doc from org.apache.catalina.TomcatPrincipal.getAttribute. Returns the value of the named attribute as an `Object`, or `null` if no attribute of the given name exists, or if `null` has 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 `Realm` implementation'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 the `Principal`. `Realm` implementations that are provided by Tomcat will not provide complex type mapping, but will in most cases always return a result as a `String` object which may need custom decoding. `Realm` implementations that are provided by Tomcat will not provide an implementation for this facility unless it is inherent to the storage backend of the `Realm` itself and metadata is available without additional user intervention or configuration. Parameters name:String a `String` specifying the name of the attribute Returns:Object an `Object` containing the value of the attribute, or `null` if the attribute does not exist, or if `null` has been specified as the attribute's name Annotations @Override

public Object getAttribute(String name)

Implements org.apache.catalina.TomcatPrincipal.getAttribute.

Doc from org.apache.catalina.TomcatPrincipal.getAttribute.

Returns the value of the named attribute as an Object, or null if no attribute of the given name exists, or if null has 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 Realm implementation'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 the Principal.

Realm implementations that are provided by Tomcat will not provide complex type mapping, but will in most cases always return a result as a String object which may need custom decoding.

Realm implementations that are provided by Tomcat will not provide an implementation for this facility unless it is inherent to the storage backend of the Realm itself and metadata is available without additional user intervention or configuration.

Parameters

name:String: a String specifying the name of the attribute

Returns:Object

an Object containing the value of the attribute, or null if the attribute does not exist, or if null has been specified as the attribute's name

Annotations

@Override

getAttributeNames back to summary

getAttributeNames	back to summary
public Enumeration<String> getAttributeNames() Implements org.apache.catalina.TomcatPrincipal.getAttributeNames. Doc from org.apache.catalina.TomcatPrincipal.getAttributeNames. Returns an `Enumeration` containing the names of the attributes available to this Principal. This method returns an empty `Enumeration` if the Principal has no attributes available to it. Returns:Enumeration<String> an `Enumeration` of strings containing the names of the Principal's attributes Annotations @Override

public Enumeration<String> getAttributeNames()

Implements org.apache.catalina.TomcatPrincipal.getAttributeNames.

Doc from org.apache.catalina.TomcatPrincipal.getAttributeNames.

Returns an Enumeration containing the names of the attributes available to this Principal. This method returns an empty Enumeration if the Principal has no attributes available to it.

Returns:Enumeration<String>

an Enumeration of strings containing the names of the Principal's attributes

Annotations

@Override

getGssCredential	back to summary
public GSSCredential getGssCredential() Implements org.apache.catalina.TomcatPrincipal.getGssCredential. Returns:GSSCredential Doc from org.apache.catalina.TomcatPrincipal.getGssCredential. The user's delegated credentials. Annotations @Override

getGssCredential

back to summary

public GSSCredential getGssCredential()

Implements org.apache.catalina.TomcatPrincipal.getGssCredential.

Returns:GSSCredential

Doc from org.apache.catalina.TomcatPrincipal.getGssCredential.

The user's delegated credentials.

Annotations

@Override

getName back to summary

getName	back to summary
public String getName() Implements java.security.Principal.getName. Doc from java.security.Principal.getName. Returns the name of this `Principal`. Returns:String the name of this `Principal`. Annotations @Override

public String getName()

Implements java.security.Principal.getName.

Doc from java.security.Principal.getName.

Returns the name of this Principal.

Returns:String

the name of this Principal.

Annotations

@Override

getRoles	back to summary
public String[] getRoles()

getUserPrincipal	back to summary
public Principal getUserPrincipal() Implements org.apache.catalina.TomcatPrincipal.getUserPrincipal. Returns:Principal Doc from org.apache.catalina.TomcatPrincipal.getUserPrincipal. The authenticated Principal to be exposed to applications. Annotations @Override

getUserPrincipal

back to summary

public Principal getUserPrincipal()

Implements org.apache.catalina.TomcatPrincipal.getUserPrincipal.

Returns:Principal

Doc from org.apache.catalina.TomcatPrincipal.getUserPrincipal.

The authenticated Principal to be exposed to applications.

Annotations

@Override

hasRole back to summary

hasRole	back to summary
public boolean hasRole(String role) Does the user represented by this Principal possess the specified role? Parameters role:String Role to be tested Returns:boolean `true` if this Principal has been assigned the given role, otherwise `false`

public boolean hasRole(String role)

Does the user represented by this Principal possess the specified role?

Parameters

role:String: Role to be tested

Returns:boolean

true if this Principal has been assigned the given role, otherwise false

logout	back to summary
public void logout() throws Exception Implements org.apache.catalina.TomcatPrincipal.logout. Doc from org.apache.catalina.TomcatPrincipal.logout. Calls logout, if necessary, on any associated JAASLoginContext and/or GSSContext. May in the future be extended to cover other logout requirements. Annotations @Override Exceptions 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

logout

back to summary

public void logout() throws Exception

Implements org.apache.catalina.TomcatPrincipal.logout.

Doc from org.apache.catalina.TomcatPrincipal.logout.

Calls logout, if necessary, on any associated JAASLoginContext and/or GSSContext. May in the future be extended to cover other logout requirements.

Annotations

@Override

Exceptions

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

setGssCredential	back to summary
protected void setGssCredential(GSSCredential gssCredential)

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Implements java.security.Principal.toString. Return a String representation of this object, which exposes only information that should be public. Returns:String Doc from java.security.Principal.toString. a string representation of this `Principal`. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Implements java.security.Principal.toString.

Return a String representation of this object, which exposes only information that should be public.

Returns:String

Doc from java.security.Principal.toString.

a string representation of this Principal.

Annotations

@Override

writeReplace	back to summary
private Object writeReplace()

org.apache.catalina.realm back to summary

private Class GenericPrincipal.SerializablePrincipal

Class Inheritance

extends Object
implements Serializable

java.lang.Object
org.apache.catalina.realm.GenericPrincipal.SerializablePrincipal

All Implemented Interfaces

java.io.Serializable

Field Summary

Modifier and Type	Field and Description
private final Map<String, Object>	attributes
private final String	name
private final Principal	principal
private final String[]	roles
private static final long	serialVersionUID

Constructor Summary

Access	Constructor and Description
pack-priv	SerializablePrincipal(String name, String[] roles, Principal principal, Map<String, Object> attributes)

Method Summary

Modifier and Type	Method and Description
private Object	readResolve()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

attributes	back to summary
private final Map<String, Object> attributes

name	back to summary
private final String name

principal	back to summary
private final Principal principal

roles	back to summary
private final String[] roles

serialVersionUID	back to summary
private static final long serialVersionUID

Constructor Detail

SerializablePrincipal	back to summary
pack-priv SerializablePrincipal(String name, String[] roles, Principal principal, Map<String, Object> attributes)

Method Detail

readResolve	back to summary
private Object readResolve()

public Class GenericPrincipal

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class GenericPrincipal.SerializablePrincipal

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail