ddf.catalog.plugin

Interface PolicyPlugin

All Known Implementing Classes:

CatalogPolicy, FilterPostQueryPlugin, HistorianPolicyPlugin, MetacardAttributeSecurityPolicyPlugin, MetacardValidityFilterPlugin, PointOfContactPolicyPlugin, RegistryPolicyPlugin, ResourceUriPolicy, WorkspaceSharingPolicyPlugin, XmlAttributeSecurityPolicyPlugin

public interface PolicyPlugin

A PolicyPlugin is used to build policy information regarding the Catalog action a user is attempting.

The PolicyResponse object contains 1 or more policy objects of the type: Map>. Where the key is some attribute that you wish to assert against a Subject and Set would be the values associated with that key.

Field Summary

Fields

Modifier and Type	Field and Description
static String	OPERATION_SECURITY

Method Summary

Modifier and Type	Method and Description
PolicyResponse	processPostDelete(Metacard input, Map<String,Serializable> properties) Processes a Metacard, following the execution of ddf.catalog.source.CatalogProvider#delete(ddf.catalog.operation.DeleteRequest), to return policy information
PolicyResponse	processPostQuery(Result input, Map<String,Serializable> properties) Processes a Result, following the execution of the Query, to return policy information
PolicyResponse	processPostResource(ResourceResponse resourceResponse, Metacard metacard) Processes a ResourceResponse, following the execution of the ResourceRequest, to return policy information
PolicyResponse	processPreCreate(Metacard input, Map<String,Serializable> properties) Processes a Metacard, prior to ddf.catalog.source.CatalogProvider#create(ddf.catalog.operation.CreateRequest), to return policy information
PolicyResponse	processPreDelete(List<Metacard> metacards, Map<String,Serializable> properties) Processes a DeleteRequest, prior to ddf.catalog.source.CatalogProvider#delete(ddf.catalog.operation.DeleteRequest), to return policy information
PolicyResponse	processPreQuery(Query query, Map<String,Serializable> properties) Processes a Query, prior to execution of the Query, to return policy information
PolicyResponse	processPreResource(ResourceRequest resourceRequest) Processes a ResourceRequest, prior to execution of the ResourceRequest, to return policy information
PolicyResponse	processPreUpdate(Metacard newMetacard, Map<String,Serializable> properties) Processes a Metacard, prior to ddf.catalog.source.CatalogProvider#update(ddf.catalog.operation.UpdateRequest), to return policy information

Field Detail

OPERATION_SECURITY

static final String OPERATION_SECURITY

See Also:

Constant Field Values

Method Detail

processPreCreate

PolicyResponse processPreCreate(Metacard input,
                                Map<String,Serializable> properties)
                         throws StopProcessingException

Processes a Metacard, prior to ddf.catalog.source.CatalogProvider#create(ddf.catalog.operation.CreateRequest), to return policy information

Parameters:

input - the Metacard to process

properties - the request properties

Returns:

policy information to pass to the 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

PolicyResponse processPreUpdate(Metacard newMetacard,
                                Map<String,Serializable> properties)
                         throws StopProcessingException

Processes a Metacard, prior to ddf.catalog.source.CatalogProvider#update(ddf.catalog.operation.UpdateRequest), to return policy information

Parameters:

newMetacard - the new Metacard to process

properties - the request properties

Returns:

policy information to pass to the 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

PolicyResponse processPreDelete(List<Metacard> metacards,
                                Map<String,Serializable> properties)
                         throws StopProcessingException

Processes a DeleteRequest, prior to ddf.catalog.source.CatalogProvider#delete(ddf.catalog.operation.DeleteRequest), to return policy information

Parameters:

metacards - the list of metacards being deleted

properties - the request properties

Returns:

policy information to pass to the 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

PolicyResponse processPostDelete(Metacard input,
                                 Map<String,Serializable> properties)
                          throws StopProcessingException

Processes a Metacard, following the execution of ddf.catalog.source.CatalogProvider#delete(ddf.catalog.operation.DeleteRequest), to return policy information

Parameters:

input - the Metacard to process

properties - the request properties

Returns:

policy information to pass to the 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

PolicyResponse processPreQuery(Query query,
                               Map<String,Serializable> properties)
                        throws StopProcessingException

Processes a Query, prior to execution of the Query, to return policy information

Parameters:

query - the Query to process

properties - the request properties

Returns:

policy information to pass to the 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

PolicyResponse processPostQuery(Result input,
                                Map<String,Serializable> properties)
                         throws StopProcessingException

Processes a Result, following the execution of the Query, to return policy information

Parameters:

input - the Result to process

properties - the request properties

Returns:

policy information to pass to the 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

PolicyResponse processPreResource(ResourceRequest resourceRequest)
                           throws StopProcessingException

Processes a ResourceRequest, prior to execution of the ResourceRequest, to return policy information

Parameters:

resourceRequest - the ResourceRequest to process

Returns:

policy information to pass to the 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

PolicyResponse processPostResource(ResourceResponse resourceResponse,
                                   Metacard metacard)
                            throws StopProcessingException

Processes a ResourceResponse, following the execution of the ResourceRequest, to return policy information

Parameters:

resourceResponse - the ResourceResponse to process

metacard - the Metacard related to the response

Returns:

policy information to pass to the 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.