org.dspace.eperson

Class Subscribe

java.lang.Object

org.dspace.eperson.Subscribe

public class Subscribe
extends java.lang.Object

Class defining methods for sending new item e-mail alerts to users

Version:

$Revision$

Author:

Robert Tansley

Constructor Summary

Constructors

Constructor and Description
Subscribe()

Method Summary

Methods

Modifier and Type	Method and Description
static Collection[]	getAvailableSubscriptions(Context context) Find out which collections the currently logged in e-person can subscribe to
static Collection[]	getAvailableSubscriptions(Context context, EPerson eperson) Find out which collections an e-person can subscribe to
static Collection[]	getSubscriptions(Context context, EPerson eperson) Find out which collections an e-person is subscribed to
static boolean	isSubscribed(Context context, EPerson eperson, Collection collection) Is that e-person subscribed to that collection?
static void	main(java.lang.String[] argv) Method for invoking subscriptions via the command line
static void	processDaily(Context context, boolean test) Process subscriptions.
static void	sendEmail(Context context, EPerson eperson, java.util.List<Collection> collections, boolean test) Sends an email to the given e-person with details of new items in the given collections, items that appeared yesterday.
static void	subscribe(Context context, EPerson eperson, Collection collection) Subscribe an e-person to a collection.
static void	unsubscribe(Context context, EPerson eperson, Collection collection) Unsubscribe an e-person to a collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

Subscribe

public Subscribe()

Method Detail

subscribe

public static void subscribe(Context context,
             EPerson eperson,
             Collection collection)
                      throws java.sql.SQLException,
                             AuthorizeException

Subscribe an e-person to a collection. An e-mail will be sent every day a new item appears in the collection.

Parameters:

context - DSpace context

eperson - EPerson to subscribe

collection - Collection to subscribe to

Throws:

java.sql.SQLException

AuthorizeException

unsubscribe

public static void unsubscribe(Context context,
               EPerson eperson,
               Collection collection)
                        throws java.sql.SQLException,
                               AuthorizeException

Unsubscribe an e-person to a collection. Passing in null for the collection unsubscribes the e-person from all collections they are subscribed to.

Parameters:

context - DSpace context

eperson - EPerson to unsubscribe

collection - Collection to unsubscribe from

Throws:

java.sql.SQLException

AuthorizeException

getSubscriptions

public static Collection[] getSubscriptions(Context context,
                            EPerson eperson)
                                     throws java.sql.SQLException

Find out which collections an e-person is subscribed to

Parameters:

context - DSpace context

eperson - EPerson

Returns:

array of collections e-person is subscribed to

Throws:

java.sql.SQLException

getAvailableSubscriptions

public static Collection[] getAvailableSubscriptions(Context context)
                                              throws java.sql.SQLException

Find out which collections the currently logged in e-person can subscribe to

Parameters:

context - DSpace context

eperson - EPerson

Returns:

array of collections the currently logged in e-person can subscribe to

Throws:

java.sql.SQLException

getAvailableSubscriptions

public static Collection[] getAvailableSubscriptions(Context context,
                                     EPerson eperson)
                                              throws java.sql.SQLException

Find out which collections an e-person can subscribe to

Parameters:

context - DSpace context

eperson - EPerson

Returns:

array of collections e-person can subscribe to

Throws:

java.sql.SQLException

isSubscribed

public static boolean isSubscribed(Context context,
                   EPerson eperson,
                   Collection collection)
                            throws java.sql.SQLException

Is that e-person subscribed to that collection?

Parameters:

context - DSpace context

eperson - find out if this e-person is subscribed

collection - find out if subscribed to this collection

Returns:

true if they are subscribed

Throws:

java.sql.SQLException

processDaily

public static void processDaily(Context context,
                boolean test)
                         throws java.sql.SQLException,
                                java.io.IOException

Process subscriptions. This must be invoked only once a day. Messages are only sent out when a collection has actually received new items, so that people's mailboxes are not clogged with many "no new items" mails.

Yesterday's newly available items are included. If this is run at for example midday, any items that have been made available during the current day will not be included, but will be included in the next day's run.

For example, if today's date is 2002-10-10 (in UTC) items made available during 2002-10-09 (UTC) will be included.

Parameters:

context - DSpace context object

test -

Throws:

java.sql.SQLException

java.io.IOException

sendEmail

public static void sendEmail(Context context,
             EPerson eperson,
             java.util.List<Collection> collections,
             boolean test)
                      throws java.io.IOException,
                             javax.mail.MessagingException,
                             java.sql.SQLException

Sends an email to the given e-person with details of new items in the given collections, items that appeared yesterday. No e-mail is sent if there aren't any new items in any of the collections.

Parameters:

context - DSpace context object

eperson - eperson to send to

collections - List of collection IDs (Integers)

test -

Throws:

java.io.IOException

javax.mail.MessagingException

java.sql.SQLException

main

public static void main(java.lang.String[] argv)

Method for invoking subscriptions via the command line

Parameters:

argv - command-line arguments, none used yet