Index (Wren Security Commons Audit - Framework Core 23.0.0-SNAPSHOT Documentation)

A B C D E F G H I J K L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

accept(File, String) - Method in class org.forgerock.audit.retention.TimestampFilenameFilter: Matches the name of a file to the FilenameFilter.
AccessAuditEventBuilder<T extends AccessAuditEventBuilder<T>> - Class in org.forgerock.audit.events: Builder for audit access events.
AccessAuditEventBuilder() - Constructor for class org.forgerock.audit.events.AccessAuditEventBuilder
AccessAuditEventBuilder.ResponseStatus - Enum in org.forgerock.audit.events: The status of the access request.
accessEvent() - Static method in class org.forgerock.audit.events.AccessAuditEventBuilder: Starts to build an audit access event.
ACTION_PARAM_TARGET_HANDLER - Static variable in class org.forgerock.audit.AuditServiceProxy: Parameter that may be used when using an action, to provide the name of the handler to use as a target.
ActivityAuditEventBuilder<T extends ActivityAuditEventBuilder<T>> - Class in org.forgerock.audit.events: Builder for audit activity events.
ActivityAuditEventBuilder() - Constructor for class org.forgerock.audit.events.ActivityAuditEventBuilder: Creates the builder.
activityEvent() - Static method in class org.forgerock.audit.events.ActivityAuditEventBuilder: Starts to build an audit activity event.
adapt(Throwable) - Static method in class org.forgerock.audit.util.ResourceExceptionsUtil: Adapts a Throwable to a ResourceException.
addToBatch(String, JsonValue, StringBuilder) - Method in interface org.forgerock.audit.events.handlers.buffering.BatchConsumer: Adds an audit event to a batch payload.
after(String) - Method in class org.forgerock.audit.events.ActivityAuditEventBuilder: Records the new state of the modified object as a String.
after(JsonValue) - Method in class org.forgerock.audit.events.ActivityAuditEventBuilder: Records the new state of the modified object as JSON.
AFTER - Static variable in class org.forgerock.audit.events.ActivityAuditEventBuilder
afterRollingOver() - Method in interface org.forgerock.audit.events.handlers.writers.RotatableWriter.RolloverLifecycleHook: This method is called after the rotation and retention checks are done.
ANY_DISK_SPACE - Static variable in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRetention: The disk space value when disk space is unrestricted.
ARRAY_TYPE - Static variable in class org.forgerock.audit.events.AuditEventHelper: Json array value type.
AsynchronousTextWriter - Class in org.forgerock.audit.events.handlers.writers: A Text Writer which writes log records asynchronously to character-based stream.
AsynchronousTextWriter(String, boolean, TextWriter) - Constructor for class org.forgerock.audit.events.handlers.writers.AsynchronousTextWriter: Construct a new AsynchronousTextWriter wrapper.
Audit - Annotation Type in org.forgerock.audit: Denotes audit dependencies.
AuditEvent - Class in org.forgerock.audit.events: Represents an audit event.
AuditEventBuilder<T extends AuditEventBuilder<T>> - Class in org.forgerock.audit.events: Root builder for all audit events.
AuditEventBuilder() - Constructor for class org.forgerock.audit.events.AuditEventBuilder: Creates the builder.
AuditEventHandler - Interface in org.forgerock.audit.events.handlers: The interface for an AuditEventHandler.
AuditEventHandlerBase - Class in org.forgerock.audit.events.handlers: Abstract AuditEventHandler class.
AuditEventHandlerBase(String, EventTopicsMetaData, Set<String>, boolean) - Constructor for class org.forgerock.audit.events.handlers.AuditEventHandlerBase: Create a new AuditEventHandler instance.
AuditEventHandlerFactory - Interface in org.forgerock.audit.events.handlers: Factory interface for creating instances of AuditEventHandler.
AuditEventHelper - Class in org.forgerock.audit.events: Helper methods for AuditEvents.
AuditEventTopicState - Class in org.forgerock.audit.events.handlers: Stores the state of the details sent to AuditEventHandler.publishEvent(Context, String, JsonValue).
AuditEventTopicState(Context, String, JsonValue) - Constructor for class org.forgerock.audit.events.handlers.AuditEventTopicState: Creates a (topic,event) pair.
AuditException - Exception in org.forgerock.audit: Root class of all exceptions in the Commons Audit Framework.
AuditException(String) - Constructor for exception org.forgerock.audit.AuditException: Constructs an AuditException using the given message.
AuditException(String, Throwable) - Constructor for exception org.forgerock.audit.AuditException: Constructs an AuditException using the given message and parent cause.
AuditException(Throwable) - Constructor for exception org.forgerock.audit.AuditException: Constructs an AuditException using the given parent cause.
AuditingContext - Class in org.forgerock.audit: A Context used when auditing over the router.
AuditingContext(JsonValue, ClassLoader) - Constructor for class org.forgerock.audit.AuditingContext: Restore a serialized audit context.
AuditingContext(Context) - Constructor for class org.forgerock.audit.AuditingContext: Construct a new audit context with the provided parent.
AuditService - Interface in org.forgerock.audit: CREST RequestHandler responsible for storing and retrieving audit events.
AuditServiceBuilder - Class in org.forgerock.audit: Builder for AuditService.
AuditServiceConfiguration - Class in org.forgerock.audit: Configuration of the audit service.
AuditServiceConfiguration() - Constructor for class org.forgerock.audit.AuditServiceConfiguration: Empty constructor.
AuditServiceConfiguration(AuditServiceConfiguration) - Constructor for class org.forgerock.audit.AuditServiceConfiguration: Copy-constructor, in order to obtain a copy from an existing configuration.
AuditServiceProxy - Class in org.forgerock.audit: AuditService proxy that allows products to implement threadsafe hot-swappable configuration updates.
AuditServiceProxy(AuditService) - Constructor for class org.forgerock.audit.AuditServiceProxy: Create a new AuditServiceProxy.
AuthenticationAuditEventBuilder<T extends AuthenticationAuditEventBuilder<T>> - Class in org.forgerock.audit.events: Builder for audit authentication events.
AuthenticationAuditEventBuilder() - Constructor for class org.forgerock.audit.events.AuthenticationAuditEventBuilder
AuthenticationAuditEventBuilder.Status - Enum in org.forgerock.audit.events: Defines a fixed set of authentication statuses that can be logged.
authenticationEvent() - Static method in class org.forgerock.audit.events.AuthenticationAuditEventBuilder: Starts to build an audit authentication event.
autoFlush(boolean) - Method in interface org.forgerock.audit.events.handlers.buffering.BufferedBatchPublisher.Builder: Whether events to should be automatically flushed on shutdown.
averagePerEventPayloadSize(int) - Method in interface org.forgerock.audit.events.handlers.buffering.BufferedBatchPublisher.Builder: Sets the average event payload size, used to initialise string buffers.

B

BatchConsumer - Interface in org.forgerock.audit.events.handlers.buffering: Implementation is responsible for being able to build up a batch payload and to publish that payload.
BatchException - Exception in org.forgerock.audit.events.handlers.buffering: Indicates failure during a batch operation.
BatchException(String) - Constructor for exception org.forgerock.audit.events.handlers.buffering.BatchException: Constructs a new BatchException with given message.
BatchException(String, Throwable) - Constructor for exception org.forgerock.audit.events.handlers.buffering.BatchException: Constructs a new BatchException with given message and cause.
BatchPublisher - Interface in org.forgerock.audit.events.handlers.buffering: Implementations of BatchPublisher are able to consume multiple audit events and build batches out of them.
BatchPublisherFactory - Interface in org.forgerock.audit.events.handlers.buffering: Batch publisher factory provides new instances of BatchPublisher.
BatchPublisherFactoryImpl - Class in org.forgerock.audit.events.handlers.buffering: Basic batch publisher factory implementation.
BatchPublisherFactoryImpl() - Constructor for class org.forgerock.audit.events.handlers.buffering.BatchPublisherFactoryImpl
before(String) - Method in class org.forgerock.audit.events.ActivityAuditEventBuilder: Records the previous state of the modified object as a String.
before(JsonValue) - Method in class org.forgerock.audit.events.ActivityAuditEventBuilder: Records the previous state of the modified object as JSON.
BEFORE - Static variable in class org.forgerock.audit.events.ActivityAuditEventBuilder
beforeRollingOver() - Method in interface org.forgerock.audit.events.handlers.writers.RotatableWriter.RolloverLifecycleHook: This method is called before the rotation and retention checks are done.
BOOLEAN_TYPE - Static variable in class org.forgerock.audit.events.AuditEventHelper: Json boolean value type.
BufferedBatchPublisher - Class in org.forgerock.audit.events.handlers.buffering: Buffers audit events to a bounded queue, periodically flushing the queue to a provided BatchConsumer.
BufferedBatchPublisher.Builder - Interface in org.forgerock.audit.events.handlers.buffering: Builder used to construct a new BufferedBatchPublisher.
build() - Method in class org.forgerock.audit.AuditServiceBuilder: Creates a new AuditService instance.
build() - Method in class org.forgerock.audit.events.EventTopicsMetaDataBuilder: Create a new instance of EventTopicsMetaData.
build() - Method in interface org.forgerock.audit.events.handlers.buffering.BufferedBatchPublisher.Builder: Constructs a new BatchPublisher.
build() - Method in class org.forgerock.audit.filter.FilterChainBuilder: Builds the FilterChain.
buildRetentionPolicies() - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRetention: Builds RetentionPolicy instances from configuration options.
buildRotationPolicies() - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation: Builds RotationPolicy instances from configuration options.
buildTimeStampFileNamingPolicy(File) - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation: Builds a TimeStampFileNamingPolicy instance from configuration options.

