org.gcube.gcat.persistence.ckan

Class CKAN

java.lang.Object

org.gcube.gcat.persistence.ckan.CKAN

Direct Known Subclasses:

CKANGroup, CKANLicense, CKANOrganization, CKANPackage, CKANResource, CKANUser

public abstract class CKAN
extends Object

Author:

Luca Frosini (ISTI - CNR)

Field Summary

Fields

Modifier and Type	Field and Description
protected String	apiKey
static String	AUTH_CKAN_HEADER
protected static String	AUTHORIZATION_ERROR
static String	CKAN_API_PATH
protected String	CREATE
protected org.gcube.datacatalogue.ckanutillibrary.server.DataCatalogue	dataCatalogue
protected String	DELETE
protected static String	ERROR_KEY
protected static String	ERROR_TYPE_KEY
protected static String	ID_KEY
static String	LIMIT_KEY
protected String	LIST
protected com.fasterxml.jackson.databind.ObjectMapper	mapper
protected static String	MESSAGE_KEY
protected String	name
protected static String	NAME_KEY
protected static String	NOT_FOUND_ERROR
static String	OFFSET_KEY
protected static String	OWNER_ORG_KEY
protected String	PATCH
protected String	PURGE
protected String	READ
protected com.fasterxml.jackson.databind.JsonNode	result
protected static String	RESULT_KEY
protected static String	SUCCESS_KEY
protected String	UPDATE
protected static String	VALIDATION_ERROR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CKAN()

Method Summary

Modifier and Type	Method and Description
protected com.fasterxml.jackson.databind.JsonNode	checkName(com.fasterxml.jackson.databind.JsonNode jsonNode)
protected com.fasterxml.jackson.databind.JsonNode	checkName(String json)
String	create(String json)
protected com.fasterxml.jackson.databind.JsonNode	createJsonNodeWithID(String id)
protected com.fasterxml.jackson.databind.JsonNode	createJsonNodeWithNameAsID()
protected void	delete()
void	delete(boolean purge)
String	getApiKey()
protected com.fasterxml.jackson.databind.JsonNode	getAsJsonNode(String json)
protected String	getAsString(com.fasterxml.jackson.databind.JsonNode node)
static org.gcube.datacatalogue.ckanutillibrary.server.DataCatalogue	getCatalogue() Retrieve an instance of the library for the current scope
protected org.gcube.common.gxhttp.request.GXHTTPStringRequest	getGXHTTPStringRequest(String path)
com.fasterxml.jackson.databind.JsonNode	getJsonNodeResult()
com.fasterxml.jackson.databind.ObjectMapper	getMapper()
protected Map<String,String>	getMapWithID(String id)
protected Map<String,String>	getMapWithNameAsID()
String	getName()
protected String	getResultAsString(HttpURLConnection httpURLConnection)
protected StringBuilder	getStringBuilder(InputStream inputStream)
String	list(int limit, int offset)
String	patch(String json)
protected void	purge()
String	read()
protected String	sendGetRequest(String path, Map<String,String> parameters)
protected String	sendPostRequest(String path, com.fasterxml.jackson.databind.JsonNode jsonNode)
protected String	sendPostRequest(String path, String body)
void	setApiKey(String apiKey)
void	setName(String name)
String	update(String json)
protected com.fasterxml.jackson.databind.JsonNode	validateCKANResponse(String json) Validate the CKAN response and return the

Methods inherited from class java.lang.Object

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

Field Detail

ID_KEY

protected static final String ID_KEY

See Also:

Constant Field Values

NAME_KEY

protected static final String NAME_KEY

See Also:

Constant Field Values

ERROR_KEY

protected static final String ERROR_KEY

See Also:

Constant Field Values

ERROR_TYPE_KEY

protected static final String ERROR_TYPE_KEY

See Also:

Constant Field Values

MESSAGE_KEY

protected static final String MESSAGE_KEY

See Also:

Constant Field Values

OWNER_ORG_KEY

protected static final String OWNER_ORG_KEY

See Also:

Constant Field Values

RESULT_KEY

