Package ddf.catalog.plugin

Interface AccessPlugin

public interface AccessPlugin

An AccessPlugin allows or denies access to the Catalog operation or response. AccessPlugin are independent and should not rely on ordering of other plugins

Method Summary

Modifier and Type	Method	Description
DeleteResponse	processPostDelete(DeleteResponse input)	Processes a DeleteResponse, following the execution of CatalogProvider.delete(DeleteRequest), to determine whether or not the user can access the Catalog operation
QueryResponse	processPostQuery(QueryResponse input)	Processes a QueryResponse, following the execution of the Query, to determine whether or not the user can access the Response.
ResourceResponse	processPostResource(ResourceResponse input, Metacard metacard)	Processes a ResourceResponse, following the execution of the ResourceRequest, to determine whether or not the user can access the Response.
CreateRequest	processPreCreate(CreateRequest input)	Processes a CreateRequest, prior to CatalogProvider.create(CreateRequest), to determine whether or not the user can access the Catalog operation
DeleteRequest	processPreDelete(DeleteRequest input)	Processes a DeleteRequest, prior to CatalogProvider.delete(DeleteRequest), to determine whether or not the user can access the Catalog operation
QueryRequest	processPreQuery(QueryRequest input)	Processes a QueryRequest, prior to execution of the Query, to determine whether or not the user can access the Catalog operation.
ResourceRequest	processPreResource(ResourceRequest input)	Processes a ResourceRequest, prior to execution of the ResourceRequest, to determine whether or not the user can access the Catalog operation.
UpdateRequest	processPreUpdate(UpdateRequest input, Map<String,Metacard> existingMetacards)	Processes an UpdateRequest, prior to execution of the Update, to determine whether or not the user can access the Catalog operation

Method Details

processPreCreate

CreateRequest processPreCreate(CreateRequest input)
                        throws StopProcessingException

Processes a CreateRequest, prior to CatalogProvider.create(CreateRequest), to determine whether or not the user can access the Catalog operation

Parameters:

input - the CreateRequest to process

Returns:

the value of the processed CreateRequest to pass to the next AccessPlugin

Throws:

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

processPreUpdate

UpdateRequest processPreUpdate(UpdateRequest input,
 Map<String,Metacard> existingMetacards)
                        throws StopProcessingException

Processes an UpdateRequest, prior to execution of the Update, to determine whether or not the user can access the Catalog operation

Parameters:

input - the UpdateRequest to process

existingMetacards - the Map of Metacards that currently exist

Returns:

the value of the processed UpdateRequest to pass to the next AccessPlugin

Throws:

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

processPreDelete

DeleteRequest processPreDelete(DeleteRequest input)
                        throws StopProcessingException

Processes a DeleteRequest, prior to CatalogProvider.delete(DeleteRequest), to determine whether or not the user can access the Catalog operation

Parameters:

input - the DeleteRequest to process

Returns:

the value of the processed DeleteRequest to pass to the next AccessPlugin

Throws:

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

processPostDelete

DeleteResponse processPostDelete(DeleteResponse input)
                          throws StopProcessingException

Processes a DeleteResponse, following the execution of CatalogProvider.delete(DeleteRequest), to determine whether or not the user can access the Catalog operation

Parameters:

input - the DeleteResponse to process

Returns:

the value of the processed DeleteResponse to pass to the next AccessPlugin

Throws:

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

processPreQuery

QueryRequest processPreQuery(QueryRequest input)
                      throws StopProcessingException

Processes a QueryRequest, prior to execution of the Query, to determine whether or not the user can access the Catalog operation. The AccessPlugins will be run in the same order for both processPreQuery and processPostQuery

Parameters:

input - the QueryRequest to process

Returns:

the value of the processed QueryRequest to pass to the next AccessPlugin

Throws:

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

processPostQuery

QueryResponse processPostQuery(QueryResponse input)
                        throws StopProcessingException

Processes a QueryResponse, following the execution of the Query, to determine whether or not the user can access the Response. The AccessPlugins will be run in the same order for both processPreQuery and processPostQuery

Parameters:

input - the QueryResponse to process

Returns:

the value of the processed QueryResponse to pass to the next AccessPlugin

Throws:

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

processPreResource

ResourceRequest processPreResource(ResourceRequest input)
                            throws StopProcessingException

Processes a ResourceRequest, prior to execution of the ResourceRequest, to determine whether or not the user can access the Catalog operation. The AccessPlugins will be run in the same order for both processPreQuery and processPostQuery

Parameters:

input - the ResourceRequest to process

Returns:

the value of the processed QueryRequest to pass to the next AccessPlugin

Throws:

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

processPostResource

ResourceResponse processPostResource(ResourceResponse input,
 Metacard metacard)
                              throws StopProcessingException

Processes a ResourceResponse, following the execution of the ResourceRequest, to determine whether or not the user can access the Response. The AccessPlugins will be run in the same order for both processPreResource and processPostResource

Parameters:

input - the ResourceResponse to process

Returns:

the value of the processed ResourceResponse to pass to the next AccessPlugin

Throws:

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