Package org.alfresco.service.cmr.security

Enum Class AuthorityType

java.lang.Object

java.lang.Enum<AuthorityType>

org.alfresco.service.cmr.security.AuthorityType

All Implemented Interfaces:

Serializable, Comparable<AuthorityType>, Constable

@AlfrescoPublicApi
public enum AuthorityType
extends Enum<AuthorityType>

The types of authority that are available.

Available types are:

1. USER - an authority that identifies a user
2. GROUP - an authority that identifies a group
3. OWNER - the special authority that applies to the owner of a node
4. EVERYONE - the special authority that is interpreted as everyone
5. GUEST - the special authority that applies to a GUEST (An unknown, unauthenticated user)
6. WILDCARD - the set of all authorities (including the guest user)

Author:

Andy Hind

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADMIN
EVERYONE
GROUP
GUEST
OWNER
ROLE
USER
WILDCARD

Method Summary

Modifier and Type	Method	Description
boolean	equals(String authority)
static AuthorityType	getAuthorityType(String authority)
abstract String	getFixedString()
abstract int	getOrderPosition()
abstract String	getPrefixString()
abstract boolean	isFixedString()
abstract boolean	isPrefixed()
static AuthorityType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AuthorityType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ADMIN

public static final AuthorityType ADMIN

EVERYONE

public static final AuthorityType EVERYONE

OWNER

public static final AuthorityType OWNER

GUEST

public static final AuthorityType GUEST

GROUP

public static final AuthorityType GROUP

ROLE

public static final AuthorityType ROLE

USER

public static final AuthorityType USER

WILDCARD

public static final AuthorityType WILDCARD

Method Details

values

public static AuthorityType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static AuthorityType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

isFixedString

public abstract boolean isFixedString()

getFixedString

public abstract String getFixedString()

isPrefixed

public abstract boolean isPrefixed()

getPrefixString

public abstract String getPrefixString()

getOrderPosition

public abstract int getOrderPosition()

equals

public boolean equals(String authority)

getAuthorityType

public static AuthorityType getAuthorityType(String authority)