1Workflow::Persister::FiUlsee(r3)Contributed Perl DocumenWtoartkifolnow::Persister::File(3)
2
3
4

NAME

6       Workflow::Persister::File - Persist workflow and history to the
7       filesystem
8

VERSION

10       This documentation describes version 1.10 of this package
11

SYNOPSIS

13        <persister name="MainPersister"
14                   class="Workflow::Persister::File"
15                   path="/home/workflow/storage"/>
16

DESCRIPTION

18       Main persistence class for storing the workflow and workflow history
19       records to a filesystem for later retrieval. Data are stored in
20       serialized Perl data structure files.
21
22   METHODS
23       constitute_object
24
25       This method deserializes an object.
26
27       Takes a single parameter of an filesystem path pointing to an object
28
29       Returns the re-instantiated object or dies.
30
31       create_history
32
33       Serializes history records associated with a workflow object
34
35       Takes two parameters: a workflow object and an array of workflow
36       history objects
37
38       Returns: provided array of workflow history objects upon success
39
40       create_workflow
41
42       Serializes a workflow into the persistance entity configured by our
43       workflow.
44
45       Takes a single parameter: a workflow object
46
47       Returns a single value, a id for unique identification of out
48       serialized workflow for possible deserialization.
49
50       fetch_history
51
52       Deserializes history records associated with a workflow object
53
54       Takes a single parameter: a workflow object
55
56       Returns an array of workflow history objects upon success
57
58       fetch_workflow
59
60       Deserializes a workflow from the persistance entity configured by our
61       workflow.
62
63       Takes a single parameter: the unique id assigned to our workflow upon
64       serialization (see "create_workflow").
65
66       Returns a hashref consisting of two keys:
67
68       ·   state, the workflows current state
69
70       ·   last_update, date indicating last update
71
72       init ( \%params )
73
74       Method to initialize the persister object. Sets up the configured
75       generators
76
77       Throws a Workflow::Exception if a valid filesystem path is not provided
78       with the parameters.
79
80       serialize_object
81
82       Method that writes a given object to a given path.
83
84       Takes two parameters: path (a filesystem path) and an object
85
86       Throws Workflow::Exception if unable to serialize the given object to
87       the given path.
88
89       Returns: Nothing
90
91       update_workflow
92
93       Updates a serialized workflow in the persistance entity configured by
94       our workflow.
95
96       Takes a single parameter: a workflow object
97
98       Returns: Nothing
99

TODO

101       ·   refactor "constitute_object", no checks are made on filesystem
102           prior to deserialization attempt.
103

SEE ALSO

105       Workflow::Persister
106

108       Copyright (c) 2003-2007 Chris Winters. All rights reserved.
109
110       This library is free software; you can redistribute it and/or modify it
111       under the same terms as Perl itself.
112

AUTHORS

114       Jonas B. Nielsen (jonasbn) <jonasbn@cpan.org> is the current
115       maintainer.
116
117       Chris Winters <chris@cwinters.com>, original author.
118
119
120
121perl v5.28.0                      2018-07-15      Workflow::Persister::File(3)
Impressum