C

capacity(int) - Method in interface org.forgerock.audit.events.handlers.buffering.BufferedBatchPublisher.Builder: Sets the maximum queue capacity.
CHANGED_FIELDS - Static variable in class org.forgerock.audit.events.ActivityAuditEventBuilder
changedFields(String...) - Method in class org.forgerock.audit.events.ActivityAuditEventBuilder: Sets the list of fields that were changed by this update.
client(String) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder: Sets the provided client ip for the event.
client(String, int) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder: Sets the provided client ip and port for the event.
CLIENT - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder: The client event payload field name.
clientFromContext(Context) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder: Sets client ip, port and host from ClientContext, if the provided Context contains a ClientContext.
close() - Method in class org.forgerock.audit.events.handlers.writers.MeteredStream: Close the output stream which closes the target output stream.
close() - Method in class org.forgerock.audit.events.handlers.writers.RotatableWriter: Closes the rotatable file.
close() - Method in class org.forgerock.audit.events.handlers.writers.TextWriterAdapter
close() - Method in interface org.forgerock.audit.rotation.RotatableObject: Closes the rotatable file.
CommonAuditBatchConfiguration - Class in org.forgerock.audit.batch: This class stores the common audit logging batch process configurations.
compare(File, File) - Method in class org.forgerock.audit.util.LastModifiedTimeFileComparator: Compare two files based on file modification time.
ConfigAuditEventBuilder<T extends ConfigAuditEventBuilder<T>> - Class in org.forgerock.audit.events: Builder for audit config events.
ConfigAuditEventBuilder() - Constructor for class org.forgerock.audit.events.ConfigAuditEventBuilder: Creates the builder.
configEvent() - Static method in class org.forgerock.audit.events.ConfigAuditEventBuilder: Starts to build an audit config event.
containsTopic(String) - Method in class org.forgerock.audit.events.EventTopicsMetaData: Returns true if this object has meta-data for the specified topic.
context(Map<String, Object>) - Method in class org.forgerock.audit.events.AuthenticationAuditEventBuilder: Sets the context used in the authentication event.
CONTEXT - Static variable in class org.forgerock.audit.events.AuthenticationAuditEventBuilder: Defines the context key.
CONTINUE - Enum constant in enum org.forgerock.audit.events.AuthenticationAuditEventBuilder.Status: Authentication operation has not yet completed.
COOKIES - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder: The cookies event payload field name.
coreTopicSchemas() - Static method in class org.forgerock.audit.events.EventTopicsMetaDataBuilder: Create a new instance of EventTopicsMetaDataBuilder that will populate EventTopicsMetaData objects its creates with the schema meta-data for core topics.
create(String, Class<T>, EventHandlerConfiguration, EventTopicsMetaData) - Method in interface org.forgerock.audit.events.handlers.AuditEventHandlerFactory: Create a new AuditEventHandler instance.
create(String, Class<T>, EventHandlerConfiguration, EventTopicsMetaData) - Method in class org.forgerock.audit.events.handlers.DependencyProviderAuditEventHandlerFactory
CREST_PROTOCOL - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder: The protocol field CREST value.
currentDateTime() - Method in class org.forgerock.audit.util.DateUtil: Get current time.

D

DateUtil - Class in org.forgerock.audit.util: Manages timestamp strings in ISO8601 format.
DEFAULT_ROTATION_FILE_SUFFIX - Static variable in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation: The default file rotation suffix format.
DefaultKeyStoreHandlerProvider - Class in org.forgerock.audit.providers: Default implementation of KeyStoreHandlerProvider.
DefaultKeyStoreHandlerProvider() - Constructor for class org.forgerock.audit.providers.DefaultKeyStoreHandlerProvider: Creates a initially empty provider.
DefaultKeyStoreHandlerProvider(Map<String, KeyStoreHandler>) - Constructor for class org.forgerock.audit.providers.DefaultKeyStoreHandlerProvider: Creates a provider with some KeyStoreHandler instances.
DefaultLocalHostNameProvider - Class in org.forgerock.audit.providers: Default implementation of LocalHostNameProvider using InetAddress to lookup host name of local host.
DefaultLocalHostNameProvider() - Constructor for class org.forgerock.audit.providers.DefaultLocalHostNameProvider
DefaultSecureStorageProvider - Class in org.forgerock.audit.providers: Default implementation of SecureStorageProvider.
DefaultSecureStorageProvider() - Constructor for class org.forgerock.audit.providers.DefaultSecureStorageProvider: Creates a initially empty provider.
DefaultSecureStorageProvider(Map<String, SecureStorage>) - Constructor for class org.forgerock.audit.providers.DefaultSecureStorageProvider: Creates a provider with some storages instances.
deleteFiles(FileNamingPolicy) - Method in class org.forgerock.audit.retention.DiskSpaceUsedRetentionPolicy
deleteFiles(FileNamingPolicy) - Method in class org.forgerock.audit.retention.FreeDiskSpaceRetentionPolicy
deleteFiles(FileNamingPolicy) - Method in interface org.forgerock.audit.retention.RetentionPolicy: Returns all files that should be deleted according to the policy.
deleteFiles(FileNamingPolicy) - Method in class org.forgerock.audit.retention.SizeBasedRetentionPolicy
denormalizeJson(JsonValue) - Static method in class org.forgerock.audit.util.ElasticsearchUtil: De-normalizes JSON that was previously normalized by ElasticsearchUtil.normalizeJson(JsonValue).
DependencyProvider - Interface in org.forgerock.audit: An interface for a simple dependency provider.
DependencyProviderAuditEventHandlerFactory - Class in org.forgerock.audit.events.handlers: AuditEventFactory capable of performing construction injection by resolving dependencies using a DependencyProvider.
DependencyProviderAuditEventHandlerFactory(DependencyProvider) - Constructor for class org.forgerock.audit.events.handlers.DependencyProviderAuditEventHandlerFactory: Construct a new instance.
DependencyProviderBase - Class in org.forgerock.audit: Base DependencyProvider that has provides no dependencies.
DependencyProviderBase() - Constructor for class org.forgerock.audit.DependencyProviderBase
DETAIL - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder: The detail event payload field name.
DiskSpaceUsedRetentionPolicy - Class in org.forgerock.audit.retention: A RetentionPolicy that will retain/delete log files based off the total disk space used.
DiskSpaceUsedRetentionPolicy(long) - Constructor for class org.forgerock.audit.retention.DiskSpaceUsedRetentionPolicy: Constructs a DiskSpaceUsedRetentionPolicy with a given maximum of disk space to use in bytes.
doFilter(String, JsonValue) - Method in interface org.forgerock.audit.filter.Filter: Runs a filter on the given audit event.
doFilter(String, JsonValue) - Method in class org.forgerock.audit.filter.FilterChainBuilder.FilterChain: Runs the filters in the filter chain.
dotNotationToJsonPointer(String) - Static method in class org.forgerock.audit.events.AuditEventHelper: Converts dotted-path field identifier to JsonPointer form.

E

ELAPSED_TIME - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder: The elapsed time event payload field name.
ELAPSED_TIME_UNITS - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder: The elapsed time unit event payload field name.
ElasticsearchUtil - Class in org.forgerock.audit.util: Utilities for working with Elasticsearch.
entries(List<?>) - Method in class org.forgerock.audit.events.AuthenticationAuditEventBuilder: Sets the list of auth modules used in the authentication event and their state.
ENTRIES - Static variable in class org.forgerock.audit.events.AuthenticationAuditEventBuilder: Defines the entries key.
ENTRY_CURRENT_KEY - Static variable in class org.forgerock.audit.secure.KeyStoreSecureStorage: The current key used to calculate the HEADER_HMAC.
ENTRY_CURRENT_SIGNATURE - Static variable in class org.forgerock.audit.secure.KeyStoreSecureStorage: The last signature inserted into the file.
ENTRY_INITIAL_KEY - Static variable in class org.forgerock.audit.secure.KeyStoreSecureStorage: The initial key used to calculate the HEADER_HMAC.
ENTRY_SIGNATURE - Static variable in class org.forgerock.audit.secure.KeyStoreSecureStorage: The alias to lookup the private/public signature key into the keystore.
equals(Object) - Method in class org.forgerock.audit.events.handlers.AuditEventTopicState
EVENT_NAME - Static variable in class org.forgerock.audit.events.AuditEventBuilder: Event name event payload field name.
EventHandlerConfiguration - Class in org.forgerock.audit.events.handlers: Base class for audit event handler configuration.
EventHandlerConfiguration() - Constructor for class org.forgerock.audit.events.handlers.EventHandlerConfiguration
eventName(String) - Method in class org.forgerock.audit.events.AuditEventBuilder: Sets the provided name for the event.
eventTopicsMetaData - Variable in class org.forgerock.audit.events.handlers.AuditEventHandlerBase: The event topic meta data for the handler.
EventTopicsMetaData - Class in org.forgerock.audit.events: Encapsulates meta-data for event topics.
EventTopicsMetaData(Map<String, JsonValue>) - Constructor for class org.forgerock.audit.events.EventTopicsMetaData: Create a new EventTopicsMetaData.
EventTopicsMetaDataBuilder - Class in org.forgerock.audit.events: Builder for EventTopicsMetaData.
expand(Map<String, Object>) - Static method in class org.forgerock.audit.util.JsonValueUtils: Expands a Json Object Map, where the keys of the map are the JsonPointers and the values are the value the JsonPointer resolves to.
extractValueAsString(JsonValue, String) - Static method in class org.forgerock.audit.util.JsonValueUtils: Extracts String representation of field identified by fieldName from json object.
extractValueAsString(JsonValue, JsonPointer) - Static method in class org.forgerock.audit.util.JsonValueUtils: Extracts String representation of field identified by pointer from json object.

