oracle.iam.request.vo

Class RequestEntity

java.lang.Object

oracle.iam.request.vo.RequestEntity

All Implemented Interfaces:

java.io.Serializable

public class RequestEntity
extends java.lang.Object
implements java.io.Serializable

This is the value object that stores User or Role entity details associated with a request. This object needs to be associated with a request only for following request types:

• Create User
• Self-Register User
• Delete User
• Enable User
• Disable User
• Modify User Profile
• Modify Self Profile
• Create Role
• Delete Role
• Modify Role

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ROLE_ENTITY_TYPE A constant for Role entity-type.
static java.lang.String	USER_ENTITY_TYPE A constant for User entity-type.

Constructor Summary

Constructors

Constructor and Description
RequestEntity() Constructs RequestEntity object with default construct

Method Summary

Modifier and Type	Method and Description
java.util.List	getAdditionalEntityData() Gets the additional data associated with this RequestEntity
java.util.List	getEntityData() Gets the request data associated with this RequestEntity.
java.lang.String	getEntityKey() Gets the associated entity key set for this object.
java.lang.String	getEntitySubType() Gets Role name in case of Role based request type, otherwise null.
java.lang.String	getEntityType() Deprecated.
java.lang.String	getOperation()
RequestEntityAttribute	getRequestEntityAttribute(java.lang.String attributeName) Gets a list of entity attributes from the request data.
OIMType	getRequestEntityType() Returns the enum equivalent of request entity type i.e User/Role/Resource
void	setAdditionalEntityData(java.util.List additionalAttributes) Set additional data specific to the entity
void	setEntityData(java.util.List entityAttributes) Sets the Request data for this RequestEntity.
void	setEntityKey(java.lang.String entityKey) Sets the entity key for this RequestEntity.
void	setEntitySubType(java.lang.String entitySubType) Sets entity name associated with the entity.Only in case of Role based request type,set this value to Role name.
void	setEntityType(java.lang.String entityType) Deprecated. use the setEntityType method with OIMType as input parameter. This method will be replaced with setRequestEntityType
void	setOperation(java.lang.String operation)
void	setRequestEntityType(OIMType entityType) Sets the request entity type i.e User/Role/Resource from the given OIMType

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

USER_ENTITY_TYPE

public static final java.lang.String USER_ENTITY_TYPE

A constant for User entity-type.

See Also:

Constant Field Values

ROLE_ENTITY_TYPE

public static final java.lang.String ROLE_ENTITY_TYPE

A constant for Role entity-type.

See Also:

Constant Field Values

Constructor Detail

RequestEntity

public RequestEntity()

Constructs RequestEntity object with default construct

Method Detail

setEntityType

@Deprecated
public void setEntityType(java.lang.String entityType)

Deprecated. use the setEntityType method with OIMType as input parameter. This method will be replaced with setRequestEntityType

Sets the request entity type i.e User/Role

Parameters:

entityType - Request entity type.

getEntityType

@Deprecated
public java.lang.String getEntityType()

Deprecated.

Gets the entity-type for this object

Returns:

Entity-type i.e. "User"/"Role"

setRequestEntityType

public void setRequestEntityType(OIMType entityType)

Sets the request entity type i.e User/Role/Resource from the given OIMType

Parameters:

entityType - Request entity type. Enums defined in the OIMType

getRequestEntityType

public OIMType getRequestEntityType()

Returns the enum equivalent of request entity type i.e User/Role/Resource

Returns:

enum equivalent of request entity type.

setEntityData

public void setEntityData(java.util.List entityAttributes)

Sets the Request data for this RequestEntity. List of RequestEntityAttribute represents the data to be collected by request for the operation, based on the attributes defined in dataset and request type.

Parameters:

entityAttributes - List of entity attributes objects. Each attribute defined needs to be a valid attribute defined in dataset for the request type and its data-value based on data-type.

getEntityData

public java.util.List getEntityData()

Gets the request data associated with this RequestEntity. (Note: only entity specific data, and not additional data)

Returns:

List of entity attribute objects

getEntitySubType

public java.lang.String getEntitySubType()

Gets Role name in case of Role based request type, otherwise null.

Returns:

entity sub type.

setEntitySubType

public void setEntitySubType(java.lang.String entitySubType)

Sets entity name associated with the entity.Only in case of Role based request type,set this value to Role name. This value is used to generate request Preview by Request Engine and pass details to SOA.

Parameters:

entitySubType - Role name incase of Role based request type.

getEntityKey

public java.lang.String getEntityKey()

Gets the associated entity key set for this object. For request type that is associated with User entity and non-create, it returns usr_key, and for request type associated with Role entity, it returns ugp_key.For request type that is of create type , it returns null.

Returns:

entity key i.e. usr_key for User and ugp_key for Role entity, otherwise null.

setEntityKey

public void setEntityKey(java.lang.String entityKey)

Sets the entity key for this RequestEntity.

Parameters:

entityKey - usr_key for User and ugp_key for Role entity, when request type is of non-create type.

getRequestEntityAttribute

public RequestEntityAttribute getRequestEntityAttribute(java.lang.String attributeName)

Gets a list of entity attributes from the request data. These attributes are based on request dataset attributes, for the specific request type, and its associated data-value.

Parameters:

attributeName - Attribute name based on dataset attribute name .

Returns:

attribute list of attribute object and its value.

setOperation

public void setOperation(java.lang.String operation)

getOperation

public java.lang.String getOperation()

setAdditionalEntityData

public void setAdditionalEntityData(java.util.List additionalAttributes)

Set additional data specific to the entity

Parameters:

additionalAttributes - - additional data to be added to the entity

getAdditionalEntityData

public java.util.List getAdditionalEntityData()

Gets the additional data associated with this RequestEntity

Returns:

List of entity attribute objects