org.gcube.dataaccess.ckanutillibrary

Class CKanUtilsImpl

java.lang.Object

org.gcube.dataaccess.ckanutillibrary.CKanUtilsImpl

All Implemented Interfaces:

CKanUtilsInterface

public class CKanUtilsImpl
extends Object
implements CKanUtilsInterface

This is the Ckan Utils implementation class.

Author:

Costantino Perciante at ISTI-CNR (costantino.perciante@isti.cnr.it)

Constructor Summary

Constructors

Constructor and Description
CKanUtilsImpl(String scope)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	finalize()
String	findLicenseIdByLicense(String chosenLicense) Finds the id associated to the chosen license
String	getApiKeyFromUser(String username) Retrieve the API_KEY given the username .
String	getCatalogueUrl() Return the ckan catalogue url in this scope.
Map<String,List<ROLES_IN_ORGANIZATION>>	getGroupsAndRolesByUser(String username, List<ROLES_IN_ORGANIZATION> rolesToMatch) Given a username and a list of roles to be matched, find the organizations to who the user belongs and the role(s) he has in them.
List<String>	getLicenseTitles() Get the list of licenses' titles.
List<eu.trentorise.opendata.jackan.model.CkanOrganization>	getOrganizationsByUser(String username) Returns the list of organizations to whom the user belongs.
List<String>	getOrganizationsNamesByUser(String username) Returns the list of organizations' names to whom the user belongs.
CKanUserWrapper	getUserFromApiKey(String apiKey) Retrieve the user given the API_KEY (the user is retrieved if it is active).

Methods inherited from class java.lang.Object

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

Constructor Detail

CKanUtilsImpl

public CKanUtilsImpl(String scope)
              throws Exception

Throws:

Exception

Method Detail

getApiKeyFromUser

public String getApiKeyFromUser(String username)

Description copied from interface: CKanUtilsInterface

Retrieve the API_KEY given the username .

Specified by:

getApiKeyFromUser in interface CKanUtilsInterface

Returns:

an API_KEY string

getUserFromApiKey

public CKanUserWrapper getUserFromApiKey(String apiKey)

Description copied from interface: CKanUtilsInterface

Retrieve the user given the API_KEY (the user is retrieved if it is active).

Specified by:

getUserFromApiKey in interface CKanUtilsInterface

Returns:

an API_KEY string

getOrganizationsByUser

public List<eu.trentorise.opendata.jackan.model.CkanOrganization> getOrganizationsByUser(String username)

Description copied from interface: CKanUtilsInterface

Returns the list of organizations to whom the user belongs.

Specified by:

getOrganizationsByUser in interface CKanUtilsInterface

Returns:

a list of organizations

getGroupsAndRolesByUser

public Map<String,List<ROLES_IN_ORGANIZATION>> getGroupsAndRolesByUser(String username,
                                                              List<ROLES_IN_ORGANIZATION> rolesToMatch)

Description copied from interface: CKanUtilsInterface

Given a username and a list of roles to be matched, find the organizations to who the user belongs and the role(s) he has in them.

Specified by:

getGroupsAndRolesByUser in interface CKanUtilsInterface

Returns:

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

getCatalogueUrl

public String getCatalogueUrl()

Description copied from interface: CKanUtilsInterface

Return the ckan catalogue url in this scope.

Specified by:

getCatalogueUrl in interface CKanUtilsInterface

Returns:

getOrganizationsNamesByUser

public List<String> getOrganizationsNamesByUser(String username)

Description copied from interface: CKanUtilsInterface

Returns the list of organizations' names to whom the user belongs.

Specified by:

getOrganizationsNamesByUser in interface CKanUtilsInterface

Returns:

a list of organizations

findLicenseIdByLicense

public String findLicenseIdByLicense(String chosenLicense)

Description copied from interface: CKanUtilsInterface

Finds the id associated to the chosen license

Specified by:

findLicenseIdByLicense in interface CKanUtilsInterface

Returns:

getLicenseTitles

public List<String> getLicenseTitles()

Description copied from interface: CKanUtilsInterface

Get the list of licenses' titles.

Specified by:

getLicenseTitles in interface CKanUtilsInterface

Returns: