com.iplanet.am.sdk
Class AMEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--com.iplanet.am.sdk.AMEvent

All Implemented Interfaces:

java.io.Serializable

public class AMEvent

extends java.util.EventObject

Represents an event fired by Sun Java System Access Manager SDK.

AMEvent's state consists of the following:

• The event source: The underlying object that caused the event.
• The event source DN: DN of the underlying object that caused the event.
• The event type
• The source object type: Type of the underlying object that caused event.

See Also:

Serialized Form

Field Summary

static int	OBJECT_ADDED Represents an object addition event type.
static int	OBJECT_CHANGED Represents an object change event type.
static int	OBJECT_REMOVED Represents an object removal event type.
static int	OBJECT_RENAMED Represents an object renaming event type.

Constructor Summary

AMEvent(java.lang.Object source, int eventType)
Constructs an event object.

Method Summary

int	getEventType() Returns the type of the event.
java.lang.String	getSourceDN() Returns the distinguished name of the source object in a String format.
int	getSourceType() Returns the type of the source object that caused the event.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Field Detail

OBJECT_ADDED

public static final int OBJECT_ADDED

Represents an object addition event type.

OBJECT_CHANGED

public static final int OBJECT_CHANGED

Represents an object change event type.

OBJECT_REMOVED

public static final int OBJECT_REMOVED

Represents an object removal event type.

OBJECT_RENAMED

public static final int OBJECT_RENAMED

Represents an object renaming event type.

Constructor Detail

AMEvent

public AMEvent(java.lang.Object source,
               int eventType)

Constructs an event object. This constructor accepts the event source object and passes it onto the base class constructor.

Parameters:

source - The source object that caused the event. The source object could be User, Role, Group, Organization, etc., from this SDK. The source could also be a String representing the DN (distinguished name) of the source object.

eventType - type of event.

Method Detail

getSourceDN

public java.lang.String getSourceDN()

Returns the distinguished name of the source object in a String format. Use this method if no searching or parsing operations need to be performed on the distinguished name.

Returns:

distinguished name of the source object.

getEventType

public int getEventType()

Returns the type of the event.

Returns:

Returns one of the following possible values:

• AMEvent.OBJECT_ADDED
• AMEvent.OBJECT_CHANGED
• AMEvent.OBJECT_REMOVED
• AMEvent.OBJECT_RENAMED

getSourceType

public int getSourceType()

Returns the type of the source object that caused the event.

Returns:

Returns one of the following possible values:

• AMObject.USER
• AMObject.ROLE
• AMObject.FILTERED_ROLE
• AMObject.GROUP
• AMObject.DYNAMIC_GROUP
• AMObject.ASSIGNABLE_DYNAMIC_GROUP
• AMObject.ORGANIZATION
• AMObject.PEOPLE_CONTAINER
• AMObject.GROUP_CONTAINER
• AMObject.ORGINATIONAL_UNIT
• AMObject.UNKNOWN_OBJECT_TYPE if source unknown