FreeBSD Manual Pages
OpenXPKI::Workflow::FaUseryContributed Perl DocuOpenXPKI::Workflow::Factory(3)
get_action_info
Return the UI info for the named action.
Todo: Some of this code is duplicated in the OpenXPKI::Workflow::Config
- might be useful to merge this into a helper. Might be useful in the
API.
authorize_workflow
Public wrapper around __authorize_workflow, boolean return (true if
access it granted).
check_acl (TYPE, WF_CREATOR, USER, ROLE)
Helper method to evaluate the acl given in the workflow config against
against a concrete instance. Type and creator are mandatory, user and
role is read from the current session if user not set.
Returns 1 if the user can access the workflow. Return undef if no acl
is defined for the current role and 0 if an acl was found but does not
authorize the current user.
update_proc_state($wf, $old_state, $new_state)
Tries to update the "proc_state" in the database to $new_state.
Returns 1 on success and 0 if e.g. another parallel process already
changed the given $old_state.
Name
OpenXPKI::Workflow::Factory - OpenXPKI specific workflow factory
Description
This is the OpenXPKI specific subclass of Workflow::Factory. We need
an OpenXPKI specific subclass because Workflow currently enforces that
a Factory is a singleton. In OpenXPKI, we want to have several factory
objects (one for each version and each PKI realm). The most important
difference between Workflow::Factory and OpenXPKI::Workflow::Factory is
in the instance() class method, which creates only one global instance
in the original and a new one for each call in the OpenXPKI version.
In addition, the fetch_workflow() method has been modified to do ACL
checks before returning the workflow to the caller. Typically, it also
'censors' the workflow context by removing certain workflow context
entries. Unfiltered access is possible via fetch_unfiltered_workflow()
- please note that this is sort of an ACL circumvention and should only
be used if really necessary (and should only be used to create a
temporary object that is used to retrieve the relevant entries).
All methods return an object of class OpenXPKI::Server::Workflow, which
is derived from Workflow base class and implements the
pause/resume-features. see there for details.
perl v5.32.0 2020-08-29 OpenXPKI::Workflow::Factory(3)
Name | Description
Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=OpenXPKI::Workflow::Factory&sektion=3&manpath=FreeBSD+12.2-RELEASE+and+Ports>