PropertyType (PicketLink Identity Management API 3.0.0.Beta2 API)

java.lang.Object
- java.lang.Enum<PropertyType>
- - org.picketlink.idm.jpa.annotations.PropertyType

All Implemented Interfaces:

Serializable, Comparable<PropertyType>
```
public enum PropertyType
extends Enum<PropertyType>
```
This enum is used in conjunction with the @IDMProperty annotation to mark an entity bean property for the storage of Identity Management related state.

Author:

Shane Bryzak

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AGENT_LOGIN_NAME` The login name used by an Agent (or User) to authenticate - this property should be unique
`ATTRIBUTE_IDENTITY` Connects an attribute entity back to its owning identity
`ATTRIBUTE_NAME` Attribute name
`ATTRIBUTE_TYPE` Attribute type
`ATTRIBUTE_VALUE` Attribute value
`CREDENTIAL_ATTRIBUTE_CREDENTIAL` Connects a credential attribute value back to its owning credential
`CREDENTIAL_ATTRIBUTE_NAME` The name of a credential attribute
`CREDENTIAL_ATTRIBUTE_VALUE` The value of a credential attribute
`CREDENTIAL_EFFECTIVE_DATE` The effective date of a credential
`CREDENTIAL_EXPIRY_DATE` The expiry date of a credential
`CREDENTIAL_IDENTITY` The identity that a credential belongs to
`CREDENTIAL_TYPE` Credential type
`CREDENTIAL_VALUE` Credential value
`GROUP_PARENT` The parent group of a group
`GROUP_PATH` The group path defines the name hierarchy for a specific group.
`IDENTITY_CREATION_DATE` Creation date
`IDENTITY_DISCRIMINATOR` The discriminator identifies the particular identity type (such as user, role, group, etc) of the Identity
`IDENTITY_ENABLED` Indicates whether the identity type is enabled
`IDENTITY_EXPIRY_DATE` Expiry date
`IDENTITY_ID` The unique identifier of an identity
`IDENTITY_NAME` The name of the identity.
`IDENTITY_PARTITION` The partition that an identity belongs to
`PARTITION_ID` The id value of a partition
`PARTITION_PARENT` The parent partition of a partition, where supported (such as for Tiers)
`PARTITION_TYPE` The type of partition
`RELATIONSHIP_ATTRIBUTE_NAME` The name of a relationship attribute
`RELATIONSHIP_ATTRIBUTE_RELATIONSHIP` Connects a relationship attribute back to its owning relationship
`RELATIONSHIP_ATTRIBUTE_VALUE` The value of a relationship attribute
`RELATIONSHIP_CLASS` The fully qualified class name of the relationship type
`RELATIONSHIP_DESCRIPTOR` Describes the role of an identity within a relationship
`RELATIONSHIP_ID` The unique identifier of a relationship
`RELATIONSHIP_IDENTITY` Represents the identity that participates in a relationship
`RELATIONSHIP_IDENTITY_RELATIONSHIP` Relates a relationship identity back to its owning relationship
`USER_EMAIL` User's e-mail address
`USER_FIRST_NAME` User's first name
`USER_LAST_NAME` User's last name

Method Summary

Methods
Modifier and Type	Method and Description
`static PropertyType`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static PropertyType[]`	`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
  - IDENTITY_ID
```
public static final PropertyType IDENTITY_ID
```
    The unique identifier of an identity
  - IDENTITY_DISCRIMINATOR
```
public static final PropertyType IDENTITY_DISCRIMINATOR
```
    The discriminator identifies the particular identity type (such as user, role, group, etc) of the Identity
  - GROUP_PATH
```
public static final PropertyType GROUP_PATH
```
    The group path defines the name hierarchy for a specific group. eg.: /groupA/groupB
  - IDENTITY_NAME
```
public static final PropertyType IDENTITY_NAME
```
    The name of the identity. For User identities, this will be the username, for Groups, the group name and for Roles, the role name
  - IDENTITY_ENABLED
```
public static final PropertyType IDENTITY_ENABLED
```
    Indicates whether the identity type is enabled
  - IDENTITY_CREATION_DATE
```
public static final PropertyType IDENTITY_CREATION_DATE
```
    Creation date
  - IDENTITY_EXPIRY_DATE
```
public static final PropertyType IDENTITY_EXPIRY_DATE
```
    Expiry date
  - CREDENTIAL_VALUE
```
public static final PropertyType CREDENTIAL_VALUE
```
    Credential value
  - ATTRIBUTE_IDENTITY
```
public static final PropertyType ATTRIBUTE_IDENTITY
```
    Connects an attribute entity back to its owning identity
  - ATTRIBUTE_NAME
```
public static final PropertyType ATTRIBUTE_NAME
```
    Attribute name
  - ATTRIBUTE_TYPE
```
public static final PropertyType ATTRIBUTE_TYPE
```
    Attribute type
  - ATTRIBUTE_VALUE
```
public static final PropertyType ATTRIBUTE_VALUE
```
    Attribute value
  - GROUP_PARENT
```
public static final PropertyType GROUP_PARENT
```
    The parent group of a group
  - AGENT_LOGIN_NAME
```
public static final PropertyType AGENT_LOGIN_NAME
```
    The login name used by an Agent (or User) to authenticate - this property should be unique
  - USER_FIRST_NAME
```
public static final PropertyType USER_FIRST_NAME
```
    User's first name
  - USER_LAST_NAME
```
public static final PropertyType USER_LAST_NAME
```
    User's last name
  - USER_EMAIL
```
public static final PropertyType USER_EMAIL
```
    User's e-mail address
  - IDENTITY_PARTITION
```
public static final PropertyType IDENTITY_PARTITION
```
    The partition that an identity belongs to
  - PARTITION_ID
```
public static final PropertyType PARTITION_ID
```
    The id value of a partition
  - PARTITION_TYPE
```
public static final PropertyType PARTITION_TYPE
```
    The type of partition
  - PARTITION_PARENT
```
public static final PropertyType PARTITION_PARENT
```
    The parent partition of a partition, where supported (such as for Tiers)
  - CREDENTIAL_IDENTITY
```
public static final PropertyType CREDENTIAL_IDENTITY
```
    The identity that a credential belongs to
  - CREDENTIAL_TYPE
```
public static final PropertyType CREDENTIAL_TYPE
```
    Credential type
  - CREDENTIAL_EFFECTIVE_DATE
```
public static final PropertyType CREDENTIAL_EFFECTIVE_DATE
```
    The effective date of a credential
  - CREDENTIAL_EXPIRY_DATE
```
public static final PropertyType CREDENTIAL_EXPIRY_DATE
```
    The expiry date of a credential
  - CREDENTIAL_ATTRIBUTE_CREDENTIAL
```
public static final PropertyType CREDENTIAL_ATTRIBUTE_CREDENTIAL
```
    Connects a credential attribute value back to its owning credential
  - CREDENTIAL_ATTRIBUTE_NAME
```
public static final PropertyType CREDENTIAL_ATTRIBUTE_NAME
```
    The name of a credential attribute
  - CREDENTIAL_ATTRIBUTE_VALUE
```
public static final PropertyType CREDENTIAL_ATTRIBUTE_VALUE
```
    The value of a credential attribute
  - RELATIONSHIP_ID
```
public static final PropertyType RELATIONSHIP_ID
```
    The unique identifier of a relationship
  - RELATIONSHIP_CLASS
```
public static final PropertyType RELATIONSHIP_CLASS
```
    The fully qualified class name of the relationship type
  - RELATIONSHIP_IDENTITY
```
public static final PropertyType RELATIONSHIP_IDENTITY
```
    Represents the identity that participates in a relationship
  - RELATIONSHIP_IDENTITY_RELATIONSHIP
```
public static final PropertyType RELATIONSHIP_IDENTITY_RELATIONSHIP
```
    Relates a relationship identity back to its owning relationship
  - RELATIONSHIP_DESCRIPTOR
```
public static final PropertyType RELATIONSHIP_DESCRIPTOR
```
    Describes the role of an identity within a relationship
  - RELATIONSHIP_ATTRIBUTE_NAME
```
public static final PropertyType RELATIONSHIP_ATTRIBUTE_NAME
```
    The name of a relationship attribute
  - RELATIONSHIP_ATTRIBUTE_VALUE
```
public static final PropertyType RELATIONSHIP_ATTRIBUTE_VALUE
```
    The value of a relationship attribute
  - RELATIONSHIP_ATTRIBUTE_RELATIONSHIP
```
public static final PropertyType RELATIONSHIP_ATTRIBUTE_RELATIONSHIP
```
    Connects a relationship attribute back to its owning relationship
- Method Detail
  - values
```
public static PropertyType[] 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 (PropertyType c : PropertyType.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static PropertyType 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

Enum PropertyType

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

IDENTITY_ID

IDENTITY_DISCRIMINATOR

GROUP_PATH

IDENTITY_NAME

IDENTITY_ENABLED

IDENTITY_CREATION_DATE

IDENTITY_EXPIRY_DATE

CREDENTIAL_VALUE

ATTRIBUTE_IDENTITY

ATTRIBUTE_NAME

ATTRIBUTE_TYPE

ATTRIBUTE_VALUE

GROUP_PARENT

AGENT_LOGIN_NAME

USER_FIRST_NAME

USER_LAST_NAME

USER_EMAIL

IDENTITY_PARTITION

PARTITION_ID

PARTITION_TYPE

PARTITION_PARENT

CREDENTIAL_IDENTITY

CREDENTIAL_TYPE

CREDENTIAL_EFFECTIVE_DATE

CREDENTIAL_EXPIRY_DATE

CREDENTIAL_ATTRIBUTE_CREDENTIAL

CREDENTIAL_ATTRIBUTE_NAME

CREDENTIAL_ATTRIBUTE_VALUE

RELATIONSHIP_ID

RELATIONSHIP_CLASS

RELATIONSHIP_IDENTITY

RELATIONSHIP_IDENTITY_RELATIONSHIP

RELATIONSHIP_DESCRIPTOR

RELATIONSHIP_ATTRIBUTE_NAME

RELATIONSHIP_ATTRIBUTE_VALUE

RELATIONSHIP_ATTRIBUTE_RELATIONSHIP

Method Detail

values

valueOf