oracle.ifs.common

Class IfsEvent

java.lang.Object

oracle.ifs.common.IfsEvent

All Implemented Interfaces:

Serializable

public final class IfsEvent
extends Object
implements Serializable

A IfsEvent is a message indicating that a specific LibraryObject was changed in some way.

Every time a LibraryObject is created, altered, or removed, the Internet File System server posts a IfsEvent on that LibraryObject by invoking LibraryObject.postEvent. This posted event is routed to the handleEvent methods of both LibrarySession and that LibraryObject, not just for the session that triggered the event, but for all iFS sessions.

IfsEvent has methods to determine the event type (creation, alteration, or removal of a LibraryObject) and the event status (uncommitted, rolled back, or committed). Only "committed" events are propagated between sessions.

IfsEvents also have a subtype, the meaning of which depends on the event type, event status, and LibraryObject. Document management applications can introduce their own subtypes. An IfsEvent's long payload can also be used for application-specific purposes.

A document management application can extend or override the handleEvent methods for any ClassObjects it introduces. In addition, an application may register to receive events on a specific LibraryObject or class of LibraryObjects by invoking the registerEventHandler or registerClassEventHandler methods of LibrarySession. An application could use this to automatically update a GUI whenever a displayed object is altered (even if it is altered by another session).

Version:

1.0

Author:

David Pitfield

See Also:

Serialized Form

(Published)

Field Summary

Fields

Modifier and Type	Field and Description
static int	EVENTSTATUS_COMMITTED Event status for committed changes.
static int	EVENTSTATUS_ROLLEDBACK Event status for rollback of uncommitted changes.
static int	EVENTSTATUS_UNCOMMITTED Event status for uncommitted changes.
static int	EVENTSUBTYPE_ACL_FREED Subtype for SPECIAL event for a freed ACL.
static int	EVENTSUBTYPE_ACL_INVALIDATED Subtype for SPECIAL event for ACLs being invalidated.
static int	EVENTSUBTYPE_ATTRIBUTES_RSN_CHANGED Subtype for SPECIAL event for Oracle use.
static int	EVENTSUBTYPE_AUDIT_CERTIFICATE_CHANGED Subtype for SPECIAL event for new events in an object that reflects a change in Audit certificate information.
static int	EVENTSUBTYPE_AUDIT_FOLDERPATH_CHANGED Subtype for SPECIAL event for new events in an object that reflects a change in the folder path representations used in Auditing.
static int	EVENTSUBTYPE_AUDIT_HISTORY_ALERTED Subtype for SPECIAL event for new events in an object that reflects new Audit history events.
static int	EVENTSUBTYPE_AUDIT_TYPES_REGISTERED Subtype for SPECIAL event for Oracle use.
static int	EVENTSUBTYPE_CLASSOBJECT_ATTRIBUTE_ADDED_OR_REMOVED Subtype for SPECIAL event for a ClassObject having an Attribute either added or removed.
static int	EVENTSUBTYPE_CONTENTQUOTA_CONSUMPTION_CHANGE Subtype for SPECIAL event for indicating content being created.
static int	EVENTSUBTYPE_CREATE_BROADCAST Subtype for CREATEINSTANCE events which needs to be broadcast to other services.
static int	EVENTSUBTYPE_CREATE_NOBROADCAST Subtype for CREATEINSTANCE events which do not need to be broadcast to other services.
static int	EVENTSUBTYPE_DETAILS_CHANGED Subtype for SPECIAL event for details changing in a master/detail object relationship.
static int	EVENTSUBTYPE_GENERAL_ALERT Subtype for SPECIAL event for a general alert, to be interpreted by the receiving event handler.
static int	EVENTSUBTYPE_GROUPMEMBER_ADDED Subtype for SPECIAL event for members being added to a group.
static int	EVENTSUBTYPE_GROUPMEMBER_REMOVED Subtype for SPECIAL event for members being removed from a group.
static int	EVENTSUBTYPE_PERMISSIONBUNDLE_INVALIDATED Subtype for SPECIAL event for PermissionBundles being invalidated.
static int	EVENTSUBTYPE_PROPERTY_ADDED Subtype for SPECIAL event for Oracle use.
static int	EVENTSUBTYPE_PROPERTY_REMOVED Subtype for SPECIAL event for Oracle use.
static int	EVENTSUBTYPE_QUARANTINE Subtype for SPECIAL event for Oracle use.
static int	EVENTSUBTYPE_RELATIONSHIP_ADDED Subtype for SPECIAL event for Items added to an object.
static int	EVENTSUBTYPE_RELATIONSHIP_REMOVED Subtype for SPECIAL event for Items removed from an object.
static int	EVENTSUBTYPE_RELATIONSHIP_RENAMED Subtype for SPECIAL event for Items of an object being renamed.
static int	EVENTSUBTYPE_RELATIONSHIPS_CHANGED Subtype for SPECIAL event for Relationships changed.
static int	EVENTSUBTYPE_RUNTIMESTATE_CHANGE_REQUEST Deprecated. 9.3.4: no longer recognized by the runtime system
static int	EVENTSUBTYPE_RUNTIMESTATE_CONTROLLERALERT Subtype for SPECIAL event for runtime state ControllerAlert posted.
static int	EVENTSUBTYPE_RUNTIMESTATE_CONTROLLERREPLY Subtype for SPECIAL event for runtime state ControllerReply posted.
static int	EVENTSUBTYPE_RUNTIMESTATE_CONTROLLERREQUEST Subtype for SPECIAL event for runtime state ControllerRequest posted.
static int	EVENTSUBTYPE_SECURITY_CHANGED Subtype for SPECIAL event for Oracle use.
static int	EVENTSUBTYPE_SERVICE_KEEP_ALIVE Subtype for SPECIAL event for indicating a service is alive.
static int	EVENTSUBTYPE_SESSION_LOCK_FREED Subtype for SPECIAL event for freeing an object with a session lock.
static int	EVENTSUBTYPE_SESSION_LOCK_OBTAINED Subtype for SPECIAL event for obtaining a session lock.
static int	EVENTSUBTYPE_SESSION_LOCK_RELEASED Subtype for SPECIAL event for releasing a session lock.
static int	EVENTSUBTYPE_SHARED_STATE_INVALIDATED Subtype for SPECIAL event for Oracle use.
static int	EVENTSUBTYPE_UNKNOWN Unknown event subtype.
static int	EVENTTYPE_CREATEINSTANCE Event type for creation of new objects.
static int	EVENTTYPE_FREE Event type for freeing existing objects.
static int	EVENTTYPE_SETATTRIBUTES Event type for alteration of existing objects.
static int	EVENTTYPE_SPECIAL Event type for special events, as described by the event subtype.
static int	EVENTTYPE_UNKNOWN Unknown event type.
protected Long	m_ClassId The class id of the LibraryObject posting the event.
protected int	m_EventStatus The enumerated event status.
protected int	m_EventSubtype The event subtype.
protected int	m_EventType The enumerated event type.
protected Long	m_Id The id of the LibraryObject posting the event.
protected long	m_LongPayload The long payload.
protected Long	m_ServiceId The service id of the LibraryObject posting the event.
protected Long	m_SessionId The session id of the LibraryObject posting the event.

