org.xwiki.users

Interface User

All Superinterfaces:

Comparable<User>

All Known Implementing Classes:

AbstractUser

@Unstable
public interface User
extends Comparable<User>

XWiki User Interface.

Since:

1.0M9

Version:

$Id: 74bade55aa14a0c56df663825bb6cbe92d048d2f $

Method Summary

Methods

Modifier and Type	Method and Description
boolean	exists() Check if the returned user profile actually exists or not.
Object	getAttribute(String attributeName) Get the value of an attribute defined for the user.
String	getId() An identifier which can be used internally for identifying the user.
String	getName() The real name of 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.
URI	getProfileURI() If the user has an associated URI where their profile can be seen, return it.
String	getUsername() The username used for identifying the user in the form.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

exists

boolean exists()

Check if the returned user profile actually exists or not.

Returns:

true if the user profile is valid (e.g. the profile wiki document exists for a wiki user)

getId

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.

Returns:

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

getUsername

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.

Returns:

short username

getName

String getName()

The real name of the user. The returned value should be in the "Givenname Familyname" format.

Returns:

user full (real) name, displayed in the UI to other wiki users

getProfileDocument

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.

Returns:

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

getProfileURI

URI getProfileURI()

If the user has an associated URI where their profile can be seen, return it. For users defined (or mirrored) in the wiki, a link to their profile document is returned. For external SSO users with a publicly accessible profile, a link to their external profile is returned. For SSO services not accessible on the web, null is returned.

Returns:

a link to the user's profile page, if one exists, or null otherwise

getAttribute

Object getAttribute(String attributeName)

Get the value of an attribute defined for the user. Some example attributes are the user's given and family names, email address, company, birth date. Actual attributes depend on the actual user management system.

Parameters:

attributeName - the name of the attribute to retrieve

Returns:

the attribute value, if defined, or null otherwise