Advanced

Advanced topics

 

Generator: CallService

Class name:org.weborganic.bastille.pageseeder.CallService
Version:0.6.7 - 3 June 2011
Library:Bastille
Cacheable:No
Generated:2012-12-21

Description

A generator than can connect to PageSeeder and call a PageSeeder service.

Configuration

There is no configuration directly required with this generator; however since this generator connects to PageSeeder the bastille pageseeder properties must setup in the Global Configuration to defined which server to connect to.

Parameters

The following parameter is required:

ps-serviceThe url path after /ps/service of the service to connect to e.g. /groups/acme-forum/comments (required)

 The following parameters can also be specified:

ps-methodThe HTTP method to use to connect to PageSeeder, must be either GET|POST; GET is the default is this parameter is not specified

Any other parameter will automatically be transmitted to the PageSeeder service.

Returned XML

TODO

Error handling

If an error occurs while invoking the service, the XML will also include the error and message attributes. The HTTP status should correspond to an HTTP error code.

<ps-service resource="/members/[member id]/projects" 
         http-status="[error]"
        content-type="application/xml"
               error="[error-type]"
             message="[error-message]">
 </ps-service>

Permission

This generator will attempt to use the user currently logged in.

If the current user is not PageSeeder user or if there is no user currently logged in, the request will be made anonymously.

Usage

This is a generic generator; use this generator when no other specialized generator provides the same functionality.

Created on , last edited on