m.c.m.proxyma.plugins.retrivers
Class TestPageRetriver

java.lang.Object
  extended by m.c.m.proxyma.plugins.retrivers.AbstractRetriver
      extended by m.c.m.proxyma.plugins.retrivers.TestPageRetriver
All Implemented Interfaces:
ResourceHandler

public class TestPageRetriver
extends AbstractRetriver

This retriver simply generates a test page.
It's useful only for testing puropses.

NOTE: this software is released under GPL License. See the LICENSE of this distribution for more informations.

Version:
$Id: TestPageRetriver.java 170 2010-07-02 21:16:10Z marcolinuz $
Author:
Marco Casavecchia Morganti (marcolinuz) [marcolinuz-at-gmail.com]

Constructor Summary
TestPageRetriver(ProxymaContext context)
          The default constructor for this class
It prepares the context logger.
 
Method Summary
 java.lang.String getHtmlDescription()
          Returns a short description of what the plugin does..
 java.lang.String getName()
          Returns the name of the plugin.
 void process(ProxymaResource aResource)
          This method creates a test page to sent back to the client.
 
Methods inherited from class m.c.m.proxyma.plugins.retrivers.AbstractRetriver
getType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TestPageRetriver

public TestPageRetriver(ProxymaContext context)
The default constructor for this class
It prepares the context logger. NOTE: Every plugin to work must have a constructor that takes a ProxymaContext as parameter.

Method Detail

process

public void process(ProxymaResource aResource)
             throws java.lang.Exception
This method creates a test page to sent back to the client.

Specified by:
process in interface ResourceHandler
Specified by:
process in class AbstractRetriver
Parameters:
aResource - any ProxymaResource
Throws:
java.lang.Exception

getName

public java.lang.String getName()
Returns the name of the plugin.

Specified by:
getName in interface ResourceHandler
Specified by:
getName in class AbstractRetriver
Returns:
the name of the plugin.

getHtmlDescription

public java.lang.String getHtmlDescription()
Returns a short description of what the plugin does..
You can use html tags into it.
The result of this method call can be used by any interface to explain for what is the puropse of the plugin.

Specified by:
getHtmlDescription in interface ResourceHandler
Specified by:
getHtmlDescription in class AbstractRetriver
Returns:
a short description of the plugin


Copyright © 2010. All Rights Reserved.