com.communote.server.core.common.ldap

Enum LdapGroupAttribute

java.lang.Object

java.lang.Enum<LdapGroupAttribute>

com.communote.server.core.common.ldap.LdapGroupAttribute

All Implemented Interfaces:

Serializable, Comparable<LdapGroupAttribute>

public enum LdapGroupAttribute
extends Enum<LdapGroupAttribute>

Property constants that represent attribute names to be mapped to LDAP attributes for synchronization of users with LDAP directories

Author:

Communote GmbH - http://www.communote.com/

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALIAS attribute referring to the alias of a Group
DESCRIPTION attribute referring to the discription of a Group
MEMBERSHIP attribute referring to the LDAP attribute holding member/membership information of an external Group, e.g.
NAME attribute referring to the display name of a Group
UID attribute referring to a permanent unique ID of an external Group

Method Summary

Modifier and Type	Method and Description
String	getName()
String	getRequired()
boolean	isRequired()
String	toString()
static LdapGroupAttribute	valueOf(String name) Returns the enum constant of this type with the specified name.
static LdapGroupAttribute[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UID

public static final LdapGroupAttribute UID

attribute referring to a permanent unique ID of an external Group

MEMBERSHIP

public static final LdapGroupAttribute MEMBERSHIP

attribute referring to the LDAP attribute holding member/membership information of an external Group, e.g. member, memberOf, uniqueMember

NAME

public static final LdapGroupAttribute NAME

attribute referring to the display name of a Group

ALIAS

public static final LdapGroupAttribute ALIAS

attribute referring to the alias of a Group

DESCRIPTION

public static final LdapGroupAttribute DESCRIPTION

attribute referring to the discription of a Group

Method Detail

values

public static LdapGroupAttribute[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (LdapGroupAttribute c : LdapGroupAttribute.values())
    System.out.println(c);

Returns:

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

valueOf

public static LdapGroupAttribute valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getName

public String getName()

Returns:

the kenmei name of the attribute

getRequired

public String getRequired()

Returns:

true (in String representation) if this attribute is required.

isRequired

public boolean isRequired()

Returns:

true if this attribute is required.

toString

public String toString()

Overrides:

toString in class Enum<LdapGroupAttribute>

Returns:

value of getName