org.codice.ddf.catalog.security.policy.xml

Class XmlAttributeSecurityPolicyPlugin

java.lang.Object

org.codice.ddf.catalog.security.policy.xml.XmlAttributeSecurityPolicyPlugin

All Implemented Interfaces:

PolicyPlugin

public class XmlAttributeSecurityPolicyPlugin
extends Object
implements PolicyPlugin

Plugin that parses XML metadata for elements that contain attributes with security policy information

Field Summary

Fields inherited from interface ddf.catalog.plugin.PolicyPlugin

OPERATION_SECURITY

Constructor Summary

Constructors

Constructor and Description
XmlAttributeSecurityPolicyPlugin()

Method Summary

Modifier and Type	Method and Description
List<String>	getSecurityAttributeIntersections()
List<String>	getSecurityAttributeUnions()
List<String>	getXmlElements()
Map<String,Set<String>>	parseSecurityMetadata(Metacard metacard) Parse XML metadata using StAX to find the security element
PolicyResponse	processPostDelete(Metacard metacard, Map<String,Serializable> map) Processes a Metacard, following the execution of ddf.catalog.source.CatalogProvider#delete(ddf.catalog.operation.DeleteRequest), to return policy information
PolicyResponse	processPostQuery(Result result, Map<String,Serializable> map) 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 metacard, Map<String,Serializable> map) Processes a Metacard, prior to ddf.catalog.source.CatalogProvider#create(ddf.catalog.operation.CreateRequest), to return policy information
PolicyResponse	processPreDelete(List<Metacard> list, Map<String,Serializable> map) 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> map) 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 metacard, Map<String,Serializable> map) Processes a Metacard, prior to ddf.catalog.source.CatalogProvider#update(ddf.catalog.operation.UpdateRequest), to return policy information
void	setSecurityAttributeIntersections(List<String> securityAttributeIntersections)
void	setSecurityAttributeUnions(List<String> securityAttributeUnions)
void	setXmlElements(List<String> xmlElements)

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlAttributeSecurityPolicyPlugin

public XmlAttributeSecurityPolicyPlugin()

Method Detail

parseSecurityMetadata

public Map<String,Set<String>> parseSecurityMetadata(Metacard metacard)

Parse XML metadata using StAX to find the security element

Parameters:

metacard - XML metadata to parse

getXmlElements

public List<String> getXmlElements()

setXmlElements

public void setXmlElements(List<String> xmlElements)

getSecurityAttributeUnions

public List<String> getSecurityAttributeUnions()

setSecurityAttributeUnions

public void setSecurityAttributeUnions(List<String> securityAttributeUnions)

getSecurityAttributeIntersections

public List<String> getSecurityAttributeIntersections()

setSecurityAttributeIntersections

public void setSecurityAttributeIntersections(List<String> securityAttributeIntersections)

processPreCreate

public PolicyResponse processPreCreate(Metacard metacard,
                                       Map<String,Serializable> map)
                                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:

metacard - the Metacard to process

map - 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 metacard,
                                       Map<String,Serializable> map)
                                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:

metacard - the new Metacard to process

map - 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> list,
                                       Map<String,Serializable> map)
                                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:

list - the list of metacards being deleted

map - 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 metacard,
                                        Map<String,Serializable> map)
                                 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:

metacard - the Metacard to process

map - 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> map)
                               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

map - 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 result,
                                       Map<String,Serializable> map)
                                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:

result - the Result to process

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