EZIDIdentifierProvider (DSpace Kernel :: API and Implementation 6.1 API)

java.lang.Object
- org.dspace.identifier.IdentifierProvider
- - org.dspace.identifier.EZIDIdentifierProvider

```
public class EZIDIdentifierProvider
extends IdentifierProvider
```
Provide service for DOIs through DataCite using the EZID service.
Configuration of this class is is in two parts.

Installation-specific configuration (credentials and the "shoulder" value which forms a prefix of the site's DOIs) is supplied from property files in [DSpace]/config**.

identifier.doi.ezid.shoulder

base of the site's DOIs. Example: 10.5072/FK2

identifier.doi.ezid.user

EZID username.

identifier.doi.ezid.password

EZID password.

identifier.doi.ezid.publisher

A default publisher, for Items not previously published. EZID requires a publisher.

Then there are properties injected using Spring:
- There is a Map (with the property name "crosswalk") from EZID metadata field names into DSpace field names, injected by Spring. Specify the fully-qualified names of all metadata fields to be looked up on a DSpace object and their values set on mapped fully-qualified names in the object's DataCite metadata.
- A second map ("crosswalkTransform") provides Transform instances mapped from EZID metadata field names. This allows the crosswalk to rewrite field values where the form maintained by DSpace is not directly usable in EZID metadata.
- Optional: A boolean property ("generateDataciteXML") that controls the creation and inclusion of DataCite xml schema during the metadata crosswalking. The default "DataCite" dissemination plugin uses DIM2DataCite.xsl for crosswalking. Default value: false.
- Optional: A string property ("disseminationCrosswalkName") that can be used to set the name of the dissemination crosswalk plugin for metadata crosswalking. Default value: "DataCite".
Author:

mwood

Field Summary

Fields
Modifier and Type	Field and Description
`protected ContentServiceFactory`	`contentServiceFactory`
`protected String`	`DATACITE_XML_CROSSWALK`
`static String`	`DOI_ELEMENT`
`static String`	`DOI_QUALIFIER`
`protected boolean`	`GENERATE_DATACITE_XML`
`protected ItemService`	`itemService`
`static String`	`MD_SCHEMA`

Fields inherited from class org.dspace.identifier.IdentifierProvider
configurationService, parentService

Constructor Summary

Constructors
Constructor and Description

EZIDIdentifierProvider()

Constructors
Constructor and Description
`EZIDIdentifierProvider()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`delete(Context context, DSpaceObject dso)` Unbind this type of identifier(s) from an object.
`void`	`delete(Context context, DSpaceObject dso, String identifier)` Unbind the given identifier from an object.
`Map<String,String>`	`getCrosswalk()`
`EZIDRequestFactory`	`getRequestFactory()`
`String`	`lookup(Context context, DSpaceObject object)` Return the identifier for a DSpaceObject.
`String`	`mint(Context context, DSpaceObject dso)` Create an identifier for a DSpaceObject.
`String`	`register(Context context, DSpaceObject dso)` Create and apply an identifier to a DSpaceObject.
`void`	`register(Context context, DSpaceObject object, String identifier)` Create a specific identifier and apply it to an object.
`void`	`reserve(Context context, DSpaceObject dso, String identifier)` Set an object's identifier.
`DSpaceObject`	`resolve(Context context, String identifier, String... attributes)` Find the object named by a given identifier.
`void`	`setCrosswalk(Map<String,String> aCrosswalk)` Provide a map from DSO metadata keys to EZID keys.
`void`	`setCrosswalkTransform(Map<String,Transform> transformMap)` Provide a map from DSO metadata keys to classes which can transform their values to something acceptable to EZID.
`void`	`setDisseminationCrosswalkName(String DATACITE_XML_CROSSWALK)`
`void`	`setGenerateDataciteXML(boolean GENERATE_DATACITE_XML)`
`protected void`	`setItemService(ItemService itemService)` Method should never be used aside from the unit tests where we can cannot autowire this class.
`void`	`setRequestFactory(EZIDRequestFactory aRequestFactory)`
`boolean`	`supports(Class<? extends Identifier> identifier)` Can this provider provide identifiers of a given type?
`boolean`	`supports(String identifier)` Can this provider provide identifiers of a given type?

Methods inherited from class org.dspace.identifier.IdentifierProvider
setConfigurationService, setParentService

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MD_SCHEMA
```
public static final String MD_SCHEMA
```
    See Also:
    
    Constant Field Values
  - DOI_ELEMENT
```
public static final String DOI_ELEMENT
```
    See Also:
    
    Constant Field Values
  - DOI_QUALIFIER
```
public static final String DOI_QUALIFIER
```
  - GENERATE_DATACITE_XML
```
protected boolean GENERATE_DATACITE_XML
```
  - DATACITE_XML_CROSSWALK
```
protected String DATACITE_XML_CROSSWALK
```
  - contentServiceFactory
```
@Autowired(required=true)
protected ContentServiceFactory contentServiceFactory
```
  - itemService
```
@Autowired(required=true)
protected ItemService itemService
```
- Constructor Detail
  - EZIDIdentifierProvider
```
public EZIDIdentifierProvider()
```
- Method Detail
  - supports
```
public boolean supports(Class<? extends Identifier> identifier)
```
    Description copied from class: IdentifierProvider
    
    Can this provider provide identifiers of a given type?
    
    Specified by:
    
    supports in class IdentifierProvider
    
    Parameters:
    
    identifier - requested type.
    
    Returns:
    
    true if the given type is assignable from this provider's type.
  - supports
```
public boolean supports(String identifier)
```
    Description copied from class: IdentifierProvider
    
    Can this provider provide identifiers of a given type?
    
    Specified by:
    
    supports in class IdentifierProvider
    
    Parameters:
    
    identifier - requested type.
    
    Returns:
    
    true if this provider can provide the named type of identifier.
  - register
```
public String register(Context context,
                       DSpaceObject dso)
                throws IdentifierException
```
    Description copied from class: IdentifierProvider
    
    Create and apply an identifier to a DSpaceObject. If you just mark an identifier for an asynchronous registration, please call org.dspace.content.DSpaceObject#resetIdentifiersCache() after its registration. If you register identifiers directly in this method the IdentifierService will call this method for you.
    
    Specified by:
    
    register in class IdentifierProvider
    
    dso - object to be named.
    
    Returns:
    
    existing identifier of item if it has one, else a new identifier.
    
    Throws:
    
    IdentifierException - if identifier error
  - register
```
public void register(Context context,
                     DSpaceObject object,
                     String identifier)
```
    Description copied from class: IdentifierProvider
    
    Create a specific identifier and apply it to an object.
    
    Specified by:
    
    register in class IdentifierProvider
    
    object - to be identified.
    
    identifier - to be created.
  - reserve
```
public void reserve(Context context,
                    DSpaceObject dso,
                    String identifier)
             throws IdentifierException
```
    Description copied from class: IdentifierProvider
    
    Set an object's identifier.
    
    Specified by:
    
    reserve in class IdentifierProvider
    
    dso - object to be identified.
    
    identifier - to be set on the object.
    
    Throws:
    
    IdentifierException - if identifier error
  - mint
```
public String mint(Context context,
                   DSpaceObject dso)
            throws IdentifierException
```
    Description copied from class: IdentifierProvider
    
    Create an identifier for a DSpaceObject.
    
    Specified by:
    
    mint in class IdentifierProvider
    
    dso - object to be named.
    
    Returns:
    
    existing identifier of dso if it has one, else a new identifier.
    
    Throws:
    
    IdentifierException - if identifier error
  - resolve
```
public DSpaceObject resolve(Context context,
                            String identifier,
                            String... attributes)
                     throws IdentifierNotFoundException,
                            IdentifierNotResolvableException
```
    Description copied from class: IdentifierProvider
    
    Find the object named by a given identifier.
    
    Specified by:
    
    resolve in class IdentifierProvider
    
    identifier - to be resolved.
    
    attributes - additional information for resolving identifier.
    
    Returns:
    
    the named object.
    
    Throws:
    
    IdentifierNotFoundException - if identifier not found
    
    IdentifierNotResolvableException - if identifier not resolvable
  - lookup
```
public String lookup(Context context,
                     DSpaceObject object)
              throws IdentifierNotFoundException,
                     IdentifierNotResolvableException
```
    Description copied from class: IdentifierProvider
    
    Return the identifier for a DSpaceObject.
    
    Specified by:
    
    lookup in class IdentifierProvider
    
    object - The object to be looked up.
    
    Returns:
    
    identifier for object.
    
    Throws:
    
    IdentifierNotFoundException - if identifier not found
    
    IdentifierNotResolvableException - if identifier not resolvable
  - delete
```
public void delete(Context context,
                   DSpaceObject dso)
            throws IdentifierException
```
    Description copied from class: IdentifierProvider
    
    Unbind this type of identifier(s) from an object.
    
    Specified by:
    
    delete in class IdentifierProvider
    
    dso - object to lose its identity.
    
    Throws:
    
    IdentifierException - if identifier error
  - delete
```
public void delete(Context context,
                   DSpaceObject dso,
                   String identifier)
            throws IdentifierException
```
    Description copied from class: IdentifierProvider
    
    Unbind the given identifier from an object.
    
    Specified by:
    
    delete in class IdentifierProvider
    
    dso - object to be de-identified.
    
    identifier - to be removed.
    
    Throws:
    
    IdentifierException - if identifier error
  - setCrosswalk
```
public void setCrosswalk(Map<String,String> aCrosswalk)
```
    Provide a map from DSO metadata keys to EZID keys. This will drive the generation of EZID metadata for the minting of new identifiers.
    
    Parameters:
    
    aCrosswalk -
  - getCrosswalk
```
public Map<String,String> getCrosswalk()
```
  - setCrosswalkTransform
```
public void setCrosswalkTransform(Map<String,Transform> transformMap)
```
    Provide a map from DSO metadata keys to classes which can transform their values to something acceptable to EZID.
    
    Parameters:
    
    transformMap -
  - setGenerateDataciteXML
```
public void setGenerateDataciteXML(boolean GENERATE_DATACITE_XML)
```
  - setDisseminationCrosswalkName
```
public void setDisseminationCrosswalkName(String DATACITE_XML_CROSSWALK)
```
  - setRequestFactory
```
public void setRequestFactory(EZIDRequestFactory aRequestFactory)
```
  - getRequestFactory
```
public EZIDRequestFactory getRequestFactory()
```
  - setItemService
```
protected void setItemService(ItemService itemService)
```
    Method should never be used aside from the unit tests where we can cannot autowire this class.
    
    Parameters:
    
    itemService -

Class EZIDIdentifierProvider

Field Summary

Fields inherited from class org.dspace.identifier.IdentifierProvider

Constructor Summary

Method Summary

Methods inherited from class org.dspace.identifier.IdentifierProvider

Methods inherited from class java.lang.Object

Field Detail

MD_SCHEMA

DOI_ELEMENT

DOI_QUALIFIER

GENERATE_DATACITE_XML

DATACITE_XML_CROSSWALK

contentServiceFactory

itemService

Constructor Detail

EZIDIdentifierProvider

Method Detail

supports

supports

register

register

reserve

mint

resolve

lookup

delete

delete

setCrosswalk

getCrosswalk

setCrosswalkTransform

setGenerateDataciteXML

setDisseminationCrosswalkName

setRequestFactory

getRequestFactory

setItemService