Constructor Summary

Constructors

Constructor and Description
IfsEvent(Long id, Long classId, Long sessionId, Long serviceId, int eventType, int eventSubtype, int eventStatus, long longPayload) Internal use only: Constructs a IfsEvent.

Method Summary

Modifier and Type	Method and Description
Long	getClassId() Gets the class id of the LibraryObject that posted the event.
int	getEventStatus() Gets the event status.
int	getEventSubtype() Gets the event subtype.
int	getEventType() Gets the event type.
Long	getId() Gets the id of the LibraryObject that posted the event.
long	getLongPayload() Gets the long payload.
Long	getServiceId() Gets the service id of the LibraryObject that posted the event.
Long	getSessionId() Gets the session id of the LibraryObject that posted the event.
String	toString() Convert to English string representation.
String	toString(String targetName) Convert to English string representation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EVENTTYPE_UNKNOWN

public static final int EVENTTYPE_UNKNOWN

Unknown event type.

See Also:

Constant Field Values

(Published)

EVENTTYPE_CREATEINSTANCE

public static final int EVENTTYPE_CREATEINSTANCE

Event type for creation of new objects.

See Also:

Constant Field Values

(Published)

EVENTTYPE_SETATTRIBUTES

public static final int EVENTTYPE_SETATTRIBUTES

Event type for alteration of existing objects.

See Also:

Constant Field Values

(Published)

EVENTTYPE_FREE

