Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

returns
a String whose significance varies by the type of event and the type of subject it is
about, as follows:

Panel
borderColor#ccc
bgColor#fff
titleContents of the Detail field in an Event
borderStyledashed

Object Type

Create

Delete

Add

Remove

Modify

ModifyMetadata

Code Block
Bitstream

null,"REGISTER"

Code Block
subject.getSequenceID()

n/a

n/a

null

field list

Code Block
Bundle

null

Code Block
subject.getName()
Code Block
object.getSequenceID()
Code Block
object.getSequenceID()

null

null

Code Block
Item

null

Code Block
subject.getHandle()
Code Block
object.getName()
Code Block
object.getName()

null, "WITHDRAW", "REINSTATE"

DC field list

Code Block
Collection
Code Block
subject.getHandle()
Code Block
subject.getHandle()
Code Block
object.getHandle()
Code Block
object.getHandle()

"remove_template_item",null

metadata field names

Code Block
Community
Code Block
subject.getHandle()
Code Block
subject.getHandle()
Code Block
object.getHandle()
Code Block
object.getHandle()

null

metadata field names

Code Block
EPerson

null

Code Block
subject.getEMail()

n/a

n/a

null

field names

Code Block
Group

null

Code Block
subject.getName()
Code Block
object.getEMail(), object.getName()
Code Block
object.getEMail(), object.getName()

n/a

"name"

Code Block
Site

n/a

n/a

Code Block
object.getHandle()

n/a

n/a

n/a

Key:

  • n/a means the event does not occur; for example, a Bitstream cannot add or remove members.
  • null means the field is set to the null value.
  • A comma-separated list describes several different possibilities.

...

DSpace 1.5 and later requires Java 1.5 or later to build and run. Be sure your default java invocation or

...

$JAVA_HOME

...

is running Sun's JVM of at least that version. It was tested under Sun JRE Standard Edition 1.5.0_08.

...

Here is a list of all the configuration keys, topic, followed by
by an example (default) fragment of your configuration file.

Consumers

...

event.consumer.

...

name

...

.class

...

- Creates a consumer named name, the
value is a fully-qualified Java class name that implements the consumer.
There must be a corresponding filters configuration.

...

event.consumer.

...

name

...

.filters

...

- Defines a set of event filters
for the named Consumer. The value is a list of "filters" which select
the events this consumer will see, selected by combinations of
DSpace object type and action. The filter list value consists of a
set of filter
clauses separated
by colons (

...

:

...

). Each clause is a set of DSpace Object types, a
plus sign (+), and a set of actions. The object and action lists are
separated by vertical-bar (|). Here is a rough grammar:

Panel

Wiki Markup
filter-list ::= filter \[ ":" filter \]..

filter ::= object-set "+" action-set

Wiki Markup
object-set ::= object \[ "\|" object\]..

Wiki Markup
action-set ::= action \[ "\|" action\]..

object ::= "All" | "Bitstream" | "Bundle" | "Item" | "Collection" | "Community" | "Site" | "Group" | "Eperson"

action ::= "All" | "Create" | "Modify" | "Modify_Metadata" | "Add" | "Remove" | "Delete"

The special value

...

"All"

...

denotes all available objects or actions. The filter

...

All+All

...

allows all events through.

The filters in a list are logically ORed together, although they should
be distinct.

Whitespace and case are ignored in the filter list, so e.g.

...

ALL

...

is as good as

...

all

...

.

Dispatchers

Code Block
event.dispatcher.

...

To start the broker, run the command

Panel

dspace-install/bin/asynch-broker start

e.g.

Panel

/dspace/bin/asynch-broker start

To stop the broker (perhaps to restart it), run the command

Panel

dspace-install/bin/asynch-broker stop

You can make these commands part of the regular startup and shutdown
procedure of your server; they are designed to be invoked from
System-V-type "rc.d" scripts as are used on Solaris and Linux. Just
be sure to run it as the same user who owns your DSpace processes.

...

To process asynchronous events, you can run one consumer at a time
with the command:

Panel

/dspace/bin/dsrun org.dspace.event.AsynchEventManager -c CONSUMER

e.g.

Panel

/dspace/bin/dsrun org.dspace.event.AsynchEventManager -c mail

..substituting the consumer name for

...