Package org.dspace.subscriptions

Class SubscriptionEmailNotification

java.lang.Object

org.dspace.scripts.DSpaceRunnable<SubscriptionEmailNotificationConfiguration<SubscriptionEmailNotification>>

org.dspace.subscriptions.SubscriptionEmailNotification

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

SubscriptionEmailNotificationCli

public class SubscriptionEmailNotification
extends DSpaceRunnable<SubscriptionEmailNotificationConfiguration<SubscriptionEmailNotification>>

Implementation of DSpaceRunnable to find subscribed objects and send notification mails about them

Author:

alba aliu

Nested Class Summary

Nested classes/interfaces inherited from class org.dspace.scripts.DSpaceRunnable

DSpaceRunnable.StepResult

Field Summary

Fields inherited from class org.dspace.scripts.DSpaceRunnable

commandLine, handler, helpCommandLine

Constructor Summary

Constructors

Constructor	Description
SubscriptionEmailNotification()

Method Summary

Modifier and Type	Method	Description
Context	getContext()
SubscriptionEmailNotificationConfiguration<SubscriptionEmailNotification>	getScriptConfiguration()	This method will return the Configuration that the implementing DSpaceRunnable uses
SubscriptionEmailNotificationService	getSubscriptionEmailNotificationService()
void	internalRun()	This method has to be included in every script and this will be the main execution block for the script that'll contain all the logic needed
void	setContext(Context context)
void	setSubscriptionEmailNotificationService(SubscriptionEmailNotificationService notificationService)
void	setup()	This method has to be included in every script and handles the setup of the script by parsing the CommandLine and setting the variables

Methods inherited from class org.dspace.scripts.DSpaceRunnable

getEpersonIdentifier, getFileNamesFromInputStreamOptions, initialize, printHelp, run, setEpersonIdentifier

Methods inherited from class java.lang.Object

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

Constructor Detail

SubscriptionEmailNotification

public SubscriptionEmailNotification()

Method Detail

getScriptConfiguration

public SubscriptionEmailNotificationConfiguration<SubscriptionEmailNotification> getScriptConfiguration()

Description copied from class: DSpaceRunnable

This method will return the Configuration that the implementing DSpaceRunnable uses

Specified by:

getScriptConfiguration in class DSpaceRunnable<SubscriptionEmailNotificationConfiguration<SubscriptionEmailNotification>>

Returns:

The ScriptConfiguration that this implementing DspaceRunnable uses

setup

public void setup()
           throws org.apache.commons.cli.ParseException

Description copied from class: DSpaceRunnable

This method has to be included in every script and handles the setup of the script by parsing the CommandLine and setting the variables

Specified by:

setup in class DSpaceRunnable<SubscriptionEmailNotificationConfiguration<SubscriptionEmailNotification>>

Throws:

org.apache.commons.cli.ParseException - If something goes wrong

internalRun

public void internalRun()
                 throws Exception

Description copied from class: DSpaceRunnable

This method has to be included in every script and this will be the main execution block for the script that'll contain all the logic needed

Specified by:

internalRun in class DSpaceRunnable<SubscriptionEmailNotificationConfiguration<SubscriptionEmailNotification>>

Throws:

Exception - If something goes wrong

getSubscriptionEmailNotificationService

public SubscriptionEmailNotificationService getSubscriptionEmailNotificationService()

setSubscriptionEmailNotificationService

public void setSubscriptionEmailNotificationService(SubscriptionEmailNotificationService notificationService)

getContext

public Context getContext()

setContext

public void setContext(Context context)