org.codice.ddf.catalog.security.logging

Class SecurityLoggingPlugin

java.lang.Object

org.codice.ddf.catalog.security.logging.SecurityLoggingPlugin

All Implemented Interfaces:

PostCreateStoragePlugin, PostUpdateStoragePlugin, PreCreateStoragePlugin, PreUpdateStoragePlugin, PostFederatedQueryPlugin, PostIngestPlugin, PostQueryPlugin, PostResourcePlugin, PreFederatedQueryPlugin, PreIngestPlugin, PreQueryPlugin, PreResourcePlugin

public class SecurityLoggingPlugin
extends Object
implements PreIngestPlugin, PostIngestPlugin, PreQueryPlugin, PostQueryPlugin, PreFederatedQueryPlugin, PostFederatedQueryPlugin, PreResourcePlugin, PostResourcePlugin, PreCreateStoragePlugin, PreUpdateStoragePlugin, PostCreateStoragePlugin, PostUpdateStoragePlugin

Logs the current operation being performed to the security logger.

Constructor Summary

Constructors

Constructor and Description
SecurityLoggingPlugin()

Method Summary

Modifier and Type	Method and Description
CreateRequest	process(CreateRequest input) Process a CreateRequest prior to CatalogProvider.create(CreateRequest).
CreateResponse	process(CreateResponse input) Processes the CreateResponse.
CreateStorageRequest	process(CreateStorageRequest input) Processes the CreateStorageRequest.
CreateStorageResponse	process(CreateStorageResponse input) Processes the CreateStorageResponse.
DeleteRequest	process(DeleteRequest input) Processes the DeleteRequest prior to the execution of the update operation.
DeleteResponse	process(DeleteResponse input) Processes the DeleteResponse.
QueryRequest	process(QueryRequest input) Processes a QueryRequest prior to execution of the Query.
QueryResponse	process(QueryResponse input) Processes a QueryResponse after the execution of the Query.
ResourceRequest	process(ResourceRequest input) Processes the ResourceRequest.
ResourceResponse	process(ResourceResponse input) Processes a ResourceResponse after the execution of a getResource operation.
QueryRequest	process(Source source, QueryRequest input) Processes a QueryRequest prior to execution of the Federated Query.
UpdateRequest	process(UpdateRequest input) Process a UpdateRequest prior to CatalogProvider.update(UpdateRequest).
UpdateResponse	process(UpdateResponse input) Processes the UpdateResponse.
UpdateStorageRequest	process(UpdateStorageRequest input) Processes the UpdateStorageRequest.
UpdateStorageResponse	process(UpdateStorageResponse input) Processes the UpdateStorageResponse.

Methods inherited from class java.lang.Object

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

Constructor Detail

SecurityLoggingPlugin

public SecurityLoggingPlugin()

Method Detail

process

public CreateRequest process(CreateRequest input)
                      throws PluginExecutionException,
                             StopProcessingException

Description copied from interface: PreIngestPlugin

Process a CreateRequest prior to CatalogProvider.create(CreateRequest).

Specified by:

process in interface PreIngestPlugin

Parameters:

input - the CreateRequest to process

Returns:

the value of the processed CreateRequest to pass to the next PreIngestPlugin, or to the CatalogProvider if this is the last PreIngestPlugin to be called

Throws:

PluginExecutionException - if an error in processing occurs

StopProcessingException

process

public UpdateRequest process(UpdateRequest input)
                      throws PluginExecutionException,
                             StopProcessingException

Description copied from interface: PreIngestPlugin

Process a UpdateRequest prior to CatalogProvider.update(UpdateRequest).

Specified by:

process in interface PreIngestPlugin

Parameters:

input - the UpdateRequest to process

Returns:

the value of the processed UpdateRequest to pass to the next PreIngestPlugin, or to the CatalogProvider if this is the last PreIngestPlugin to be called

Throws:

PluginExecutionException - if an error in processing occurs

StopProcessingException

process

public DeleteRequest process(DeleteRequest input)
                      throws PluginExecutionException,
                             StopProcessingException

Description copied from interface: PreIngestPlugin

Processes the DeleteRequest prior to the execution of the update operation.

Specified by:

process in interface PreIngestPlugin

Parameters:

input - the DeleteRequest to process

Returns:

the value of the processed DeleteRequest to pass to the next PreIngestPlugin, or if this is the last PreIngestPlugin to be called

Throws:

PluginExecutionException - thrown when an error in processing occurs

StopProcessingException

process

public QueryRequest process(QueryRequest input)
                     throws PluginExecutionException,
                            StopProcessingException

Description copied from interface: PreQueryPlugin

Processes a QueryRequest prior to execution of the Query.

Specified by:

process in interface PreQueryPlugin

Parameters:

input - the QueryRequest to process

Returns:

the value of the processed QueryRequest to pass to the next PreQueryPlugin, or if this is the last PreQueryPlugin to be called

Throws:

PluginExecutionException - thrown when an error occurs while processing the QueryRequest

StopProcessingException - thrown to halt processing when a critical issue occurs during processing. This is intended to prevent other plugins from processing as well.

process

public ResourceRequest process(ResourceRequest input)
                        throws PluginExecutionException,
                               StopProcessingException

Description copied from interface: PreResourcePlugin

Processes the ResourceRequest.

Specified by:

process in interface PreResourcePlugin

Parameters:

input - - the ResourceRequest to process

Returns:

