Package org.dspace.identifier

Class IdentifierServiceImpl

java.lang.Object

org.dspace.identifier.IdentifierServiceImpl

All Implemented Interfaces:

IdentifierService

public class IdentifierServiceImpl
extends Object
implements IdentifierService

The main service class used to reserve, register and resolve identifiers

Author:

Fabio Bolognesi (fabio at atmire dot com), Mark Diggory (markd at atmire dot com), Ben Bosman (ben at atmire dot com)

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentServiceFactory	contentServiceFactory
protected HandleService	handleService

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	IdentifierServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	delete(Context context, DSpaceObject dso)	Delete (Unbind) all identifiers registered for a specific DSpace item.
void	delete(Context context, DSpaceObject dso, String identifier)	Used to Delete a Specific Identifier (for example a Handle, hdl:1234.5/6) The provider is responsible for Detecting and Processing the appropriate identifier, all Providers are interrogated, multiple providers can process the same identifier.
List<IdentifierProvider>	getProviders()	Get List of currently enabled IdentifierProviders
List<String>	lookup(Context context, DSpaceObject dso)	Gets the identifiers all registered IdentifierProvider returns if asked to lookup the provided DSpaceObject.
String	lookup(Context context, DSpaceObject dso, Class<? extends Identifier> identifier)	Get an identifier for a given object which is assignment-compatible with a given Identifier type.
void	register(Context context, DSpaceObject dso)	Used to register newly-minted identifiers.
void	register(Context context, DSpaceObject dso, Class<? extends Identifier> type)	Register identifier(s) for the given DSO just with providers that support that Identifier class, and apply the given filter if that provider extends FilteredIdentifierProvider
void	register(Context context, DSpaceObject dso, Class<? extends Identifier> type, Filter filter)	Register identifier(s) for the given DSO just with providers that support that Identifier class, and apply the given filter if that provider extends FilteredIdentifierProvider
void	register(Context context, DSpaceObject object, String identifier)	Used to Register a specific Identifier (for example a Handle, hdl:1234.5/6).
void	register(Context context, DSpaceObject dso, Map<Class<? extends Identifier>,Filter> typeFilters)	Register identifiers for a DSO, with a map of logical filters for each Identifier class to apply at the time of local registration.
void	reserve(Context context, DSpaceObject dso)	Reserves identifiers for the item
void	reserve(Context context, DSpaceObject dso, String identifier)	Used to Reserve a Specific Identifier (for example a Handle, hdl:1234.5/6) The provider is responsible for Detecting and Processing the appropriate identifier, all Providers are interrogated, multiple providers can process the same identifier.
DSpaceObject	resolve(Context context, String identifier)	This will resolve a DSpaceObject based on a provided Identifier.
void	setProviders(List<IdentifierProvider> providers)

Methods inherited from class java.lang.Object

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

Field Details

contentServiceFactory

@Autowired(required=true)
protected ContentServiceFactory contentServiceFactory

handleService

@Autowired(required=true)
protected HandleService handleService

Constructor Details

IdentifierServiceImpl

protected IdentifierServiceImpl()

Method Details

setProviders

@Autowired(required=true)
public void setProviders(List<IdentifierProvider> providers)

getProviders

public List<IdentifierProvider> getProviders()

Description copied from interface: IdentifierService

Get List of currently enabled IdentifierProviders

Specified by:

getProviders in interface IdentifierService

Returns:

List of enabled IdentifierProvider objects.

reserve

public void reserve(Context context,
 DSpaceObject dso)
             throws AuthorizeException,
SQLException,
IdentifierException

Reserves identifiers for the item

Specified by:

reserve in interface IdentifierService

Parameters:

context - dspace context

dso - dspace object

Throws:

AuthorizeException - if authorization error

SQLException - if database error

IdentifierException - if identifier error

reserve

public void reserve(Context context,
 DSpaceObject dso,
 String identifier)
             throws AuthorizeException,
SQLException,
IdentifierException

Description copied from interface: IdentifierService

Used to Reserve a Specific Identifier (for example a Handle, hdl:1234.5/6) The provider is responsible for Detecting and Processing the appropriate identifier, all Providers are interrogated, multiple providers can process the same identifier.

Specified by:

reserve in interface IdentifierService

Parameters:

context - The relevant DSpace Context.

dso - DSpace object to be reserved

identifier - instance of an Identifier of the required type.

Throws:

AuthorizeException - if authorization error

SQLException - if database error

IdentifierException - if identifier error

register

public void register(Context context,
 DSpaceObject dso)
              throws AuthorizeException,
SQLException,
IdentifierException

Description copied from interface: IdentifierService

Used to register newly-minted identifiers. Each provider is responsible for creating the appropriate identifier. All providers are interrogated.

Specified by:

register in interface IdentifierService

Parameters:

context - The relevant DSpace Context.

dso - DSpace object to be registered

Throws:

AuthorizeException - if authorization error

SQLException - if database error

IdentifierException - if identifier error

register

public void register(Context context,
 DSpaceObject dso,
 Class<? extends Identifier> type,
 Filter filter)
              throws AuthorizeException,
SQLException,
IdentifierException

