com.exlibris.dps.sdk.registry

Interface ConverterRegistryPlugin

public interface ConverterRegistryPlugin

Interface for a ConverterRegistry plug-in type. The plugin converts a mets XMl to a different representation, in preparation for publishing. See PublisherRegistryPlugin for more information on the publishing process.
This plugin interface only supports java implementation.

Method Summary

Modifier and Type	Method and Description
java.lang.String	convert(java.lang.String ieXml) converts a given mets XML to a new representation.
void	initParam(java.util.Map<java.lang.String,java.lang.String> params) initializes parameters needed for the plugin
default boolean	isUnPublishRequired() If unPublish conversion is not required for the plugin, you should override isUnPublishRequired() and return false.
java.lang.String	unPublish(java.lang.String ieXml) Modifies a given mets XML prior to the unPublish action.

Method Detail

convert

java.lang.String convert(java.lang.String ieXml)

converts a given mets XML to a new representation.

Parameters:

ieXml - a mets XML

Returns:

the converted representation

initParam

void initParam(java.util.Map<java.lang.String,java.lang.String> params)

initializes parameters needed for the plugin

Parameters:

params - initialization parameters for the plugin.

unPublish

java.lang.String unPublish(java.lang.String ieXml)

Modifies a given mets XML prior to the unPublish action.
The unPublish action may be done by using a PublisherRegistryPlugin

Parameters:

ieXml - a mets XML

Returns:

the modified XML

isUnPublishRequired

default boolean isUnPublishRequired()

If unPublish conversion is not required for the plugin, you should
override isUnPublishRequired() and return false. It will benefit system performance.

Since:

Rosetta 7.2