Package org.dspace.app.suggestion.script

Class PublicationLoaderScriptConfiguration<T extends PublicationLoaderRunnable>

java.lang.Object

org.dspace.scripts.configuration.ScriptConfiguration<T>

org.dspace.app.suggestion.script.PublicationLoaderScriptConfiguration<T>

Type Parameters:

T - The specific type of PublicationLoaderRunnable that this configuration supports.

All Implemented Interfaces:

Aware, BeanNameAware

Direct Known Subclasses:

PublicationLoaderCliScriptConfiguration

public class PublicationLoaderScriptConfiguration<T extends PublicationLoaderRunnable>
extends ScriptConfiguration<T>

Configuration class for the PublicationLoader script. This class extends ScriptConfiguration to provide configuration settings and execution permissions for the PublicationLoaderRunnable script.

Author:

Adamo Fapohunda (adamo.fapohunda at 4science.com)

Field Summary

Fields inherited from class org.dspace.scripts.configuration.ScriptConfiguration

options

Constructor Summary

Constructors

Constructor	Description
PublicationLoaderScriptConfiguration()

Method Summary

Modifier and Type	Method	Description
Class<T>	getDspaceRunnableClass()	Retrieves the class type of the DSpace runnable script.
org.apache.commons.cli.Options	getOptions()	Defines the command-line options available for the script.
boolean	isAllowedToExecute(Context context, List<DSpaceCommandLineParameter> commandLineParameters)	Determines whether the current user is authorized to execute the script.
void	setDspaceRunnableClass(Class<T> dspaceRunnableClass)	Sets the class type of the DSpace runnable script.

Methods inherited from class org.dspace.scripts.configuration.ScriptConfiguration

getDescription, getHelpOptions, getName, setBeanName, setDescription, setName

Methods inherited from class java.lang.Object

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

Constructor Details

PublicationLoaderScriptConfiguration

public PublicationLoaderScriptConfiguration()

Method Details

getDspaceRunnableClass

public Class<T> getDspaceRunnableClass()

Retrieves the class type of the DSpace runnable script.

Specified by:

getDspaceRunnableClass in class ScriptConfiguration<T extends PublicationLoaderRunnable>

Returns:

the class of type PublicationLoaderScriptConfiguration representing the script to execute.

setDspaceRunnableClass

public void setDspaceRunnableClass(Class<T> dspaceRunnableClass)

Sets the class type of the DSpace runnable script.

Specified by:

setDspaceRunnableClass in class ScriptConfiguration<T extends PublicationLoaderRunnable>

Parameters:

dspaceRunnableClass - The class of the script to be set.

isAllowedToExecute

public boolean isAllowedToExecute(Context context,
 List<DSpaceCommandLineParameter> commandLineParameters)

Determines whether the current user is authorized to execute the script. This check is based on whether the user has administrator privileges.

Overrides:

isAllowedToExecute in class ScriptConfiguration<T extends PublicationLoaderRunnable>

Parameters:

context - The DSpace context.

commandLineParameters - The list of command line parameters provided.

Returns:

true if the user has administrative privileges, false otherwise.

Throws:

RuntimeException - if an SQL exception occurs while checking authorization.

getOptions

public org.apache.commons.cli.Options getOptions()

Defines the command-line options available for the script. These options allow customization of the script execution parameters.

Specified by:

getOptions in class ScriptConfiguration<T extends PublicationLoaderRunnable>

Returns:

an Options object containing the available script options.