F

FAILED - Enum constant in enum org.forgerock.audit.events.AccessAuditEventBuilder.ResponseStatus: The access request was not successfully completed.
FAILED - Enum constant in enum org.forgerock.audit.events.AuthenticationAuditEventBuilder.Status: Authentication operation has completed unsuccessfully.
FIELD - Enum constant in enum org.forgerock.audit.filter.Filters.FilterNames: Field event filter type.
FIELD_NAMES_FIELD - Static variable in class org.forgerock.audit.util.ElasticsearchUtil: JSON field-name of normalized field-names.
FileBasedEventHandlerConfiguration - Class in org.forgerock.audit.events.handlers: Configures time based or size based log file rotation.
FileBasedEventHandlerConfiguration() - Constructor for class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration
FileBasedEventHandlerConfiguration.FileRetention - Class in org.forgerock.audit.events.handlers: Groups the file retention config parameters.
FileBasedEventHandlerConfiguration.FileRotation - Class in org.forgerock.audit.events.handlers: Groups the file rotation config parameters.
FileNamingPolicy - Interface in org.forgerock.audit.retention: An interface to declare the names of audit log files.
FileRetention() - Constructor for class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRetention
FileRotation() - Constructor for class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation
filter(Set<String>) - Method in class org.forgerock.audit.events.EventTopicsMetaData: Returns a new instance of EventTopicsMetaData containing only the meta-data for topics held by this object that are named within provided topics parameter.
Filter - Interface in org.forgerock.audit.filter: Interface that represents and audit filter.
FilterChainBuilder - Class in org.forgerock.audit.filter: A builder that builds a filter chain.
FilterChainBuilder() - Constructor for class org.forgerock.audit.filter.FilterChainBuilder
FilterChainBuilder.FilterChain - Class in org.forgerock.audit.filter: Chains together multiple filters and runs them all.
FilterPolicy - Class in org.forgerock.audit.filter: Represents a FilterPolicy which contains the includeIf and excludeIf values for the filter.
FilterPolicy() - Constructor for class org.forgerock.audit.filter.FilterPolicy
Filters - Class in org.forgerock.audit.filter: Utility methods for creating audit event filters.
Filters.FilterNames - Enum in org.forgerock.audit.filter: The filter types.
FixedTimeRotationPolicy - Class in org.forgerock.audit.rotation: Rotates audit files at fixed times throughout the day.
FixedTimeRotationPolicy(List<Duration>) - Constructor for class org.forgerock.audit.rotation.FixedTimeRotationPolicy: Constructs a FixedTimeRotationPolicy given a list of milliseconds after midnight to rotateIfNeeded the files.
flatten(JsonValue) - Static method in class org.forgerock.audit.util.JsonValueUtils: Flattens a JsonValue to a Map, where the keys of the Map are JsonPointers and the values are the value the JsonPointers resolve to.
flush() - Method in class org.forgerock.audit.events.handlers.writers.AsynchronousTextWriter
flush() - Method in class org.forgerock.audit.events.handlers.writers.MeteredStream: Flush the output stream which flushes the target output stream.
flush() - Method in class org.forgerock.audit.events.handlers.writers.RotatableWriter
flush() - Method in interface org.forgerock.audit.events.handlers.writers.TextWriter: Flushes any buffered contents of the output stream.
flush() - Method in class org.forgerock.audit.events.handlers.writers.TextWriter.Stream
flush() - Method in class org.forgerock.audit.events.handlers.writers.TextWriterAdapter
forceRotation() - Method in class org.forgerock.audit.events.handlers.writers.RotatableWriter: Forces a rotation of the writer.
forContext(Context) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder: Sets common fields from services contexts.
forHttpRequest(Context, Request) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder: Sets common fields from CREST contexts and request.
formatDateTime(long) - Method in class org.forgerock.audit.util.DateUtil: Formats a given timestamp into a ISO8601 timestamp.
formatDateTime(Date) - Method in class org.forgerock.audit.util.DateUtil: Formats a given date into a timestamp.
formatDateTime(DateTime) - Method in class org.forgerock.audit.util.DateUtil: Formats a given DateTime into a timestamp.
FreeDiskSpaceRetentionPolicy - Class in org.forgerock.audit.retention: A RetentionPolicy that will retain/delete log files given a minimum amount of disk space the file system must contain.
FreeDiskSpaceRetentionPolicy(long) - Constructor for class org.forgerock.audit.retention.FreeDiskSpaceRetentionPolicy: Constructs a FreeDiskSpaceRetentionPolicy given a minimum amount of disk space the file system must contain.

G

