flux.security
Class User

java.lang.Object
  flux.security.User

All Implemented Interfaces:

java.io.Serializable

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

Contains information about a user. Changing any information through this User interface does not take effect until SecurityAdministrator.putUser() is called.

Author:

Copyright 2014 Flux Corporation. All rights reserved.

See Also:

SecurityAdministrator, Serialized Form

Constructor Summary

User()

Method Summary

java.lang.String	getDisplayName() Returns the user's full display name.
java.lang.String	getPassword() Returns the user's password.
java.lang.String	getRole() Returns the name of the security role in which this user participates.
java.lang.String	getUsername() Returns a unique identifier for this user.
void	setDisplayName(java.lang.String displayName) Sets the user's full display name.
void	setPassword(java.lang.String password) Sets the user's password.
void	setRole(java.lang.String role) Sets the name of the security roles in which this user participates.
void	setUsername(java.lang.String username) Sets a unique identifier for this user.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

User

public User()

Method Detail

getDisplayName

public java.lang.String getDisplayName()

Returns the user's full display name. A user's display name does not uniquely identify a user; the username does.

Returns:

The user's full display name.

getPassword

public java.lang.String getPassword()

Returns the user's password.

Returns:

The user's password.

getRole

public java.lang.String getRole()

Returns the name of the security role in which this user participates. Each role name matches an existing role already defined under the Security Administrator.

Returns:

The name of the role in which this user participates. Is not null.

getUsername

public java.lang.String getUsername()

Returns a unique identifier for this user. The username is case-insensitive and represents an email address.

Returns:

A unique identifier for this user.

setDisplayName

public void setDisplayName(java.lang.String displayName)

Sets the user's full display name. A user's display name does not uniquely identify a user; the username does.

Parameters:

displayName - The user's full display name.

setPassword

public void setPassword(java.lang.String password)

Sets the user's password.

Parameters:

password - The user's password.

Throws:

java.lang.IllegalArgumentException - If password is null or empty.

setRole

public void setRole(java.lang.String role)

Sets the name of the security roles in which this user participates. The role must match an existing role already defined under the Security Administrator.

Parameters:

role - The name of the role in which this user participates. Cannot be null.

Throws:

java.lang.IllegalArgumentException - If role is null.

setUsername

public void setUsername(java.lang.String username)

Sets a unique identifier for this user. The username is case-insensitive and represents an email address.

Parameters:

username - A unique identifier for this user.

Throws:

java.lang.IllegalArgumentException - If username is null or empty.