org.gcube.gcat.persistence.ckan

Class CKANPackage

java.lang.Object

org.gcube.gcat.persistence.ckan.CKAN

org.gcube.gcat.persistence.ckan.CKANPackage

public class CKANPackage
extends CKAN

Author:

Luca Frosini (ISTI - CNR)

Field Summary

Fields

Modifier and Type	Field and Description
protected static String[]	allowedListQueryParameters
protected static String	AUTHOR_EMAIL_KEY
protected static String	AUTHOR_KEY
protected static String	CAPACITY_KEY
protected String	currentContext
protected String	currentOrganizationName
protected org.gcube.common.scope.impl.ScopeBean	currentScopeBean
protected static String	EXTRAS_ITEM_URL_KEY
static String	EXTRAS_KEY
static String	EXTRAS_KEY_KEY
static String	EXTRAS_KEY_VALUE_SYSTEM_TYPE
static String	EXTRAS_VALUE_KEY
static String	GENERIC_RESOURCE_NAME_FOR_ORGANIZATIONS
static String	GENERIC_RESOURCE_SECONDARY_TYPE_FOR_ORGANIZATIONS
static String	GENERIC_RESOURCE_TAG_NAME
static String	GENERIC_RESOURCE_TAG_NAME_PLURAL
static String	GROUPS_KEY
static String	ITEM_CREATE
static String	ITEM_DELETE
static String	ITEM_LIST
static String	ITEM_PATCH
static String	ITEM_PURGE
static String	ITEM_SHOW
static String	ITEM_UPDATE
protected String	itemID
protected static String	LICENSE_KEY
protected List<CKANResource>	managedResources
protected static String	ORGANIZATION_FILTER_TEMPLATE
protected static String	ORGANIZATION_REGEX
protected static Pattern	ORGANIZATION_REGEX_PATTERN
protected static String	OWNER_ORG_KEY
protected static String	PRIVATE_KEY
protected static String	RESOURCES_KEY
protected static String	ROWS_KEY
protected static String	SEARCHABLE_KEY
protected static String	START_KEY
protected Set<String>	supportedOrganizations
static String	TAGS_KEY
protected static String	TITLE_KEY

Fields inherited from class org.gcube.gcat.persistence.ckan.CKAN

apiKey, AUTH_CKAN_HEADER, AUTHORIZATION_ERROR, CKAN_API_PATH, CREATE, DELETE, ERROR_KEY, ERROR_TYPE_KEY, ID_KEY, LIMIT_KEY, LIST, mapper, MESSAGE_KEY, name, NAME_KEY, NAME_REGEX, nameRegex, NOT_FOUND_ERROR, OFFSET_KEY, PATCH, PURGE, READ, result, RESULT_KEY, SUCCESS_KEY, UPDATE, uriInfo, VALIDATION_ERROR

Constructor Summary

Constructors

Constructor and Description
CKANPackage()

Method Summary

Modifier and Type	Method and Description
protected org.gcube.com.fasterxml.jackson.databind.JsonNode	addExtraField(org.gcube.com.fasterxml.jackson.databind.JsonNode jsonNode, String key, String value)
protected String	addItemURLViaResolver(org.gcube.com.fasterxml.jackson.databind.JsonNode jsonNode)
org.gcube.com.fasterxml.jackson.databind.node.ObjectNode	checkBaseInformation(String json)
org.gcube.com.fasterxml.jackson.databind.node.ObjectNode	checkBaseInformation(String json, boolean allowPartialInfo)
protected CKANOrganization	checkGotOrganization(String gotOrganization)
protected Map<String,String>	checkListParameters(javax.ws.rs.core.MultivaluedMap<String,String> queryParameters, Map<String,String> parameters)
protected Set<String>	checkOrganizationFilter(String q)
int	count()
String	create(String json)
protected org.gcube.com.fasterxml.jackson.databind.node.ArrayNode	createResources(org.gcube.com.fasterxml.jackson.databind.node.ArrayNode resourcesToBeCreated)
protected void	delete()
protected String	getCurrentContext()
protected String	getFilterForOrganizations()
protected String	getOrganizationName()
protected static String	getOrganizationName(org.gcube.common.scope.impl.ScopeBean scopeBean)
protected CKANOrganization	getPublishingOrganization(org.gcube.com.fasterxml.jackson.databind.node.ObjectNode objectNode)
protected Set<String>	getSupportedOrganizationsFromIS()
String	list(int limit, int offset)
String	list(Map<String,String> parameters)
String	patch(String json)
void	purge()
protected void	rollbackManagedResources()
protected void	sendSocialPost(String title, String catalogueItemURL)
String	update(String json)
protected org.gcube.com.fasterxml.jackson.databind.JsonNode	validateJson(String json)