generateJsonPointers(JsonValue) - Static method in class org.forgerock.audit.util.JsonSchemaUtils: Generates the Set of JsonPointers in a given JsonSchema.
getAuditEventProperties(JsonValue) - Static method in class org.forgerock.audit.events.AuditEventHelper: Gets the Audit Event schema properties.
getAuditEventSchema(JsonValue) - Static method in class org.forgerock.audit.events.AuditEventHelper: Gets the Audit Event schema.
getAvailableAuditEventHandlers() - Method in class org.forgerock.audit.AuditServiceConfiguration: Returns a list of class names of available audit event handlers.
getBytesWritten() - Method in class org.forgerock.audit.events.handlers.writers.AsynchronousTextWriter: Retrieves the number of bytes written by this writer.
getBytesWritten() - Method in class org.forgerock.audit.events.handlers.writers.MeteredStream: Returns the number of bytes written in this stream.
getBytesWritten() - Method in class org.forgerock.audit.events.handlers.writers.RotatableWriter: Retrieves the number of bytes written by this writer.
getBytesWritten() - Method in interface org.forgerock.audit.events.handlers.writers.TextWriter: Retrieves the number of bytes written by this writer.
getBytesWritten() - Method in class org.forgerock.audit.events.handlers.writers.TextWriter.Stream
getBytesWritten() - Method in class org.forgerock.audit.events.handlers.writers.TextWriterAdapter
getBytesWritten() - Method in interface org.forgerock.audit.rotation.RotatableObject: Retrieves the number of bytes written to the file.
getConfig() - Method in interface org.forgerock.audit.AuditService: Gets the AuditService configuration.
getConfig() - Method in class org.forgerock.audit.AuditServiceProxy
getConfiguredAuditEventHandlers(JsonValue) - Static method in class org.forgerock.audit.events.AuditEventHelper: Gets the AuditEventHandlers that the audit event is configure to log to.
getContext() - Method in class org.forgerock.audit.events.handlers.AuditEventTopicState: Returns the context that triggered the event.
getDailyRotationTimes() - Method in class org.forgerock.audit.rotation.FixedTimeRotationPolicy: Get the list of times since midnight that rotation will occur at.
getDateDifferenceInDays(Date, Date, Boolean) - Static method in class org.forgerock.audit.util.DateUtil: return the number of days between the two dates.
getDateUtil() - Static method in class org.forgerock.audit.util.DateUtil: Fetches a DateUtil that is set in the default timezone.
getDateUtil(String) - Static method in class org.forgerock.audit.util.DateUtil: Returns a DateUtil using a specified timezone.
getDateUtil(DateTimeZone) - Static method in class org.forgerock.audit.util.DateUtil: Creates a DateUtil using a specified timezone.
getDependency(Class<T>) - Method in interface org.forgerock.audit.DependencyProvider: Retrieve the dependency of type T.
getDependency(Class<T>) - Method in class org.forgerock.audit.DependencyProviderBase: Retrieve the dependency of type T.
getEvent() - Method in class org.forgerock.audit.events.handlers.AuditEventTopicState: Returns the event content.
getExcludeIf() - Method in class org.forgerock.audit.filter.FilterPolicy: Gets the excludeIf list.
getFileRetention() - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration: Gets the FileBasedEventHandlerConfiguration.FileRetention.
getFileRotation() - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration: Gets the FileBasedEventHandlerConfiguration.FileRotation.
getFilterPolicies() - Method in class org.forgerock.audit.AuditServiceConfiguration: Get the filter policy mappings.
getHandledTopics() - Method in interface org.forgerock.audit.events.handlers.AuditEventHandler: Gets the names of all audit event topics this handler is registered against.
getHandledTopics() - Method in class org.forgerock.audit.events.handlers.AuditEventHandlerBase
getHandlerForQueries() - Method in class org.forgerock.audit.AuditServiceConfiguration: Returns the name of the handler to use for querying the audit events.
getIncludeIf() - Method in class org.forgerock.audit.filter.FilterPolicy: Gets the includeIf list.
getInitialFile() - Method in class org.forgerock.audit.rotation.RotationContext: Get the initial file.
getInitialName() - Method in interface org.forgerock.audit.retention.FileNamingPolicy: Initializes the policy and returns the current name to use.
getInitialName() - Method in class org.forgerock.audit.retention.TimeStampFileNamingPolicy: Gets the initial file.
getKeystoreHandler(String) - Method in class org.forgerock.audit.providers.DefaultKeyStoreHandlerProvider
getKeystoreHandler(String) - Method in interface org.forgerock.audit.providers.KeyStoreHandlerProvider: Returns the keystore handler corresponding to the given name.
getKnownTopics() - Method in interface org.forgerock.audit.AuditService: Returns the set of event topics (schemas) that the AuditService understands.
getKnownTopics() - Method in class org.forgerock.audit.AuditServiceProxy
getLastRotationTime() - Method in class org.forgerock.audit.events.handlers.writers.RotatableWriter: Retrieves the last time the file was rotated.
getLastRotationTime() - Method in interface org.forgerock.audit.rotation.RotatableObject: Retrieves the last time the file was rotated.
getLocalHostName() - Method in class org.forgerock.audit.providers.DefaultLocalHostNameProvider
getLocalHostName() - Method in interface org.forgerock.audit.providers.LocalHostNameProvider: Establish the local hostname of the current server.
getLocation() - Method in class org.forgerock.audit.secure.JcaKeyStoreHandler
getLocation() - Method in interface org.forgerock.audit.secure.KeyStoreHandler: Returns the path to the keystore.
getLocation() - Method in class org.forgerock.audit.secure.KeyStoreHandlerDecorator
getMaxDiskSpaceToUse() - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRetention: Gets the maximum disk space the audit logs can occupy.
getMaxFileSize() - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation: Gets the maximum file size of an audit log file in bytes.
getMaxFileSizeInBytes() - Method in class org.forgerock.audit.rotation.SizeBasedRotationPolicy: Gets the maximum size (in bytes) a file may grow to before being rotated.
getMaxNumberOfHistoryFiles() - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRetention: Gets the maximum number of historical log files to retain. -1 disables pruning of old history files.
getMinFreeSpaceRequired() - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRetention: Gets the minimum free space the system must contain.
getName() - Method in interface org.forgerock.audit.events.handlers.AuditEventHandler: Gets the name of this audit event handler.
getName() - Method in class org.forgerock.audit.events.handlers.AuditEventHandlerBase
getName() - Method in class org.forgerock.audit.events.handlers.EventHandlerConfiguration: Returns the name of this handler.
getNextFile() - Method in class org.forgerock.audit.rotation.RotationContext: Get the next file.
getNextName() - Method in interface org.forgerock.audit.retention.FileNamingPolicy: Gets the next name to use.
getNextName() - Method in class org.forgerock.audit.retention.TimeStampFileNamingPolicy: Gets the next name for this FileNamingPolicy.
getPassword() - Method in class org.forgerock.audit.secure.JcaKeyStoreHandler
getPassword() - Method in interface org.forgerock.audit.secure.KeyStoreHandler: Returns the password.
getPassword() - Method in class org.forgerock.audit.secure.KeyStoreHandlerDecorator
getPassword() - Method in class org.forgerock.audit.secure.KeyStoreSecureStorage
getPassword() - Method in interface org.forgerock.audit.secure.SecureStorage: Returns the password used to access the storage.
getProductName() - Method in interface org.forgerock.audit.providers.ProductInfoProvider: Returns the name of the application hosting the AuditService.
getPropertyType(JsonValue, JsonPointer) - Static method in class org.forgerock.audit.events.AuditEventHelper: Gets a AuditEvent property type.
getRegisteredHandler(String) - Method in interface org.forgerock.audit.AuditService: Returns the registered handler corresponding to provided name.
getRegisteredHandler(String) - Method in class org.forgerock.audit.AuditServiceProxy
getRegisteredHandlers() - Method in interface org.forgerock.audit.AuditService: Returns the registered handlers.
getRegisteredHandlers() - Method in class org.forgerock.audit.AuditServiceProxy
getRotationFilePrefix() - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation: Gets the prefix to add to a log file on rotation.
getRotationFileSuffix() - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation: Gets the suffix to add to a log file on rotation.
getRotationInterval() - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation: Gets the interval to trigger a file rotation.
getRotationInterval() - Method in class org.forgerock.audit.rotation.TimeLimitRotationPolicy: Gets the rotation duration interval.
getRotationRetentionCheckInterval() - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration: Gets the interval to check time-based file rotation policies.
getRotationTimes() - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation: Gets a list of times at which file rotation should be triggered; times should be provided as Strings that can be parsed by Duration that each specify an offset from midnight.
getSchema(String) - Method in class org.forgerock.audit.events.EventTopicsMetaData: Returns the JSON schema for the requested topic if this object has meta-data for that topic.
getSecureStorage(String) - Method in class org.forgerock.audit.providers.DefaultSecureStorageProvider
getSecureStorage(String) - Method in interface org.forgerock.audit.providers.SecureStorageProvider: Returns the secure storage corresponding to the given name.
getStore() - Method in class org.forgerock.audit.secure.JcaKeyStoreHandler
getStore() - Method in interface org.forgerock.audit.secure.KeyStoreHandler: Get the keystore.
getStore() - Method in class org.forgerock.audit.secure.KeyStoreHandlerDecorator
getTopic() - Method in class org.forgerock.audit.events.handlers.AuditEventTopicState: Returns the topic of the event.
getTopics() - Method in class org.forgerock.audit.events.EventTopicsMetaData: Returns the names of the set of topics for which this object has meta-data.
getTopics() - Method in class org.forgerock.audit.events.handlers.EventHandlerConfiguration: Returns the names of the topics accepted by this handler.
getType() - Method in class org.forgerock.audit.secure.JcaKeyStoreHandler
getType() - Method in interface org.forgerock.audit.secure.KeyStoreHandler: Returns the type of the keystore.
getType() - Method in class org.forgerock.audit.secure.KeyStoreHandlerDecorator
getValue() - Method in class org.forgerock.audit.events.AuditEvent: Returns the Json value of this event.
getWrappedWriter() - Method in class org.forgerock.audit.events.handlers.writers.AsynchronousTextWriter: Retrieves the wrapped writer.
getWriter() - Method in class org.forgerock.audit.rotation.RotationContext: Get the writer.

H

handleAction(Context, String, ActionRequest) - Method in interface org.forgerock.audit.events.handlers.AuditEventHandler: Performs an action.
handleAction(Context, String, ActionRequest) - Method in class org.forgerock.audit.events.handlers.AuditEventHandlerBase
handleAction(Context, ActionRequest) - Method in interface org.forgerock.audit.AuditService: Audit service may support actions on the service itself or on handlers.
handleAction(Context, ActionRequest) - Method in class org.forgerock.audit.AuditServiceProxy
handleCreate(Context, CreateRequest) - Method in interface org.forgerock.audit.AuditService: Propagates the audit event to the AuditEventHandler objects that have been registered for the audit event topic.
handleCreate(Context, CreateRequest) - Method in class org.forgerock.audit.AuditServiceProxy
handleDelete(Context, DeleteRequest) - Method in interface org.forgerock.audit.AuditService: Audit service does not support changing audit entries.
handleDelete(Context, DeleteRequest) - Method in class org.forgerock.audit.AuditServiceProxy
handlePatch(Context, PatchRequest) - Method in interface org.forgerock.audit.AuditService: Audit service does not support changing audit entries.
handlePatch(Context, PatchRequest) - Method in class org.forgerock.audit.AuditServiceProxy
handleQuery(Context, QueryRequest, QueryResourceHandler) - Method in interface org.forgerock.audit.AuditService: Performs the query on the specified object and returns the associated results.
handleQuery(Context, QueryRequest, QueryResourceHandler) - Method in class org.forgerock.audit.AuditServiceProxy
handleRead(Context, ReadRequest) - Method in interface org.forgerock.audit.AuditService: Gets an object from the audit logs by identifier.
handleRead(Context, ReadRequest) - Method in class org.forgerock.audit.AuditServiceProxy
handleUpdate(Context, UpdateRequest) - Method in interface org.forgerock.audit.AuditService: Audit service does not support changing audit entries.
handleUpdate(Context, UpdateRequest) - Method in class org.forgerock.audit.AuditServiceProxy
hashCode() - Method in class org.forgerock.audit.events.handlers.AuditEventTopicState
HEADERS - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder: The headers event payload field name.
HMAC_ALGORITHM - Static variable in class org.forgerock.audit.secure.KeyStoreSecureStorage: The HMAC algorithm to use.
HTTP - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder: The http event payload field name.
httpFromContext(Context) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder: Sets HTTP method, path, queryString and headers from HttpContext, if the provided Context contains a HttpContext.
httpRequest(boolean, String, String, Map<String, List<String>>, Map<String, List<String>>) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder: Sets the provided HTTP request fields for the event.
httpRequest(boolean, String, String, Map<String, List<String>>, Map<String, List<String>>, Map<String, String>) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder: Sets the provided HTTP request fields for the event.
httpResponse(Map<String, List<String>>) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder: Sets the provided HTTP fields for the event.

I

IP - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder: The IP event payload field name.
isAuditing(String) - Method in interface org.forgerock.audit.AuditService: Returns whether or not events of the specified topic will be handled.
isAuditing(String) - Method in class org.forgerock.audit.AuditServiceProxy
isEnabled() - Method in interface org.forgerock.audit.events.handlers.AuditEventHandler: Checks if the audit event handler is enabled.
isEnabled() - Method in class org.forgerock.audit.events.handlers.AuditEventHandlerBase
isEnabled() - Method in class org.forgerock.audit.events.handlers.EventHandlerConfiguration: Checks if the audit event handler is enabled.
isPropertyRequired(JsonValue, JsonPointer) - Static method in class org.forgerock.audit.events.AuditEventHelper: Gets whether a AuditEvent property is required.
isReverseDnsLookupEnabled() - Method in class org.forgerock.audit.events.AccessAuditEventBuilder: Whether the client.host should be looked up from client.ip.
isRotationEnabled() - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation: Gets log rotation enabled state.
isRunning() - Method in interface org.forgerock.audit.AuditService: Returns true if this object is running.
isRunning() - Method in class org.forgerock.audit.AuditServiceProxy
isUsableForQueries() - Method in class org.forgerock.audit.events.handlers.EventHandlerConfiguration: States if an AuditEventHandler can be used for queries.

