Package nl.knaw.dans.lib.dataverse

Class AdminApi

java.lang.Object

nl.knaw.dans.lib.dataverse.AdminApi

public class AdminApi
extends Object

Administration API end-points.

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
DataverseHttpResponse<DataMessageWithId>	addBannerMessage(String json)	Adds a banner message.
DataverseHttpResponse<DataMessageWithId>	addBannerMessage(Messages messages)	Adds a banner message.
protected Path	buildPath(Path base, String... components)
DataverseHttpResponse<DataMessage>	deleteBannerMessage(int id)	Deletes a banner message.
DataverseHttpResponse<Map<String,String>>	getAvailableStorageDrivers()	Retrieves a list of available storage drivers from the Dataverse instance.
DataverseHttpResponse<DataMessage>	getDatabaseSetting(String key)
protected Map<String,List<String>>	getQueryParamsFromMetadataKeys(Map<String,String> metadataKeys)
DataverseHttpResponse<List<BannerMessage>>	listBannerMessages()	Lists all banner messages.
DataverseHttpResponse<AuthenticatedUser>	listSingleUser(String id)
DataverseHttpResponse<Map<String,String>>	putDatabaseSetting(String key, String value)
DataverseHttpResponse<DataMessage>	submitDatasetVersionToArchive(String id, String version, boolean isPersistentId)	Submits a dataset version to the archive.
String	toString()
DataverseHttpResponseWithoutEnvelope<DatasetFileValidationResultList>	validateDatasetFiles(int dbId)	The following validates all the physical files in the dataset specified by recalculating the checksums and comparing them against the values saved in the database.
DataverseHttpResponseWithoutEnvelope<DatasetFileValidationResultList>	validateDatasetFiles(String pid)	Validates all the physical files in the dataset specified by recalculating the checksums and comparing them against the values saved in the database.
DataverseHttpResponseWithoutEnvelope<DatasetFileValidationResultList>	validateDatasetFiles(String id, boolean isPersistentId)	Validates all the physical files in the dataset specified by recalculating the checksums and comparing them against the values saved in the database.

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

listSingleUser

public DataverseHttpResponse<AuthenticatedUser> listSingleUser(String id)
                                                        throws IOException,
DataverseException

Parameters:

id - username

Returns:

the user

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

putDatabaseSetting

public DataverseHttpResponse<Map<String,String>> putDatabaseSetting(String key,
 String value)
                                                             throws IOException,
DataverseException

Parameters:

key - the settings key

value - the new value

Returns:

the result

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

getDatabaseSetting

public DataverseHttpResponse<DataMessage> getDatabaseSetting(String key)
                                                      throws IOException,
DataverseException

Parameters:

key - the settings key

Returns:

the result

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

validateDatasetFiles

public DataverseHttpResponseWithoutEnvelope<DatasetFileValidationResultList> validateDatasetFiles(int dbId)
                                                                                           throws IOException,
DataverseException

The following validates all the physical files in the dataset specified by recalculating the checksums and comparing them against the values saved in the database.

Parameters:

dbId - the dataset database id

Returns:

the result

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

validateDatasetFiles

public DataverseHttpResponseWithoutEnvelope<DatasetFileValidationResultList> validateDatasetFiles(String pid)
                                                                                           throws IOException,
DataverseException

Validates all the physical files in the dataset specified by recalculating the checksums and comparing them against the values saved in the database.

Parameters:

pid - the dataset persistent identifier

Returns:

the result

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

validateDatasetFiles

public DataverseHttpResponseWithoutEnvelope<DatasetFileValidationResultList> validateDatasetFiles(String id,
 boolean isPersistentId)
                                                                                           throws IOException,
DataverseException

Validates all the physical files in the dataset specified by recalculating the checksums and comparing them against the values saved in the database.

Parameters:

id - the dataset id (dbId or pid)

isPersistentId - indicates whether the id is a persistent identifier

Returns:

the result

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

listBannerMessages

public DataverseHttpResponse<List<BannerMessage>> listBannerMessages()
                                                              throws IOException,
DataverseException

Lists all banner messages.

Returns:

the list of banner messages

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

addBannerMessage

public DataverseHttpResponse<DataMessageWithId> addBannerMessage(String json)
                                                          throws IOException,
DataverseException

Adds a banner message.

Parameters:

json - the banner message in JSON format

Returns:

the response

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

addBannerMessage

public DataverseHttpResponse<DataMessageWithId> addBannerMessage(Messages messages)
                                                          throws IOException,
DataverseException

Adds a banner message.

Parameters:

messages - the banner message

Returns:

the response

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

deleteBannerMessage

public DataverseHttpResponse<DataMessage> deleteBannerMessage(int id)
                                                       throws IOException,
DataverseException

Deletes a banner message.

Parameters:

id - the banner message id

Returns:

the response envelope from Dataverse

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

submitDatasetVersionToArchive

public DataverseHttpResponse<DataMessage> submitDatasetVersionToArchive(String id,
 String version,
 boolean isPersistentId)
                                                                 throws IOException,
DataverseException

Submits a dataset version to the archive.

Parameters:

id - the dataset id

version - the version of the dataset

isPersistentId - indicates whether the id is a persistent identifier

Returns:

the result

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

getAvailableStorageDrivers

public DataverseHttpResponse<Map<String,String>> getAvailableStorageDrivers()
                                                                     throws IOException,
DataverseException

Retrieves a list of available storage drivers from the Dataverse instance.

Returns:

a DataverseHttpResponse containing a list of StorageDriver objects

Throws:

IOException - if an I/O error occurs during the interaction with Dataverse

DataverseException - if Dataverse fails to process the request

See Also:

• Dataverse documentation

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)