Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
OpenXPKI::Service::DefUser:Contributed POpenXPKI::Service::Default::Command(3)

Name
       OpenXPKI::Service::Default::Command

Description
       Default service command base class. Handles command execution to
       distinct	command	implementations.

Functions
   START - new()
       This class derives from Class::Std. Please read the corresponding
       documentation concerning	BUILD, START construction methods and other
       class-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	are
       accepted	and throws an exception	otherwise. If the constructor returns
       without 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 whitelisted	to be available	for
       use by the caller) the execute()	method detects that no explicit
       implementation is available and automatically delegates 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
       containing the proper arguments). To be called by command
       implementations.

perl v5.24.1			  2017-0OpenXPKI::Service::Default::Command(3)

Name | Description | Functions

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=OpenXPKI::Service::Default::Command&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help