MAN page from OpenSuSE perl-OpenXPKI-Core-0.9.1389-6.362.CS.i586.rpm

OpenXPKI::Server::API

Section: User Contributed Perl Documentation (3)
Updated: 2008-12-22
Index

Name

Description

This is the interface which should be used by all user interfaces of OpenXPKI.A user interface MUST NOT access the server directly. The only allowedaccess is via this API. Any function which is not available in this API isnot for public use.The API gets access to the server via the 'server' context object. Thisobject must be set before instantiating the API.

Functions

new

Default constructor created by Class::Std. The named parameterEXTERNAL should be set to 1 if the API is used from an externalsource (e.g. within a service). If EXTERNAL is set, in addition tothe parameter checks, ACL checks are enabled.

AUTOMETHOD

This method is used by Class::Std when a method is called that is undefinedin the current class. In our case, this method does the parameterchecking for the requested method. If the class has been instantiatedwith the EXTERNAL parameter, ACL checks are done in addition. Then theclass name is constructed from the $method_info hash reference andthe corresponding method is called with the given parameters.

This document was created byman2html,using the manual pages.