Package nl.knaw.dans.lib.dataverse

Class BasicFileAccessApi

java.lang.Object

nl.knaw.dans.lib.dataverse.BasicFileAccessApi

public class BasicFileAccessApi
extends Object

Basic file access API end-points.

See Also:

• Dataverse documentation

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)
<T> T	getFile(GetFileOptions options, GetFileRange range, org.apache.hc.core5.http.io.HttpClientResponseHandler<T> handler)
<T> T	getFile(GetFileOptions options, org.apache.hc.core5.http.io.HttpClientResponseHandler<T> handler)
<T> T	getFile(GetFileRange range, org.apache.hc.core5.http.io.HttpClientResponseHandler<T> handler)
<T> T	getFile(org.apache.hc.core5.http.io.HttpClientResponseHandler<T> handler)
protected Map<String,List<String>>	getQueryParamsFromMetadataKeys(Map<String,String> metadataKeys)
protected Map<String,List<String>>	params(Map<String,List<String>> queryParams)
protected Path	subPath(String endPoint)
String	toString()
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

getFile

public <T> T getFile(GetFileRange range,
 org.apache.hc.core5.http.io.HttpClientResponseHandler<T> handler)
              throws DataverseException,
IOException

Throws:

DataverseException

IOException

getFile

public <T> T getFile(GetFileOptions options,
 org.apache.hc.core5.http.io.HttpClientResponseHandler<T> handler)
              throws DataverseException,
IOException

Throws:

DataverseException

IOException

getFile

public <T> T getFile(org.apache.hc.core5.http.io.HttpClientResponseHandler<T> handler)
              throws DataverseException,
IOException

Throws:

DataverseException

IOException

getFile

public <T> T getFile(GetFileOptions options,
 GetFileRange range,
 org.apache.hc.core5.http.io.HttpClientResponseHandler<T> handler)
              throws DataverseException,
IOException

Throws:

DataverseException

IOException

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)