eu.trentorise.opendata.jackan

Class CheckedCkanClient

java.lang.Object

eu.trentorise.opendata.jackan.CkanClient

eu.trentorise.opendata.jackan.CheckedCkanClient

public class CheckedCkanClient
extends CkanClient

This client performs additional checks when writing to CKAN to ensure written content is correct. For this reason it might do additional calls and results of validation might be different from default Ckan ones. But if Ckan actually performed all the checks it should do there wouldn't be any need of this class as well..

Note: For create operations, this client fails if item is already existing on the server. This behaviour is different from ckan default upsert behaviour (update an existing) to prevent misuse.

Since:

0.4.1

Author:

David Leoni

Nested Class Summary

Nested classes/interfaces inherited from class eu.trentorise.opendata.jackan.CkanClient

CkanClient.Builder, CkanClient.GroupForDatasetPosting

Field Summary

Fields inherited from class eu.trentorise.opendata.jackan.CkanClient

CKAN_NO_MILLISECS_PATTERN, CKAN_TIMESTAMP_PATTERN, DEFAULT_TIMEOUT, NONE, SUPPORTED_API_VERSIONS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CheckedCkanClient()
protected	CheckedCkanClient(String url)
	CheckedCkanClient(String catalogUrl, String ckanToken)

Method Summary

Methods

Modifier and Type	Method and Description
static CkanClient.Builder	builder() Returns a builder instance.
CkanDataset	createDataset(CkanDatasetBase dataset) Creates CkanDataset on the server.
CkanGroup	createGroup(CkanGroup group) Creates CkanGroup on the server.
CkanOrganization	createOrganization(CkanOrganization org) Creates CkanOrganization on the server.
CkanResource	createResource(CkanResourceBase resource) Creates ckan resource on the server.
CkanDataset	patchUpdateDataset(CkanDatasetBase dataset) Jackan specific.
CkanResource	patchUpdateResource(CkanResourceBase resource) Jackan specific.
CkanDataset	updateDataset(CkanDatasetBase dataset) Updates a dataset on the ckan server using a straight package_update call.
CkanResource	updateResource(CkanResourceBase resource) Updates a resource on the server using a straight resource_update call.

Methods inherited from class eu.trentorise.opendata.jackan.CkanClient

configureObjectMapper, configureObjectMapperForPosting, configureRequest, createTag, createUser, createVocabulary, deleteDataset, deleteResource, extrasMapToList, formatTimestamp, getApiVersion, getCatalogUrl, getCkanToken, getDataset, getDatasetList, getDatasetList, getFormats, getGroup, getGroupList, getGroupNames, getLicenseList, getObjectMapper, getObjectMapperForPosting, getOrganization, getOrganizationList, getOrganizationNames, getProxy, getResource, getTagList, getTagNamesList, getTagNamesList, getTimeout, getUser, getUserList, makeDatasetUrl, makeGroupUrl, makeOrganizationUrl, makeResourceUrl, newBuilder, parseTimestamp, searchDatasets, searchDatasets, throwCkanException, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckedCkanClient

protected CheckedCkanClient()

CheckedCkanClient

protected CheckedCkanClient(String url)

CheckedCkanClient

public CheckedCkanClient(String catalogUrl,
                 @Nullable
                 String ckanToken)

Method Detail

builder

public static CkanClient.Builder builder()

Returns a builder instance. The builder is not threadsafe and you can use one builder instance to build only one client instance.

createOrganization

public CkanOrganization createOrganization(CkanOrganization org)

Creates CkanOrganization on the server.

NOTE: In CheckedCkanClient create operations fail if item already exists. This is different from Ckan default behaviour, which updates items if they already exist.

Overrides:

createOrganization in class CkanClient

Parameters:

org - requires at least the name or id. Only non-null fields of CkanGroupOrgBase will be sent to server.

Returns:

a new object with the created organization.

createResource

public CkanResource createResource(CkanResourceBase resource)

Creates ckan resource on the server.

NOTE: In CheckedCkanClient create operations fail if item already exists. This is different from Ckan default behaviour, which updates items if they already exist.

Overrides:

createResource in class CkanClient

Parameters:

resource - ckan resource object with the minimal set of parameters required. See CkanResource.CkanResource(String, String)

Returns:

the newly created resource

updateResource

public CkanResource updateResource(CkanResourceBase resource)

Description copied from class: CkanClient

Updates a resource on the server using a straight resource_update call. Null fields will not be sent and thus won't get updated, but be careful about custom fields of CkanResourceBase.getOthers(), if not sent they will be erased on the server! To prevent this behaviour, see CkanClient.patchUpdateResource(CkanResourceBase)

Overrides:

updateResource in class CkanClient

patchUpdateResource

public CkanResource patchUpdateResource(CkanResourceBase resource)

Description copied from class: CkanClient

Jackan specific. Patches a resource on the ckan server using a resource_update call. Todo: this is a temporary solution until we implement new patch api of CKAN 2.3

Overrides:

patchUpdateResource in class CkanClient

Parameters:

resource - ckan resource object. Fields set to null won't be updated on the server. Items present in lists such as others will be added to existing ones on the server. To support this behaviour provided resource might be patched with latest metadata from the server prior sending it for update.

See Also:

CkanClient.updateResource(CkanResourceBase)

createGroup

public CkanGroup createGroup(CkanGroup group)

Creates CkanGroup on the server.

NOTE: In CheckedCkanClient create operations fail if item already exists. This is different from Ckan default behaviour, which updates items if they already exist.

Overrides:

createGroup in class CkanClient

Parameters:

group - requires at least the name or id. Only non-null fields of CkanGroupOrgBase will be sent to server.

Returns:

a new object with the created group.

createDataset

public CkanDataset createDataset(CkanDatasetBase dataset)

Creates CkanDataset on the server. Will also create eventual resources present in the dataset.

NOTE: In CheckedCkanClient create operations fail if item already exists. This is different from Ckan default behaviour, which updates items if they already exist.

Overrides:

createDataset in class CkanClient

Parameters:

dataset - Ckan dataset without id

Returns:

the newly created dataset

updateDataset

public CkanDataset updateDataset(CkanDatasetBase dataset)

Description copied from class: CkanClient

Updates a dataset on the ckan server using a straight package_update call. Null fields will not be sent and thus won't get updated, but be careful about list fields, if not sent they will be erased on the server! To prevent this behaviour, see CkanClient.patchUpdateDataset(CkanDatasetBase)

Overrides:

updateDataset in class CkanClient

patchUpdateDataset

public CkanDataset patchUpdateDataset(CkanDatasetBase dataset)

Description copied from class: CkanClient

Jackan specific. Patches a dataset on the ckan server using a package_update call. Todo: this is a temporary solution until we implement new patch api of CKAN 2.3

Overrides:

patchUpdateDataset in class CkanClient

Parameters:

dataset - ckan dataset object. Fields set to null won't be updated on the server. Items present in lists such as resources or extras will be added to existing ones on the server. To support this behaviour provided dataset might be patched with latest metadata from the server prior sending it for update.