com.communote.server.service

Enum UserService.UserServiceRetrievalFlag

java.lang.Object

java.lang.Enum<UserService.UserServiceRetrievalFlag>

com.communote.server.service.UserService.UserServiceRetrievalFlag

All Implemented Interfaces:

Serializable, Comparable<UserService.UserServiceRetrievalFlag>

Enclosing class:

UserService

public static enum UserService.UserServiceRetrievalFlag
extends Enum<UserService.UserServiceRetrievalFlag>

These flags allow to control the retrieval process of a user in the UserService.

Author:

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
CREATE This flag defines that a user should be created from an external repository (if not found before).
FORCE_EXTERNAL_REPO_CHECK This flag defines that the user lookup will be forced on the configured external system.

Method Summary

Modifier and Type	Method and Description
static boolean	containsFlag(UserService.UserServiceRetrievalFlag[] flags, UserService.UserServiceRetrievalFlag flag) Checks if the flag is contained in flags
static UserService.UserServiceRetrievalFlag	valueOf(String name) Returns the enum constant of this type with the specified name.
static UserService.UserServiceRetrievalFlag[]	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

CREATE

public static final UserService.UserServiceRetrievalFlag CREATE

This flag defines that a user should be created from an external repository (if not found before). It should typically be set if a user is retrieved within a login process.

FORCE_EXTERNAL_REPO_CHECK

public static final UserService.UserServiceRetrievalFlag FORCE_EXTERNAL_REPO_CHECK

This flag defines that the user lookup will be forced on the configured external system. The flag will be ignored if there is no external system configured. Use it during the login process to synchronize the users properties. Remark: The flag will be ignored if there is no repository configured or if the user identification is marked as system user

Method Detail

values

public static UserService.UserServiceRetrievalFlag[] 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 (UserService.UserServiceRetrievalFlag c : UserService.UserServiceRetrievalFlag.values())
    System.out.println(c);

Returns:

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

valueOf

public static UserService.UserServiceRetrievalFlag 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

containsFlag

public static boolean containsFlag(UserService.UserServiceRetrievalFlag[] flags,
                                   UserService.UserServiceRetrievalFlag flag)

Checks if the flag is contained in flags

Parameters:

flags - the flags

flag - the flag

Returns:

true if flag is in flags