Methods inherited from class org.gcube.gcat.persistence.ckan.CKAN

checkName, checkName, createJsonNodeWithID, createJsonNodeWithNameAsID, delete, getApiKey, getAsJsonNode, getAsString, getGXHTTPStringRequest, getJsonNodeResult, getMapper, getMapWithID, getMapWithNameAsID, getName, getResultAndValidate, read, sendGetRequest, sendPostRequest, sendPostRequest, setApiKey, setName, setUriInfo, validateCKANResponse

Methods inherited from class java.lang.Object

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

Field Detail

ITEM_LIST

public static final String ITEM_LIST

See Also:

Constant Field Values

ITEM_CREATE

public static final String ITEM_CREATE

See Also:

Constant Field Values

ITEM_SHOW

public static final String ITEM_SHOW

See Also:

Constant Field Values

ITEM_UPDATE

public static final String ITEM_UPDATE

See Also:

Constant Field Values

ITEM_PATCH

public static final String ITEM_PATCH

See Also:

Constant Field Values

ITEM_DELETE

public static final String ITEM_DELETE

See Also:

Constant Field Values

ITEM_PURGE

public static final String ITEM_PURGE

See Also:

Constant Field Values

ROWS_KEY

protected static final String ROWS_KEY

See Also:

Constant Field Values

START_KEY

protected static final String START_KEY

See Also:

Constant Field Values

ORGANIZATION_FILTER_TEMPLATE

protected static final String ORGANIZATION_FILTER_TEMPLATE

See Also:

Constant Field Values

ORGANIZATION_REGEX

protected static final String ORGANIZATION_REGEX

See Also:

Constant Field Values

ORGANIZATION_REGEX_PATTERN

protected static final Pattern ORGANIZATION_REGEX_PATTERN

GENERIC_RESOURCE_SECONDARY_TYPE_FOR_ORGANIZATIONS

public static final String GENERIC_RESOURCE_SECONDARY_TYPE_FOR_ORGANIZATIONS

See Also:

Constant Field Values

GENERIC_RESOURCE_NAME_FOR_ORGANIZATIONS

public static final String GENERIC_RESOURCE_NAME_FOR_ORGANIZATIONS

See Also:

Constant Field Values

GENERIC_RESOURCE_TAG_NAME

public static final String GENERIC_RESOURCE_TAG_NAME

See Also:

Constant Field Values

GENERIC_RESOURCE_TAG_NAME_PLURAL

public static final String GENERIC_RESOURCE_TAG_NAME_PLURAL

See Also:

Constant Field Values

LICENSE_KEY

protected static final String LICENSE_KEY

See Also:

Constant Field Values

EXTRAS_ITEM_URL_KEY

protected static final String EXTRAS_ITEM_URL_KEY

See Also:

Constant Field Values

AUTHOR_KEY

protected static final String AUTHOR_KEY

See Also:

Constant Field Values

AUTHOR_EMAIL_KEY

protected static final String AUTHOR_EMAIL_KEY

See Also:

Constant Field Values

OWNER_ORG_KEY

protected static final String OWNER_ORG_KEY

See Also:

Constant Field Values

RESOURCES_KEY

protected static final String RESOURCES_KEY

See Also:

Constant Field Values

TITLE_KEY

protected static final String TITLE_KEY

See Also:

Constant Field Values

EXTRAS_KEY

public static final String EXTRAS_KEY

See Also:

Constant Field Values

EXTRAS_KEY_KEY

public static final String EXTRAS_KEY_KEY

See Also:

Constant Field Values

EXTRAS_KEY_VALUE_SYSTEM_TYPE

