oracle.ifs.common

Class AuditFolderPath

java.lang.Object

oracle.ifs.common.AuditFolderPath

All Implemented Interfaces:

Serializable, LooselyBoundedCacheable

public final class AuditFolderPath
extends Object
implements Serializable, LooselyBoundedCacheable

An AuditFolderPath represents a folder path captured at the time an AuditEvent is posted, and is subsequently used in dispatching the event.

Author:

Dave Long

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AuditFolderPath(long folderPathId, long folderContextId, Long[] pathIds, long expTime) Constructs an AuditFolderPath.

Method Summary

Modifier and Type	Method and Description
void	added(Object id) Called when an instance is added to the cache.
boolean	canPurge() Gets whether the item can be purged from the the BoundedCache.
long	getExpirationTime() Gets the timestamp repsenting the time this entry expires, as a time offset from 1970.
long	getFolderContextId() Gets the ID of the folder context.
long	getFolderPathId() Gets the ID of the entry in the audit folder path table.
Long[]	getPathIds() The IDs of the items that comprise the folder path.
boolean	isEquivalent(Long[] ids) Checks if the specified array of IDs matches the ID array represented by this instance.
boolean	isExpired() Checks to see if this instance is expired
void	removed(Object id) Called when an instance is removed to the cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuditFolderPath

public AuditFolderPath(long folderPathId,
                       long folderContextId,
                       Long[] pathIds,
                       long expTime)

Constructs an AuditFolderPath.

Parameters:

folderPathId - the ID of the entry in the audit folder path table

folderContextId - the ID of the folder context

pathIds - the IDs of the items that comprise the folder path

expTime - the expiration time

Method Detail

getFolderPathId

public long getFolderPathId()

Gets the ID of the entry in the audit folder path table.

Returns:

the ID of the entry in the audit folder path table

getFolderContextId

public long getFolderContextId()

Gets the ID of the folder context.

Returns:

the ID of the folder context

getPathIds

public Long[] getPathIds()

The IDs of the items that comprise the folder path.

The array is sorted so that the first element is the audit folder context, and the last is the folder that is a direct child of the domain context.

Returns:

the path IDs

getExpirationTime

public long getExpirationTime()

Gets the timestamp repsenting the time this entry expires, as a time offset from 1970.

Returns:

the expiration time

isEquivalent

public boolean isEquivalent(Long[] ids)

Checks if the specified array of IDs matches the ID array represented by this instance.

Returns:

true if the specified ID set matches; false otherwise

isExpired

public boolean isExpired()

Checks to see if this instance is expired

Returns:

true if the specified instance is expired; false otherwise

canPurge

public boolean canPurge()
                 throws IfsException

Gets whether the item can be purged from the the BoundedCache.

The caller of this method indicates a desire to purge the object. The implementation should treat this as a purge request, but can return false if the item should not be purged.

Specified by:

canPurge in interface LooselyBoundedCacheable

Returns:

whether the item can be purged.

Throws:

IfsException - if operation fails.

added

public void added(Object id)

Called when an instance is added to the cache.

Specified by:

added in interface LooselyBoundedCacheable

Parameters:

id - the id used for this entry in the cache

removed

public void removed(Object id)

Called when an instance is removed to the cache.

Specified by:

removed in interface LooselyBoundedCacheable

Parameters:

id - the id used for this entry in the cache