Package com.spotfire.server.api.userdir

Enum Class PrincipalProperty

java.lang.Object

java.lang.Enum<PrincipalProperty>

com.spotfire.server.api.userdir.PrincipalProperty

All Implemented Interfaces:

Serializable, Comparable<PrincipalProperty>, Constable

public enum PrincipalProperty
extends Enum<PrincipalProperty>

Represents searchable properties (fields) of user directory principals.

Since:

10.1

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
DISPLAY_NAME	The display name of a principal.
EMAIL	The email address of a principal.
NAME	The name of a principal.

Method Summary

Modifier and Type	Method	Description
static PrincipalProperty	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PrincipalProperty[]	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

NAME

public static final PrincipalProperty NAME

The name of a principal. If the value is given in the form of the currently configured domain name style (controlled using the user-directory.domain-name-style configuration property) and the security.parse-user-and-domain-name is true then the value will be parsed, allowing searches on both domain name and principal name (otherwise the expression will be matched against the principal name).

DISPLAY_NAME

public static final PrincipalProperty DISPLAY_NAME

The display name of a principal.

EMAIL

public static final PrincipalProperty EMAIL

The email address of a principal.

Method Details

values

public static PrincipalProperty[] 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 PrincipalProperty 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