Package nl.knaw.dans.lib.dataverse

Class MetricsApi

java.lang.Object

nl.knaw.dans.lib.dataverse.MetricsApi

public class MetricsApi
extends Object

API for Dataverse metrics endpoints.

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
protected Path	buildPath(Path base, String... components)
protected Map<String,List<String>>	getQueryParamsFromMetadataKeys(Map<String,String> metadataKeys)
String	toString()
DataverseHttpResponse<MetricsTreeNode>	tree()	Returns the metrics tree of dataverses.

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

tree

public DataverseHttpResponse<MetricsTreeNode> tree()
                                            throws IOException,
DataverseException

Returns the metrics tree of dataverses.

Returns:

the root node of the metrics tree

Throws:

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

DataverseException - when Dataverse fails to perform the request

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)