Package nl.knaw.dans.lib.dataverse

Class LicenseApi

java.lang.Object

nl.knaw.dans.lib.dataverse.LicenseApi

public class LicenseApi
extends Object

License 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<DataMessage>	addLicense(License license)
protected Path	buildPath(Path base, String... components)
DataverseHttpResponse<DataMessage>	deleteLicense(long id)
DataverseHttpResponse<DataMessage>	getDefaultLicense()
DataverseHttpResponse<License>	getLicenseById(long id)
DataverseHttpResponse<List<License>>	getLicenses()
protected Map<String,List<String>>	getQueryParamsFromMetadataKeys(Map<String,String> metadataKeys)
DataverseHttpResponse<DataMessage>	setActiveState(long id, boolean active)
DataverseHttpResponse<DataMessage>	setDefaultLicense(long id)
String	toString()

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

getLicenses

public DataverseHttpResponse<List<License>> getLicenses()
                                                 throws IOException,
DataverseException

Throws:

IOException

DataverseException

getLicenseById

public DataverseHttpResponse<License> getLicenseById(long id)
                                              throws IOException,
DataverseException

Throws:

IOException

DataverseException

addLicense

public DataverseHttpResponse<DataMessage> addLicense(License license)
                                              throws IOException,
DataverseException

Throws:

IOException

DataverseException

getDefaultLicense

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

Throws:

IOException

DataverseException

setDefaultLicense

public DataverseHttpResponse<DataMessage> setDefaultLicense(long id)
                                                     throws IOException,
DataverseException

Throws:

IOException

DataverseException

setActiveState

public DataverseHttpResponse<DataMessage> setActiveState(long id,
 boolean active)
                                                  throws IOException,
DataverseException

Throws:

IOException

DataverseException

deleteLicense

public DataverseHttpResponse<DataMessage> deleteLicense(long id)
                                                 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)