public static final int EVENTTYPE_FREE

Event type for freeing existing objects.

See Also:

Constant Field Values

(Published)

EVENTTYPE_SPECIAL

public static final int EVENTTYPE_SPECIAL

Event type for special events, as described by the event subtype.

See Also:

Constant Field Values

(Published)

EVENTSUBTYPE_UNKNOWN

public static final int EVENTSUBTYPE_UNKNOWN

Unknown event subtype.

See Also:

Constant Field Values

(Published)

EVENTSUBTYPE_CREATE_BROADCAST

public static final int EVENTSUBTYPE_CREATE_BROADCAST

Subtype for CREATEINSTANCE events which needs to be broadcast to other services.

See Also:

Constant Field Values

(Published)

EVENTSUBTYPE_CREATE_NOBROADCAST

public static final int EVENTSUBTYPE_CREATE_NOBROADCAST

Subtype for CREATEINSTANCE events which do not need to be broadcast to other services.

See Also:

Constant Field Values

(Published)

EVENTSUBTYPE_ACL_INVALIDATED

public static final int EVENTSUBTYPE_ACL_INVALIDATED

Subtype for SPECIAL event for ACLs being invalidated.

See Also:

Constant Field Values

(Published)

EVENTSUBTYPE_ACL_FREED

public static final int EVENTSUBTYPE_ACL_FREED

Subtype for SPECIAL event for a freed ACL.

See Also:

Constant Field Values

(Published)

EVENTSUBTYPE_RELATIONSHIPS_CHANGED

public static final int EVENTSUBTYPE_RELATIONSHIPS_CHANGED

Subtype for SPECIAL event for Relationships changed.

See Also:

Constant Field Values

(Published)

EVENTSUBTYPE_CLASSOBJECT_ATTRIBUTE_ADDED_OR_REMOVED

public static final int EVENTSUBTYPE_CLASSOBJECT_ATTRIBUTE_ADDED_OR_REMOVED

Subtype for SPECIAL event for a ClassObject having an Attribute either added or removed.

See Also:

Constant Field Values

(Published)

EVENTSUBTYPE_AUDIT_HISTORY_ALERTED

public static final int EVENTSUBTYPE_AUDIT_HISTORY_ALERTED

Subtype for SPECIAL event for new events in an object that reflects new Audit history events.

See Also:

Constant Field Values

(Published)

EVENTSUBTYPE_SESSION_LOCK_OBTAINED

public static final int EVENTSUBTYPE_SESSION_LOCK_OBTAINED

Subtype for SPECIAL event for obtaining a session lock.

See Also:

Constant Field Values

(Published)

EVENTSUBTYPE_SESSION_LOCK_RELEASED

public static final int EVENTSUBTYPE_SESSION_LOCK_RELEASED

Subtype for SPECIAL event for releasing a session lock.

See Also:

Constant Field Values

(Published)

EVENTSUBTYPE_SERVICE_KEEP_ALIVE

public static final int EVENTSUBTYPE_SERVICE_KEEP_ALIVE

Subtype for SPECIAL event for indicating a service is alive.

See Also:

Constant Field Values

(Published)

EVENTSUBTYPE_CONTENTQUOTA_CONSUMPTION_CHANGE

public static final int EVENTSUBTYPE_CONTENTQUOTA_CONSUMPTION_CHANGE

Subtype for SPECIAL event for indicating content being created.

See Also:

Constant Field Values

(Published)

EVENTSUBTYPE_RELATIONSHIP_ADDED

public static final int EVENTSUBTYPE_RELATIONSHIP_ADDED

Subtype for SPECIAL event for Items added to an object.

See Also:

Constant Field Values

(Published)

EVENTSUBTYPE_RELATIONSHIP_REMOVED

public static final int EVENTSUBTYPE_RELATIONSHIP_REMOVED

Subtype for SPECIAL event for Items removed from an object.

See Also:

Constant Field Values

(Published)

EVENTSUBTYPE_RELATIONSHIP_RENAMED

public static final int EVENTSUBTYPE_RELATIONSHIP_RENAMED

Subtype for SPECIAL event for Items of an object being renamed.

See Also:

Constant Field Values

(Published)

EVENTSUBTYPE_DETAILS_CHANGED

public static final int EVENTSUBTYPE_DETAILS_CHANGED

Subtype for SPECIAL event for details changing in a master/detail object relationship. The event is posted on the master.

