Package com.evolveum.midpoint.xml.ns._public.common.common_3

Enum Class ShadowPurposeType

java.lang.Object
java.lang.Enum<ShadowPurposeType>
com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowPurposeType
All Implemented Interfaces:
TypeSafeEnum, Serializable, Comparable<ShadowPurposeType>, Constable
public enum ShadowPurposeType extends Enum<ShadowPurposeType> implements TypeSafeEnum
Purpose for existence (or non-existence) of a resource object referenced by the shadow. E.g. it specifies whether the resource object is fully operational, whether it is not completely prepared yet, it may indicate why we are keeping the resource object instead of deleting it, and so on. It can be thought of as a "business lifecycle", specifying the reason for this object or shadow. Purposes considered to the future: * reserved: Resource object exists for the sole purpose of reserving identifiers or other resources. E.g. account that exists only to make sure the username is not taken by any other account, or that a username is not re-used. It can be used both for existing and non-existing resource objects. I.e. it may be only a shadow, reserving identifier at midPoint level, or it may be an account (probably inactive), reserving identifier at resource level. May also be used for (non-existent or disabled) accounts that are yet to be "claimed" by the user. (Question: do we need separate "thombstone" state for accounts that were deleted?) * suspended: Resource object is inactivated (disabled) for a longer period of time. E.g. used for maternal leave or sabbatical. This purpose may be used to avoid deleting such accounts, e.g. in delayed delete scenarios. * lingering: Resource object is still there, even though it should be gone already. E.g. account exists (although it is disabled), even though it should be deleted. This can be used to mark shadows that are kept due to disable-instead-of-delete scenarios.

  • Enum Constant Details

    • REGULAR

      public static final ShadowPurposeType REGULAR
      Regular, completely ordinary resource object. It is in full working condition, everything works normally.

    • INCOMPLETE

      public static final ShadowPurposeType INCOMPLETE
      Resource object is not complete, it is not yet fully usable. Some kind of action is necessary to complete the process. May be used for shadows that are technically in perfect working conditions, however user is not able to fully use them. For example, an account that was created with random password, the password was not delivered to the user. The user is expected to "activate" the account by resetting the password. However, technically, the account is in perfect working condition, enabled, password is set and so on. This "purpose" value is stored by midPoint to remember that additional action is needed to make this account fully operation on user level.

  • Method Details

    • values

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

    • value

      public String value()
      Description copied from interface: TypeSafeEnum
      Returns enum value defined as in schema.
      Specified by:
      value in interface TypeSafeEnum
      Returns:

    • fromValue

      public static ShadowPurposeType fromValue(String v)