Package nl.knaw.dans.lib.dataverse

Class DataverseClient

java.lang.Object

nl.knaw.dans.lib.dataverse.DataverseClient

public class DataverseClient
extends Object

Object that lets your code talk to a Dataverse server.

Constructor Summary

Constructors

Constructor	Description
DataverseClient(DataverseClientConfig config)	Creates a DataverseClient.
DataverseClient(DataverseClientConfig config, org.apache.hc.client5.http.classic.HttpClient httpClient, com.fasterxml.jackson.databind.ObjectMapper objectMapper)	Creates a DataverseClient with a custom HttpClient.

Method Summary

Modifier and Type	Method	Description
DataAccessRequestsApi	accessRequests(long id)
DataAccessRequestsApi	accessRequests(long id, String invocationId)
DataAccessRequestsApi	accessRequests(String pid)
DataAccessRequestsApi	accessRequests(String pid, String invocationId)
AdminApi	admin()
BasicFileAccessApi	basicFileAccess(long id)
BasicFileAccessApi	basicFileAccess(long id, String invocationId)
BasicFileAccessApi	basicFileAccess(String pid)
BasicFileAccessApi	basicFileAccess(String pid, String invocationId)
BuiltinUserApi	builtinUsers(String builtinUsersKey)
void	checkConnection()
DatabaseApi	database()
DatasetApi	dataset(int pid)
DatasetApi	dataset(int pid, String invocationId)
DatasetApi	dataset(String pid)
DatasetApi	dataset(String pid, String invocationId)
DataverseApi	dataverse(String alias)
FileApi	file(long id)
FileApi	file(long id, String invocationId)
LicenseApi	license()
MetricsApi	metrics()
SearchApi	search()
SwordApi	sword()
String	toString()
WorkflowsApi	workflows()

Methods inherited from class java.lang.Object

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

Constructor Details

DataverseClient

public DataverseClient(DataverseClientConfig config)

Creates a DataverseClient.

Parameters:

config - configuration for this DataverseClient

DataverseClient

public DataverseClient(DataverseClientConfig config,
 org.apache.hc.client5.http.classic.HttpClient httpClient,
 com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Creates a DataverseClient with a custom HttpClient.

Parameters:

config - configuration for this DataverseClient

httpClient - the HttpClient to use, or null to use a default client

objectMapper - the Jackson object mapper to use, or null to use a default mapper

Method Details

checkConnection

public void checkConnection()
                     throws IOException,
DataverseException

Throws:

IOException

DataverseException

workflows

public WorkflowsApi workflows()

dataset

public DatasetApi dataset(String pid)

dataset

public DatasetApi dataset(String pid,
 String invocationId)

dataset

public DatasetApi dataset(int pid)

dataset

public DatasetApi dataset(int pid,
 String invocationId)

dataverse

public DataverseApi dataverse(String alias)

admin

public AdminApi admin()

sword

public SwordApi sword()

file

public FileApi file(long id)

file

public FileApi file(long id,
 String invocationId)

accessRequests

public DataAccessRequestsApi accessRequests(String pid)

accessRequests

public DataAccessRequestsApi accessRequests(long id)

accessRequests

public DataAccessRequestsApi accessRequests(String pid,
 String invocationId)

accessRequests

public DataAccessRequestsApi accessRequests(long id,
 String invocationId)

basicFileAccess

public BasicFileAccessApi basicFileAccess(String pid)

basicFileAccess

public BasicFileAccessApi basicFileAccess(String pid,
 String invocationId)

basicFileAccess

public BasicFileAccessApi basicFileAccess(long id)

basicFileAccess

public BasicFileAccessApi basicFileAccess(long id,
 String invocationId)

search

public SearchApi search()

license

public LicenseApi license()

metrics

public MetricsApi metrics()

database

public DatabaseApi database()

builtinUsers

public BuiltinUserApi builtinUsers(String builtinUsersKey)

toString

public String toString()

Overrides:

toString in class Object