protected static final String RESULT_KEY

See Also:

Constant Field Values

SUCCESS_KEY

protected static final String SUCCESS_KEY

See Also:

Constant Field Values

LIMIT_KEY

public static final String LIMIT_KEY

See Also:

Constant Field Values

OFFSET_KEY

public static final String OFFSET_KEY

See Also:

Constant Field Values

NOT_FOUND_ERROR

protected static final String NOT_FOUND_ERROR

See Also:

Constant Field Values

AUTHORIZATION_ERROR

protected static final String AUTHORIZATION_ERROR

See Also:

Constant Field Values

VALIDATION_ERROR

protected static final String VALIDATION_ERROR

See Also:

Constant Field Values

CKAN_API_PATH

public static final String CKAN_API_PATH

See Also:

Constant Field Values

AUTH_CKAN_HEADER

public static final String AUTH_CKAN_HEADER

See Also:

Constant Field Values

LIST

protected String LIST

CREATE

protected String CREATE

READ

protected String READ

UPDATE

protected String UPDATE

PATCH

protected String PATCH

DELETE

protected String DELETE

PURGE

protected String PURGE

mapper

protected final com.fasterxml.jackson.databind.ObjectMapper mapper

dataCatalogue

protected final org.gcube.datacatalogue.ckanutillibrary.server.DataCatalogue dataCatalogue

name

protected String name

apiKey

protected String apiKey

result

protected com.fasterxml.jackson.databind.JsonNode result

Constructor Detail

CKAN

protected CKAN()

Method Detail

getApiKey

public String getApiKey()

setApiKey

public void setApiKey(String apiKey)

getName

public String getName()

setName

public void setName(String name)

getMapper

public com.fasterxml.jackson.databind.ObjectMapper getMapper()

getJsonNodeResult

public com.fasterxml.jackson.databind.JsonNode getJsonNodeResult()

getAsJsonNode

protected com.fasterxml.jackson.databind.JsonNode getAsJsonNode(String json)

getCatalogue

public static org.gcube.datacatalogue.ckanutillibrary.server.DataCatalogue getCatalogue()
                                                                                 throws Exception

Retrieve an instance of the library for the current scope

Returns:

Throws:

Exception

validateCKANResponse

protected com.fasterxml.jackson.databind.JsonNode validateCKANResponse(String json)

Validate the CKAN response and return the

Parameters:

json -

Returns:

getAsString

protected String getAsString(com.fasterxml.jackson.databind.JsonNode node)

checkName

protected com.fasterxml.jackson.databind.JsonNode checkName(com.fasterxml.jackson.databind.JsonNode jsonNode)

checkName

protected com.fasterxml.jackson.databind.JsonNode checkName(String json)

createJsonNodeWithID

protected com.fasterxml.jackson.databind.JsonNode createJsonNodeWithID(String id)

createJsonNodeWithNameAsID

protected com.fasterxml.jackson.databind.JsonNode createJsonNodeWithNameAsID()

getMapWithNameAsID

protected Map<String,String> getMapWithNameAsID()

getMapWithID

protected Map<String,String> getMapWithID(String id)

getStringBuilder

protected StringBuilder getStringBuilder(InputStream inputStream)
                                  throws IOException

Throws:

IOException

getGXHTTPStringRequest

protected org.gcube.common.gxhttp.request.GXHTTPStringRequest getGXHTTPStringRequest(String path)
                                                                              throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

getResultAsString

protected String getResultAsString(HttpURLConnection httpURLConnection)
                            throws IOException

Throws:

IOException

sendGetRequest

protected String sendGetRequest(String path,
                                Map<String,String> parameters)

sendPostRequest

protected String sendPostRequest(String path,
                                 String body)

sendPostRequest

protected String sendPostRequest(String path,
                                 com.fasterxml.jackson.databind.JsonNode jsonNode)

list

public String list(int limit,
                   int offset)

create

public String create(String json)

read

public String read()

update

public String update(String json)

patch

public String patch(String json)

delete

protected void delete()

delete

public void delete(boolean purge)

purge

protected void purge()