Package nl.knaw.dans.lib.dataverse

Class FileApi

java.lang.Object

nl.knaw.dans.lib.dataverse.FileApi

public class FileApi
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<String,String>	extraHeaders
protected final nl.knaw.dans.lib.dataverse.HttpClientWrapper	httpClientWrapper
protected final String	id
protected static final String	invocationIdHeaderName
protected final boolean	isPersistentId
protected static final String	MDKEY_PARAM_NAME_PREFIX
protected static final String	persistendId
protected static final String	publish
protected final Path	targetBase

Method Summary

Modifier and Type	Method	Description
protected Path	buildPath(Path base, String... components)
protected Map<String,List<String>>	getQueryParamsFromMetadataKeys(Map<String,String> metadataKeys)
protected Map<String,List<String>>	params(Map<String,List<String>> queryParams)
DataverseHttpResponse<FileList>	replaceFile(Path dataFile, String fileMeta)
DataverseHttpResponse<FileList>	replaceFile(Path dataFile, FileMeta fileMeta)
protected Path	subPath(String endPoint)
String	toString()
DataverseHttpResponse<String>	updateMetadata(String fileMeta)
DataverseHttpResponse<String>	updateMetadata(FileMeta fileMeta)
protected Path	versionedSubPath(String endPoint, String version)

Methods inherited from class java.lang.Object

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

Field Details

persistendId

protected static final String persistendId

See Also:

• Constant Field Values

publish

protected static final String publish

See Also:

• Constant Field Values

invocationIdHeaderName

protected static final String invocationIdHeaderName

See Also:

• Constant Field Values

targetBase

protected final Path targetBase

id

protected final String id

isPersistentId

protected final boolean isPersistentId

extraHeaders

protected final Map<String,String> extraHeaders

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

replaceFile

public DataverseHttpResponse<FileList> replaceFile(Path dataFile,
 FileMeta fileMeta)
                                            throws IOException,
DataverseException

Parameters:

dataFile - the data file

fileMeta - json containing file metadata

Returns:

a file list

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

replaceFile

public DataverseHttpResponse<FileList> replaceFile(Path dataFile,
 String fileMeta)
                                            throws IOException,
DataverseException

Parameters:

dataFile - the data file

fileMeta - json containing file metadata

Returns:

a file list

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

updateMetadata

public DataverseHttpResponse<String> updateMetadata(FileMeta fileMeta)
                                             throws IOException,
DataverseException

Parameters:

fileMeta - the file metadata

Returns:

hash map

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

updateMetadata

public DataverseHttpResponse<String> updateMetadata(String fileMeta)
                                             throws IOException,
DataverseException

Parameters:

fileMeta - the file metadata

Returns:

hash map

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

toString

public String toString()

Overrides:

toString in class Object

params

protected Map<String,List<String>> params(Map<String,List<String>> queryParams)

subPath

protected Path subPath(String endPoint)

versionedSubPath

protected Path versionedSubPath(String endPoint,
 String version)

buildPath

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

getQueryParamsFromMetadataKeys

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