public static final String EXTRAS_KEY_VALUE_SYSTEM_TYPE

See Also:

Constant Field Values

EXTRAS_VALUE_KEY

public static final String EXTRAS_VALUE_KEY

See Also:

Constant Field Values

PRIVATE_KEY

protected static final String PRIVATE_KEY

See Also:

Constant Field Values

SEARCHABLE_KEY

protected static final String SEARCHABLE_KEY

See Also:

Constant Field Values

CAPACITY_KEY

protected static final String CAPACITY_KEY

See Also:

Constant Field Values

GROUPS_KEY

public static final String GROUPS_KEY

See Also:

Constant Field Values

TAGS_KEY

public static final String TAGS_KEY

See Also:

Constant Field Values

managedResources

protected final List<CKANResource> managedResources

itemID

protected String itemID

currentScopeBean

protected org.gcube.common.scope.impl.ScopeBean currentScopeBean

currentContext

protected String currentContext

currentOrganizationName

protected String currentOrganizationName

supportedOrganizations

protected Set<String> supportedOrganizations

allowedListQueryParameters

protected static String[] allowedListQueryParameters

Constructor Detail

CKANPackage

public CKANPackage()

Method Detail

getSupportedOrganizationsFromIS

protected Set<String> getSupportedOrganizationsFromIS()

getOrganizationName

protected static String getOrganizationName(org.gcube.common.scope.impl.ScopeBean scopeBean)

getCurrentContext

protected String getCurrentContext()

getOrganizationName

protected String getOrganizationName()

checkGotOrganization

protected CKANOrganization checkGotOrganization(String gotOrganization)
                                         throws javax.ws.rs.ForbiddenException

Throws:

javax.ws.rs.ForbiddenException

getPublishingOrganization

protected CKANOrganization getPublishingOrganization(org.gcube.com.fasterxml.jackson.databind.node.ObjectNode objectNode)
                                              throws javax.ws.rs.ForbiddenException

Throws:

javax.ws.rs.ForbiddenException

checkBaseInformation

public org.gcube.com.fasterxml.jackson.databind.node.ObjectNode checkBaseInformation(String json)
                                                                              throws Exception

Throws:

Exception

checkBaseInformation

public org.gcube.com.fasterxml.jackson.databind.node.ObjectNode checkBaseInformation(String json,
                                                                                     boolean allowPartialInfo)
                                                                              throws Exception

Parameters:

json - The json to check

allowPartialInfo - used for patch method which provide only partial information (i.e. the info to patch)

Returns:

ObjectNode from json

Throws:

Exception

validateJson

protected org.gcube.com.fasterxml.jackson.databind.JsonNode validateJson(String json)

count

public int count()

list

public String list(int limit,
                   int offset)

Overrides:

list in class CKAN

checkOrganizationFilter

protected Set<String> checkOrganizationFilter(String q)

getFilterForOrganizations

protected String getFilterForOrganizations()

checkListParameters

protected Map<String,String> checkListParameters(javax.ws.rs.core.MultivaluedMap<String,String> queryParameters,
                                                 Map<String,String> parameters)

list

public String list(Map<String,String> parameters)

rollbackManagedResources

protected void rollbackManagedResources()

createResources

protected org.gcube.com.fasterxml.jackson.databind.node.ArrayNode createResources(org.gcube.com.fasterxml.jackson.databind.node.ArrayNode resourcesToBeCreated)

addExtraField

protected org.gcube.com.fasterxml.jackson.databind.JsonNode addExtraField(org.gcube.com.fasterxml.jackson.databind.JsonNode jsonNode,
                                                                          String key,
                                                                          String value)

addItemURLViaResolver

protected String addItemURLViaResolver(org.gcube.com.fasterxml.jackson.databind.JsonNode jsonNode)

sendSocialPost

protected void sendSocialPost(String title,
                              String catalogueItemURL)

create

public String create(String json)

Overrides:

create in class CKAN

update

public String update(String json)

Overrides:

update in class CKAN

patch

public String patch(String json)

Overrides:

patch in class CKAN

delete

protected void delete()

Overrides:

delete in class CKAN

purge

public void purge()

Overrides:

purge in class CKAN