org.gatein.api.security

Class User

java.lang.Object

org.gatein.api.security.User

public class User
extends Object

Represents a user

Author:

Nick Scavelli

Constructor Summary

Constructors

Constructor and Description
User(String id) Creates a new user with the specified id.

Method Summary

Methods

Modifier and Type	Method and Description
static User	anonymous() Creates a anonymous user
String	getId() Returns the user id
boolean	isAnonymous() Returns true if the user is anonymous

Methods inherited from class java.lang.Object

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

Constructor Detail

User

public User(String id)

Creates a new user with the specified id. To create a anonymous user use the static method isAnonymous()

Parameters:

id - the user

Throws:

IllegalArgumentException - if id is null

Method Detail

getId

public String getId()

Returns the user id

Returns:

the user id

isAnonymous

public boolean isAnonymous()

Returns true if the user is anonymous

Returns:

true if anonymous user

anonymous

public static User anonymous()

Creates a anonymous user

Returns:

the anonymous user