Package net.sf.michaelo.tomcat.realm

Class ActiveDirectoryPrincipal

java.lang.Object

net.sf.michaelo.tomcat.realm.ActiveDirectoryPrincipal

All Implemented Interfaces:

Principal, TomcatPrincipal

public class ActiveDirectoryPrincipal
extends Object
implements TomcatPrincipal

Represents a principal from Active Directory with a list of roles.

An Active Directory principal is comprised of the following items:

• the GSS name,
• the security identifier (SID),
• an optional GSS credential for credential delegation (impersonation),
• an array of security groups the user has been assigned to, stored according to the role format configured in the realm,
• and a map with additional attributes which are either a String, byte[] or a List of either one.

Constructor Summary

Constructors

Constructor	Description
ActiveDirectoryPrincipal(GSSName gssName, Sid sid, List<String> roles, GSSCredential gssCredential, Map<String,Object> additionalAttributes)	Constructs a new principal for the given parameters.
ActiveDirectoryPrincipal(GSSName gssName, Sid sid, GSSCredential gssCredential)	Constructs a new principal for the given parameters.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Map<String,Object>	getAdditionalAttributes()	Holds additional attributes for a given principal which may be stored in Active Directory.
Object	getAttribute(String name)
Enumeration<String>	getAttributeNames()
GSSCredential	getGssCredential()
GSSName	getGssName()	Returns the underlying GSS name.
String	getName()
String[]	getRoles()	Returns the sorted roles of the given principal.
Sid	getSid()	Returns the security identifier (SID) of the principal.
Principal	getUserPrincipal()
int	hashCode()
boolean	hasRole(String role)	Grants access if supplied role is associated with this principal.
void	logout()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.security.Principal

implies

Constructor Detail

ActiveDirectoryPrincipal

public ActiveDirectoryPrincipal(GSSName gssName,
                                Sid sid,
                                GSSCredential gssCredential)

Constructs a new principal for the given parameters.

ActiveDirectoryPrincipal

public ActiveDirectoryPrincipal(GSSName gssName,
                                Sid sid,
                                List<String> roles,
                                GSSCredential gssCredential,
                                Map<String,Object> additionalAttributes)

Constructs a new principal for the given parameters.

Method Detail

getUserPrincipal

public Principal getUserPrincipal()

Specified by:

getUserPrincipal in interface TomcatPrincipal

getName

public String getName()

Specified by:

getName in interface Principal

getGssName

public GSSName getGssName()

Returns the underlying GSS name.

Returns:

the underlying GSS name

getSid

public Sid getSid()

Returns the security identifier (SID) of the principal.

Returns:

the security identifier

getGssCredential

public GSSCredential getGssCredential()

Specified by:

getGssCredential in interface TomcatPrincipal

hasRole

public boolean hasRole(String role)

Grants access if supplied role is associated with this principal.

Parameters:

role - the role to check

Returns:

true if principal is associated with the role, else false

getRoles

public String[] getRoles()

Returns the sorted roles of the given principal.

Returns:

a sorted read-only view of the roles

getAttribute

public Object getAttribute(String name)

Specified by:

getAttribute in interface TomcatPrincipal

getAttributeNames

public Enumeration<String> getAttributeNames()

Specified by:

getAttributeNames in interface TomcatPrincipal

getAdditionalAttributes

public Map<String,Object> getAdditionalAttributes()

Holds additional attributes for a given principal which may be stored in Active Directory.

Returns:

a read-only view of the additional attributes

equals

public boolean equals(Object obj)

Specified by:

equals in interface Principal

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Principal

Overrides:

hashCode in class Object

toString

public String toString()

Specified by:

toString in interface Principal

Overrides:

toString in class Object

logout

public void logout()
            throws Exception

Specified by:

logout in interface TomcatPrincipal

Throws:

Exception