Ckan2Zenodo (CKAN 2 Zenodo Library 1.0.2-SNAPSHOT API)

All Known Implementing Classes:

Ckan2ZenodoImpl
```
public interface Ckan2Zenodo
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`EnvironmentReport`	`checkEnvironment()` Checks environment configuration -gCat is present -Zenodo credentials are present
`List<CkanResource>`	`filterResources(CkanItemDescriptor desc)` Filters ckan resources of @param desc by using mappings declared in current VRE
`ZenodoDeposition`	`forceTranslation(CkanItemDescriptor desc)` Forces translation of passed @param desc without raising Configuration Exception
`ZenodoDeposition`	`publish(ZenodoDeposition dep, CkanItemDescriptor toUpdate)` Publishes @param dep, setting/updateing DOI reference into @param toUpdate
`CkanItemDescriptor`	`read(String itemName)` Loads a CkanItem identified by @param itemName from current VRE gCat
`ZenodoDeposition`	`translate(CkanItemDescriptor desc)` Translates @param desc into a ZenodoDeposition using mappings declared in current VRE and previous existing Zenodo Deposition if any
`ZenodoDeposition`	`updatedMetadata(ZenodoDeposition toUpdate)` Create / update metadata of @param toUpdate into the Zenodo instance declared in current VRE
`Future<ZenodoDeposition>`	`uploadFiles(Set<CkanResource> toUpload, ZenodoDeposition deposition)` Same as uploadFiles(Set toUpload,ZenodoDeposition deposition,UploadPolicy policy) with default policy

Method Detail

read
```
CkanItemDescriptor read(String itemName)
                 throws GcatException
```
Loads a CkanItem identified by @param itemName from current VRE gCat

Parameters:

itemName -

Returns:

Throws:

GcatException

translate

ZenodoDeposition translate(CkanItemDescriptor desc)
                    throws InvalidItemException,
                           ZenodoException,
                           ConfigurationException,
                           TransformationException

Translates @param desc into a ZenodoDeposition using mappings declared in current VRE and previous existing Zenodo Deposition if any

Parameters:: desc -
Returns:
Throws:: InvalidItemException; ZenodoException; ConfigurationException; TransformationException

forceTranslation

ZenodoDeposition forceTranslation(CkanItemDescriptor desc)
                           throws InvalidItemException,
                                  ZenodoException,
                                  TransformationException

Forces translation of passed @param desc without raising Configuration Exception

Parameters:: desc -
Returns:: *
Throws:: TransformationException; ZenodoException; InvalidItemException

updatedMetadata

ZenodoDeposition updatedMetadata(ZenodoDeposition toUpdate)
                          throws ZenodoException,
                                 ConfigurationException

Create / update metadata of @param toUpdate into the Zenodo instance declared in current VRE

Parameters:: toUpdate -
Returns:
Throws:: ZenodoException; ConfigurationException

filterResources
```
List<CkanResource> filterResources(CkanItemDescriptor desc)
                            throws TransformationException
```
Filters ckan resources of @param desc by using mappings declared in current VRE

Parameters:

desc -

Returns:

Throws:

ConfigurationException

TransformationException

uploadFiles

Future<ZenodoDeposition> uploadFiles(Set<CkanResource> toUpload,
                                     ZenodoDeposition deposition)
                              throws ZenodoException,
                                     ConfigurationException

Same as uploadFiles(Set toUpload,ZenodoDeposition deposition,UploadPolicy policy) with default policy

Parameters:: toUpload -; deposition -
Returns:
Throws:: ZenodoException; ConfigurationException

publish

ZenodoDeposition publish(ZenodoDeposition dep,
                         CkanItemDescriptor toUpdate)
                  throws ZenodoException,
                         ConfigurationException,
                         InvalidItemException,
                         MalformedURLException

Publishes @param dep, setting/updateing DOI reference into @param toUpdate

Parameters:: dep -; toUpdate -
Returns:
Throws:: ZenodoException; ConfigurationException; InvalidItemException; MalformedURLException

checkEnvironment
```
EnvironmentReport checkEnvironment()
```
Checks environment configuration -gCat is present -Zenodo credentials are present

Interface Ckan2Zenodo