See Also:

Constant Field Values

(Published)

EVENTSUBTYPE_SESSION_LOCK_FREED

public static final int EVENTSUBTYPE_SESSION_LOCK_FREED

Subtype for SPECIAL event for freeing an object with a session lock.

See Also:

Constant Field Values

(Published)

EVENTSUBTYPE_ATTRIBUTES_RSN_CHANGED

public static final int EVENTSUBTYPE_ATTRIBUTES_RSN_CHANGED

Subtype for SPECIAL event for Oracle use.

See Also:

Constant Field Values

(Published)

EVENTSUBTYPE_SHARED_STATE_INVALIDATED

public static final int EVENTSUBTYPE_SHARED_STATE_INVALIDATED

Subtype for SPECIAL event for Oracle use.

See Also:

Constant Field Values

(Published)

EVENTSUBTYPE_QUARANTINE

public static final int EVENTSUBTYPE_QUARANTINE

Subtype for SPECIAL event for Oracle use.

See Also:

Constant Field Values

(Published)

EVENTSUBTYPE_PROPERTY_ADDED

public static final int EVENTSUBTYPE_PROPERTY_ADDED

Subtype for SPECIAL event for Oracle use.

See Also:

Constant Field Values

(Published)

EVENTSUBTYPE_PROPERTY_REMOVED

public static final int EVENTSUBTYPE_PROPERTY_REMOVED

Subtype for SPECIAL event for Oracle use.

See Also:

Constant Field Values

(Published)

EVENTSUBTYPE_SECURITY_CHANGED

public static final int EVENTSUBTYPE_SECURITY_CHANGED

Subtype for SPECIAL event for Oracle use.

See Also:

Constant Field Values

(Published)

EVENTSUBTYPE_AUDIT_TYPES_REGISTERED

public static final int EVENTSUBTYPE_AUDIT_TYPES_REGISTERED

Subtype for SPECIAL event for Oracle use.

See Also:

Constant Field Values

(Published)

EVENTSUBTYPE_AUDIT_FOLDERPATH_CHANGED

public static final int EVENTSUBTYPE_AUDIT_FOLDERPATH_CHANGED

Subtype for SPECIAL event for new events in an object that reflects a change in the folder path representations used in Auditing.

See Also:

Constant Field Values

(Published)

EVENTSUBTYPE_AUDIT_CERTIFICATE_CHANGED

public static final int EVENTSUBTYPE_AUDIT_CERTIFICATE_CHANGED

Subtype for SPECIAL event for new events in an object that reflects a change in Audit certificate information.

See Also:

Constant Field Values

(Published)

EVENTSUBTYPE_PERMISSIONBUNDLE_INVALIDATED

public static final int EVENTSUBTYPE_PERMISSIONBUNDLE_INVALIDATED

Subtype for SPECIAL event for PermissionBundles being invalidated.

See Also:

Constant Field Values

(Published)

EVENTSUBTYPE_GENERAL_ALERT

public static final int EVENTSUBTYPE_GENERAL_ALERT

Subtype for SPECIAL event for a general alert, to be interpreted by the receiving event handler.

See Also:

Constant Field Values

(Published)

EVENTSUBTYPE_RUNTIMESTATE_CHANGE_REQUEST

public static final int EVENTSUBTYPE_RUNTIMESTATE_CHANGE_REQUEST

Deprecated. 9.3.4: no longer recognized by the runtime system

Subtype for SPECIAL event for runtime state change request. Event payload clarifies the request.

This is now obsolete.

See Also:

Constant Field Values

(Published)

EVENTSUBTYPE_GROUPMEMBER_ADDED

public static final int EVENTSUBTYPE_GROUPMEMBER_ADDED

Subtype for SPECIAL event for members being added to a group.

See Also:

Constant Field Values

(Published)

EVENTSUBTYPE_GROUPMEMBER_REMOVED

public static final int EVENTSUBTYPE_GROUPMEMBER_REMOVED

Subtype for SPECIAL event for members being removed from a group.

See Also:

Constant Field Values

(Published)

EVENTSUBTYPE_RUNTIMESTATE_CONTROLLERREQUEST

public static final int EVENTSUBTYPE_RUNTIMESTATE_CONTROLLERREQUEST

Subtype for SPECIAL event for runtime state ControllerRequest posted.

See Also:

Constant Field Values