J

JcaKeyStoreHandler - Class in org.forgerock.audit.secure: Default implementation of a Keystore handler.
JcaKeyStoreHandler(String, String, String) - Constructor for class org.forgerock.audit.secure.JcaKeyStoreHandler: Creates a new keystore handler.
JCEKS_KEYSTORE_TYPE - Static variable in class org.forgerock.audit.secure.KeyStoreSecureStorage: The name of the Java Cryptography Extension KeyStore (JCEKS) type.
jsonPointerToDotNotation(String) - Static method in class org.forgerock.audit.events.AuditEventHelper: Converts JsonPointer field identifier to dotted-path form.
JsonSchemaUtils - Class in org.forgerock.audit.util: Contains Utility methods for dealing with JsonSchema data.
jsonValue - Variable in class org.forgerock.audit.events.AuditEventBuilder: Represents the event as a JSON value.
JSONVALUE_FILTER_VISITOR - Static variable in class org.forgerock.audit.util.JsonValueUtils: A generic JsonValue Query Filter Visitor.
JsonValueUtils - Class in org.forgerock.audit.util: Contains some JsonValue Utility methods.

K

KeyStoreHandler - Interface in org.forgerock.audit.secure: Handles the access to a KeyStore.
KeyStoreHandlerDecorator - Class in org.forgerock.audit.secure: Decorate a KeyStoreHandler in order to add some commons utility methods to read or write keystore's entries.
KeyStoreHandlerDecorator(KeyStoreHandler) - Constructor for class org.forgerock.audit.secure.KeyStoreHandlerDecorator: Constructs a new KeyStoreHandlerDecorator.
KeyStoreHandlerProvider - Interface in org.forgerock.audit.providers: Strategy for obtaining a keystore handler.
KeyStoreSecureStorage - Class in org.forgerock.audit.secure: Implementation of a secure storage using a keystore.
KeyStoreSecureStorage(KeyStoreHandler, PrivateKey) - Constructor for class org.forgerock.audit.secure.KeyStoreSecureStorage: Creates the storage with a keystore handler, initialized to verify only.
KeyStoreSecureStorage(KeyStoreHandler, PublicKey) - Constructor for class org.forgerock.audit.secure.KeyStoreSecureStorage: Creates the storage with a keystore handler, initialized to verify only.
KeyStoreSecureStorage(KeyStoreHandler, PublicKey, PrivateKey) - Constructor for class org.forgerock.audit.secure.KeyStoreSecureStorage: Creates the storage with a keystore handler, initialized to verify only.

L

LastModifiedTimeFileComparator - Class in org.forgerock.audit.util: Compare two files based on file modification time.
LastModifiedTimeFileComparator() - Constructor for class org.forgerock.audit.util.LastModifiedTimeFileComparator
listFiles() - Method in interface org.forgerock.audit.retention.FileNamingPolicy: Lists all the archived files.
listFiles() - Method in class org.forgerock.audit.retention.TimeStampFileNamingPolicy: List the files in the initial file directory that match the prefix, name and suffix format.
LocalHostNameProvider - Interface in org.forgerock.audit.providers: Strategy for obtaining the server's local hostname.

M

maxBatchEvents(int) - Method in interface org.forgerock.audit.events.handlers.buffering.BufferedBatchPublisher.Builder: Sets the maximum number of events in a given batch.
MeteredStream - Class in org.forgerock.audit.events.handlers.writers: A metered stream is a subclass of OutputStream that (a) forwards all its output to a target stream (b) keeps track of how many bytes have been written.
MeteredStream(OutputStream, long) - Constructor for class org.forgerock.audit.events.handlers.writers.MeteredStream: Create the stream wrapped around the specified output stream.
METHOD - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder: The method event payload field name.

N

newAuditService() - Static method in class org.forgerock.audit.AuditServiceBuilder: Factory method for new instances of this builder.
newBufferedPublisher(BatchConsumer) - Method in interface org.forgerock.audit.events.handlers.buffering.BatchPublisherFactory: Provides a new instance of a buffered batch publisher.
newBufferedPublisher(BatchConsumer) - Method in class org.forgerock.audit.events.handlers.buffering.BatchPublisherFactoryImpl
newBuilder(BatchConsumer) - Static method in class org.forgerock.audit.events.handlers.buffering.BufferedBatchPublisher: Provides a new builder.
newFilter(String, List<String>, FilterPolicy) - Static method in class org.forgerock.audit.filter.Filters: Create a new filter for of the type specified.
newValueOrFieldFilter(List<String>, FilterPolicy) - Static method in class org.forgerock.audit.filter.Filters: Create a new filter for values and fields.
NO_MAX_FILE_SIZE - Static variable in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation: The file size value to use when no maximum is set.
NOOP_ROLLOVER_LIFECYCLE_HOOK - Static variable in class org.forgerock.audit.events.handlers.writers.RotatableWriter: A RotationRetentionCheckHook that does nothing.
NoOpAuditEventHandler - Class in org.forgerock.audit.events.handlers: An event handler that does nothing.
NoOpAuditEventHandler() - Constructor for class org.forgerock.audit.events.handlers.NoOpAuditEventHandler: Default constructor.
NoOpRotatationHooks() - Constructor for class org.forgerock.audit.rotation.RotationHooks.NoOpRotatationHooks
NORMALIZED_FIELD - Static variable in class org.forgerock.audit.util.ElasticsearchUtil: JSON field-name of metadata to assist in de-normalization.
normalizeJson(JsonValue) - Static method in class org.forgerock.audit.util.ElasticsearchUtil: Normalizes JSON to conform to Elasticsearch data-format restrictions.
normalizeJsonPointer(JsonPointer) - Static method in class org.forgerock.audit.util.ElasticsearchUtil: Replaces periods in JsonPointer keys with underscore.
notSupported(Request) - Static method in class org.forgerock.audit.util.ResourceExceptionsUtil: Creates a NotSupportedException.
notSupportedOnCollection(Request) - Static method in class org.forgerock.audit.util.ResourceExceptionsUtil: Creates a NotSupportedException.
notSupportedOnInstance(Request) - Static method in class org.forgerock.audit.util.ResourceExceptionsUtil: Creates a NotSupportedException.
now() - Method in class org.forgerock.audit.util.DateUtil: Generate a formatted timestamp for the current time.
NullRetentionHooks() - Constructor for class org.forgerock.audit.retention.RetentionHooks.NullRetentionHooks
NUMBER_TYPE - Static variable in class org.forgerock.audit.events.AuditEventHelper: Json number value type.

O

OBJECT_ID - Static variable in class org.forgerock.audit.events.ActivityAuditEventBuilder
OBJECT_MAPPER - Static variable in class org.forgerock.audit.util.ElasticsearchUtil: Jackson ObjectMapper for working with JSON.
OBJECT_TYPE - Static variable in class org.forgerock.audit.events.AuditEventHelper: Json Object value type.
objectId(String) - Method in class org.forgerock.audit.events.ActivityAuditEventBuilder: Sets the provided objectId for the event.
objectIdFromCrestRequest(Request) - Method in class org.forgerock.audit.events.ActivityAuditEventBuilder: Sets objectId method from Request.
obtainReadLock() - Method in class org.forgerock.audit.AuditServiceProxy: Obtain the read lock or block until it becomes available.
obtainWriteLock() - Method in class org.forgerock.audit.AuditServiceProxy: Obtain the write lock or block until it becomes available.
offer(String, JsonValue) - Method in interface org.forgerock.audit.events.handlers.buffering.BatchPublisher: Offers up an event to be added to a batch.
offer(String, JsonValue) - Method in class org.forgerock.audit.events.handlers.buffering.BufferedBatchPublisher: Inserts the specified element at the tail of this queue if it is possible to do so immediately without exceeding the queue's capacity, returning true upon success and false if this queue is full.
operation(String) - Method in class org.forgerock.audit.events.ActivityAuditEventBuilder: Sets the provided operation for the event.
OPERATION - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder: The operation event payload field name.
OPERATION - Static variable in class org.forgerock.audit.events.ActivityAuditEventBuilder
operationFromCrestRequest(Request) - Method in class org.forgerock.audit.events.ActivityAuditEventBuilder: Sets operation method from Request.
org.forgerock.audit - package org.forgerock.audit: Package contains the AuditService.
org.forgerock.audit.batch - package org.forgerock.audit.batch: Package contains common audit batch configuration files.
org.forgerock.audit.events - package org.forgerock.audit.events: Package contains audit events.
org.forgerock.audit.events.handlers - package org.forgerock.audit.events.handlers: This package contains the default AuditEventHandlers.
org.forgerock.audit.events.handlers.buffering - package org.forgerock.audit.events.handlers.buffering: This package contains the batch publisher and its various implementations.
org.forgerock.audit.events.handlers.writers - package org.forgerock.audit.events.handlers.writers: Utility classes for writing streams of characters.
org.forgerock.audit.filter - package org.forgerock.audit.filter: Contains the classes for filtering audit events.
org.forgerock.audit.providers - package org.forgerock.audit.providers: Dependencies that can be made available to the AuditService via a DependencyProvider.
org.forgerock.audit.retention - package org.forgerock.audit.retention: File retention classes.
org.forgerock.audit.rotation - package org.forgerock.audit.rotation: Audit log file rotation classes.
org.forgerock.audit.secure - package org.forgerock.audit.secure: Classes for handling secure audit logging.
org.forgerock.audit.util - package org.forgerock.audit.util: This package contains utility classes used in the audit service.

