Package nl.knaw.dans.lib.dataverse

Class DataverseApi

java.lang.Object

nl.knaw.dans.lib.dataverse.DataverseApi

public class DataverseApi
extends Object

API end-points that operate on a dataverse collection.

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<DataMessage>	assignDefaultRoleOnDataset(String roleName)
DataverseHttpResponse<DataMessage>	assignRole(RoleAssignment roleAssignment)
protected Path	buildPath(Path base, String... components)
DataverseHttpResponse<Dataverse>	create(String dataverse)
DataverseHttpResponse<Dataverse>	create(Dataverse dataverse)
DataverseHttpResponse<DatasetCreationResult>	createDataset(String dataset)
DataverseHttpResponse<DatasetCreationResult>	createDataset(String dataset, Map<String,String> metadataKeys)
DataverseHttpResponse<DatasetCreationResult>	createDataset(Dataset dataset)
DataverseHttpResponse<DatasetCreationResult>	createDataset(Dataset dataset, Map<String,String> metadataKeys)
DataverseHttpResponse<DataMessage>	createRole(String role)
DataverseHttpResponse<DataMessage>	createRole(Role role)
DataverseHttpResponse<DataMessage>	defineMetadataBlocks(List<String> metadataBlocks)
DataverseHttpResponse<DataMessage>	delete()
DataverseHttpResponse<DataMessage>	deleteRoleAssignment(int roleAssignmentId)
DataverseHttpResponse<List<DataverseItem>>	getContents()
DataverseHttpResponse<DataMessage>	getGuestBookResponses()
protected Map<String,List<String>>	getQueryParamsFromMetadataKeys(Map<String,String> metadataKeys)
DataverseHttpResponse<DataMessage>	getStorageSize()
DataverseHttpResponse<DatasetCreationResult>	importDataset(String dataset, String persistentId, boolean autoPublish)
DataverseHttpResponse<DatasetCreationResult>	importDataset(String dataset, String persistentId, boolean autoPublish, Map<String,String> metadataKeys)
DataverseHttpResponse<DatasetCreationResult>	importDataset(Dataset dataset, String persistentId, boolean autoPublish)
DataverseHttpResponse<DatasetCreationResult>	importDataset(Dataset dataset, String persistentId, boolean autoPublish, Map<String,String> metadataKeys)
DataverseHttpResponse<DatasetCreationResult>	importDatasetFromDdi()
DataverseHttpResponse<Boolean>	isMetadataBlocksRoot()
DataverseHttpResponse<DataMessage>	listFacets()
DataverseHttpResponse<List<MetadataBlockSummary>>	listMetadataBlocks()
DataverseHttpResponse<List<RoleAssignmentReadOnly>>	listRoleAssignments()
DataverseHttpResponse<List<Role>>	listRoles()
DataverseHttpResponse<DataMessage>	publish()
DataverseHttpResponse<DataMessage>	setFacets(List<String> facets)
DataverseHttpResponse<DataMessage>	setMetadataBlocksRoot(boolean isRoot)
String	toString()
DataverseHttpResponse<Dataverse>	view()

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

create

public DataverseHttpResponse<Dataverse> create(String dataverse)
                                        throws IOException,
DataverseException

Parameters:

dataverse - dataverse to create

Returns:

description of the dataverse just created

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

create

public DataverseHttpResponse<Dataverse> create(Dataverse dataverse)
                                        throws IOException,
DataverseException

Parameters:

dataverse - dataverse to create

Returns:

description of the dataverse just created

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

view

public DataverseHttpResponse<Dataverse> view()
                                      throws IOException,
DataverseException

Returns:

Information about a 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

delete

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

Returns:

a generic 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

getContents

public DataverseHttpResponse<List<DataverseItem>> getContents()
                                                       throws IOException,
DataverseException

Returns:

a list of information items about subverses

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

getStorageSize

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

Returns:

a data message containing information about the storage size

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

listRoles

public DataverseHttpResponse<List<Role>> listRoles()
                                            throws IOException,
DataverseException

Returns:

a list of roles

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

listFacets

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

Returns:

a list of facets

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

setFacets

public DataverseHttpResponse<DataMessage> setFacets(List<String> facets)
                                             throws IOException,
DataverseException

Throws:

IOException

DataverseException

createRole

public DataverseHttpResponse<DataMessage> createRole(String role)
                                              throws IOException,
DataverseException

Throws:

IOException

DataverseException

createRole

public DataverseHttpResponse<DataMessage> createRole(Role role)
                                              throws IOException,
DataverseException

Throws:

IOException

DataverseException

listRoleAssignments

public DataverseHttpResponse<List<RoleAssignmentReadOnly>> listRoleAssignments()
                                                                        throws IOException,
DataverseException

Throws:

IOException

