Interface Ckan2Zenodo
-
- All Known Implementing Classes:
Ckan2ZenodoImpl
public interface Ckan2Zenodo
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description EnvironmentReportcheckEnvironment()Checks environment configuration -gCat is present -Zenodo credentials are presentList<CkanResource>filterResources(CkanItemDescriptor desc)Filters ckan resources of @param desc by using mappings declared in current VREZenodoDepositionforceTranslation(CkanItemDescriptor desc)Forces translation of passed @param desc without raising Configuration ExceptionZenodoDepositionpublish(ZenodoDeposition dep, CkanItemDescriptor toUpdate)Publishes @param dep, setting/updateing DOI reference into @param toUpdateCkanItemDescriptorread(String itemName)Loads a CkanItem identified by @param itemName from current VRE gCatZenodoDepositiontranslate(CkanItemDescriptor desc)Translates @param desc into a ZenodoDeposition using mappings declared in current VRE and previous existing Zenodo Deposition if anyZenodoDepositionupdatedMetadata(ZenodoDeposition toUpdate)Create / update metadata of @param toUpdate into the Zenodo instance declared in current VREFuture<ZenodoDeposition>uploadFiles(Set<CkanResource> toUpload, ZenodoDeposition deposition)Same as uploadFiles(SettoUpload,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:
InvalidItemExceptionZenodoExceptionConfigurationExceptionTransformationException
-
forceTranslation
ZenodoDeposition forceTranslation(CkanItemDescriptor desc) throws InvalidItemException, ZenodoException, TransformationException
Forces translation of passed @param desc without raising Configuration Exception- Parameters:
desc-- Returns:
- *
- Throws:
TransformationExceptionZenodoExceptionInvalidItemException
-
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:
ZenodoExceptionConfigurationException
-
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:
ConfigurationExceptionTransformationException
-
uploadFiles
Future<ZenodoDeposition> uploadFiles(Set<CkanResource> toUpload, ZenodoDeposition deposition) throws ZenodoException, ConfigurationException
Same as uploadFiles(SettoUpload,ZenodoDeposition deposition,UploadPolicy policy) with default policy - Parameters:
toUpload-deposition-- Returns:
- Throws:
ZenodoExceptionConfigurationException
-
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:
ZenodoExceptionConfigurationExceptionInvalidItemExceptionMalformedURLException
-
checkEnvironment
EnvironmentReport checkEnvironment()
Checks environment configuration -gCat is present -Zenodo credentials are present
-
-