Package nl.knaw.dans.lib.dataverse

Class SolrIndexApi

java.lang.Object

nl.knaw.dans.lib.dataverse.SolrIndexApi

public class SolrIndexApi
extends Object

API for Dataverse Solr index endpoints.

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
protected Path	buildPath(Path base, String... components)
DataverseHttpResponse<DataMessageSolrIndex>	clear()	Clears (deletes) the Solr index.
DataverseHttpResponse<DataMessage>	clearTimestamps()	Clears the index timestamps for all objects, causing them to be re-indexed on the next indexing run.
protected Map<String,List<String>>	getQueryParamsFromMetadataKeys(Map<String,String> metadataKeys)
DataverseHttpResponse<DataMessageSolrIndex>	indexAll()	Triggers a full reindex of all content in the Dataverse installation.
DataverseHttpResponse<DataMessageSolrIndex>	indexDataset(int id)	Indexes a specific dataset identified by its database id.
DataverseHttpResponse<DataMessageSolrIndex>	indexDataset(String persistentId)	Indexes a specific dataset identified by its persistent identifier.
DataverseHttpResponse<DataMessage>	indexDataverse(int id)	Indexes a specific dataverse identified by its database id.
DataverseHttpResponse<DataMessage>	status()	Returns the current status of the Solr index.
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

indexAll

public DataverseHttpResponse<DataMessageSolrIndex> indexAll()
                                                     throws IOException,
DataverseException

Triggers a full reindex of all content in the Dataverse installation.

Returns:

the response message from Dataverse

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

status

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

Returns the current status of the Solr index.

Returns:

the index status message

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

indexDataset

public DataverseHttpResponse<DataMessageSolrIndex> indexDataset(String persistentId)
                                                         throws IOException,
DataverseException

Indexes a specific dataset identified by its persistent identifier.

Parameters:

persistentId - the persistent identifier of the dataset (e.g. doi:10.5072/FK2/ABCDEF)

Returns:

the response message from Dataverse

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

indexDataset

public DataverseHttpResponse<DataMessageSolrIndex> indexDataset(int id)
                                                         throws IOException,
DataverseException

Indexes a specific dataset identified by its database id.

Parameters:

id - the database id of the dataset

Returns:

the response message from Dataverse

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

indexDataverse

public DataverseHttpResponse<DataMessage> indexDataverse(int id)
                                                  throws IOException,
DataverseException

Indexes a specific dataverse identified by its database id.

Parameters:

id - the database id of the dataverse

Returns:

the response message from Dataverse

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

clear

public DataverseHttpResponse<DataMessageSolrIndex> clear()
                                                  throws IOException,
DataverseException

Clears (deletes) the Solr index.

Returns:

the response message from Dataverse

Throws:

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

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

clearTimestamps

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

Clears the index timestamps for all objects, causing them to be re-indexed on the next indexing run.

Returns:

the response message from Dataverse

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

buildPath

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

getQueryParamsFromMetadataKeys

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