DataverseException

assignDefaultRoleOnDataset

public DataverseHttpResponse<DataMessage> assignDefaultRoleOnDataset(String roleName)
                                                              throws IOException,
DataverseException

Throws:

IOException

DataverseException

assignRole

public DataverseHttpResponse<DataMessage> assignRole(RoleAssignment roleAssignment)
                                              throws IOException,
DataverseException

Throws:

IOException

DataverseException

deleteRoleAssignment

public DataverseHttpResponse<DataMessage> deleteRoleAssignment(int roleAssignmentId)
                                                        throws IOException,
DataverseException

Parameters:

roleAssignmentId - Delete the assignment with this id

Returns:

A data information message

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

listMetadataBlocks

public DataverseHttpResponse<List<MetadataBlockSummary>> listMetadataBlocks()
                                                                     throws IOException,
DataverseException

Returns:

a list of metadata block summaries

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

defineMetadataBlocks

public DataverseHttpResponse<DataMessage> defineMetadataBlocks(List<String> metadataBlocks)
                                                        throws IOException,
DataverseException

Throws:

IOException

DataverseException

isMetadataBlocksRoot

public DataverseHttpResponse<Boolean> isMetadataBlocksRoot()
                                                    throws IOException,
DataverseException

Returns:

true if this dataverse is a metadata blocks root, false otherwise

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

setMetadataBlocksRoot

public DataverseHttpResponse<DataMessage> setMetadataBlocksRoot(boolean isRoot)
                                                         throws IOException,
DataverseException

Parameters:

isRoot - whether to make this dataverse collection a metadata blocks root

Returns:

a data message

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

createDataset

public DataverseHttpResponse<DatasetCreationResult> createDataset(String dataset)
                                                           throws IOException,
DataverseException

Parameters:

dataset - JSON string defining the dataset to create

Returns:

a creation result message

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

createDataset

public DataverseHttpResponse<DatasetCreationResult> createDataset(String dataset,
 Map<String,String> metadataKeys)
                                                           throws IOException,
DataverseException

Parameters:

dataset - JSON string defining the dataset to create

metadataKeys - the HashMap maps the names of the metadata blocks to their 'secret' key values

Returns:

a creation result message

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

createDataset

public DataverseHttpResponse<DatasetCreationResult> createDataset(Dataset dataset)
                                                           throws IOException,
DataverseException

Parameters:

dataset - the dataset to create

Returns:

a creation result message

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

createDataset

public DataverseHttpResponse<DatasetCreationResult> createDataset(Dataset dataset,
 Map<String,String> metadataKeys)
                                                           throws IOException,
DataverseException

Parameters:

dataset - the dataset to create

metadataKeys - maps the names of the metadata blocks to their 'secret' key values

Returns:

a creation result message

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

importDataset

public DataverseHttpResponse<DatasetCreationResult> importDataset(Dataset dataset,
 String persistentId,
 boolean autoPublish)
                                                           throws IOException,
DataverseException

Parameters:

dataset - the dataset to import

persistentId - existing persistent identifier (PID)

autoPublish - immediately publish the dataset

Returns:

an import result message

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

importDataset

public DataverseHttpResponse<DatasetCreationResult> importDataset(Dataset dataset,
 String persistentId,
 boolean autoPublish,
 Map<String,String> metadataKeys)
                                                           throws IOException,
DataverseException

Parameters:

dataset - the dataset to import

persistentId - existing persistent identifier (PID)

autoPublish - immediately publish the dataset

metadataKeys - maps the names of the metadata blocks to their 'secret' key values

Returns:

an import result message

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

importDataset

public DataverseHttpResponse<DatasetCreationResult> importDataset(String dataset,
 String persistentId,
 boolean autoPublish)
                                                           throws IOException,
DataverseException

Parameters:

dataset - JSON string defining the dataset to import

persistentId - existing persistent identifier (PID)

autoPublish - immediately publish the dataset

Returns:

an import result message

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

importDataset

public DataverseHttpResponse<DatasetCreationResult> importDataset(String dataset,
 String persistentId,
 boolean autoPublish,
 Map<String,String> metadataKeys)
                                                           throws IOException,
DataverseException

Parameters:

dataset - JSON string defining the dataset to import

persistentId - existing persistent identifier (PID)

autoPublish - immediately publish the dataset

metadataKeys - maps the names of the metadata blocks to their 'secret' key values

Returns:

an import result message

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

importDatasetFromDdi

public DataverseHttpResponse<DatasetCreationResult> importDatasetFromDdi()
                                                                  throws IOException,
DataverseException

Throws:

IOException

DataverseException

publish

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

Returns:

a data message

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

getGuestBookResponses

public DataverseHttpResponse<DataMessage> getGuestBookResponses()
                                                         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)