com.netegrity.ims
Class EventProfile

java.lang.Object
  com.netegrity.ims.EventProfile

public class EventProfile
extends java.lang.Object

This represents the data as in the Auditing subsystem

This class provides methods to set and access auditable attributes for objects that need to be audited.

For information about the various stages of an event cycle in which event attributes can be recorded for auditing, see setEventState().

Since:

Identity Manager 8.1

See Also:

AuditEvent, EnhancedAuditData, GenericAuditEvent

Nested Class Summary

class

EventProfile.TaskSessionProfile The TasksessionProfile of the tasksession this event belongs to.

Constructor Summary

EventProfile()
Constructs an EventProfile object for a managed object

Method Summary

java.lang.String	getAdminDN() Retrieves the distinguished name of the administrator who executed the task that generated the event.
java.lang.String	getAdminName() Retrieves the name of the administrator who executed the task that generated the event.
java.lang.String	getEventDescription() Retrieves an event description
java.lang.String	getEventId() Retrieves an event ID.
java.lang.String	getEventName() Retrieves an event name.
java.lang.String	getEventState() Retrieves an event state.
AuditEventStateSeverityType	getEventStateSeverity() Returns the event state severity type.
java.lang.String	getEventType() Retrieves an event type.
java.lang.String	getIMSEnvName() Retrieves the Identity Manager environment name.
java.lang.String	getIMSEnvOID() Retrieves the Identity Manager environment object identifier.
java.lang.String	getLocale() Retrieves a locale.
java.lang.String	getParentEventOID() The parent Event in case this is a child of a event
java.lang.String	getParentOrgDN() Retrieves the distinguished name of the parent organization.
EventProfile.TaskSessionProfile	getTaskSessionProfile()
void	setAdminDN(java.lang.String value) Sets the distinguished name of the administrator who executed the task that generated the event.
void	setAdminName(java.lang.String value) Sets the name of the administrator who executed the task that generated the event.
void	setEventDescription(java.lang.String value) Sets the event description.
void	setEventId(java.lang.String id) Sets and event ID.
void	setEventName(java.lang.String value) Sets the event name.
void	setEventState(java.lang.String value) Sets an event state.
void	setEventStateSeverity(AuditEventStateSeverityType severity) Sets the event state severity.
void	setEventType(java.lang.String value) Sets an event type.
void	setIMSEnvName(java.lang.String value) Sets the Identity Manager environment name.
void	setIMSEnvOID(java.lang.String value) Sets the Identity Manager environment object identifier.
void	setLocale(java.lang.String value) Sets a locale.
void	setParentEventOID(java.lang.String parentEventOID) The parent Event in case this is a child of a event
void	setParentOrgDN(java.lang.String parentOrgDN) Sets the distinguished name of the parent organization.
java.lang.String	toString() Returns a string representation of the contents of this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventProfile

public EventProfile()

Constructs an EventProfile object for a managed object

Method Detail

getTaskSessionProfile

public EventProfile.TaskSessionProfile getTaskSessionProfile()

toString

public java.lang.String toString()

Returns a string representation of the contents of this object.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

getParentOrgDN

public java.lang.String getParentOrgDN()

Retrieves the distinguished name of the parent organization.

Returns:

The distinguished name of the parent organization.

setParentOrgDN

public void setParentOrgDN(java.lang.String parentOrgDN)

Sets the distinguished name of the parent organization.

Parameters:

parentOrgDN - The distinguished name to set.

setAdminName

public void setAdminName(java.lang.String value)

Sets the name of the administrator who executed the task that generated the event.

Parameters:

value - The administrator's name.

getAdminName

public java.lang.String getAdminName()

Retrieves the name of the administrator who executed the task that generated the event.

Returns:

The name to set.

setAdminDN

public void setAdminDN(java.lang.String value)

Sets the distinguished name of the administrator who executed the task that generated the event.

Parameters:

value - The distinguished name to set.

getAdminDN

public java.lang.String getAdminDN()

Retrieves the distinguished name of the administrator who executed the task that generated the event.

Returns:

The administrator's distinguished name.

getParentEventOID

public java.lang.String getParentEventOID()

The parent Event in case this is a child of a event

Returns:

the parentEventOID

setParentEventOID

public void setParentEventOID(java.lang.String parentEventOID)

The parent Event in case this is a child of a event

Parameters:

parentEventOID - the parentEventOID to set

setLocale

public void setLocale(java.lang.String value)

Sets a locale.

Parameters:

value - The locale to associate with the event.

getLocale

public java.lang.String getLocale()

Retrieves a locale.

Returns:

The locale associated with the event.

setEventType

public void setEventType(java.lang.String value)

Sets an event type.

Parameters:

value - The event type to set.

getEventType

public java.lang.String getEventType()

Retrieves an event type.

Returns:

The event type.

setEventName

public void setEventName(java.lang.String value)

Sets the event name.

Parameters:

value - The name to set.

getEventName

public java.lang.String getEventName()

Retrieves an event name.

Returns:

The event name.

setEventDescription

public void setEventDescription(java.lang.String value)

Sets the event description.

Parameters:

value - The description to set for the event.

getEventDescription

public java.lang.String getEventDescription()

Retrieves an event description

Returns:

The description of the event

setEventState

public void setEventState(java.lang.String value)

Sets an event state.

An event state specifies the stages during the life cycle of an event when event attributes can be recorded for auditing.

The following are valid event states. The strings must be specified in upper case letters:

Event State	Description
BEGIN	Audits the set of attributes populated by the user interface, and custom handlers, including business logic task handlers, logical attribute handlers and attribute validation implementations. This state also audits attributes populated by TEWS.
PRE	Audits attributes that are affected by event listeners that execute during the BEGIN state.
APPROVED	Audits changes to attributes during the approval process.
REJECTED	Records status information when an event under workflow control is rejected.
EXECUTE	Records information when an event executes.
POST	Audits any changes that an event listener makes to an attribute in the POST state.
INVALID	Records status information when Identity Manager encounters an invalid event.
COMPLETE	Records status information when an event completes.
CANCELLED	Records status information when an event is cancelled. Note: After an event is rejected, it proceeds to the CANCELLED state.

Parameters:

value - The event state to set. The event state strings in the above table must be specified in capital letters.

getEventState

public java.lang.String getEventState()

Retrieves an event state.

For information about event states, see setEventState().

Returns:

The event state.

setIMSEnvOID

public void setIMSEnvOID(java.lang.String value)

Sets the Identity Manager environment object identifier.

Parameters:

value - The environment object identifier to set.

getIMSEnvOID

public java.lang.String getIMSEnvOID()

Retrieves the Identity Manager environment object identifier.

Returns:

The object identifier for the environment.

setIMSEnvName

public void setIMSEnvName(java.lang.String value)

Sets the Identity Manager environment name.

Parameters:

value - The environment name to set.

getIMSEnvName

public java.lang.String getIMSEnvName()

Retrieves the Identity Manager environment name.

Returns:

The environment name.

setEventStateSeverity

public void setEventStateSeverity(AuditEventStateSeverityType severity)

Sets the event state severity.

Parameters:

severity - The state severity type to assign to the event.

getEventStateSeverity

public AuditEventStateSeverityType getEventStateSeverity()

Returns the event state severity type.

Returns:

The state severity type for the event.

setEventId

public void setEventId(java.lang.String id)

Sets and event ID.

Parameters:

id - The ID to assign to the event.

getEventId

public java.lang.String getEventId()

Retrieves an event ID.

Returns:

The ID assigned to the event.