Package pl.edu.icm.unity.engine.api.translation.in

Enum IdentityEffectMode

java.lang.Object

java.lang.Enum<IdentityEffectMode>

pl.edu.icm.unity.engine.api.translation.in.IdentityEffectMode

All Implemented Interfaces:

Serializable, Comparable<IdentityEffectMode>

public enum IdentityEffectMode
extends Enum<IdentityEffectMode>

Defines how a mapped IdentityParam should be handled.

Author:

K. Benedyczak

Enum Constant Summary

Enum Constants

Enum Constant	Description
CREATE_OR_MATCH	Identity will be created if doesn't exists.
MATCH	If an identity is found the remote principal will be mapped to this identity.
REQUIRE_MATCH	The remote principal must exist in the local database, and will be mapped to it.
UPDATE_OR_MATCH	Identity will be created if it doesn't exist and if the user was matched by any other of identity mapping rules.

Method Summary

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

public static final IdentityEffectMode CREATE_OR_MATCH

Identity will be created if doesn't exists. If exists the remote principal will be mapped to the existing entity.

MATCH

public static final IdentityEffectMode MATCH

If an identity is found the remote principal will be mapped to this identity.

REQUIRE_MATCH

public static final IdentityEffectMode REQUIRE_MATCH

The remote principal must exist in the local database, and will be mapped to it.

UPDATE_OR_MATCH

public static final IdentityEffectMode UPDATE_OR_MATCH

Identity will be created if it doesn't exist and if the user was matched by any other of identity mapping rules. If identity exists the remote principal will be mapped to the existing entity.

Method Detail

values

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

Returns:

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

valueOf

public static IdentityEffectMode 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

mayModifyIdentity

public boolean mayModifyIdentity()