org.codice.ddf.catalog.plugin.metacard

Class MetacardIngestNetworkPlugin

java.lang.Object

org.codice.ddf.catalog.plugin.metacard.MetacardIngestNetworkPlugin

All Implemented Interfaces:

PreAuthorizationPlugin

public class MetacardIngestNetworkPlugin
extends Object
implements PreAuthorizationPlugin

Conditional attribute adjustments for metacards based on IP, hostname, scheme, and context path.

The list of new attributes are parsed into a map whose key is the attribute name and attribute descriptor name, and value is the desired value of that attribute by the admin. If the value in the client-info map (populated by) at key "criteria key" is equal to the "expected value", then the plugin will attempt to add the list of new attributes to the metacards in the given request.

Any attribute already set on the metacards cannot be changed. Currently there is no support for appending new values within a multi-valued attribute onto an already existing one. As long as an attribute is not null, it cannot be overwritten.

See MetacardCondition for details on its immutability and volatility.

Constructor Summary

Constructors

Constructor and Description
MetacardIngestNetworkPlugin(KeyValueParser keyValueParser, MetacardServices metacardServices, AttributeFactory attributeFactory, MetacardCondition metacardCondition) Constructor requires all dependencies.

Method Summary

Modifier and Type	Method and Description
void	destroy() Method required by the component-managed strategy.
String	getCriteriaKey()
String	getExpectedValue()
List<String>	getNewAttributes()
void	init() Method required by the component-managed strategy.
DeleteResponse	processPostDelete(DeleteResponse input) Process a DeleteResponse for use cases that occur prior to security rules.
QueryResponse	processPostQuery(QueryResponse input) Process a QueryResponse for use cases that occur prior to security rules.
ResourceResponse	processPostResource(ResourceResponse input, Metacard metacard) Process a ResourceResponse for use cases that occur prior to security rules.
CreateRequest	processPreCreate(CreateRequest input) Process a CreateRequest for use cases that occur prior to security rules.
DeleteRequest	processPreDelete(DeleteRequest input) Process a DeleteRequest for use cases that occur prior to security rules.
QueryRequest	processPreQuery(QueryRequest input) Process a QueryRequest for use cases that occur prior to security rules.
ResourceRequest	processPreResource(ResourceRequest input) Process a ResourceRequest for use cases that occur prior to security rules.
UpdateRequest	processPreUpdate(UpdateRequest input, Map<String,Metacard> existingMetacards) Process an UpdateRequest for use cases that occur prior to security rules.
void	setCriteriaKey(String criteriaKey)
void	setExpectedValue(String expectedValue)
void	setNewAttributes(List<String> newAttributes)
void	updateCondition(Map<String,Object> properties) Atomically update the condition so that ingest rules are not evaluated based on an invalid rule.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetacardIngestNetworkPlugin

public MetacardIngestNetworkPlugin(KeyValueParser keyValueParser,
                                   MetacardServices metacardServices,
                                   AttributeFactory attributeFactory,
                                   MetacardCondition metacardCondition)

Constructor requires all dependencies.

Method Detail

getCriteriaKey

public String getCriteriaKey()

getExpectedValue

public String getExpectedValue()

getNewAttributes

public List<String> getNewAttributes()

setCriteriaKey

public void setCriteriaKey(String criteriaKey)

setExpectedValue

public void setExpectedValue(String expectedValue)

setNewAttributes

public void setNewAttributes(List<String> newAttributes)

init

public void init()

Method required by the component-managed strategy. Performs set-up based on initial values passed to the service.

destroy

public void destroy()

Method required by the component-managed strategy.

updateCondition

public void updateCondition(Map<String,Object> properties)

Atomically update the condition so that ingest rules are not evaluated based on an invalid rule.

processPreCreate

public CreateRequest processPreCreate(CreateRequest input)
                               throws StopProcessingException

Description copied from interface: PreAuthorizationPlugin

Process a CreateRequest for use cases that occur prior to security rules.

Specified by:

processPreCreate in interface PreAuthorizationPlugin

Parameters:

input - the CreateRequest to process

Returns:

the value of the processed CreateRequest to pass to the next PreAuthorizationPlugin

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: PreAuthorizationPlugin

Process an UpdateRequest for use cases that occur prior to security rules.

Specified by:

processPreUpdate in interface PreAuthorizationPlugin

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 PreAuthorizationPlugin

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: PreAuthorizationPlugin

Process a DeleteRequest for use cases that occur prior to security rules.

Specified by:

processPreDelete in interface PreAuthorizationPlugin

Parameters:

input - the DeleteRequest to process

Returns:

the value of the processed DeleteRequest to pass to the next PreAuthorizationPlugin

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: PreAuthorizationPlugin

Process a DeleteResponse for use cases that occur prior to security rules.

Specified by:

processPostDelete in interface PreAuthorizationPlugin

Parameters:

input - the DeleteResponse to process

Returns:

the value of the processed DeleteResponse to pass to the next PreAuthorizationPlugin

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: PreAuthorizationPlugin

Process a QueryRequest for use cases that occur prior to security rules.

Specified by:

processPreQuery in interface PreAuthorizationPlugin

Parameters:

input - the QueryRequest to process

Returns:

the value of the processed QueryRequest to pass to the next PreAuthorizationPlugin

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: PreAuthorizationPlugin

Process a QueryResponse for use cases that occur prior to security rules.

Specified by:

processPostQuery in interface PreAuthorizationPlugin

Parameters:

input - the QueryResponse to process

Returns:

the value of the processed QueryResponse to pass to the next PreAuthorizationPlugin

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: PreAuthorizationPlugin

Process a ResourceRequest for use cases that occur prior to security rules.

Specified by:

processPreResource in interface PreAuthorizationPlugin

Parameters:

input - the ResourceRequest to process

Returns:

the value of the processed QueryRequest to pass to the next PreAuthorizationPlugin

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: PreAuthorizationPlugin

Process a ResourceResponse for use cases that occur prior to security rules.

Specified by:

processPostResource in interface PreAuthorizationPlugin

Parameters:

input - the ResourceResponse to process

Returns:

the value of the processed ResourceResponse to pass to the next PreAuthorizationPlugin

Throws:

StopProcessingException - thrown to halt processing when a critical issue occurs during processing. This is intended to prevent other plugins from processing as well.