Package org.gcube.common.software.processor.zenodo

Class ZenodoExporter

java.lang.Object

org.gcube.common.software.processor.SoftwareArtifactProcessor

org.gcube.common.software.processor.zenodo.ZenodoExporter

public class ZenodoExporter
extends SoftwareArtifactProcessor

Author:

Luca Frosini (ISTI - CNR)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ZenodoExporter.AutoHeaderFilter	Client Request Filter to automatically add headers to all requests
protected static class	ZenodoExporter.ClientAndBuilder	Wrapper class to hold both client and builder for proper resource management
static class	ZenodoExporter.RateLimitResponseFilter	Client Response Filter to automatically apply rate limiting after each response

Field Summary

Fields

Modifier and Type	Field	Description
protected String	accessToken
static final String	ADDITIONAL_HTML_DESCRIPTION_CONFIG_FIELD_NAME
static final String	COMMUNITIES_FIELD_NAME
static final String	DEPOSITION_PATH
static final String	DEPOSITIONS_COLLECTION_PATH
static final String	DEPOSTION_EDIT_PATH
static final String	DEPOSTION_FILES_PATH
static final String	DEPOSTION_NEW_VERSION_PATH
static final String	DEPOSTION_PUBLISH_PATH
protected String	doiBaseURL
static final String	EXPORT_FILENAME_EXTENSION
static final String	GUCBE_ZENODO_SOFTWARE_DEPOSIT
static final String	HTML_DESCRIPTION_CONFIG_FIELD_NAME
static final String	METADATA_FIELD_NAME
static final String	RECORD_PATH
protected com.fasterxml.jackson.databind.JsonNode	response
static final String	SKIP_GRANTS_CONFIG_FIELD_NAME
protected URL	zenodoBaseURL
protected String	zenodoID

Fields inherited from class org.gcube.common.software.processor.SoftwareArtifactProcessor

availableProcessors, exportFileNameExtension, first, globalConfig, last, outputDirectory, processorConfig, softwareArtifactMetadata

Constructor Summary

Constructors

Constructor	Description
ZenodoExporter()

Method Summary

Modifier and Type	Method	Description
protected void	addFilesToDeposition(List<File> files)
protected void	commitVersion()
void	create()
protected String	createZenodoDOIURLFromID(String id)
protected void	deletePreviousFiles(com.fasterxml.jackson.databind.JsonNode jsonNode)	Remove previous depositionFiles
void	export()
protected void	finalizeProcessing()
protected String	getConfig(String propertyName)
protected jakarta.ws.rs.client.Client	getJerseyClientWithAutoHeaders(String baseUrl)	Creates a Jersey Client with automatic header injection and rate limiting
protected com.fasterxml.jackson.databind.node.ObjectNode	getObjectNode()
File	getOutputFile()
protected void	getZenodoConnectionConfig()
protected String	getZenodoIDFromDOIURL(String doiURL)
protected String	getZenodoIDFromDOIURL(URL doiURL)
protected ZenodoExporter.ClientAndBuilder	getZenodoRequestBuilderWithClient(String path)	Alternative method that returns both client and builder for manual resource management
void	newVersion()
void	update()
protected void	updateMetadata()
protected void	writeObjectNodeToFile(com.fasterxml.jackson.databind.node.ObjectNode toBeExported, File file)

Methods inherited from class org.gcube.common.software.processor.SoftwareArtifactProcessor

getAvailableProcessors, getGlobalConfig, getProcessorConfig, getSoftwareArtifactConfig, setFirst, setGlobalConfig, setLast, setOutputDirectory, setProcessorConfig, setSoftwareArtifactConfig

Methods inherited from class java.lang.Object

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

Field Details

EXPORT_FILENAME_EXTENSION

public static final String EXPORT_FILENAME_EXTENSION

See Also:

• Constant Field Values

GUCBE_ZENODO_SOFTWARE_DEPOSIT

public static final String GUCBE_ZENODO_SOFTWARE_DEPOSIT

See Also:

• Constant Field Values

HTML_DESCRIPTION_CONFIG_FIELD_NAME

public static final String HTML_DESCRIPTION_CONFIG_FIELD_NAME

See Also:

• Constant Field Values

ADDITIONAL_HTML_DESCRIPTION_CONFIG_FIELD_NAME