P

parseIfDate(String) - Method in class org.forgerock.audit.util.DateUtil: Parses an ISO8601 compliant timestamp into a DateTime object.
parseTimestamp(String) - Method in class org.forgerock.audit.util.DateUtil: Parses an ISO8601 compliant timestamp into a DateTime object.
PATH - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder: The path event payload field name.
POLLING_INTERVAL - Static variable in class org.forgerock.audit.batch.CommonAuditBatchConfiguration: Common Audit Batch log records queue polling timeout as Duration.
POLLING_TIMEOUT - Static variable in class org.forgerock.audit.batch.CommonAuditBatchConfiguration: Common Audit Batch log records queue polling timeout.
POLLING_TIMEOUT_UNIT - Static variable in class org.forgerock.audit.batch.CommonAuditBatchConfiguration: Common Audit Batch log records queue polling timeout unit.
PORT - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder: The port event payload field name.
postRetentionAction() - Method in class org.forgerock.audit.retention.RetentionHooks.NullRetentionHooks
postRetentionAction() - Method in interface org.forgerock.audit.retention.RetentionHooks: Method to run an action just before the file is run through the RetentionPolicy's.
postRotationAction(RotationContext) - Method in class org.forgerock.audit.rotation.RotationHooks.NoOpRotatationHooks
postRotationAction(RotationContext) - Method in interface org.forgerock.audit.rotation.RotationHooks: Method to run an action just after file has been rotated.
preRotationAction(RotationContext) - Method in class org.forgerock.audit.rotation.RotationHooks.NoOpRotatationHooks
preRotationAction(RotationContext) - Method in interface org.forgerock.audit.rotation.RotationHooks: Method to run an action just before file will be rotated.
principal(List<String>) - Method in class org.forgerock.audit.events.AuthenticationAuditEventBuilder: Sets the principals of the authentication event.
PRINCIPAL - Static variable in class org.forgerock.audit.events.AuthenticationAuditEventBuilder: Defines the principal key.
ProductInfoProvider - Interface in org.forgerock.audit.providers: Strategy for obtaining the information relating to the product in which the AuditService is deployed.
PROTOCOL - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder: The protocol event payload field name.
publishBatch(String) - Method in interface org.forgerock.audit.events.handlers.buffering.BatchConsumer: Publishes the batch payload.
publishEvent(Context, String, JsonValue) - Method in interface org.forgerock.audit.events.handlers.AuditEventHandler: Publishes an event to the provided topic.
publishEvent(Context, String, JsonValue) - Method in class org.forgerock.audit.events.handlers.NoOpAuditEventHandler

Q

QUERY_PARAMETERS - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder: The query parameters event payload field name.
queryEvents(Context, String, QueryRequest, QueryResourceHandler) - Method in interface org.forgerock.audit.events.handlers.AuditEventHandler: Query some events from the provided topic.
queryEvents(Context, String, QueryRequest, QueryResourceHandler) - Method in class org.forgerock.audit.events.handlers.NoOpAuditEventHandler

R

readCurrentKey() - Method in class org.forgerock.audit.secure.KeyStoreSecureStorage
readCurrentKey() - Method in interface org.forgerock.audit.secure.SecureStorage: Reads the current key.
readEvent(Context, String, String) - Method in interface org.forgerock.audit.events.handlers.AuditEventHandler: Reads an event with the provided resource id from the provided topic.
readEvent(Context, String, String) - Method in class org.forgerock.audit.events.handlers.NoOpAuditEventHandler
readInitialKey() - Method in class org.forgerock.audit.secure.KeyStoreSecureStorage
readInitialKey() - Method in interface org.forgerock.audit.secure.SecureStorage: Reads the initial key.
readPrivateKeyFromKeyStore(String) - Method in class org.forgerock.audit.secure.KeyStoreHandlerDecorator: Get a private key for the alias using the default password from KeyStoreHandlerDecorator.getPassword().
readPrivateKeyFromKeyStore(String, String) - Method in class org.forgerock.audit.secure.KeyStoreHandlerDecorator: Get the private key with the given alias.
readPublicKeyFromKeyStore(String) - Method in class org.forgerock.audit.secure.KeyStoreHandlerDecorator: Get the public key with the given alias.
readSecretKeyFromKeyStore(String) - Method in class org.forgerock.audit.secure.KeyStoreHandlerDecorator: Get the secret key with the given alias using the default password from KeyStoreHandlerDecorator.getPassword().
readSecretKeyFromKeyStore(String, String) - Method in class org.forgerock.audit.secure.KeyStoreHandlerDecorator: Get the secret key with the given alias.
register(Class<T>, T) - Method in class org.forgerock.audit.DependencyProviderBase: Register a new provided dependency.
registerKeyStoreHandler(String, KeyStoreHandler) - Method in class org.forgerock.audit.providers.DefaultKeyStoreHandlerProvider: Register a storage with the given name.
registerRotationHooks(RotationHooks) - Method in class org.forgerock.audit.events.handlers.writers.RotatableWriter: Registers hooks into the rotation process.
registerRotationHooks(RotationHooks) - Method in interface org.forgerock.audit.rotation.RotatableObject: Registers hooks into the rotation process.
registerSecureStorage(String, SecureStorage) - Method in class org.forgerock.audit.providers.DefaultSecureStorageProvider: Register a storage with the given name.
releaseReadLock() - Method in class org.forgerock.audit.AuditServiceProxy: Release the read lock.
releaseWriteLock() - Method in class org.forgerock.audit.AuditServiceProxy: Release the write lock.
renameField(JsonValue, String, String) - Static method in class org.forgerock.audit.util.ElasticsearchUtil: Renames a field within the given JsonValue.
replaceKeyPeriodsWithUnderscores(String) - Static method in class org.forgerock.audit.util.ElasticsearchUtil: Replaces all period-characters in JSON keys with underscore-characters [ref].
request(String, String) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder: Sets the provided request details for the event.
request(String, String, JsonValue) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder: Sets the provided request details for the event.
REQUEST - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder: The request event payload field name.
requestFromCrestRequest(Request) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder: Sets request detail from Request.
requireField(String) - Method in class org.forgerock.audit.events.AuditEventBuilder: Helper method to be used when overriding AuditEventBuilder.validate().
ResourceExceptionsUtil - Class in org.forgerock.audit.util: Utility class to use on ResourceExceptions.
response(AccessAuditEventBuilder.ResponseStatus, String, long, TimeUnit) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder: Sets the provided response for the event.
RESPONSE - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder: The response event payload field name.
responseWithDetail(AccessAuditEventBuilder.ResponseStatus, String, long, TimeUnit, JsonValue) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder: Sets the provided response for the event, with an additional detail.
restoreKeyPeriods(JsonValue, JsonValue) - Static method in class org.forgerock.audit.util.ElasticsearchUtil: Reverses the normalization steps preformed by ElasticsearchUtil.replaceKeyPeriodsWithUnderscores(String).
result(AuthenticationAuditEventBuilder.Status) - Method in class org.forgerock.audit.events.AuthenticationAuditEventBuilder: Sets the authentication audit event overall result.
RESULT - Static variable in class org.forgerock.audit.events.AuthenticationAuditEventBuilder: Defines the authentication result key.
RetentionHooks - Interface in org.forgerock.audit.retention: Hook into the retention checking operations for a file.
RetentionHooks.NullRetentionHooks - Class in org.forgerock.audit.retention: RetentionHooks that do nothing.
RetentionPolicy - Interface in org.forgerock.audit.retention: Defines the retention conditions and the files that need to be deleted.
revision(String) - Method in class org.forgerock.audit.events.ActivityAuditEventBuilder: Sets the revision for the event.
REVISION - Static variable in class org.forgerock.audit.events.ActivityAuditEventBuilder
RotatableObject - Interface in org.forgerock.audit.rotation: Interface defining methods a rotatable file needs.
RotatableWriter - Class in org.forgerock.audit.events.handlers.writers: Creates an RotatableWriter that supports file rotation and retention.
RotatableWriter(File, FileBasedEventHandlerConfiguration, boolean) - Constructor for class org.forgerock.audit.events.handlers.writers.RotatableWriter: Constructs a RotatableWriter given an initial file to manage rotation/retention, and a FileBasedEventHandlerConfiguration.
RotatableWriter(File, FileBasedEventHandlerConfiguration, boolean, RotatableWriter.RolloverLifecycleHook) - Constructor for class org.forgerock.audit.events.handlers.writers.RotatableWriter: Constructs a RotatableWriter given an initial file to manage rotation/retention, a a FileBasedEventHandlerConfiguration and a RotatableWriter.RolloverLifecycleHook.
RotatableWriter.RolloverLifecycleHook - Interface in org.forgerock.audit.events.handlers.writers: Callback hooks to allow custom action to be taken before and after the checks for rotation and retention is performed.
rotateIfNeeded() - Method in class org.forgerock.audit.events.handlers.writers.RotatableWriter: Rotate the log file if any of the configured rotation policies determine that rotation is required.
rotateIfNeeded() - Method in interface org.forgerock.audit.rotation.RotatableObject: Checks the rotatable file for rotation then retention.
RotationContext - Class in org.forgerock.audit.rotation: This class holds some information while a file is being rotated.
RotationContext() - Constructor for class org.forgerock.audit.rotation.RotationContext
RotationHooks - Interface in org.forgerock.audit.rotation: Callback hooks to allow custom action to be taken before and after file rotation occurs.
RotationHooks.NoOpRotatationHooks - Class in org.forgerock.audit.rotation: RotationHooks that do nothing.
RotationPolicy - Interface in org.forgerock.audit.rotation: Interface to decide if a file should be rotated or not.
RUN_AS - Static variable in class org.forgerock.audit.events.ActivityAuditEventBuilder
runAs(String) - Method in class org.forgerock.audit.events.ActivityAuditEventBuilder: Sets the provided runAs for the event.

