ePages 6.10 - DE_EPAGES/WebService/API/WebService/BaseService.pm

Package DE_EPAGES::WebService::API::WebService::BaseService

Base class for web services with permission handling.

Functions

CheckPermission
_mapType
getMimeParts
new
object
user

CheckPermission

Checks if the user identified by $Login and $Password has permission to to execute the method $Method of the web service $WebService.

Syntax
$IsAllowed = $self->CheckPermission( $WebService, $Method, $Login, $Password );
Input
$WebService (object)
web service object
$Method (object)
web service method object
$Login (string)
login
$Password (string)
password
Return
$IsAllowed (boolean)
true if the method call is allowed

_mapType

Map the given XSD Types to a specific Uri.

Syntax
$service->_mapType($aTypes, $Uri);
Example
$service->_mapType(['TProduct, TPrice], 'urn://myservice/2005/06');
Return
$aTypes (ref.array.string)
list of types
$Uri (string)
uri to map to

getMimeParts

get the MIME::Entity parts of the current request. All parts are returned as a list of MIME::Entity objects Used to transfer Binaries via Webservices (If you would get the attachment of a part you have to filter out the MIME::Entity parts with attachments!)

Syntax
$self->getMimeParts()
Return
$aEntities (ref.array.object)
list of MIME::Entity objects

new

Creates a new web service object as a blessed hash reference and adds the values from the %Options hash.

Syntax
$Service = DE_EPAGES::WebService::API::WebService::BaseService->new( %Options );
Input
%Options (hash)
user-defined values
Return
$Service (object)
web service object

object

Returns the base object on which the WebService will act.

Syntax
$base_object = $service->object;
Return
$Object (object)
base WebService object

user

Returns the User object of the current user of the WebService.

Syntax
$user_object = $service->user;
Return
$User (User object)
WebService User

Package SOAP::XMLSchema2001::Serializer