Description copied from interface: IdentifierService

Register identifier(s) for the given DSO just with providers that support that Identifier class, and apply the given filter if that provider extends FilteredIdentifierProvider

Specified by:

register in interface IdentifierService

Parameters:

context - The relevant DSpace Context.

dso - DSpace object to be registered

type - Type of identifier to register

filter - If a service supports a given Identifier implementation, apply this specific filter

Throws:

AuthorizeException - if authorization error

SQLException - if database error

IdentifierException - if identifier error

register

public void register(Context context,
 DSpaceObject dso,
 Class<? extends Identifier> type)
              throws AuthorizeException,
SQLException,
IdentifierException

Description copied from interface: IdentifierService

Register identifier(s) for the given DSO just with providers that support that Identifier class, and apply the given filter if that provider extends FilteredIdentifierProvider

Specified by:

register in interface IdentifierService

Parameters:

context - The relevant DSpace Context.

dso - DSpace object to be registered

type - Type of identifier to register

Throws:

AuthorizeException - if authorization error

SQLException - if database error

IdentifierException - if identifier error

register

public void register(Context context,
 DSpaceObject dso,
 Map<Class<? extends Identifier>,Filter> typeFilters)
              throws AuthorizeException,
SQLException,
IdentifierException

Description copied from interface: IdentifierService

Register identifiers for a DSO, with a map of logical filters for each Identifier class to apply at the time of local registration.

Specified by:

register in interface IdentifierService

Parameters:

context - The relevant DSpace Context.

dso - DSpace object to be registered

typeFilters - If a service supports a given Identifier implementation, apply the associated filter

Throws:

AuthorizeException - if authorization error

SQLException - if database error

IdentifierException - if identifier error

register

public void register(Context context,
 DSpaceObject object,
 String identifier)
              throws AuthorizeException,
SQLException,
IdentifierException

Description copied from interface: IdentifierService

Used to Register a specific Identifier (for example a Handle, hdl:1234.5/6). The provider is responsible for detecting and processing the appropriate identifier. All Providers are interrogated. Multiple providers can process the same identifier.

Specified by:

register in interface IdentifierService

Parameters:

context - The relevant DSpace Context.

object - DSpace object to be registered

identifier - instance of an Identifier of the required type.

Throws:

AuthorizeException - if authorization error

SQLException - if database error

IdentifierException - if identifier error

lookup

public String lookup(Context context,
 DSpaceObject dso,
 Class<? extends Identifier> identifier)

Description copied from interface: IdentifierService

Get an identifier for a given object which is assignment-compatible with a given Identifier type.

Specified by:

lookup in interface IdentifierService

Parameters:

context - The relevant DSpace Context.

dso - the object to be identified.

identifier - instance of an Identifier of the required type.

Returns:

the matching identifier, or the site identifier if the object is a Site, or null if no matching identifier is found.

lookup

public List<String> lookup(Context context,
 DSpaceObject dso)

Description copied from interface: IdentifierService

Gets the identifiers all registered IdentifierProvider returns if asked to lookup the provided DSpaceObject.

Specified by:

lookup in interface IdentifierService

Parameters:

context - The relevant DSpace Context.

dso - the object to be identified.

Returns:

the matching identifiers, or the site identifier if the object is a Site, or an empty array if no matching identifier is found.

resolve

public DSpaceObject resolve(Context context,
 String identifier)
                     throws IdentifierNotFoundException,
IdentifierNotResolvableException

Description copied from interface: IdentifierService

This will resolve a DSpaceObject based on a provided Identifier. The Service will interrogate the providers in no particular order and return the first successful result discovered. If no resolution is successful, the method will return null if no object is found. TODO: Verify null is returned.

Specified by:

resolve in interface IdentifierService

Parameters:

context - The relevant DSpace Context.

identifier - instance of an Identifier of the required type.

Returns:

the DSpace object associated with the identifier

Throws:

IdentifierNotFoundException - if identifier not found

IdentifierNotResolvableException - if identifier not resolvable

delete

public void delete(Context context,
 DSpaceObject dso)
            throws AuthorizeException,
SQLException,
IdentifierException

Description copied from interface: IdentifierService

Delete (Unbind) all identifiers registered for a specific DSpace item. Identifiers are "unbound" across all providers in no particular order.

Specified by:

delete in interface IdentifierService

Parameters:

context - The relevant DSpace Context.

dso - DSpace object to be deleted

Throws:

AuthorizeException - if authorization error

SQLException - if database error

IdentifierException - if identifier error

delete

public void delete(Context context,
 DSpaceObject dso,
 String identifier)
            throws AuthorizeException,
SQLException,
IdentifierException

Description copied from interface: IdentifierService

Used to Delete a Specific Identifier (for example a Handle, hdl:1234.5/6) The provider is responsible for Detecting and Processing the appropriate identifier, all Providers are interrogated, multiple providers can process the same identifier.

Specified by:

delete in interface IdentifierService

Parameters:

context - The relevant DSpace Context.

dso - DSpace object to be deleted

identifier - instance of an Identifier of the required type.

Throws:

AuthorizeException - if authorization error

SQLException - if database error

IdentifierException - if identifier error