the value of the processed ResourceRequest to pass to the next PreResourcePlugin, or if this is the last PreResourcePlugin to be called

Throws:

PluginExecutionException - when an error occurs during processing

StopProcessingException

process

public CreateResponse process(CreateResponse input)
                       throws PluginExecutionException

Description copied from interface: PostIngestPlugin

Processes the CreateResponse.

Specified by:

process in interface PostIngestPlugin

Parameters:

input - the CreateResponse to process

Returns:

the value of the processed CreateResponse to pass to the next PostIngestPlugin, or if this is the last PostIngestPlugin to be called

Throws:

PluginExecutionException - thrown when an error occurs during processing

process

public UpdateResponse process(UpdateResponse input)
                       throws PluginExecutionException

Description copied from interface: PostIngestPlugin

Processes the UpdateResponse.

Specified by:

process in interface PostIngestPlugin

Parameters:

input - the UpdateResponse to process

Returns:

the value of the processed UpdateResponse to pass to the next PostIngestPlugin, or if this is the last PostIngestPlugin to be called

Throws:

PluginExecutionException - thrown when an error occurs during processing

process

public DeleteResponse process(DeleteResponse input)
                       throws PluginExecutionException

Description copied from interface: PostIngestPlugin

Processes the DeleteResponse.

Specified by:

process in interface PostIngestPlugin

Parameters:

input - the DeleteResponse to process

Returns:

the value of the processed DeleteResponse to pass to the next PostIngestPlugin, or if this is the last PostIngestPlugin to be called

Throws:

PluginExecutionException - thrown when an error occurs during processing

process

public QueryResponse process(QueryResponse input)
                      throws PluginExecutionException,
                             StopProcessingException

Description copied from interface: PostQueryPlugin

Processes a QueryResponse after the execution of the Query.

Specified by:

process in interface PostFederatedQueryPlugin

Specified by:

process in interface PostQueryPlugin

Parameters:

input - the QueryResponse to process

Returns:

the value of the processed QueryResponse to pass to the next PostQueryPlugin, or if this is the last PostQueryPlugin to be called

Throws:

PluginExecutionException - thrown when an error occurs while processing the QueryResponse

StopProcessingException - thrown to halt processing when a critical issue occurs during processing. This is intended to prevent other plugins from processing as well.

process

public ResourceResponse process(ResourceResponse input)
                         throws PluginExecutionException,
                                StopProcessingException

Description copied from interface: PostResourcePlugin

Processes a ResourceResponse after the execution of a getResource operation.

Specified by:

process in interface PostResourcePlugin

Parameters:

input - the ResourceResponse to process

Returns:

the value of the processed ResourceResponse to pass to the next PostResourcePlugin, or if this is the last PostResourcePlugin to be called

Throws:

PluginExecutionException - thrown when an error occurs while processing the ResourceResponse

StopProcessingException - thrown to halt processing when a critical issue occurs during processing. This is intended to prevent other plugins from processing as well.

process

public QueryRequest process(Source source,
                            QueryRequest input)
                     throws PluginExecutionException,
                            StopProcessingException

Description copied from interface: PreFederatedQueryPlugin

Processes a QueryRequest prior to execution of the Federated Query.

Specified by:

process in interface PreFederatedQueryPlugin

Parameters:

source - the Source the query will be sent to

input - the QueryRequest to process

Returns:

the value of the processed QueryRequest to pass to the next PreFederatedQueryPlugin, or if this is the last PreFederatedQueryPlugin to be called

Throws:

PluginExecutionException - thrown when an error occurs while processing the QueryRequest

StopProcessingException - thrown to halt processing when a critical issue occurs during processing. This is intended to prevent other plugins from processing as well.

process

public CreateStorageRequest process(CreateStorageRequest input)
                             throws PluginExecutionException

Description copied from interface: PreCreateStoragePlugin

Processes the CreateStorageRequest.

Specified by:

process in interface PreCreateStoragePlugin

Parameters:

input - the CreateStorageRequest to process

Returns:

the processed CreateStorageRequest to pass to the next PreCreateStoragePlugin

Throws:

PluginExecutionException - if an error occurs during processing

process

public UpdateStorageRequest process(UpdateStorageRequest input)
                             throws PluginExecutionException

Description copied from interface: PreUpdateStoragePlugin

Processes the UpdateStorageRequest.

Specified by:

process in interface PreUpdateStoragePlugin

Parameters:

input - the UpdateStorageRequest to process

Returns:

the processed UpdateStorageRequest to pass to the next PreUpdateStoragePlugin

Throws:

PluginExecutionException - if an error occurs during processing

process

public CreateStorageResponse process(CreateStorageResponse input)
                              throws PluginExecutionException

Description copied from interface: PostCreateStoragePlugin

Processes the CreateStorageResponse.

Specified by:

process in interface PostCreateStoragePlugin

Parameters:

input - the CreateStorageResponse to process

Returns:

the processed CreateStorageResponse to pass to the next PostCreateStoragePlugin

Throws:

PluginExecutionException - if an error occurs during processing

process

public UpdateStorageResponse process(UpdateStorageResponse input)
                              throws PluginExecutionException

Description copied from interface: PostUpdateStoragePlugin

Processes the UpdateStorageResponse.

Specified by:

process in interface PostUpdateStoragePlugin

Parameters:

input - the UpdateStorageResponse to process

Returns:

the processed UpdateStorageResponse to pass to the next PostUpdateStoragePlugin

Throws:

PluginExecutionException - if an error occurs during processing