ddf.catalog.security.plugin

Class SecurityPlugin

java.lang.Object

ddf.catalog.security.plugin.SecurityPlugin

All Implemented Interfaces:

AccessPlugin

public class SecurityPlugin
extends Object
implements AccessPlugin

Security-based plugin that looks for a subject using SecurityUtils and adds it to the current operation's properties map.

Constructor Summary

Constructors

Constructor and Description
SecurityPlugin()

Method Summary

Modifier and Type	Method and 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

Methods inherited from class java.lang.Object

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

Constructor Detail

SecurityPlugin

public SecurityPlugin()

Method Detail

processPreCreate

public CreateRequest processPreCreate(CreateRequest input)
                               throws StopProcessingException

Description copied from interface: AccessPlugin

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

Specified by:

processPreCreate in interface AccessPlugin

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

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

Description copied from interface: AccessPlugin

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

Specified by:

processPreUpdate in interface AccessPlugin

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

public DeleteRequest processPreDelete(DeleteRequest input)
                               throws StopProcessingException

Description copied from interface: AccessPlugin

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

Specified by:

processPreDelete in interface AccessPlugin

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

public DeleteResponse processPostDelete(DeleteResponse input)
                                 throws StopProcessingException

Description copied from interface: AccessPlugin

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

Specified by:

processPostDelete in interface AccessPlugin

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

public QueryRequest processPreQuery(QueryRequest input)
                             throws StopProcessingException

Description copied from interface: AccessPlugin

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

Specified by:

processPreQuery in interface AccessPlugin

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

public QueryResponse processPostQuery(QueryResponse input)
                               throws StopProcessingException

Description copied from interface: AccessPlugin

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

Specified by:

processPostQuery in interface AccessPlugin

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

public ResourceRequest processPreResource(ResourceRequest input)
                                   throws StopProcessingException

Description copied from interface: AccessPlugin

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

Specified by:

processPreResource in interface AccessPlugin

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

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

Description copied from interface: AccessPlugin

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

Specified by:

processPostResource in interface AccessPlugin

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.