org.nuxeo.ecm.core.search.api.client.query
Interface SearchPrincipal

All Superinterfaces:

java.security.Principal, java.io.Serializable

All Known Implementing Classes:

SearchPrincipalImpl

public interface SearchPrincipal
extends java.security.Principal, java.io.Serializable

Search principal.

Author:

Julien Anguenot

Method Summary

java.lang.String[]	getGroups() Return the groups the principal belong to.
java.io.Serializable	getOriginalPrincipal() Returns the original principal from which the search principal has been constructed.
boolean	isAdministrator() Returns tru if user is an administrator Security will still apply to this user
boolean	isSystemUser() Is the search principal a system user.

Methods inherited from interface java.security.Principal

equals, getName, hashCode, toString

Method Detail

getGroups

java.lang.String[] getGroups()

Return the groups the principal belong to.

Returns:

a list of group identifiers.

isAdministrator

boolean isAdministrator()

Returns tru if user is an administrator

Security will still apply to this user

Since:

5.3 GA

isSystemUser

boolean isSystemUser()

Is the search principal a system user.

A system user is a user which doesn't have security restriction at application level. (i.e : only used internally by application components)

This is will be helpful for the backend to decide if wether or not it should apply stack security queries.

Returns:

true if wether or not this principal is a system principal.

getOriginalPrincipal

java.io.Serializable getOriginalPrincipal()

Returns the original principal from which the search principal has been constructed.

It returns a Serializable instance since Principal since Principal is not a Serializable.

If not constructed from a principal then this method will return null.

Returns:

a principal instance.