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
protected Path	buildPath(Path base, String... components)
DataverseHttpResponse<DataMessage>	getDatabaseSetting(String key)
protected Map<String,List<String>>	getQueryParamsFromMetadataKeys(Map<String,String> metadataKeys)
DataverseHttpResponse<AuthenticatedUser>	listSingleUser(String id)
DataverseHttpResponse<Map<String,String>>	putDatabaseSetting(String key, String value)
String	toString()
DataverseHttpResponseWithoutEnvelope<DatasetFileValidationResultList>	validateDatasetFiles(int dbId)
DataverseHttpResponseWithoutEnvelope<DatasetFileValidationResultList>	validateDatasetFiles(String pid)
DataverseHttpResponseWithoutEnvelope<DatasetFileValidationResultList>	validateDatasetFiles(String id, boolean isPersistentId)

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

Throws:

IOException

DataverseException

validateDatasetFiles

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

Throws:

IOException

DataverseException

validateDatasetFiles

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

Throws:

IOException

DataverseException

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)