(Published)

EVENTSUBTYPE_RUNTIMESTATE_CONTROLLERREPLY

public static final int EVENTSUBTYPE_RUNTIMESTATE_CONTROLLERREPLY

Subtype for SPECIAL event for runtime state ControllerReply posted.

See Also:

Constant Field Values

(Published)

EVENTSUBTYPE_RUNTIMESTATE_CONTROLLERALERT

public static final int EVENTSUBTYPE_RUNTIMESTATE_CONTROLLERALERT

Subtype for SPECIAL event for runtime state ControllerAlert posted.

See Also:

Constant Field Values

(Published)

EVENTSTATUS_UNCOMMITTED

public static final int EVENTSTATUS_UNCOMMITTED

Event status for uncommitted changes. In almost all cases, a status of EVENTSTATUS_UNCOMMITTED should be posted. When the current transaction is committed, any event that was posted as EVENTSTATUS_UNCOMMITTED will automatically get re-posted as EVENTSTATUS_COMMITTED. If the current transaction is rolled back, the event gets re-posted as EVENTSTATUS_ROLLEDBACK.

See Also:

Constant Field Values

(Published)

EVENTSTATUS_ROLLEDBACK

public static final int EVENTSTATUS_ROLLEDBACK

Event status for rollback of uncommitted changes.

See Also:

Constant Field Values

(Published)

EVENTSTATUS_COMMITTED

public static final int EVENTSTATUS_COMMITTED

Event status for committed changes. Only in very rare cases (usually involving DDL SQL statements, which automatically commit transactions) it is correct to post an event with status EVENTSTATUS_COMMITTED.

See Also:

Constant Field Values

(Published)

m_Id

protected Long m_Id

The id of the LibraryObject posting the event.

(Unpublished)

m_ClassId

protected Long m_ClassId

The class id of the LibraryObject posting the event.

(Unpublished)

m_SessionId

protected Long m_SessionId

The session id of the LibraryObject posting the event.

(Unpublished)

m_ServiceId

protected Long m_ServiceId

The service id of the LibraryObject posting the event.

(Unpublished)

m_EventType

protected int m_EventType

The enumerated event type.

(Unpublished)

m_EventSubtype

protected int m_EventSubtype

The event subtype.

(Unpublished)

m_EventStatus

protected int m_EventStatus

The enumerated event status.

(Unpublished)

m_LongPayload

protected long m_LongPayload

The long payload.

(Unpublished)

Constructor Detail

IfsEvent

public IfsEvent(Long id,
                Long classId,
                Long sessionId,
                Long serviceId,
                int eventType,
                int eventSubtype,
                int eventStatus,
                long longPayload)

Internal use only: Constructs a IfsEvent.

For internal use only. Do not use this method.

Parameters:

id - the id of the LibraryObject posting the event

classId - the class id of the LibraryObject posting the event

sessionId - the session id of the LibraryObject posting the event

serviceId - the service id of the LibraryObject posting the event

eventType - the event type; an enumerated value

eventSubtype - the event subtype

eventStatus - the event status; an enumerated value

longPayload - the long payload

(Unpublished)

Method Detail

getId

public final Long getId()

Gets the id of the LibraryObject that posted the event.

Returns:

the id

(Published)

getClassId

public final Long getClassId()

Gets the class id of the LibraryObject that posted the event.

Returns:

the class id

(Published)

getSessionId

public final Long getSessionId()

Gets the session id of the LibraryObject that posted the event.

Returns:

the session id

(Published)

getServiceId

public final Long getServiceId()

Gets the service id of the LibraryObject that posted the event.

Returns:

the service id

(Published)

getEventType

public final int getEventType()

Gets the event type.

Returns:

the event type

(Published)

getEventSubtype

public final int getEventSubtype()

Gets the event subtype.

Returns:

the event subtype

(Published)

getEventStatus

public final int getEventStatus()

Gets the event status.

Returns:

the event status

(Published)

getLongPayload

public final long getLongPayload()

Gets the long payload.

Returns:

the long payload

(Published)

toString

public String toString()

Convert to English string representation. Use numeric name for the target object, with format: "ID:[numeric id]"

Overrides:

toString in class Object

(Unpublished)

toString

public String toString(String targetName)

Convert to English string representation

Parameters:

targetName - the name of the target; if null, use numeric name of "ID:[numeric id]"

(Unpublished)