org.codice.ddf.registry.policy

Class RegistryPolicyPlugin

java.lang.Object

org.codice.ddf.registry.policy.RegistryPolicyPlugin

All Implemented Interfaces:

PolicyPlugin

public class RegistryPolicyPlugin
extends Object
implements PolicyPlugin

Field Summary

Fields inherited from interface ddf.catalog.plugin.PolicyPlugin

OPERATION_SECURITY

Constructor Summary

Constructors

Constructor and Description
RegistryPolicyPlugin()

Method Summary

Modifier and Type	Method and Description
Map<String,Set<String>>	getBypassAccessPolicy()
Map<String,Set<String>>	getCreateAccessPolicy()
Map<String,Set<String>>	getDeleteAccessPolicy()
Map<String,Set<String>>	getReadAccessPolicy()
Set<String>	getRegistryEntryIds() Get a string set of the federation service ids allowed to be queried
Map<String,Set<String>>	getUpdateAccessPolicy()
void	init()
boolean	isRegistryDisabled()
boolean	isWhiteList()
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 input, Map<String,Serializable> properties) Processes a Metacard, prior to ddf.catalog.source.CatalogProvider#update(ddf.catalog.operation.UpdateRequest), to return policy information
void	setCreateAccessPolicyStrings(List<String> accessPolicyStrings)
void	setDeleteAccessPolicyStrings(List<String> accessPolicyStrings)
void	setReadAccessPolicyStrings(List<String> readAccessPolicyStrings)
void	setRegistryBypassPolicyStrings(List<String> permStrings) Setter used by the ui to set the permissions/attributes
void	setRegistryDisabled(boolean registryDisabled)
void	setRegistryEntryIds(Set<String> registryEntryIds) Setter for the list of allowed federation service ids.
void	setUpdateAccessPolicyStrings(List<String> accessPolicyStrings)
void	setWhiteList(boolean whiteList) Sets the whether or not the registry entry ids list is a 'white list' or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

RegistryPolicyPlugin

public RegistryPolicyPlugin()

Method Detail

init

public void init()

isWhiteList

public boolean isWhiteList()

Returns:

Returns true if the registry entry ids represents a set of 'white listed' entries. Default is false.

setWhiteList

public void setWhiteList(boolean whiteList)

Sets the whether or not the registry entry ids list is a 'white list' or not.

Parameters:

whiteList - boolean value for whiteList

getRegistryEntryIds

public Set<String> getRegistryEntryIds()

Get a string set of the federation service ids allowed to be queried

Returns:

A set of registry entry id strings

setRegistryEntryIds

public void setRegistryEntryIds(Set<String> registryEntryIds)

Setter for the list of allowed federation service ids. All registry ids in this list will be allowed to be queried and returned

Parameters:

registryEntryIds - Set of registry entry ids

isRegistryDisabled

public boolean isRegistryDisabled()

setRegistryDisabled

public void setRegistryDisabled(boolean registryDisabled)

setCreateAccessPolicyStrings

public void setCreateAccessPolicyStrings(List<String> accessPolicyStrings)

setUpdateAccessPolicyStrings

public void setUpdateAccessPolicyStrings(List<String> accessPolicyStrings)

setDeleteAccessPolicyStrings

public void setDeleteAccessPolicyStrings(List<String> accessPolicyStrings)

setReadAccessPolicyStrings

public void setReadAccessPolicyStrings(List<String> readAccessPolicyStrings)

setRegistryBypassPolicyStrings

public void setRegistryBypassPolicyStrings(List<String> permStrings)

Setter used by the ui to set the permissions/attributes

Parameters:

permStrings - The list of bypass permissions

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 input,
                                       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:

input - 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.

getBypassAccessPolicy

public Map<String,Set<String>> getBypassAccessPolicy()

getCreateAccessPolicy

public Map<String,Set<String>> getCreateAccessPolicy()

getUpdateAccessPolicy

public Map<String,Set<String>> getUpdateAccessPolicy()

getDeleteAccessPolicy

public Map<String,Set<String>> getDeleteAccessPolicy()

getReadAccessPolicy

public Map<String,Set<String>> getReadAccessPolicy()