public class SecurityContext
extends java.lang.Object
implements java.io.Serializable
SecurityContext
class contains information about an authenticated SpotfirePrincipal
.Constructor and Description |
---|
SecurityContext(java.lang.String username)
Deprecated.
Please use
SecurityContext.SecurityContext(String, String) with an explicit domain name instead |
SecurityContext(java.lang.String username,
java.lang.String domainName)
Creates a new
SecurityContext instance. |
SecurityContext(java.lang.String username,
java.lang.String domainName,
java.lang.String displayName,
java.lang.String emailAddress)
Creates a new
SecurityContext instance. |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getDisplayName()
Returns the display name of the authenticated principal, or
null if no display name has been set. |
java.lang.String |
getDomainName()
Returns the domain name of the authenticated principal.
|
java.lang.String |
getEmailAddress()
Returns the email address of the authenticated principal, or
null if no email address has been set. |
SpotfirePrincipal |
getPrincipal()
Returns the
SpotfirePrincipal instance representing the authenticated principal. |
java.lang.String |
getUsername()
Returns the username of the authenticated principal.
|
void |
logout()
Deprecated.
overriding this method is discouraged since the logout functionality does not function properly across
clusters of Spotfire Servers
|
@Deprecated public SecurityContext(java.lang.String username)
SecurityContext.SecurityContext(String, String)
with an explicit domain name insteadSecurityContext
instance. The domain name is assumed to be the configured default domain.username
- the username, must not be null
or an empty stringpublic SecurityContext(java.lang.String username, java.lang.String domainName)
SecurityContext
instance.username
- the username, must not be null
or an empty stringdomainName
- the domain name, must not be null
or an empty stringpublic SecurityContext(java.lang.String username, java.lang.String domainName, java.lang.String displayName, java.lang.String emailAddress)
SecurityContext
instance.username
- the username, must not be null
or an empty stringdomainName
- the domain name, must not be null
or an empty stringdisplayName
- the user's display name, may be null
but must not be an empty stringemailAddress
- the user's email address, may be null
but must not be an empty stringpublic final java.lang.String getUsername()
public final java.lang.String getDomainName()
public final java.lang.String getDisplayName()
null
if no display name has been set.null
if no display name has been set.public final java.lang.String getEmailAddress()
null
if no email address has been set.null
if no email address has been setpublic final SpotfirePrincipal getPrincipal()
SpotfirePrincipal
instance representing the authenticated principal. This principal object can
be used with the Spotfire Server User Directory API.@Deprecated public void logout()
Copyright © 2000-2020 TIBCO Software Inc. All Rights Reserved.