org.gcube.dataaccess.ckanutillibrary

Interface CKanUtilsInterface

All Known Implementing Classes:

CKanUtilsImpl

public interface CKanUtilsInterface

This is the ckan-util-library interface that shows the utility methods.

Author:

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

Method Summary

Methods

Modifier and Type	Method and Description
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).

Method Detail

getApiKeyFromUser

String getApiKeyFromUser(String username)

Retrieve the API_KEY given the username .

Parameters:

username -

Returns:

an API_KEY string

getUserFromApiKey

CKanUserWrapper getUserFromApiKey(String apiKey)

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

Parameters:

username -

Returns:

an API_KEY string

getOrganizationsByUser

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

Returns the list of organizations to whom the user belongs.

Parameters:

username -

Returns:

a list of organizations

getOrganizationsNamesByUser

List<String> getOrganizationsNamesByUser(String username)

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

Parameters:

username -

Returns:

a list of organizations

getGroupsAndRolesByUser

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.

Parameters:

username -

rolesToMatch -

Returns:

getCatalogueUrl

String getCatalogueUrl()

Return the ckan catalogue url in this scope.

Returns:

getLicenseTitles

List<String> getLicenseTitles()

Get the list of licenses' titles.

Returns:

findLicenseIdByLicense

String findLicenseIdByLicense(String chosenLicense)

Finds the id associated to the chosen license

Parameters:

chosenLicense -

Returns: