Package org.mycore.sword.application

Interface MCRSwordIngester

All Superinterfaces:

MCRSwordLifecycle

public interface MCRSwordIngester
extends MCRSwordLifecycle

Let the application decide how to add metadata and resources. Useful functions e.g. extract ZIP files can be found in MCRSwordUtil.

Method Summary

Modifier and Type	Method	Description
MCRObjectID	ingestMetadata(org.swordapp.server.Deposit entry)	Will be called when the client tries to deposit an object with metadata.
MCRObjectID	ingestMetadataResources(org.swordapp.server.Deposit entry)	Will be called when the client tries to deposit an object with metadata and resources.
void	ingestResource(MCRObject object, org.swordapp.server.Deposit entry)	Will be called when the client tries to add resources to an existing object.
void	updateMetadata(MCRObject object, org.swordapp.server.Deposit entry, boolean replace)	Will be called when the client tries to update the metadata or replace existing metadata
void	updateMetadataResources(MCRObject object, org.swordapp.server.Deposit entry)	Will be called when the client tries to update the metadata and resources.

Methods inherited from interface org.mycore.sword.application.MCRSwordLifecycle

destroy, init

Method Details

ingestMetadata

MCRObjectID ingestMetadata(org.swordapp.server.Deposit entry)
                    throws org.swordapp.server.SwordError,
org.swordapp.server.SwordServerException

Will be called when the client tries to deposit an object with metadata.

Parameters:

entry - the entry with metadata which should be added

Returns:

object id for the new created object

Throws:

org.swordapp.server.SwordError

org.swordapp.server.SwordServerException

ingestMetadataResources

MCRObjectID ingestMetadataResources(org.swordapp.server.Deposit entry)
                             throws org.swordapp.server.SwordError,
org.swordapp.server.SwordServerException

Will be called when the client tries to deposit an object with metadata and resources.

Parameters:

entry - the entry with metadata and resources which should be added

Returns:

object id for the new created object

Throws:

org.swordapp.server.SwordError

org.swordapp.server.SwordServerException

ingestResource

void ingestResource(MCRObject object,
 org.swordapp.server.Deposit entry)
             throws org.swordapp.server.SwordError,
org.swordapp.server.SwordServerException

Will be called when the client tries to add resources to an existing object.

Parameters:

object - where the resources should be added

entry - which contains the resources

Throws:

org.swordapp.server.SwordError

org.swordapp.server.SwordServerException

updateMetadata

void updateMetadata(MCRObject object,
 org.swordapp.server.Deposit entry,
 boolean replace)
             throws org.swordapp.server.SwordError,
org.swordapp.server.SwordServerException

Will be called when the client tries to update the metadata or replace existing metadata

Parameters:

object - where metadata should be added or replaced

entry - which contains metadata

replace - indicates whether metadata should be added or replaced

Throws:

org.swordapp.server.SwordError

org.swordapp.server.SwordServerException

updateMetadataResources

void updateMetadataResources(MCRObject object,
 org.swordapp.server.Deposit entry)
                      throws org.swordapp.server.SwordError,
org.swordapp.server.SwordServerException

Will be called when the client tries to update the metadata and resources.

Parameters:

object - where metadata and resources should be replaced

entry - which contains metadata and reources

Throws:

org.swordapp.server.SwordError

org.swordapp.server.SwordServerException