S

SECURE - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder: The secure event payload field name.
SecureStorage - Interface in org.forgerock.audit.secure: Represents a storage for secure keys, to be used for signing files.
SecureStorageException - Exception in org.forgerock.audit.secure: Exception that can be thrown by a SecureStorage implementation.
SecureStorageException(String) - Constructor for exception org.forgerock.audit.secure.SecureStorageException: Constructs an SecureStorageException using the given message.
SecureStorageException(String, Throwable) - Constructor for exception org.forgerock.audit.secure.SecureStorageException: Constructs an SecureStorageException using the given message and parent cause.
SecureStorageException(Throwable) - Constructor for exception org.forgerock.audit.secure.SecureStorageException: Constructs an SecureStorageException using the given parent cause.
SecureStorageProvider - Interface in org.forgerock.audit.providers: Strategy for obtaining a secure storage, used by handlers providing tamper-evident feature.
self() - Method in class org.forgerock.audit.events.AuditEventBuilder: Returns this object, as its actual type.
server(String, int) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder: Sets the provided server values for the event.
SERVER - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder: The server event payload field name.
serverFromContext(Context) - Method in class org.forgerock.audit.events.AccessAuditEventBuilder: Sets the server fields for the event, if the provided Context contains a ClientContext..
setAvailableAuditEventHandlers(List<String>) - Method in class org.forgerock.audit.AuditServiceConfiguration: Sets the list of available audit event handlers.
setDefaults() - Method in class org.forgerock.audit.events.AuditEventBuilder: Called by AuditEventBuilder.toEvent() to allow any unset fields to be given their default value.
setDefaults() - Method in class org.forgerock.audit.events.ActivityAuditEventBuilder: Called by AuditEventBuilder.toEvent() to allow any unset fields to be given their default value.
setDelegate(AuditService) - Method in class org.forgerock.audit.AuditServiceProxy: Sets the AuditService this object proxies.
setEnabled(boolean) - Method in class org.forgerock.audit.events.handlers.EventHandlerConfiguration: Sets the enabled flag for an audit event handler.
setExcludeIf(Collection<String>) - Method in class org.forgerock.audit.filter.FilterPolicy: Sets the excludeIf list.
setFileRetention(FileBasedEventHandlerConfiguration.FileRetention) - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration: Sets the FileBasedEventHandlerConfiguration.FileRetention.
setFileRotation(FileBasedEventHandlerConfiguration.FileRotation) - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration: Sets the FileBasedEventHandlerConfiguration.FileRotation.
setFilterPolicies(Map<String, FilterPolicy>) - Method in class org.forgerock.audit.AuditServiceConfiguration: Set the filter policy mappings.
setHandlerForQueries(String) - Method in class org.forgerock.audit.AuditServiceConfiguration: Sets the name of the handler to use for querying the audit events.
setIncludeIf(Collection<String>) - Method in class org.forgerock.audit.filter.FilterPolicy: Sets the includeIf list.
setInitialFile(File) - Method in class org.forgerock.audit.rotation.RotationContext: Set the initial file.
setKeyStoreHandler(KeyStoreHandler) - Method in class org.forgerock.audit.secure.KeyStoreSecureStorage: Set the key store handler.
setMaxDiskSpaceToUse(long) - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRetention: Sets the maximum disk space the audit logs can occupy.
setMaxFileSize(long) - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation: Sets the maximum file size of an audit log file in bytes.
setMaxNumberOfHistoryFiles(int) - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRetention: Sets the maximum number of historical log files to retain. -1 disables pruning of old history files.
setMinFreeSpaceRequired(long) - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRetention: Sets the minimum free space the system must contain.
setName(String) - Method in class org.forgerock.audit.events.handlers.EventHandlerConfiguration: Sets the name of this handler.
setNextFile(File) - Method in class org.forgerock.audit.rotation.RotationContext: Set the next file.
setRotationEnabled(boolean) - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation: Sets log rotation enabled state.
setRotationFilePrefix(String) - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation: Sets the prefix to add to a log file on rotation.
setRotationFileSuffix(String) - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation: Sets the suffix to add to a log file on rotation.
setRotationInterval(String) - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation: Sets the interval to trigger a file rotation.
setRotationRetentionCheckInterval(String) - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration: Sets the interval to check time-based file rotation policies.
setRotationTimes(List<String>) - Method in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRotation: Sets a list of times at which file rotation should be triggered; times should be provided as Strings that can be parsed by Duration that each specify an offset from midnight.
setStore(KeyStore) - Method in class org.forgerock.audit.secure.JcaKeyStoreHandler
setStore(KeyStore) - Method in interface org.forgerock.audit.secure.KeyStoreHandler: Sets the keystore.
setStore(KeyStore) - Method in class org.forgerock.audit.secure.KeyStoreHandlerDecorator
setTopics(Set<String>) - Method in class org.forgerock.audit.events.handlers.EventHandlerConfiguration: Sets the topics accepted by this handler.
setWriter(Writer) - Method in class org.forgerock.audit.rotation.RotationContext: Set the writer.
shouldRotateFile(RotatableObject) - Method in class org.forgerock.audit.rotation.FixedTimeRotationPolicy: This method indicates if the log file should be rotated or not.
shouldRotateFile(RotatableObject) - Method in interface org.forgerock.audit.rotation.RotationPolicy: This method indicates if the log file should be rotated or not.
shouldRotateFile(RotatableObject) - Method in class org.forgerock.audit.rotation.SizeBasedRotationPolicy: Indicates whether or not a RotatableObject needs rotation.
shouldRotateFile(RotatableObject) - Method in class org.forgerock.audit.rotation.TimeLimitRotationPolicy: Checks whether or not a RotatableObject needs rotation.
shutdown() - Method in interface org.forgerock.audit.AuditService: Closes this AuditService and all its AuditEventHandlers.
shutdown() - Method in class org.forgerock.audit.AuditServiceProxy
shutdown() - Method in interface org.forgerock.audit.events.handlers.AuditEventHandler: Instruct this object to flush any buffers and close any open file handles or network connections.
shutdown() - Method in interface org.forgerock.audit.events.handlers.buffering.BatchPublisher: Informs the publisher to stop processing offered events.
shutdown() - Method in class org.forgerock.audit.events.handlers.buffering.BufferedBatchPublisher: Stops sending batch data, and awaits termination of pending queue tasks when autoFlush is enabled.
shutdown() - Method in class org.forgerock.audit.events.handlers.NoOpAuditEventHandler
shutdown() - Method in class org.forgerock.audit.events.handlers.writers.AsynchronousTextWriter: Releases any resources held by the writer.
shutdown() - Method in class org.forgerock.audit.events.handlers.writers.RotatableWriter
shutdown() - Method in interface org.forgerock.audit.events.handlers.writers.TextWriter: Releases any resources held by the writer.
shutdown() - Method in class org.forgerock.audit.events.handlers.writers.TextWriter.Stream
shutdown() - Method in class org.forgerock.audit.events.handlers.writers.TextWriterAdapter
shutdown(boolean) - Method in class org.forgerock.audit.events.handlers.writers.AsynchronousTextWriter: Releases any resources held by the writer.
sign(byte[]) - Method in class org.forgerock.audit.secure.KeyStoreSecureStorage
sign(byte[]) - Method in interface org.forgerock.audit.secure.SecureStorage: Signs the provided data.
SIGNATURE_ALGORITHM - Static variable in class org.forgerock.audit.secure.KeyStoreSecureStorage: The algorithm to use for signing and verifying.
SizeBasedRetentionPolicy - Class in org.forgerock.audit.retention: Created a size based file retention policy.
SizeBasedRetentionPolicy(int) - Constructor for class org.forgerock.audit.retention.SizeBasedRetentionPolicy: Constructs a SizeBasedRetentionPolicy with a given maximum number of archived files.
SizeBasedRotationPolicy - Class in org.forgerock.audit.rotation: Creates a file size based rotation policy.
SizeBasedRotationPolicy(long) - Constructor for class org.forgerock.audit.rotation.SizeBasedRotationPolicy: Constructs a SizeBasedRotationPolicy given a max file size in bytes.
startup() - Method in interface org.forgerock.audit.AuditService: Allows this AuditService and all its AuditEventHandlers to perform any initialization that would be unsafe to do if any other instance of the AuditService were still running.
startup() - Method in class org.forgerock.audit.AuditServiceProxy
startup() - Method in interface org.forgerock.audit.events.handlers.AuditEventHandler: Instruct this object that it is safe to initialize file handles and network connections.
startup() - Method in interface org.forgerock.audit.events.handlers.buffering.BatchPublisher: Informs the publisher to start processing offered events.
startup() - Method in class org.forgerock.audit.events.handlers.buffering.BufferedBatchPublisher: Starts periodically sending batch data.
startup() - Method in class org.forgerock.audit.events.handlers.NoOpAuditEventHandler
STATUS - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder: The status event payload field name.
STATUS_CODE - Static variable in class org.forgerock.audit.events.AccessAuditEventBuilder: The status code event payload field name.
store() - Method in class org.forgerock.audit.secure.JcaKeyStoreHandler
store() - Method in interface org.forgerock.audit.secure.KeyStoreHandler: Saves the keystore.
store() - Method in class org.forgerock.audit.secure.KeyStoreHandlerDecorator
Stream(OutputStream) - Constructor for class org.forgerock.audit.events.handlers.writers.TextWriter.Stream: Creates a new text writer that will write to the provided output stream.
STRING_TYPE - Static variable in class org.forgerock.audit.events.AuditEventHelper: Json String value type.
SUCCESSFUL - Enum constant in enum org.forgerock.audit.events.AccessAuditEventBuilder.ResponseStatus: The access request was successfully completed.
SUCCESSFUL - Enum constant in enum org.forgerock.audit.events.AuthenticationAuditEventBuilder.Status: Authentication operation has completed successfully.

