Jump to content
EPrints Documentation

API:EPrints/DataObj/EventQueue: Difference between revisions

From EPrints Documentation
← Older edit
Pod2wiki (talk | contribs)
291 edits
No edit summary
Pod2wiki (talk | contribs)
291 edits
No edit summary
 
(2 intermediate revisions by the same user not shown)
Line 6: Line 6:
<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
==NAME==
==NAME==
'''EPrints::DataObj::EventQueue''' - scheduler/indexer event queue
'''EPrints::DataObj::EventQueue''' - Scheduler/indexer event queue.
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<span style='display:none'>User Comments</span>
<!-- Edit below this comment -->
 
 
<!-- Pod2Wiki= -->
</div>
<!-- Pod2Wiki=head_description -->
==DESCRIPTION==
Individual tasks for the EPrints event queue that can then be actioned by the EPrints indexer in the background.


<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 165: Line 176:
<!-- Pod2Wiki= -->
<!-- Pod2Wiki= -->
</div>
</div>
<!-- Pod2Wiki=head_methods -->
<!-- Pod2Wiki=head_instance_variables -->
==METHODS==
==INSTANCE VARIABLES==
See [[API:EPrints/DataObj#INSTANCE_VARIABLES|EPrints::DataObj]].
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<span style='display:none'>User Comments</span>
<span style='display:none'>User Comments</span>
Line 174: Line 187:
<!-- Pod2Wiki= -->
<!-- Pod2Wiki= -->
</div>
</div>
<!-- Pod2Wiki=item_get_system_field_info -->
<!-- Pod2Wiki=head_methods -->
===get_system_field_info===
==METHODS==
 
$metadata = EPrints::DataObj::EPrint-&gt;get_system_field_info
Return an array describing the system metadata of the event queue  dataset.
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<span style='display:none'>User Comments</span>
<span style='display:none'>User Comments</span>
Line 187: Line 196:
<!-- Pod2Wiki= -->
<!-- Pod2Wiki= -->
</div>
</div>
<!-- Pod2Wiki=item_get_dataset_id -->
<!-- Pod2Wiki=head_constructor_methods -->
===get_dataset_id===
===Constructor Methods===
 
$dataset = EPrints::DataObj::EPrint-&gt;get_dataset_id
Returns the ID of the [[API:EPrints/DataSet|EPrints::DataSet]] object to which this record belongs.
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<span style='display:none'>User Comments</span>
<span style='display:none'>User Comments</span>
Line 201: Line 206:
</div>
</div>
<!-- Pod2Wiki=item_create_unique -->
<!-- Pod2Wiki=item_create_unique -->
===create_unique===
====create_unique====


  $event = EPrints::DataObj::EventQueue-&gt;create_unique( $session, $data, [ $dataset ] )
  $event = EPrints::DataObj::EventQueue-&gt;create_unique( $session, $data, [ $dataset ] )
Returns a unique event queue task using the <tt>$data</tt> provided. Setting the <tt>eventqueueid</tt> to a MD5 hash of the <tt>pluginid</tt>, <tt>action</tt> and (if given) <tt>params</tt>.
Returns a unique event queue task using the <tt>$data</tt> provided. Setting the <tt>eventqueueid</tt> to a MD5 hash of the <tt>pluginid</tt>, <tt>action</tt> and (if given) <tt>params</tt>.


Returns <tt>undef</tt> if such an event already exists.
Returns <tt>undef</tt> if such an event already exists.
Line 218: Line 223:
</div>
</div>
<!-- Pod2Wiki=item_new_from_hash -->
<!-- Pod2Wiki=item_new_from_hash -->
===new_from_hash===
====new_from_hash====


  $event = EPrints::DataObj::EventQueue-&gt;new_from_hash( $session, $data, [ $dataset ] )
  $event = EPrints::DataObj::EventQueue-&gt;new_from_hash( $session, $data, [ $dataset ] )
Returns the event that corresponds to the MD5 hash of the <tt>$data</tt> provided, (<tt>pluginid</tt>, <tt>action</tt> and <tt>params</tt>).  Returns <tt>undef</tt> if no event queue task exists with a matching MD5 hash.
Returns the event that corresponds to the MD5 hash of the <tt>$data</tt> provided, (<tt>pluginid</tt>, <tt>action</tt> and <tt>params</tt>).  Returns <tt>undef</tt> if no event queue task exists with a matching MD5 hash.


If <tt>$dataset</tt> is not provided generate from dataset ID of the class.
If <tt>$dataset</tt> is not provided generate from dataset ID of the class.


<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<span style='display:none'>User Comments</span>
<!-- Edit below this comment -->
<!-- Pod2Wiki= -->
</div>
<!-- Pod2Wiki=head_class_methods -->
===Class Methods===
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<span style='display:none'>User Comments</span>
<!-- Edit below this comment -->
<!-- Pod2Wiki= -->
</div>
<!-- Pod2Wiki=item_get_system_field_info -->
====get_system_field_info====
$metadata = EPrints::DataObj::EPrint-&gt;get_system_field_info
Returns an array describing the system metadata of the event queue  dataset.
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<span style='display:none'>User Comments</span>
<!-- Edit below this comment -->
<!-- Pod2Wiki= -->
</div>
<!-- Pod2Wiki=item_get_dataset_id -->
====get_dataset_id====
$dataset = EPrints::DataObj::EPrint-&gt;get_dataset_id
Returns the ID of the [[API:EPrints/DataSet|EPrints::DataSet]] object to which this record belongs.
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<span style='display:none'>User Comments</span>
<!-- Edit below this comment -->
<!-- Pod2Wiki= -->
</div>
<!-- Pod2Wiki=head_object_methods -->
===Object Methods===
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<span style='display:none'>User Comments</span>
<span style='display:none'>User Comments</span>
Line 233: Line 282:
</div>
</div>
<!-- Pod2Wiki=item_execute -->
<!-- Pod2Wiki=item_execute -->
===execute===
====execute====


  $ok = $event-&gt;execute()
  $ok = $event-&gt;execute()
Line 255: Line 304:
</div>
</div>
<!-- Pod2Wiki=item_message -->
<!-- Pod2Wiki=item_message -->
===message===
====message====


  $event-&gt;message( $type, $message )
  $event-&gt;message( $type, $message )
Line 261: Line 310:


<tt>$type</tt> is required by this method but not currently used.
<tt>$type</tt> is required by this method but not currently used.
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<span style='display:none'>User Comments</span>
<!-- Edit below this comment -->
<!-- Pod2Wiki= -->
</div>
<!-- Pod2Wiki=head_see_also -->
==SEE ALSO==
[[API:EPrints/DataObj|EPrints::DataObj]] and [[API:EPrints/DataSet|EPrints::DataSet]].


<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>

Latest revision as of 16:51, 10 January 2022

Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki


NAME[edit]

EPrints::DataObj::EventQueue - Scheduler/indexer event queue.

User Comments


DESCRIPTION[edit]

Individual tasks for the EPrints event queue that can then be actioned by the EPrints indexer in the background.

User Comments


CORE METADATA FIELDS[edit]

User Comments


eventqueueid (uuid)[edit]

Either a UUID or a hash of the event (if created with create_unique).

User Comments


cleanup (boolean)[edit]

If set to true removes this event once it has finished. Defaults to true.

User Comments


priority (int)[edit]

The priority for this event.

User Comments


start_time (time)[edit]

The event should not be executed before this time.

User Comments


end_time (time)[edit]

The event was last touched at this time.

User Comments


status (set)[edit]

The status of this event. Can be waiting, inprogress, success or failed. Defaults to failed.

User Comments


description (longtext)[edit]

A human-readable description of this event (or error).

User Comments


pluginid (id)[edit]

The EPrints::Plugin::Event plugin id to call to execute this event.

User Comments


action (id)[edit]

The name of the action to execute on the plugin (i.e. method name).

User Comments


params (storable)[edit]

Parameters to pass to the action (a text serialisation).

User Comments


REFERENCES AND RELATED OBJECTS[edit]

User Comments


userid (itemref)[edit]

The user (if any) that was responsible for creating this event.

User Comments


INSTANCE VARIABLES[edit]

See EPrints::DataObj.

User Comments


METHODS[edit]

User Comments


Constructor Methods[edit]

User Comments


create_unique[edit]

$event = EPrints::DataObj::EventQueue->create_unique( $session, $data, [ $dataset ] )

Returns a unique event queue task using the $data provided. Setting the eventqueueid to a MD5 hash of the pluginid, action and (if given) params.

Returns undef if such an event already exists.

If $dataset is not provided generate from dataset ID of the class.

User Comments


new_from_hash[edit]

$event = EPrints::DataObj::EventQueue->new_from_hash( $session, $data, [ $dataset ] )

Returns the event that corresponds to the MD5 hash of the $data provided, (pluginid, action and params). Returns undef if no event queue task exists with a matching MD5 hash.

If $dataset is not provided generate from dataset ID of the class.

User Comments


Class Methods[edit]

User Comments


get_system_field_info[edit]

$metadata = EPrints::DataObj::EPrint->get_system_field_info

Returns an array describing the system metadata of the event queue dataset.

User Comments


get_dataset_id[edit]

$dataset = EPrints::DataObj::EPrint->get_dataset_id

Returns the ID of the EPrints::DataSet object to which this record belongs.

User Comments


Object Methods[edit]

User Comments


execute[edit]

$ok = $event->execute()

Execute the action this event queue task describes.

The response from the EPrints::Plugin::Event plugin action is treated as follows: 

undef - equivalent to HTTP_OK
HTTP_OK - action succeeded, event is removed if cleanup is TRUE
HTTP_RESET_CONTENT - action succeeded, event is set 'waiting'
HTTP_NOT_FOUND - action failed, event is removed if cleanup is TRUE
HTTP_LOCKED - action failed, event is re-scheduled for 10 minutes time
HTTP_INTERNAL_SERVER_ERROR - action failed, event is 'failed' and kept

User Comments


message[edit]

$event->message( $type, $message )

Utility method to log the $message for this event.

$type is required by this method but not currently used.

User Comments


SEE ALSO[edit]

EPrints::DataObj and EPrints::DataSet.

User Comments


COPYRIGHT[edit]

© Copyright 2000-2024 University of Southampton.

EPrints 3.4 is supplied by EPrints Services.

http://www.eprints.org/eprints-3.4/

LICENSE[edit]

This file is part of EPrints 3.4 http://www.eprints.org/.

EPrints 3.4 and this file are released under the terms of the GNU Lesser General Public License version 3 as published by the Free Software Foundation unless otherwise stated.

EPrints 3.4 is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with EPrints 3.4. If not, see http://www.gnu.org/licenses/.

User Comments


Retrieved from "https://wiki.eprints.org/w/index.php?title=API:EPrints/DataObj/EventQueue&oldid=14161"