org.xwiki.security
Class UserSecurityReference

java.lang.Object
  org.xwiki.model.reference.EntityReference
      org.xwiki.security.SecurityReference
          org.xwiki.security.UserSecurityReference

All Implemented Interfaces:

Serializable, Cloneable, Comparable<EntityReference>

Direct Known Subclasses:

GroupSecurityReference

public class UserSecurityReference
extends SecurityReference

A user is represented internally in the authorization module by a UserSecurityReference corresponding to the DocumentReference of the user's profile document. By inheritance, the null user is represented by the main wiki reference but with a null original reference.

Since:

4.0M2

Version:

$Id: da92f9232f0e87ba255a497dae952ed46ec51f6c $

See Also:

SecurityReferenceFactory}, Serialized Form

Field Summary

Fields inherited from class org.xwiki.security.SecurityReference

FARM, mainWikiReference

Fields inherited from class org.xwiki.model.reference.EntityReference

TOSTRING_SERIALIZER

Method Summary

DocumentReference	getOriginalReference()
boolean	isGlobal()

Methods inherited from class org.xwiki.security.SecurityReference

getOriginalDocumentReference, getOriginalSpaceReference, getOriginalWikiReference, getParentSecurityReference, getReversedSecurityReferenceChain, getSecurityType, getWikiReference

Methods inherited from class org.xwiki.model.reference.EntityReference

appendParent, compareTo, equals, extractReference, getName, getParameter, getParent, getReversedReferenceChain, getRoot, getType, hashCode, removeParent, replaceParent, setName, setParameter, setParameters, setParent, setType, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getOriginalReference

public DocumentReference getOriginalReference()

Overrides:

getOriginalReference in class SecurityReference

Returns:

the original reference used when this security reference was built.

isGlobal

public boolean isGlobal()

Returns:

true for global user

Since:

5.0M2