T

TextWriter - Interface in org.forgerock.audit.events.handlers.writers: A TextWriter provides a character-based stream which can be queried for number of bytes written.
TextWriter.Stream - Class in org.forgerock.audit.events.handlers.writers: A TextWriter implementation which writes to a given output stream.
TextWriterAdapter - Class in org.forgerock.audit.events.handlers.writers: Wraps a TextWriter in a Writer.
TextWriterAdapter(TextWriter) - Constructor for class org.forgerock.audit.events.handlers.writers.TextWriterAdapter: Creates the writer.
TimeLimitRotationPolicy - Class in org.forgerock.audit.rotation: Creates a rotation policy based on a time duration.
TimeLimitRotationPolicy(Duration) - Constructor for class org.forgerock.audit.rotation.TimeLimitRotationPolicy: Constructs a TimeLimitRotationPolicy with a given Duration.
timestamp(long) - Method in class org.forgerock.audit.events.AuditEventBuilder: Sets the provided time stamp for the event.
TIMESTAMP - Static variable in class org.forgerock.audit.events.AuditEventBuilder: Timestamp event payload field name.
TimestampFilenameFilter - Class in org.forgerock.audit.retention: A FilenameFilter that matches historical log files.
TimestampFilenameFilter(File, String, DateTimeFormatter) - Constructor for class org.forgerock.audit.retention.TimestampFilenameFilter: Constructs a TimestampFilenameFilter given an initial file, prefix and suffix.
TimeStampFileNamingPolicy - Class in org.forgerock.audit.retention: Creates a time stamp based file naming policy.
TimeStampFileNamingPolicy(File, String, String) - Constructor for class org.forgerock.audit.retention.TimeStampFileNamingPolicy: Constructs a TimeStampFileNaming policy with a given initial file, a timestamp format, and a prefix string.
toEvent() - Method in class org.forgerock.audit.events.AuditEventBuilder: Generates the audit event.
toString() - Method in class org.forgerock.audit.events.AuditEvent
toString() - Method in class org.forgerock.audit.events.handlers.AuditEventTopicState
TRACKING_IDS - Static variable in class org.forgerock.audit.events.AuditEventBuilder: Tracking IDs event payload field name.
trackingId(String) - Method in class org.forgerock.audit.events.AuditEventBuilder: Adds an entry to trackingIds for the event.
trackingIds(Set<String>) - Method in class org.forgerock.audit.events.AuditEventBuilder: Adds the specified entries to trackingIds for the event.
TRANSACTION_ID - Static variable in class org.forgerock.audit.events.AuditEventBuilder: Transaction ID event payload field name.
transactionId(String) - Method in class org.forgerock.audit.events.AuditEventBuilder: Sets the provided transactionId for the event.
transactionIdFromContext(Context) - Method in class org.forgerock.audit.events.AuditEventBuilder: Sets transactionId from ID of TransactionIdContext, if the provided Context contains a TransactionIdContext.

U

UNLIMITED_HISTORY_FILES - Static variable in class org.forgerock.audit.events.handlers.FileBasedEventHandlerConfiguration.FileRetention: The value of number of history files to use when the value is unlimited.
USER_ID - Static variable in class org.forgerock.audit.events.AuditEventBuilder: User ID event payload field name.
userId(String) - Method in class org.forgerock.audit.events.AuditEventBuilder: Sets the provided userId for the event.

V

validate() - Method in class org.forgerock.audit.events.AuditEventBuilder: Called by AuditEventBuilder.toEvent() to ensure that the audit event will be created in a valid state.
validate() - Method in class org.forgerock.audit.events.ActivityAuditEventBuilder: Called by AuditEventBuilder.toEvent() to ensure that the audit event will be created in a valid state.
VALUE - Enum constant in enum org.forgerock.audit.filter.Filters.FilterNames: Value event filter type.
valueOf(String) - Static method in enum org.forgerock.audit.events.AccessAuditEventBuilder.ResponseStatus: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.audit.events.AuthenticationAuditEventBuilder.Status: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.forgerock.audit.filter.Filters.FilterNames: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.forgerock.audit.events.AccessAuditEventBuilder.ResponseStatus: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.audit.events.AuthenticationAuditEventBuilder.Status: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.forgerock.audit.filter.Filters.FilterNames: Returns an array containing the constants of this enum type, in the order they are declared.
verify(byte[], byte[]) - Method in class org.forgerock.audit.secure.KeyStoreSecureStorage
verify(byte[], byte[]) - Method in interface org.forgerock.audit.secure.SecureStorage: Verifies that signed data corresponds to signature.

W

withAdditionalTopicSchemas(JsonValue) - Method in class org.forgerock.audit.events.EventTopicsMetaDataBuilder: Specifies schemas for additional topics.
withAuditEventHandler(Class<? extends AuditEventHandler>, EventHandlerConfiguration) - Method in class org.forgerock.audit.AuditServiceBuilder: Register an AuditEventHandler.
withAuditEventHandler(AuditEventHandler) - Method in class org.forgerock.audit.AuditServiceBuilder: Register an AuditEventHandler.
withAuditEventHandlerFactory(AuditEventHandlerFactory) - Method in class org.forgerock.audit.AuditServiceBuilder: Register factory for creating instances of AuditEventHandler.
withAuditTopics(Collection<String>) - Method in class org.forgerock.audit.filter.FilterChainBuilder: Adds the topics this filter chain is for.
withConfiguration(AuditServiceConfiguration) - Method in class org.forgerock.audit.AuditServiceBuilder: Sets the AuditServiceConfiguration that is to be passed to the AuditService.
withCoreTopicSchemaExtensions(JsonValue) - Method in class org.forgerock.audit.events.EventTopicsMetaDataBuilder: Specifies additional fields that should be added to the schemas for core event topics.
withDependencyProvider(DependencyProvider) - Method in class org.forgerock.audit.AuditServiceBuilder: Register the DependencyProvider, after which, an AuditEventHandler can be registered and receive this provider.
withEventTopicsMetaData(EventTopicsMetaData) - Method in class org.forgerock.audit.AuditServiceBuilder: Set the topic metadata that should be used by the audit service and the handlers.
withPolicies(Map<String, FilterPolicy>) - Method in class org.forgerock.audit.filter.FilterChainBuilder: Adds the policies to chain together.
withReverseDnsLookup() - Method in class org.forgerock.audit.events.AccessAuditEventBuilder: Instructs the builder to lookup client.host from client.ip when populating client details.
write(byte[]) - Method in class org.forgerock.audit.events.handlers.writers.MeteredStream: Write the specified buffer to the stream.
write(byte[], int, int) - Method in class org.forgerock.audit.events.handlers.writers.MeteredStream: Write the specified buffer to the stream.
write(char[]) - Method in class org.forgerock.audit.events.handlers.writers.TextWriterAdapter
write(char[], int, int) - Method in class org.forgerock.audit.events.handlers.writers.TextWriterAdapter
write(int) - Method in class org.forgerock.audit.events.handlers.writers.MeteredStream: Write the specified byte to the stream.
write(int) - Method in class org.forgerock.audit.events.handlers.writers.TextWriterAdapter
write(String) - Method in class org.forgerock.audit.events.handlers.writers.AsynchronousTextWriter: Write the log record asynchronously.
write(String) - Method in class org.forgerock.audit.events.handlers.writers.RotatableWriter
write(String) - Method in class org.forgerock.audit.events.handlers.writers.TextWriter.Stream
write(String) - Method in interface org.forgerock.audit.events.handlers.writers.TextWriter: Writes some text to the output stream.
write(String) - Method in class org.forgerock.audit.events.handlers.writers.TextWriterAdapter
write(String, int, int) - Method in class org.forgerock.audit.events.handlers.writers.TextWriterAdapter
writeCurrentKey(SecretKey) - Method in class org.forgerock.audit.secure.KeyStoreSecureStorage
writeCurrentKey(SecretKey) - Method in interface org.forgerock.audit.secure.SecureStorage: Writes the current key.
writeCurrentSignatureKey(SecretKey) - Method in class org.forgerock.audit.secure.KeyStoreSecureStorage
writeCurrentSignatureKey(SecretKey) - Method in interface org.forgerock.audit.secure.SecureStorage: Writes the current signature key.
writeInitialKey(SecretKey) - Method in class org.forgerock.audit.secure.KeyStoreSecureStorage
writeInitialKey(SecretKey) - Method in interface org.forgerock.audit.secure.SecureStorage: Writes the initial key.
writeInterval(Duration) - Method in interface org.forgerock.audit.events.handlers.buffering.BufferedBatchPublisher.Builder: The interval duration between each write.
writeToKeyStore(SecretKey, String) - Method in class org.forgerock.audit.secure.KeyStoreHandlerDecorator: Writes to the secret storage using the same password than the KeyStoreHandler.
writeToKeyStore(SecretKey, String, String) - Method in class org.forgerock.audit.secure.KeyStoreHandlerDecorator: Writes to the secret storage.

A B C D E F G H I J K L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form