|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.Entry
com.unboundid.ldap.sdk.ReadOnlyEntry
com.unboundid.ldap.sdk.ChangeLogEntry
com.unboundid.ldap.sdk.unboundidds.UnboundIDChangeLogEntry
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class UnboundIDChangeLogEntry
NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.This class provides an implementation of a changelog entry which provides support for all standard changelog entry attributes as well as those unique to the UnboundID Directory Server.
Field Summary | |
---|---|
static java.lang.String |
ATTR_AFTER_VALUES
The name of the attribute used to hold the resulting values for all attributes affected by the change. |
static java.lang.String |
ATTR_AFTER_VIRTUAL_VALUES
The name of the attribute used to hold information about virtual values for modified attributes after the change. |
static java.lang.String |
ATTR_BEFORE_VALUES
The name of the attribute used to hold the previous values for all attributes affected by the change. |
static java.lang.String |
ATTR_BEFORE_VIRTUAL_VALUES
The name of the attribute used to hold information about virtual values for modified attributes before the change. |
static java.lang.String |
ATTR_CHANGE_TIME
The name of the attribute used to hold a timestamp of the time the change was processed. |
static java.lang.String |
ATTR_CHANGE_TO_SOFT_DELETED_ENTRY
The name of the attribute used to indicate whether the operation represents a change to a soft-deleted entry. |
static java.lang.String |
ATTR_EXCEEDED_MAX_VALUES
The name of the attribute used to hold information about updated attributes which had more values (whether before the change, after the change, or both) than allowed to be shown in the before/after values attributes. |
static java.lang.String |
ATTR_EXCLUDED_OPERATIONAL_ATTR_COUNT
The name of the attribute used to hold information about the number of operational attributes that may have been excluded by access control and/or sensitive attribute processing. |
static java.lang.String |
ATTR_EXCLUDED_OPERATIONAL_ATTR_NAME
The name of the attribute used to hold information about the names of the operational attributes that may have been excluded by access control and/or sensitive attribute processing. |
static java.lang.String |
ATTR_EXCLUDED_USER_ATTR_COUNT
The name of the attribute used to hold information about the number of user attributes that may have been excluded by access control and/or sensitive attribute processing. |
static java.lang.String |
ATTR_EXCLUDED_USER_ATTR_NAME
The name of the attribute used to hold information about the names of the user attributes that may have been excluded by access control and/or sensitive attribute processing. |
static java.lang.String |
ATTR_KEY_VALUES
The name of the attribute used to hold the values of key attributes from the entry after the change was applied. |
static java.lang.String |
ATTR_KEY_VIRTUAL_VALUES
The name of the attribute used to hold information about virtual values for key attributes after the change. |
static java.lang.String |
ATTR_LOCAL_CSN
The name of the attribute used to hold the local change sequence number assigned to the change. |
static java.lang.String |
ATTR_NOTIFICATION_DESTINATION_ENTRY_UUID
The name of the attribute used to hold the entryUUID values for the notification destinations matched by the change. |
static java.lang.String |
ATTR_NOTIFICATION_PROPERTIES
The name of the attribute used to hold a number of properties related to the notification matched by the change. |
static java.lang.String |
ATTR_SOFT_DELETE_TO_DN
The name of the attribute used to hold the DN of the soft-deleted entry resulting from a soft delete operation. |
static java.lang.String |
ATTR_TARGET_ATTRIBUTE
The name of the attribute used to hold the names of the attributes targeted by the change. |
static java.lang.String |
ATTR_TARGET_UNIQUE_ID
The name of the attribute used to hold the entryUUID value for the entry that was targeted by the change. |
static java.lang.String |
ATTR_UNDELETE_FROM_DN
The name of the attribute used to hold the DN of the soft-deleted entry from which the content of an undelete was obtained. |
static java.lang.String |
ATTR_VIRTUAL_ATTRS
The name of the attribute used to hold information about virtual values for an add or delete operation. |
static java.lang.String |
ATTR_VIRTUAL_EXCEEDED_MAX_VALUES
The name of the attribute used to hold information about updated attributes which had more virtual values (whether before the change, after the change, or both) than allowed to be shown in the before/after values attributes. |
Fields inherited from class com.unboundid.ldap.sdk.ChangeLogEntry |
---|
ATTR_CHANGE_NUMBER, ATTR_CHANGE_TYPE, ATTR_CHANGES, ATTR_DELETE_OLD_RDN, ATTR_DELETED_ENTRY_ATTRS, ATTR_NEW_RDN, ATTR_NEW_SUPERIOR, ATTR_TARGET_DN |
Constructor Summary | |
---|---|
UnboundIDChangeLogEntry(Entry entry)
Creates a new UnboundID changelog entry object from the provided entry. |
Method Summary | |
---|---|
ReadOnlyEntry |
constructPartialEntryAfterChange()
Attempts to construct a partial representation of the target entry as it appeared after the change was processed. |
ReadOnlyEntry |
constructPartialEntryAfterChange(boolean includeVirtual)
Attempts to construct a partial representation of the target entry as it appeared after the change was processed. |
ReadOnlyEntry |
constructPartialEntryBeforeChange()
Attempts to construct a partial representation of the target entry as it appeared before the change was processed. |
ReadOnlyEntry |
constructPartialEntryBeforeChange(boolean includeVirtual)
Attempts to construct a partial representation of the target entry as it appeared before the change was processed. |
java.util.List<Attribute> |
getAddAttributes(boolean includeVirtual)
Retrieves the attribute list for an add changelog entry, optionally including information about virtual attributes. |
java.util.List<Attribute> |
getAddVirtualAttributes()
Retrieves the virtual attribute list for an add changelog entry, if available. |
Attribute |
getAttributeAfterChange(java.lang.String name)
Retrieves the specified attribute as it appeared in the target entry after the change was processed, if available. |
Attribute |
getAttributeAfterChange(java.lang.String name,
boolean includeVirtual)
Retrieves the specified attribute as it appeared in the target entry after the change was processed, if available. |
Attribute |
getAttributeBeforeChange(java.lang.String name)
Retrieves the specified attribute as it appeared in the target entry before the change was processed, if available. |
Attribute |
getAttributeBeforeChange(java.lang.String name,
boolean includeVirtual)
Retrieves the specified attribute as it appeared in the target entry before the change was processed, if available. |
java.util.List<ChangeLogEntryAttributeExceededMaxValuesCount> |
getAttributesThatExceededMaxValuesCount()
Retrieves information about any attributes updated in the associated modify or modify DN operation that had too many values to include in the changelog entry's set of before and/or after values. |
java.util.Date |
getChangeTime()
Retrieves the time that the change was processed, if available. |
java.lang.Boolean |
getChangeToSoftDeletedEntry()
Indicates whether the associated modify or delete operation targeted a soft-deleted entry. |
java.util.List<Attribute> |
getDeletedEntryAttributes(boolean includeVirtual)
Retrieves the list of attributes contained in the target entry at the time that it was deleted, optionally including information about virtual attributes. |
java.util.List<Attribute> |
getDeletedEntryVirtualAttributes()
Retrieves the virtual attribute list for a delete changelog entry, if available. |
java.util.List<java.lang.String> |
getExcludedOperationalAttributeNames()
Retrieves the names of any operational attributes for which information was excluded from the changelog entry by access control and/or sensitive attribute processing, if available. |
java.util.List<java.lang.String> |
getExcludedUserAttributeNames()
Retrieves the names of any user attributes for which information was excluded from the changelog entry by access control and/or sensitive attribute processing, if available. |
java.util.List<Attribute> |
getKeyEntryAttributes()
Retrieves a list containing key attributes from the target entry, as defined in the server configuration. |
java.util.List<Attribute> |
getKeyEntryAttributes(boolean includeVirtual)
Retrieves a list containing key attributes from the target entry, as defined in the server configuration. |
java.util.List<Attribute> |
getKeyEntryVirtualAttributes()
Retrieves a list containing virtual values for key attributes from the target entry, as defined in the server configuration. |
java.lang.String |
getLocalCSN()
Retrieves the local change sequence number (CSN) for the change, if available. |
java.util.List<java.lang.String> |
getNotificationDestinationEntryUUIDs()
Retrieves a list of the entryUUID values for any notification destinations for which the change matches one or more subscriptions. |
java.util.List<java.lang.String> |
getNotificationProperties()
Retrieves a list of any notification properties included in the changelog entry. |
int |
getNumExcludedOperationalAttributes()
Retrieves the number of operational attributes for which information was excluded from the changelog entry by access control and/or sensitive attribute processing, if available. |
int |
getNumExcludedUserAttributes()
Retrieves the number of user attributes for which information was excluded from the changelog entry by access control and/or sensitive attribute processing, if available. |
java.lang.String |
getSoftDeleteToDN()
Retrieves the DN of the soft-deleted entry that resulted from the associated soft delete operation. |
java.util.List<java.lang.String> |
getTargetAttributeNames()
Retrieves the names of any attributes targeted by the change, if available. |
java.lang.String |
getTargetUniqueID()
Retrieves the entryUUID value of the entry targeted by the change, if available. |
java.lang.String |
getUndeleteFromDN()
Retrieves the DN of the soft-deleted entry from which the content of an add operation was obtained, if that operation represents an undelete rather than a normal add. |
java.util.List<Attribute> |
getUpdatedAttributesAfterChange()
Retrieves a list containing the set of attributes that were updated in the associated modify or modify DN operation as they appeared after the change was processed. |
java.util.List<Attribute> |
getUpdatedAttributesAfterChange(boolean includeVirtual)
Retrieves a list containing the set of attributes (optionally including both real and virtual values) that were updated in the associated modify or modify DN operation as they appeared after the change was processed. |
java.util.List<Attribute> |
getUpdatedAttributesBeforeChange()
Retrieves a list containing the set of attributes that were updated in the associated modify or modify DN operation as they appeared before the change was processed. |
java.util.List<Attribute> |
getUpdatedAttributesBeforeChange(boolean includeVirtual)
Retrieves a list containing the set of attributes (optionally including both real and virtual values) that were updated in the associated modify or modify DN operation as they appeared before the change was processed. |
java.util.List<Attribute> |
getUpdatedVirtualAttributesAfterChange()
Retrieves a list containing information about virtual values for attributes that were updated in the associated modify or modify DN operation, as they appeared in the entry after the change was processed. |
java.util.List<Attribute> |
getUpdatedVirtualAttributesBeforeChange()
Retrieves a list containing information about virtual values for attributes that were updated in the associated modify or modify DN operation, as they appeared in the entry before the change was processed. |
java.util.List<ChangeLogEntryAttributeExceededMaxValuesCount> |
getVirtualAttributesThatExceededMaxValuesCount()
Retrieves information about any attributes updated in the associated modify or modify DN operation that had too many virtual values to include in the changelog entry's set of before and/or after virtual values. |
Methods inherited from class com.unboundid.ldap.sdk.ChangeLogEntry |
---|
constructChangeLogEntry, deleteOldRDN, getAddAttributes, getChangeNumber, getChangeType, getDeletedEntryAttributes, getModifications, getNewDN, getNewRDN, getNewSuperior, getTargetDN, parseAddAttributeList, processChange, toLDIFChangeRecord |
Methods inherited from class com.unboundid.ldap.sdk.ReadOnlyEntry |
---|
addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, removeAttribute, removeAttributeValue, removeAttributeValue, removeAttributeValues, removeAttributeValues, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setDN, setDN |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String ATTR_BEFORE_VALUES
public static final java.lang.String ATTR_AFTER_VALUES
public static final java.lang.String ATTR_CHANGE_TO_SOFT_DELETED_ENTRY
public static final java.lang.String ATTR_KEY_VALUES
public static final java.lang.String ATTR_EXCEEDED_MAX_VALUES
public static final java.lang.String ATTR_EXCLUDED_USER_ATTR_COUNT
public static final java.lang.String ATTR_EXCLUDED_OPERATIONAL_ATTR_COUNT
public static final java.lang.String ATTR_EXCLUDED_USER_ATTR_NAME
public static final java.lang.String ATTR_EXCLUDED_OPERATIONAL_ATTR_NAME
public static final java.lang.String ATTR_TARGET_UNIQUE_ID
public static final java.lang.String ATTR_CHANGE_TIME
public static final java.lang.String ATTR_LOCAL_CSN
public static final java.lang.String ATTR_SOFT_DELETE_TO_DN
public static final java.lang.String ATTR_TARGET_ATTRIBUTE
public static final java.lang.String ATTR_UNDELETE_FROM_DN
public static final java.lang.String ATTR_VIRTUAL_ATTRS
public static final java.lang.String ATTR_BEFORE_VIRTUAL_VALUES
public static final java.lang.String ATTR_AFTER_VIRTUAL_VALUES
public static final java.lang.String ATTR_KEY_VIRTUAL_VALUES
public static final java.lang.String ATTR_VIRTUAL_EXCEEDED_MAX_VALUES
public static final java.lang.String ATTR_NOTIFICATION_DESTINATION_ENTRY_UUID
public static final java.lang.String ATTR_NOTIFICATION_PROPERTIES
Constructor Detail |
---|
public UnboundIDChangeLogEntry(Entry entry) throws LDAPException
entry
- The entry from which to create this changelog entry.
LDAPException
- If the provided entry cannot be parsed as a
changelog entry.Method Detail |
---|
public java.lang.String getTargetUniqueID()
null
if it was not included in the changelog entry.public java.lang.String getLocalCSN()
null
if it was not
included in the changelog entry.public java.util.Date getChangeTime()
null
if it was
not included in the changelog entry.public java.util.List<Attribute> getAddAttributes(boolean includeVirtual)
includeVirtual
- Indicates whether to include both real and virtual
values (if true
, or only real values (if
false
), for the attributes to be returned.
null
if this changelog
entry does not represent an add operation.public java.util.List<Attribute> getAddVirtualAttributes()
null
if the changelog entry does not represent an add
operation, or an empty list if it does represent an add operation
but no virtual attribute information is available in the
changelog entry.public java.util.List<Attribute> getDeletedEntryAttributes(boolean includeVirtual)
includeVirtual
- Indicates whether to include both real and virtual
values (if true
, or only real values (if
false
), for the attributes to be returned.
null
if this changelog entry does not represent a delete
operation or no deleted attribute information is available.public java.util.List<Attribute> getDeletedEntryVirtualAttributes()
null
if the changelog entry does not represent a delete
operation, or an empty list if it does represent a delete
operation but no virtual attribute information is available in the
changelog entry.public java.util.List<Attribute> getUpdatedAttributesBeforeChange()
public java.util.List<Attribute> getUpdatedAttributesBeforeChange(boolean includeVirtual)
includeVirtual
- Indicates whether to include both real and virtual
values (if true
, or only real values (if
false
), for the attributes to be returned.
public java.util.List<Attribute> getUpdatedVirtualAttributesBeforeChange()
public java.util.List<Attribute> getUpdatedAttributesAfterChange()
public java.util.List<Attribute> getUpdatedAttributesAfterChange(boolean includeVirtual)
includeVirtual
- Indicates whether to include both real and virtual
values (if true
, or only real values (if
false
), for the attributes to be returned.
public java.util.List<Attribute> getUpdatedVirtualAttributesAfterChange()
public java.util.List<ChangeLogEntryAttributeExceededMaxValuesCount> getAttributesThatExceededMaxValuesCount()
public java.util.List<ChangeLogEntryAttributeExceededMaxValuesCount> getVirtualAttributesThatExceededMaxValuesCount()
public java.util.List<Attribute> getKeyEntryAttributes()
public java.util.List<Attribute> getKeyEntryAttributes(boolean includeVirtual)
includeVirtual
- Indicates whether to include both real and virtual
values (if true
, or only real values (if
false
), for the attributes to be returned.
public java.util.List<Attribute> getKeyEntryVirtualAttributes()
public int getNumExcludedUserAttributes()
public int getNumExcludedOperationalAttributes()
public java.util.List<java.lang.String> getExcludedUserAttributeNames()
public java.util.List<java.lang.String> getExcludedOperationalAttributeNames()
public java.lang.Boolean getChangeToSoftDeletedEntry()
true
if the modify or delete operation targeted a
soft-deleted entry, false
if not, or null
if that
information was not included in the changelog entry (which likely
indicates that the operation did not target a soft-deleted
entry).public java.lang.String getSoftDeleteToDN()
null
if that information was not
included in the changelog entry (e.g., because it does not
represent a soft delete operation).public java.lang.String getUndeleteFromDN()
null
if that information was
not included in the changelog entry (e.g., because it does not
represent an undelete operation).public java.util.List<java.lang.String> getTargetAttributeNames()
public java.util.List<java.lang.String> getNotificationDestinationEntryUUIDs()
public java.util.List<java.lang.String> getNotificationProperties()
public Attribute getAttributeBeforeChange(java.lang.String name) throws ChangeLogEntryAttributeExceededMaxValuesException
name
- The name of the attribute to retrieve as it appeared before
the change.
null
if it was not available
in the changelog entry.
ChangeLogEntryAttributeExceededMaxValuesException
- If the
specified attribute had more values before the change than
may be included in a changelog entry.public Attribute getAttributeBeforeChange(java.lang.String name, boolean includeVirtual) throws ChangeLogEntryAttributeExceededMaxValuesException
name
- The name of the attribute to retrieve as it
appeared before the change.includeVirtual
- Indicates whether to include both real and virtual
values (if true
, or only real values (if
false
), for the attribute to be returned.
null
if it was not available
in the changelog entry.
ChangeLogEntryAttributeExceededMaxValuesException
- If the
specified attribute had more values before the change than
may be included in a changelog entry.public Attribute getAttributeAfterChange(java.lang.String name) throws ChangeLogEntryAttributeExceededMaxValuesException
name
- The name of the attribute to retrieve as it appeared after
the change.
null
if it was not available
in the changelog entry.
ChangeLogEntryAttributeExceededMaxValuesException
- If the
specified attribute had more values before the change than
may be included in a changelog entry.public Attribute getAttributeAfterChange(java.lang.String name, boolean includeVirtual) throws ChangeLogEntryAttributeExceededMaxValuesException
name
- The name of the attribute to retrieve as it
appeared after the change.includeVirtual
- Indicates whether to include both real and virtual
values (if true
, or only real values (if
false
), for the attributes to be returned.
null
if it was not available
in the changelog entry.
ChangeLogEntryAttributeExceededMaxValuesException
- If the
specified attribute had more values before the change than
may be included in a changelog entry.public ReadOnlyEntry constructPartialEntryBeforeChange()
null
if the change was an
add operation and therefore the entry did not exist before the
change.public ReadOnlyEntry constructPartialEntryBeforeChange(boolean includeVirtual)
includeVirtual
- Indicates whether to include both real and virtual
values (if true
, or only real values (if
false
), for the attributes to be returned.
null
if the change was an
add operation and therefore the entry did not exist before the
change.public ReadOnlyEntry constructPartialEntryAfterChange()
null
if the change was a
delete operation and therefore did not exist after the change.public ReadOnlyEntry constructPartialEntryAfterChange(boolean includeVirtual)
includeVirtual
- Indicates whether to include both real and virtual
values (if true
, or only real values (if
false
), for the attributes to be returned.
null
if the change was a
delete operation and therefore did not exist after the change.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |