net.sourceforge.jaulp.auth.interfaces

Interface User<P extends Permission,R extends Role<P>>

Type Parameters:

P - the generic type

R - the generic type

All Superinterfaces:

Serializable

All Known Implementing Classes:

SimpleUser

public interface User<P extends Permission,R extends Role<P>>
extends Serializable

The Interface User.

Version:

1.1

Author:

Asterios Raptis

Method Summary

Modifier and Type	Method and Description
void	addRole(R role) Adds the given role to the user.
String	getId() Returns the field id.
String	getPw() Returns the field password.
Set<R>	getRoles() Returns the field roles.
String	getUsername() Returns the field username.
Boolean	isActive() Checks if this User is active.
Boolean	isLocked() Returns the field lock.
boolean	removeRole(R role) Removes the given role from the user.
void	setActive(Boolean active) Sets the active flag.
void	setId(String id) Sets the field id.
void	setLocked(Boolean locked) Sets the field lock.
void	setPw(String password) Sets the field password.
void	setRoles(Set<R> roles) Sets the field roles.
void	setUsername(String username) Sets the field username.

Method Detail

addRole

void addRole(R role)

Adds the given role to the user.

Parameters:

role - the role

getId

String getId()

Returns the field id.

Returns:

The field id.

getRoles

Set<R> getRoles()

Returns the field roles.

Returns:

The field roles.

getUsername

String getUsername()

Returns the field username.

Returns:

The field username.

getPw

String getPw()

Returns the field password.

Returns:

The field password.

isLocked

Boolean isLocked()

Returns the field lock.

Returns:

The field lock.

isActive

Boolean isActive()

Checks if this User is active.

Returns:

true if the User is active otherwise false.

setActive

void setActive(Boolean active)

Sets the active flag.

Parameters:

active - the new active flag.

removeRole

boolean removeRole(R role)

Removes the given role from the user.

Parameters:

role - the role

Returns:

true, if successful

setId

void setId(String id)

Sets the field id.

Parameters:

id - The id to set

setLocked

void setLocked(Boolean locked)

Sets the field lock.

Parameters:

locked - The lock to set

setRoles

void setRoles(Set<R> roles)

Sets the field roles.

Parameters:

roles - The roles to set

setUsername

void setUsername(String username)

Sets the field username.

Parameters:

username - The username to set

setPw

void setPw(String password)

Sets the field password.

Parameters:

password - The password to set