Package nl.knaw.dans.lib.dataverse

Class MetadataExportApi

java.lang.Object

nl.knaw.dans.lib.dataverse.MetadataExportApi

public class MetadataExportApi
extends Object

API for Dataverse metadata export endpoints.

See Also:

• Dataverse documentation

Field Summary

Fields

Modifier and Type	Field	Description
protected final nl.knaw.dans.lib.dataverse.HttpClientWrapper	httpClientWrapper
protected static final String	MDKEY_PARAM_NAME_PREFIX

Method Summary

Modifier and Type	Method	Description
protected Path	buildPath(Path base, String... components)
DataverseHttpResponse<DataMessage>	clearExportTimestamps()	Clears metadata export timestamps on published local datasets.
DataverseHttpResponse<Object>	exportAll()	Attempts to export all published local datasets that have not been exported yet.
protected Map<String,List<String>>	getQueryParamsFromMetadataKeys(Map<String,String> metadataKeys)
DataverseHttpResponse<Object>	reExportAll()	Forces re-export of all published local datasets.
DataverseHttpResponse<Object>	reExportAll(String olderThan, String... formats)	Forces re-export of all published local datasets with optional filters.
DataverseHttpResponse<Object>	reExportAllFormats(String... formats)	Forces re-export of all published local datasets for the selected metadata formats.
DataverseHttpResponse<Object>	reExportAllOlderThan(String olderThan)	Forces re-export of all published local datasets exported before the supplied date.
DataverseHttpResponse<Object>	reExportDataset(int id)	Forces re-export of a specific dataset identified by its database id.
DataverseHttpResponse<Object>	reExportDataset(int id, String... formats)	Forces re-export of a specific dataset identified by its database id for selected formats.
DataverseHttpResponse<Object>	reExportDataset(String pid)	Forces re-export of a specific dataset identified by its persistent identifier.
DataverseHttpResponse<Object>	reExportDataset(String pid, String... formats)	Forces re-export of a specific dataset identified by its persistent identifier for selected formats.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

MDKEY_PARAM_NAME_PREFIX

protected static final String MDKEY_PARAM_NAME_PREFIX

See Also:

• Constant Field Values

httpClientWrapper

protected final nl.knaw.dans.lib.dataverse.HttpClientWrapper httpClientWrapper

Method Details

exportAll

public DataverseHttpResponse<Object> exportAll()
                                        throws IOException,
DataverseException

Attempts to export all published local datasets that have not been exported yet.

Returns:

the response envelope

Throws:

IOException - when I/O problems occur during the interaction with Dataverse

DataverseException - when Dataverse fails to perform the request

reExportAll

public DataverseHttpResponse<Object> reExportAll()
                                          throws IOException,
DataverseException

Forces re-export of all published local datasets.

Returns:

the response envelope

Throws:

IOException - when I/O problems occur during the interaction with Dataverse

DataverseException - when Dataverse fails to perform the request

reExportAllOlderThan

public DataverseHttpResponse<Object> reExportAllOlderThan(String olderThan)
                                                   throws IOException,
DataverseException

Forces re-export of all published local datasets exported before the supplied date.

Parameters:

olderThan - re-export datasets exported before this date (YYYY-MM-DD)

Returns:

the response envelope

Throws:

IOException - when I/O problems occur during the interaction with Dataverse

DataverseException - when Dataverse fails to perform the request

reExportAllFormats

public DataverseHttpResponse<Object> reExportAllFormats(String... formats)
                                                 throws IOException,
DataverseException

Forces re-export of all published local datasets for the selected metadata formats.

Parameters:

formats - metadata formats to export (for example "Datacite", "croissant")

Returns:

the response envelope

Throws:

IOException - when I/O problems occur during the interaction with Dataverse

DataverseException - when Dataverse fails to perform the request

reExportAll

public DataverseHttpResponse<Object> reExportAll(String olderThan,
 String... formats)
                                          throws IOException,
DataverseException

Forces re-export of all published local datasets with optional filters.

Parameters:

olderThan - re-export datasets exported before this date (YYYY-MM-DD), or null

formats - metadata formats to export, or null/empty

Returns:

the response envelope

Throws:

IOException - when I/O problems occur during the interaction with Dataverse

DataverseException - when Dataverse fails to perform the request

clearExportTimestamps

public DataverseHttpResponse<DataMessage> clearExportTimestamps()
                                                         throws IOException,
DataverseException

Clears metadata export timestamps on published local datasets.

Returns:

the response message from Dataverse

Throws:

IOException - when I/O problems occur during the interaction with Dataverse

DataverseException - when Dataverse fails to perform the request

reExportDataset

public DataverseHttpResponse<Object> reExportDataset(int id)
                                              throws IOException,
DataverseException

Forces re-export of a specific dataset identified by its database id.

Parameters:

id - the database id of the dataset

Returns:

the response envelope

Throws:

IOException - when I/O problems occur during the interaction with Dataverse

DataverseException - when Dataverse fails to perform the request

reExportDataset

public DataverseHttpResponse<Object> reExportDataset(String pid)
                                              throws IOException,
DataverseException

Forces re-export of a specific dataset identified by its persistent identifier.

Parameters:

pid - the dataset persistent identifier

Returns:

the response envelope

Throws:

IOException - when I/O problems occur during the interaction with Dataverse

DataverseException - when Dataverse fails to perform the request

reExportDataset

public DataverseHttpResponse<Object> reExportDataset(int id,
 String... formats)
                                              throws IOException,
DataverseException

Forces re-export of a specific dataset identified by its database id for selected formats.

Parameters:

id - the database id of the dataset

formats - metadata formats to export

Returns:

the response envelope

Throws:

IOException - when I/O problems occur during the interaction with Dataverse

DataverseException - when Dataverse fails to perform the request

reExportDataset

public DataverseHttpResponse<Object> reExportDataset(String pid,
 String... formats)
                                              throws IOException,
DataverseException

Forces re-export of a specific dataset identified by its persistent identifier for selected formats.

Parameters:

pid - the dataset persistent identifier

formats - metadata formats to export

Returns:

the response envelope

Throws:

IOException - when I/O problems occur during the interaction with Dataverse

DataverseException - when Dataverse fails to perform the request

toString

public String toString()

Overrides:

toString in class Object

buildPath

protected Path buildPath(Path base,
 String... components)

getQueryParamsFromMetadataKeys

protected Map<String,List<String>> getQueryParamsFromMetadataKeys(Map<String,String> metadataKeys)