org.codice.ddf.registry.identification

Class IdentificationPlugin

java.lang.Object

org.codice.ddf.registry.identification.IdentificationPlugin

All Implemented Interfaces:

PreIngestPlugin

public class IdentificationPlugin
extends Object
implements PreIngestPlugin

IdentificationPlugin is a Pre/PostIngestPlugin that assigns a localID when a metacard is added to the catalog and an originID to a registry metacard during creation. It also ensures that duplicate registry-ids are not added to the catalog.

Constructor Summary

Constructors

Constructor and Description
IdentificationPlugin(UuidGenerator uuidGenerator)

Method Summary

Modifier and Type	Method and Description
CreateRequest	process(CreateRequest input) For registry metacards updates the tags and identifiers
DeleteRequest	process(DeleteRequest input) Processes the DeleteRequest prior to the execution of the update operation.
UpdateRequest	process(UpdateRequest input) For registry metacards verifies the update should take place by checking that the update metacard is at least as up to date as the existing one.
void	setMetacardMarshaller(MetacardMarshaller helper)
void	setRegistryIdPostIngestPlugin(RegistryIdPostIngestPlugin registryIdPostIngestPlugin)

Methods inherited from class java.lang.Object

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

Constructor Detail

IdentificationPlugin

public IdentificationPlugin(UuidGenerator uuidGenerator)

Method Detail

process

public CreateRequest process(CreateRequest input)
                      throws PluginExecutionException,
                             StopProcessingException

For registry metacards updates the tags and identifiers

Specified by:

process in interface PreIngestPlugin

Parameters:

input - the CreateRequest to process

Returns:

Throws:

PluginExecutionException

StopProcessingException

process

public UpdateRequest process(UpdateRequest input)
                      throws PluginExecutionException,
                             StopProcessingException

For registry metacards verifies the update should take place by checking that the update metacard is at least as up to date as the existing one. Also updates the tags, identifiers, and transient attributes of the updated metacard.

Specified by:

process in interface PreIngestPlugin

Parameters:

input - the UpdateRequest to process

Returns:

Throws:

PluginExecutionException

StopProcessingException

process

public DeleteRequest process(DeleteRequest input)
                      throws PluginExecutionException,
                             StopProcessingException

Description copied from interface: PreIngestPlugin

Processes the DeleteRequest prior to the execution of the update operation.

Specified by:

process in interface PreIngestPlugin

Parameters:

input - the DeleteRequest to process

Returns:

the value of the processed DeleteRequest to pass to the next PreIngestPlugin, or if this is the last PreIngestPlugin to be called

Throws:

PluginExecutionException - thrown when an error in processing occurs

StopProcessingException

setMetacardMarshaller

public void setMetacardMarshaller(MetacardMarshaller helper)

setRegistryIdPostIngestPlugin

public void setRegistryIdPostIngestPlugin(RegistryIdPostIngestPlugin registryIdPostIngestPlugin)