com.atlassian.confluence.user
Interface ConfluenceUser

All Superinterfaces:

com.atlassian.user.Entity, Principal, Serializable, com.atlassian.user.User

All Known Implementing Classes:

ConfluenceUserImpl

public interface ConfluenceUser
extends com.atlassian.user.User

Describing a Confluence user.

A ConfluenceUser extends a "standard" user to have a fixed unique user key. This user key replaces 'username' as the canonical key to the User allowing username to be renamed if required.

Since:

5.2

Method Summary

com.atlassian.sal.api.user.UserKey

getKey() Return the immutable and unique key for the user.

Methods inherited from interface com.atlassian.user.User

getEmail, getFullName

Methods inherited from interface com.atlassian.user.Entity

getName

Methods inherited from interface java.security.Principal

equals, getName, hashCode, toString

Method Detail

getKey

com.atlassian.sal.api.user.UserKey getKey()

Return the immutable and unique key for the user.

Returns:

the unique key for this user.