com.unboundid.directory.sdk.ds.types

Class NotificationProperties

java.lang.Object

com.unboundid.directory.sdk.ds.types.NotificationProperties

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class NotificationProperties
extends java.lang.Object

This class defines a structure used by a notification manager to specify information that it wishes to be included in a change notification.

Constructor Summary

Constructors

Constructor and Description
NotificationProperties(java.lang.String destinationID, java.util.Map<java.lang.String,java.lang.String> propertyMap, java.util.Set<AttributeType> keyAttributes) Create a new instance of this class from the provided information.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDestinationID() Retrieve the notification destination ID.
java.util.Set<AttributeType>	getKeyAttributes() Retrieve the additional key attributes to be recorded in the LDAP changelog entry and included in the notification.
java.util.Map<java.lang.String,java.lang.String>	getPropertyMap() Retrieve the set of property names and values to be included in the notification.

Methods inherited from class java.lang.Object

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

Constructor Detail

NotificationProperties

public NotificationProperties(java.lang.String destinationID,
                              java.util.Map<java.lang.String,java.lang.String> propertyMap,
                              java.util.Set<AttributeType> keyAttributes)

Create a new instance of this class from the provided information.

Parameters:

destinationID - The notification destination ID.

propertyMap - A set of property names and values to be included in the notification. May be null.

keyAttributes - Any additional key attributes to be recorded in the LDAP changelog entry and included in the notification. May be null.

Method Detail

getDestinationID

public java.lang.String getDestinationID()

Retrieve the notification destination ID.

Returns:

The notification destination ID.

getPropertyMap

public java.util.Map<java.lang.String,java.lang.String> getPropertyMap()

Retrieve the set of property names and values to be included in the notification.

Returns:

The set of property names and values to be included in the notification. Guaranteed to be non-null.

getKeyAttributes

public java.util.Set<AttributeType> getKeyAttributes()

Retrieve the additional key attributes to be recorded in the LDAP changelog entry and included in the notification.

Returns:

The additional key attributes to be recorded in the LDAP changelog entry and included in the notification.