LdapUserAttribute (Communote 3.5 API)

java.lang.Object
- java.lang.Enum<LdapUserAttribute>
- - com.communote.server.core.common.ldap.LdapUserAttribute

All Implemented Interfaces:

Serializable, Comparable<LdapUserAttribute>
```
public enum LdapUserAttribute
extends Enum<LdapUserAttribute>
```
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 `User`
`EMAIL` attribute referring to the email of a `User`
`FIRSTNAME` attribute referring to the first name of a `User`
`LASTNAME` attribute referring to the last name of a `User`
`UID` attribute referring to a permanent unique ID of an external `User`
`UPN` attribute referring to a user principal name of an external `User`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getName()`
`boolean`	`isRequired()`
`static LdapUserAttribute`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static LdapUserAttribute[]`	`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, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - ALIAS
```
public static final LdapUserAttribute ALIAS
```
    attribute referring to the alias of a User
  - EMAIL
```
public static final LdapUserAttribute EMAIL
```
    attribute referring to the email of a User
  - FIRSTNAME
```
public static final LdapUserAttribute FIRSTNAME
```
    attribute referring to the first name of a User
  - LASTNAME
```
public static final LdapUserAttribute LASTNAME
```
    attribute referring to the last name of a User
  - UID
```
public static final LdapUserAttribute UID
```
    attribute referring to a permanent unique ID of an external User
  - UPN
```
public static final LdapUserAttribute UPN
```
    attribute referring to a user principal name of an external User
- Method Detail
  - values
```
public static LdapUserAttribute[] 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 (LdapUserAttribute c : LdapUserAttribute.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static LdapUserAttribute 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
  - isRequired
```
public boolean isRequired()
```
    Returns:
    
    true if this attribute is required.

Enum LdapUserAttribute

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ALIAS

EMAIL

FIRSTNAME

LASTNAME

UID

UPN

Method Detail

values

valueOf

getName

isRequired