org.codice.ddf.catalog.plugin.clientinfo

Class ClientInfoPlugin

java.lang.Object

org.codice.ddf.catalog.plugin.clientinfo.ClientInfoPlugin

All Implemented Interfaces:

PreAuthorizationPlugin

public class ClientInfoPlugin
extends Object
implements PreAuthorizationPlugin

Injects client-specific information, if any exists for the current thread, into request properties.

Constructor Summary

Constructors

Constructor and Description
ClientInfoPlugin()

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientInfoPlugin

public ClientInfoPlugin()

Method Detail

processPreCreate

public CreateRequest processPreCreate(CreateRequest input)
                               throws StopProcessingException

Description copied from interface: PreAuthorizationPlugin

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

Specified by:

processPreCreate in interface PreAuthorizationPlugin

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

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

Description copied from interface: PreAuthorizationPlugin

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

Specified by:

processPreUpdate in interface PreAuthorizationPlugin

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

public DeleteRequest processPreDelete(DeleteRequest input)
                               throws StopProcessingException

Description copied from interface: PreAuthorizationPlugin

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

Specified by:

processPreDelete in interface PreAuthorizationPlugin

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

public DeleteResponse processPostDelete(DeleteResponse input)
                                 throws StopProcessingException

Description copied from interface: PreAuthorizationPlugin

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

Specified by:

processPostDelete in interface PreAuthorizationPlugin

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

public QueryRequest processPreQuery(QueryRequest input)
                             throws StopProcessingException

Description copied from interface: PreAuthorizationPlugin

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

Specified by:

processPreQuery in interface PreAuthorizationPlugin

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

public QueryResponse processPostQuery(QueryResponse input)
                               throws StopProcessingException

Description copied from interface: PreAuthorizationPlugin

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

Specified by:

processPostQuery in interface PreAuthorizationPlugin

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

public ResourceRequest processPreResource(ResourceRequest input)
                                   throws StopProcessingException

Description copied from interface: PreAuthorizationPlugin

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

Specified by:

processPreResource in interface PreAuthorizationPlugin

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

public ResourceResponse processPostResource(ResourceResponse input,
                                            Metacard metacard)
                                     throws StopProcessingException

Description copied from interface: PreAuthorizationPlugin

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

Specified by:

processPostResource in interface PreAuthorizationPlugin

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.