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

OpenXPKI::Service::Default::Command

Section: User Contributed Perl Documentation (3)
Updated: 2008-09-30
Index

Name

Description

Default service command base class. Handles command execution todistinct command implementations.

Functions

START - new()

This class derives from Class::Std. Please read the corresponding documentation concerning BUILD, START construction methods and otherclass-specific internals.

The new() constructor creates a new command object that is capable of executing the referenced interface command.Expects the following named parameters:
COMMAND => name of the command to execute
PARAMS => hash reference containing the command attributes

The constructor makes sure that only explicitly allowed commands areaccepted and throws an exception otherwise. If the constructor returnswithout error (exception), the command was accepted as valid and the passed parameters have been stored internally to be processed later by the execute() method.

When attaching the implementation the class first try to 'use'an actual Perl module which is named like the command. E. g.if command 'foo' is requested, it tries to attach OpenXPKI::Service::Default::Command::foo.pm.If no such module is available (but the command itself is whitelistedto be available for use by the caller) the execute() method detectsthat no explicit implementation is available and automaticallydelegates the command call to the API.

execute

Executes the specified command implementation. Returns a data structure that can be serialized and directly returned to the client.

command_response

Returns a properly formatted command response (hash reference containingthe proper arguments). To be called by command implementations.

This document was created byman2html,using the manual pages.