Package com.spotfire.server.security

Class CustomAuthenticatorPrincipal

java.lang.Object

com.spotfire.server.security.CustomAuthenticatorPrincipal

All Implemented Interfaces:

Serializable, Principal

public final class CustomAuthenticatorPrincipal
extends Object
implements Principal, Serializable

This class represents a principal that was authenticated by a CustomAuthenticator or a CustomWebAuthenticator.

Since:

7.6

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
CustomAuthenticatorPrincipal(String username, String domainName, String displayName, String emailAddress)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
String	getDisplayName()	Returns the display name of the authenticated principal.
String	getDomainName()	Returns the domain name of the authenticated principal.
String	getEmailAddress()	Returns the email address of the authenticated principal.
String	getName()	Returns the username of the authenticated principal.
String	getUsername()	Returns the username of the authenticated principal.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.security.Principal

equals, hashCode, implies

Constructor Details

CustomAuthenticatorPrincipal

public CustomAuthenticatorPrincipal(String username,
 String domainName,
 String displayName,
 String emailAddress)

Creates a new instance.

Parameters:

username - the username, must not be null or an empty string

domainName - the domain name, must not be null or an empty string

displayName - the user's display name, may be null but must not be an empty string

emailAddress - the user's email address, may be null but must not be an empty string

Since:

7.6

Method Details

getName

public String getName()

Returns the username of the authenticated principal.

Specified by:

getName in interface Principal

Returns:

the username

Since:

7.6

getUsername

public String getUsername()

Returns the username of the authenticated principal.

Returns:

the username

Since:

7.6

getDomainName

public String getDomainName()

Returns the domain name of the authenticated principal.

Returns:

the domain name

Since:

7.6

getDisplayName

public String getDisplayName()

Returns the display name of the authenticated principal.

Returns:

the display name

Since:

7.6

getEmailAddress

public String getEmailAddress()

Returns the email address of the authenticated principal.

Returns:

the email address

Since:

7.6

toString

public String toString()

Specified by:

toString in interface Principal

Overrides:

toString in class Object