public class EmbargoManager extends Object
Configuration properties: (with examples)
# DC metadata field to hold the user-supplied embargo terms
embargo.field.terms = dc.embargo.terms
# DC metadata field to hold computed "lift date" of embargo
embargo.field.lift = dc.date.available
# String to indicate indefinite (forever) embargo in terms
embargo.terms.open = Indefinite
# implementation of embargo setter plugin
plugin.single.org.dspace.embargo.EmbargoSetter = edu.my.Setter
# implementation of embargo lifter plugin
plugin.single.org.dspace.embargo.EmbargoLifter = edu.my.Lifter
| Modifier and Type | Field and Description |
|---|---|
static DCDate |
FOREVER
Special date signalling an Item is to be embargoed forever.
|
| Constructor and Description |
|---|
EmbargoManager() |
| Modifier and Type | Method and Description |
|---|---|
static DCDate |
getEmbargoTermsAsDate(Context context,
Item item)
Get the embargo lift date for an Item, if any.
|
static void |
liftEmbargo(Context context,
Item item)
Lift the embargo on an item which is assumed to be under embargo.
|
static void |
main(String[] argv)
Command-line service to scan for every Item with an expired embargo,
and then lift that embargo.
|
static void |
setEmbargo(Context context,
Item item)
Put an Item under embargo until the specified lift date.
|
public static final DCDate FOREVER
public static void setEmbargo(Context context, Item item) throws SQLException, AuthorizeException, IOException
context - the DSpace contextitem - the item to embargoSQLExceptionAuthorizeExceptionIOExceptionpublic static DCDate getEmbargoTermsAsDate(Context context, Item item) throws SQLException, AuthorizeException, IOException
Note that the plugin is *always* called, in case it gets its cue for the embargo date from sources other than, or in addition to, the specified field.
context - the DSpace contextitem - the item to embargoSQLExceptionAuthorizeExceptionIOExceptionpublic static void liftEmbargo(Context context, Item item) throws SQLException, AuthorizeException, IOException
context - the DSpace contextitem - the item on which to lift the embargoSQLExceptionAuthorizeExceptionIOExceptionpublic static void main(String[] argv)
Options:
Copyright © 2015 DuraSpace. All Rights Reserved.