public static final String ADDITIONAL_HTML_DESCRIPTION_CONFIG_FIELD_NAME

See Also:

• Constant Field Values

SKIP_GRANTS_CONFIG_FIELD_NAME

public static final String SKIP_GRANTS_CONFIG_FIELD_NAME

See Also:

• Constant Field Values

METADATA_FIELD_NAME

public static final String METADATA_FIELD_NAME

See Also:

• Constant Field Values

COMMUNITIES_FIELD_NAME

public static final String COMMUNITIES_FIELD_NAME

See Also:

• Constant Field Values

DEPOSITIONS_COLLECTION_PATH

public static final String DEPOSITIONS_COLLECTION_PATH

See Also:

• Constant Field Values

DEPOSITION_PATH

public static final String DEPOSITION_PATH

See Also:

• Constant Field Values

RECORD_PATH

public static final String RECORD_PATH

See Also:

• Constant Field Values

DEPOSTION_FILES_PATH

public static final String DEPOSTION_FILES_PATH

See Also:

• Constant Field Values

DEPOSTION_NEW_VERSION_PATH

public static final String DEPOSTION_NEW_VERSION_PATH

See Also:

• Constant Field Values

DEPOSTION_EDIT_PATH

public static final String DEPOSTION_EDIT_PATH

See Also:

• Constant Field Values

DEPOSTION_PUBLISH_PATH

public static final String DEPOSTION_PUBLISH_PATH

See Also:

• Constant Field Values

zenodoBaseURL

protected URL zenodoBaseURL

accessToken

protected String accessToken

zenodoID

protected String zenodoID

response

protected com.fasterxml.jackson.databind.JsonNode response

doiBaseURL

protected String doiBaseURL

Constructor Details

ZenodoExporter

public ZenodoExporter()

Method Details

getZenodoIDFromDOIURL

protected String getZenodoIDFromDOIURL(URL doiURL)

getZenodoIDFromDOIURL

protected String getZenodoIDFromDOIURL(String doiURL)

addFilesToDeposition

protected void addFilesToDeposition(List<File> files)
                             throws Exception

Throws:

Exception

getJerseyClientWithAutoHeaders

protected jakarta.ws.rs.client.Client getJerseyClientWithAutoHeaders(String baseUrl)

Creates a Jersey Client with automatic header injection and rate limiting

Parameters:

baseUrl - the base URL for the API

Returns:

configured Jersey Client instance with automatic headers and rate limiting

getZenodoRequestBuilderWithClient

protected ZenodoExporter.ClientAndBuilder getZenodoRequestBuilderWithClient(String path)

Alternative method that returns both client and builder for manual resource management

Parameters:

path - the API endpoint path

Returns:

ClientAndBuilder wrapper containing both client and builder

updateMetadata

protected void updateMetadata()
                       throws Exception

Throws:

Exception

commitVersion

protected void commitVersion()
                      throws Exception

Throws:

Exception

finalizeProcessing

protected void finalizeProcessing()
                           throws Exception

Throws:

Exception

createZenodoDOIURLFromID

protected String createZenodoDOIURLFromID(String id)
                                   throws MalformedURLException

Throws:

MalformedURLException

create

public void create()
            throws Exception

Throws:

Exception

update

public void update()
            throws Exception

Throws:

Exception

deletePreviousFiles

protected void deletePreviousFiles(com.fasterxml.jackson.databind.JsonNode jsonNode)
                            throws Exception

Remove previous depositionFiles

Throws:

Exception

newVersion

public void newVersion()
                throws Exception

Throws:

Exception

getConfig

protected String getConfig(String propertyName)
                    throws Exception

Throws:

Exception

getZenodoConnectionConfig

protected void getZenodoConnectionConfig()
                                  throws Exception

Throws:

Exception

export

public void export()
            throws Exception

Specified by:

export in class SoftwareArtifactProcessor

Throws:

Exception

getObjectNode

protected com.fasterxml.jackson.databind.node.ObjectNode getObjectNode()
                                                                throws Exception

Throws:

Exception

writeObjectNodeToFile

protected void writeObjectNodeToFile(com.fasterxml.jackson.databind.node.ObjectNode toBeExported,
 File file)
                              throws Exception

Throws:

Exception

getOutputFile

public File getOutputFile()
                   throws Exception

Overrides:

getOutputFile in class SoftwareArtifactProcessor

Throws:

Exception