org.xwiki.users

Class AbstractUser

java.lang.Object

org.xwiki.users.AbstractUser

All Implemented Interfaces:

Comparable<User>, User

public abstract class AbstractUser
extends Object
implements User

Base class for implementing users.

Since:

1.0M9

Version:

$Id: ca353da06d1a4ad1e8d4651fd16f2539c3921896 $

Field Summary

Fields

Modifier and Type	Field and Description
protected org.xwiki.model.reference.DocumentReference	profileReference A link to the user profile document.
protected org.xwiki.model.reference.EntityReferenceSerializer<String>	serializer Used for serializing the profile reference into a string.

Constructor Summary

Constructors

Constructor and Description
AbstractUser()

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(User user)
String	getId() An identifier which can be used internally for identifying the user.
org.xwiki.model.reference.DocumentReference	getProfileDocument() If the user has an associated wiki document where their profile can be seen, return a reference to it.
String	getUsername() The username used for identifying the user in the form.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xwiki.users.User

exists, getAttribute, getName, getProfileURI

Field Detail

profileReference

protected org.xwiki.model.reference.DocumentReference profileReference

A link to the user profile document.

serializer

protected org.xwiki.model.reference.EntityReferenceSerializer<String> serializer

Used for serializing the profile reference into a string.

Constructor Detail

AbstractUser

public AbstractUser()

Method Detail

getId

public String getId()

An identifier which can be used internally for identifying the user. This is the value that should be stored to remember the user.

Specified by:

getId in interface User

Returns:

serialized user identifier which can be used to store and retrieve back this user object

See Also:

User.getId()

getUsername

public String getUsername()

The username used for identifying the user in the form. This is not supposed to be used internally, but only as a user-friendly "username" to display to this or other users, for example in a mail reminding what username to use on the wiki.

Specified by:

getUsername in interface User

Returns:

short username

See Also:

User.getUsername()

getProfileDocument

public org.xwiki.model.reference.DocumentReference getProfileDocument()

If the user has an associated wiki document where their profile can be seen, return a reference to it. This happens for users defined in the wiki, or for SSO users mirrored/cloned in the wiki. For external SSO users without a profile clone in the wiki, null is returned.

Specified by:

getProfileDocument in interface User

Returns:

a reference to the user's profile document, if one exists, or null otherwise

See Also:

User.getProfileDocument()

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

compareTo

public int compareTo(User user)

Specified by:

compareTo in interface Comparable<User>

See Also:

Comparable.compareTo(Object)