|
Nuxeo Enterprise Platform 5.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.nuxeo.ecm.platform.usermanager.NuxeoPrincipalImpl
public class NuxeoPrincipalImpl
Field Summary | |
---|---|
java.util.List<java.lang.String> |
allGroups
|
static java.lang.String |
COMPANY_COLUMN
Deprecated. |
DataModel |
dataModel
|
static java.lang.String |
EMAIL_COLUMN
Deprecated. |
static java.lang.String |
FIRSTNAME_COLUMN
Deprecated. |
static java.lang.String |
GROUPS_COLUMN
Deprecated. |
boolean |
isAdministrator
|
boolean |
isAnonymous
|
static java.lang.String |
LASTNAME_COLUMN
Deprecated. |
DocumentModel |
model
|
java.lang.String |
origUserName
|
static java.lang.String |
PASSWORD_COLUMN
Deprecated. |
java.lang.String |
principalId
|
java.util.List<java.lang.String> |
roles
|
static java.lang.String |
USERNAME_COLUMN
Deprecated. |
java.util.List<java.lang.String> |
virtualGroups
|
Fields inherited from interface org.nuxeo.ecm.core.api.NuxeoPrincipal |
---|
PREFIX |
Constructor Summary | |
---|---|
NuxeoPrincipalImpl(java.lang.String name)
Constructor that sets principal to not anonymous, not administrator, and updates all the principal groups. |
|
NuxeoPrincipalImpl(java.lang.String name,
boolean isAnonymous)
Constructor that sets principal to not administrator, and updates all the principal groups. |
|
NuxeoPrincipalImpl(java.lang.String name,
boolean isAnonymous,
boolean isAdministrator)
Constructor that updates all the principal groups. |
|
NuxeoPrincipalImpl(java.lang.String name,
boolean isAnonymous,
boolean isAdministrator,
boolean updateAllGroups)
|
Method Summary | |
---|---|
boolean |
equals(java.lang.Object other)
|
java.util.List<java.lang.String> |
getAllGroups()
Gets the groups this principal directly or undirectly is member of. |
java.lang.String |
getCompany()
Gets the company name of this principal. |
java.lang.String |
getEmail()
|
java.lang.String |
getFirstName()
Gets the first name of this principal. |
java.util.List<java.lang.String> |
getGroups()
Gets the groups this principal is directly member of. |
java.lang.String |
getLastName()
Gets the last name of this principal. |
DocumentModel |
getModel()
|
java.lang.String |
getName()
|
java.lang.String |
getOriginatingUser()
|
java.lang.String |
getPassword()
Gets the password of this principal. |
java.lang.String |
getPrincipalId()
Returns a generated id that is unique for each principal instance. |
java.util.List<java.lang.String> |
getRoles()
Deprecated. |
java.util.List<java.lang.String> |
getVirtualGroups()
|
int |
hashCode()
|
boolean |
isAdministrator()
Returns true if the principal is an administrator. |
boolean |
isAnonymous()
Checks if the principal is anonymous (guest user). |
boolean |
isMemberOf(java.lang.String group)
Recursively test if the user is member of this group. |
void |
setCompany(java.lang.String company)
|
void |
setEmail(java.lang.String email)
|
void |
setFirstName(java.lang.String firstName)
|
void |
setGroups(java.util.List<java.lang.String> groups)
|
void |
setLastName(java.lang.String lastName)
|
void |
setModel(DocumentModel model)
|
void |
setModel(DocumentModel model,
boolean updateAllGroups)
Sets model and recomputes all groups. |
void |
setName(java.lang.String name)
|
void |
setOriginatingUser(java.lang.String originatingUser)
|
void |
setPassword(java.lang.String password)
|
void |
setPrincipalId(java.lang.String principalId)
Sets the principalId. |
void |
setRoles(java.util.List<java.lang.String> roles)
|
void |
setVirtualGroups(java.util.List<java.lang.String> virtualGroups)
Sets virtual groups and recomputes all groups. |
void |
setVirtualGroups(java.util.List<java.lang.String> virtualGroups,
boolean updateAllGroups)
|
java.lang.String |
toString()
|
void |
updateAllGroups()
|
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
@Deprecated public static final java.lang.String USERNAME_COLUMN
@Deprecated public static final java.lang.String FIRSTNAME_COLUMN
@Deprecated public static final java.lang.String LASTNAME_COLUMN
@Deprecated public static final java.lang.String COMPANY_COLUMN
@Deprecated public static final java.lang.String PASSWORD_COLUMN
@Deprecated public static final java.lang.String EMAIL_COLUMN
@Deprecated public static final java.lang.String GROUPS_COLUMN
public final java.util.List<java.lang.String> roles
public java.util.List<java.lang.String> virtualGroups
public java.util.List<java.lang.String> allGroups
public final boolean isAnonymous
public boolean isAdministrator
public java.lang.String principalId
public DocumentModel model
public DataModel dataModel
public java.lang.String origUserName
Constructor Detail |
---|
public NuxeoPrincipalImpl(java.lang.String name) throws ClientException
ClientException
public NuxeoPrincipalImpl(java.lang.String name, boolean isAnonymous) throws ClientException
ClientException
public NuxeoPrincipalImpl(java.lang.String name, boolean isAnonymous, boolean isAdministrator) throws ClientException
ClientException
public NuxeoPrincipalImpl(java.lang.String name, boolean isAnonymous, boolean isAdministrator, boolean updateAllGroups) throws ClientException
ClientException
Method Detail |
---|
public java.lang.String getCompany()
NuxeoPrincipal
getCompany
in interface NuxeoPrincipal
public void setCompany(java.lang.String company)
setCompany
in interface NuxeoPrincipal
public java.lang.String getFirstName()
NuxeoPrincipal
getFirstName
in interface NuxeoPrincipal
public void setFirstName(java.lang.String firstName)
setFirstName
in interface NuxeoPrincipal
public java.lang.String getLastName()
NuxeoPrincipal
getLastName
in interface NuxeoPrincipal
public void setLastName(java.lang.String lastName)
setLastName
in interface NuxeoPrincipal
public void setName(java.lang.String name)
setName
in interface NuxeoPrincipal
public void setRoles(java.util.List<java.lang.String> roles)
setRoles
in interface NuxeoPrincipal
public void setGroups(java.util.List<java.lang.String> groups)
setGroups
in interface NuxeoPrincipal
public java.lang.String getName()
getName
in interface java.security.Principal
public java.util.List<java.lang.String> getGroups()
NuxeoPrincipal
getGroups
in interface NuxeoPrincipal
@Deprecated public java.util.List<java.lang.String> getRoles()
NuxeoPrincipal
getRoles
in interface NuxeoPrincipal
public void setPassword(java.lang.String password)
setPassword
in interface NuxeoPrincipal
public java.lang.String getPassword()
NuxeoPrincipal
Note: Some APIs that return principals from the database intentionally do not fill this field
getPassword
in interface NuxeoPrincipal
public java.lang.String toString()
toString
in interface java.security.Principal
toString
in class java.lang.Object
public java.lang.String getPrincipalId()
NuxeoPrincipal
getPrincipalId
in interface NuxeoPrincipal
public void setPrincipalId(java.lang.String principalId)
NuxeoPrincipal
setPrincipalId
in interface NuxeoPrincipal
principalId
- a new principalId for this instancepublic java.lang.String getEmail()
public void setEmail(java.lang.String email)
public DocumentModel getModel()
getModel
in interface NuxeoPrincipal
public void setModel(DocumentModel model, boolean updateAllGroups) throws ClientException
ClientException
public void setModel(DocumentModel model) throws ClientException
setModel
in interface NuxeoPrincipal
ClientException
public boolean isMemberOf(java.lang.String group)
NuxeoPrincipal
isMemberOf
in interface NuxeoPrincipal
group
- The name of the grouppublic java.util.List<java.lang.String> getAllGroups()
NuxeoPrincipal
getAllGroups
in interface NuxeoPrincipal
public void updateAllGroups() throws ClientException
ClientException
public java.util.List<java.lang.String> getVirtualGroups()
public void setVirtualGroups(java.util.List<java.lang.String> virtualGroups, boolean updateAllGroups) throws ClientException
ClientException
public void setVirtualGroups(java.util.List<java.lang.String> virtualGroups) throws ClientException
ClientException
public boolean isAdministrator()
NuxeoPrincipal
Security checks still apply on the repository for administrator user. If user is a system user, this method will return true.
isAdministrator
in interface NuxeoPrincipal
public boolean isAnonymous()
NuxeoPrincipal
isAnonymous
in interface NuxeoPrincipal
public boolean equals(java.lang.Object other)
equals
in interface java.security.Principal
equals
in class java.lang.Object
public int hashCode()
hashCode
in interface java.security.Principal
hashCode
in class java.lang.Object
public java.lang.String getOriginatingUser()
getOriginatingUser
in interface NuxeoPrincipal
public void setOriginatingUser(java.lang.String originatingUser)
setOriginatingUser
in interface NuxeoPrincipal
|
Nuxeo Enterprise Platform 5.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |