ddf.catalog.metacard.versioning

Class HistorianPolicyPlugin

java.lang.Object

ddf.catalog.metacard.versioning.HistorianPolicyPlugin

All Implemented Interfaces:

PolicyPlugin

public class HistorianPolicyPlugin
extends Object
implements PolicyPlugin

HistorianPolicyPlugin prevents anyone without the HISTORY_ROLE from modifying a MetacardVersion in any way.

Field Summary

Fields

Modifier and Type	Field and Description
static String	HISTORY_ROLE
static String	ROLE_CLAIM

Fields inherited from interface ddf.catalog.plugin.PolicyPlugin

OPERATION_SECURITY

Constructor Summary

Constructors

Constructor and Description
HistorianPolicyPlugin()

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

Methods inherited from class java.lang.Object

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

Field Detail

HISTORY_ROLE

public static final String HISTORY_ROLE

See Also:

Constant Field Values

ROLE_CLAIM

public static final String ROLE_CLAIM

See Also:

Constant Field Values

Constructor Detail

HistorianPolicyPlugin

public HistorianPolicyPlugin()

Method Detail

processPreCreate

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

Description copied from interface: PolicyPlugin

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

Specified by:

processPreCreate in interface PolicyPlugin

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

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

Description copied from interface: PolicyPlugin

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

Specified by:

processPreUpdate in interface PolicyPlugin

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

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

Description copied from interface: PolicyPlugin

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

Specified by:

processPreDelete in interface PolicyPlugin

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

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

Description copied from interface: PolicyPlugin

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

Specified by:

processPostDelete in interface PolicyPlugin

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

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

Description copied from interface: PolicyPlugin

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

Specified by:

processPreQuery in interface PolicyPlugin

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

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

Description copied from interface: PolicyPlugin

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

Specified by:

processPostQuery in interface PolicyPlugin

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

public PolicyResponse processPreResource(ResourceRequest resourceRequest)
                                  throws StopProcessingException

Description copied from interface: PolicyPlugin

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

Specified by:

processPreResource in interface PolicyPlugin

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

public PolicyResponse processPostResource(ResourceResponse resourceResponse,
                                          Metacard metacard)
                                   throws StopProcessingException

Description copied from interface: PolicyPlugin

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

Specified by:

processPostResource in interface PolicyPlugin

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.