Package org.dspace.external

Class OpenAIRERestConnector

java.lang.Object

org.dspace.external.OpenAIRERestConnector

public class OpenAIRERestConnector
extends Object

based on OrcidRestConnector it's a rest connector for OpenAIRE API providing ways to perform searches and token grabbing

Author:

paulo-graca

Constructor Summary

Constructors

Constructor	Description
OpenAIRERestConnector(String url)

Method Summary

Modifier and Type	Method	Description
InputStream	get(String file, String accessToken)	Perform a GET request to the OpenAIRE API
protected void	getGotError(Exception e, String fullPath)
OpenAIRERestToken	grabNewAccessToken()	This method grabs an accessToken an sets the expiration time Based. Based on https://develop.openaire.eu/basic.html
eu.openaire.jaxb.model.Response	search(String path, int page, int size)	Perform an OpenAIRE Search request
eu.openaire.jaxb.model.Response	searchProjectByIDAndFunder(String projectID, String projectFunder, int page, int size)	Perform an OpenAIRE Project Search By ID and by Funder
eu.openaire.jaxb.model.Response	searchProjectByKeywords(int page, int size, String... keywords)	Perform an OpenAIRE Project Search By Keywords
void	setClientId(String clientId)	stores clientId to grab the token
void	setClientSecret(String clientSecret)	stores clientSecret to grab the token
void	setTokenEnabled(boolean tokenEnabled)	tokenUsage true to enable the usage of an access token
void	setTokenServiceUrl(String tokenServiceUrl)	stores tokenServiceUrl to grab the token
static String	trimSlashes(String path)	trim slashes from the path

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenAIRERestConnector

public OpenAIRERestConnector(String url)

Method Detail

grabNewAccessToken

public OpenAIRERestToken grabNewAccessToken()
                                     throws IOException

This method grabs an accessToken an sets the expiration time Based.
Based on https://develop.openaire.eu/basic.html

Throws:

IOException

get

public InputStream get(String file,
                       String accessToken)

Perform a GET request to the OpenAIRE API

Parameters:

file -

accessToken -

Returns:

an InputStream with a Result

searchProjectByKeywords

public eu.openaire.jaxb.model.Response searchProjectByKeywords(int page,
                                                               int size,
                                                               String... keywords)

Perform an OpenAIRE Project Search By Keywords

Parameters:

page -

size -

keywords -

Returns:

OpenAIRE Response

searchProjectByIDAndFunder

public eu.openaire.jaxb.model.Response searchProjectByIDAndFunder(String projectID,
                                                                  String projectFunder,
                                                                  int page,
                                                                  int size)

Perform an OpenAIRE Project Search By ID and by Funder

Parameters:

projectID -

projectFunder -

page -

size -

Returns:

OpenAIRE Response

search

public eu.openaire.jaxb.model.Response search(String path,
                                              int page,
                                              int size)

Perform an OpenAIRE Search request

Parameters:

path -

page -

size -

Returns:

OpenAIRE Response

trimSlashes

public static String trimSlashes(String path)

trim slashes from the path

Parameters:

path -

Returns:

string path without trailing slashes

setClientId

@Autowired(required=false)
public void setClientId(String clientId)

stores clientId to grab the token

Parameters:

clientId -

setTokenServiceUrl

@Autowired(required=false)
public void setTokenServiceUrl(String tokenServiceUrl)

stores tokenServiceUrl to grab the token

Parameters:

tokenServiceUrl -

setClientSecret

@Autowired(required=false)
public void setClientSecret(String clientSecret)

stores clientSecret to grab the token

Parameters:

clientSecret -

setTokenEnabled

@Autowired(required=false)
public void setTokenEnabled(boolean tokenEnabled)

tokenUsage true to enable the usage of an access token

Parameters:

tokenUsage -

getGotError

protected void getGotError(Exception e,
                           String fullPath)