com.hyfinity.xgate

Interface XGatePlugin

All Known Implementing Classes:

ExportWebAppXGatePlugin, FileUploadPlugin, ImportExportXGatePlugin, SetLocalePlugin, ThemeEditorXGatePlugin

public interface XGatePlugin

This is the interface that must be implemented by any custom XGate plugins. Each plugin must define two methods, processInput and processOutput. The first will be called before the input document is passed to the platform, and the second after the response has been recieved. Each method has access to the current XML message, as well as the servlet request and response objects. You can provide an empty implementation of one method if you are only concerned with processing in one direction.
All plugins must be thread safe.

For your plugin to be used, it must be defined within the XGate configuration file, xgate.xml which is found within the doc directory of the webapp. For example:

    <xgate>
        ...
        <plugins>
            ...
            <custom_plugins>
                <custom_plugin name="my plugin" priority="10" runtime_instance="com.company.MyPlugin"/>
            </custom_plugins>
        </plugins>
    </xgate>
 

The priority value indicates when your plugin will be called. Plugins with a lower priroty number will be called first. All the inbuilt plugins that handle data binding etc have a priority of 50.

Version:

1.0

Author:

Hyfinity Ltd. Copyright (c) 2005

Method Summary

Methods

Modifier and Type	Method and Description
void	processInput(XDocument input, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Process the request before it is passed to the platform.
void	processOutput(XDocument output, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Process the response recieved from the platform, before it is returned to the browser.

Method Detail

processInput

void processInput(XDocument input,
                javax.servlet.http.HttpServletRequest request,
                javax.servlet.http.HttpServletResponse response)

Process the request before it is passed to the platform.

Parameters:

input - An XDocument object containing the current state of the XML message. The document this contains should be updated as required.

request - The HttpServletRequest object that defines the request being processed. This provides access to any request or session parameters etc.

response - The HttpServletResponse object that will eventually be written to. You should not write to this as that will be handled automatically, but you may want to add a cookie, or set a header for example.

processOutput

void processOutput(XDocument output,
                 javax.servlet.http.HttpServletRequest request,
                 javax.servlet.http.HttpServletResponse response)

Process the response recieved from the platform, before it is returned to the browser.

Parameters:

output - An XDocument object containing the current state of the XML message (this will often be HTML). The document this contains should be updated as required.

request - The HttpServletRequest object that defines the request being processed. This provides access to any request or session parameters etc.

response - The HttpServletResponse object that will eventually be written to. You should not write to this to output the message content as that will be handled automatically, but you may want to add a cookie, or set a header for example.
Alternatively, if you wish to output non HTML content (eg return a pdf file) then you can output this content here, and then set the output document to null (output.setDocument(null)) to prevent XGate from trying to return the normal content.