org.eclipse.scada.sec

Class UserInformation

java.lang.Object

org.eclipse.scada.sec.UserInformation

All Implemented Interfaces:

java.io.Serializable

public class UserInformation
extends java.lang.Object
implements java.io.Serializable

A user information object

Since:

0.3.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static UserInformation	ANONYMOUS

Constructor Summary

Constructors

Constructor and Description
UserInformation(java.lang.String name)
UserInformation(java.lang.String name, java.util.Collection<java.lang.String> roles)
UserInformation(java.lang.String name, java.lang.String[] roles)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static UserInformation	fromPrincipal(java.security.Principal principal) Create a user information object
java.lang.String	getName() Get the name of the user
java.util.Set<java.lang.String>	getRoles()
boolean	hasAllRoles(java.util.Collection<java.lang.String> roles)
boolean	hasAllRoles(java.lang.String[] roles)
boolean	hasAnyRole(java.util.Collection<java.lang.String> roles)
boolean	hasAnyRole(java.lang.String[] roles)
int	hashCode()
boolean	hasRole(java.lang.String role)
boolean	isAnonymous()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ANONYMOUS

public static final UserInformation ANONYMOUS

Constructor Detail

UserInformation

public UserInformation(java.lang.String name)

UserInformation

public UserInformation(java.lang.String name,
               java.util.Collection<java.lang.String> roles)

UserInformation

public UserInformation(java.lang.String name,
               java.lang.String[] roles)

Method Detail

fromPrincipal

public static UserInformation fromPrincipal(java.security.Principal principal)

Create a user information object

Parameters:

principal -

Returns:

Returns the converted user information object or ANONYMOUS if principal was null. Never returns null.

isAnonymous

public boolean isAnonymous()

getName

public java.lang.String getName()

Get the name of the user

Returns:

the name of the user or null if it an anonymous user information

getRoles

public java.util.Set<java.lang.String> getRoles()

hasRole

public boolean hasRole(java.lang.String role)

hasAllRoles

public boolean hasAllRoles(java.lang.String[] roles)

hasAllRoles

public boolean hasAllRoles(java.util.Collection<java.lang.String> roles)

hasAnyRole

public boolean hasAnyRole(java.lang.String[] roles)

hasAnyRole

public boolean hasAnyRole(java.util.Collection<java.lang.String> roles)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object