ddf.catalog.plugin

Interface PreAuthorizationPlugin

All Known Implementing Classes:

ClientInfoPlugin, MetacardIngestNetworkPlugin, PointOfContactUpdatePlugin

public interface PreAuthorizationPlugin

The PreAuthorizationPlugin extension point allows for request/response processing before any security rules (policy and access) are implemented at the beginning of the plugin chain. That is, pre-processing occurs before policy, access, and the catalog framework. Post-processing occurs after the catalog framework but before the second round of policy and access.

This code is experimental. While this interface is functional and tested, it may change or be removed in a future version of the library.

Method Summary

Modifier and Type	Method and Description
DeleteResponse	processPostDelete(DeleteResponse input) Process a DeleteResponse for use cases that occur prior to security rules.
QueryResponse	processPostQuery(QueryResponse input) Process a QueryResponse for use cases that occur prior to security rules.
ResourceResponse	processPostResource(ResourceResponse input, Metacard metacard) Process a ResourceResponse for use cases that occur prior to security rules.
CreateRequest	processPreCreate(CreateRequest input) Process a CreateRequest for use cases that occur prior to security rules.
DeleteRequest	processPreDelete(DeleteRequest input) Process a DeleteRequest for use cases that occur prior to security rules.
QueryRequest	processPreQuery(QueryRequest input) Process a QueryRequest for use cases that occur prior to security rules.
ResourceRequest	processPreResource(ResourceRequest input) Process a ResourceRequest for use cases that occur prior to security rules.
UpdateRequest	processPreUpdate(UpdateRequest input, Map<String,Metacard> existingMetacards) Process an UpdateRequest for use cases that occur prior to security rules.

Method Detail

processPreCreate

CreateRequest processPreCreate(CreateRequest input)
                        throws StopProcessingException

Process a CreateRequest for use cases that occur prior to security rules.

Parameters:

input - the CreateRequest to process

Returns:

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

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

Process an UpdateRequest for use cases that occur prior to security rules.

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 PreAuthorizationPlugin

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

Process a DeleteRequest for use cases that occur prior to security rules.

Parameters:

input - the DeleteRequest to process

Returns:

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

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

Process a DeleteResponse for use cases that occur prior to security rules.

Parameters:

input - the DeleteResponse to process

Returns:

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

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

Process a QueryRequest for use cases that occur prior to security rules.

Parameters:

input - the QueryRequest to process

Returns:

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

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

Process a QueryResponse for use cases that occur prior to security rules.

Parameters:

input - the QueryResponse to process

Returns:

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

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

Process a ResourceRequest for use cases that occur prior to security rules.

Parameters:

input - the ResourceRequest to process

Returns:

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

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

Process a ResourceResponse for use cases that occur prior to security rules.

Parameters:

input - the ResourceResponse to process

Returns:

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

Throws:

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