Package de.xima.fc.e2e.containerplugin.plugin

Class MailInboxPartServletPlugin

java.lang.Object

de.xima.fc.e2e.containerplugin.plugin.MailInboxPartServletPlugin

All Implemented Interfaces:

INameProviding, ITransferable, INamedUiElement, IFCPlugin, IPluginServletAction, Serializable

public class MailInboxPartServletPlugin
extends Object
implements IPluginServletAction

Simple servlet for downloading a content part of a mail, meant for integration tests.

Since:

7.1.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAME	The unique name of this plugin.
static String	PARAM_CLIENT_ID	The name of the query parameter for the client id.
static String	PARAM_MESSAGE_NUMBER	The name of the query parameter for the message number.
static String	PARAM_PART_ID	The name of the query parameter for the part id.

Fields inherited from interface de.xima.fc.plugin.interfaces.IFCPlugin

CONFIG_FILENAME

Fields inherited from interface de.xima.fc.interfaces.INamedUiElement

ATTR_DISPLAY_NAME

Fields inherited from interface de.xima.fc.entities.interfaces.INameProviding

ATTR_NAME, COL_NAME

Constructor Summary

Constructors

Constructor	Description
MailInboxPartServletPlugin()

Method Summary

Modifier and Type	Method	Description
IPluginServletActionRetVal	execute(IPluginServletActionParams params)	The main method of this plugin.
String	getName()	Getter for the name of this plugin.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.xima.fc.plugin.interfaces.IFCPlugin

getDescription, getDescription, getDisplayName, initialize, initPlugin, install, shutdown, shutdown, uninstall

Field Detail

NAME

public static final String NAME

The unique name of this plugin.

See Also:

Constant Field Values

PARAM_CLIENT_ID

public static final String PARAM_CLIENT_ID

The name of the query parameter for the client id.

See Also:

Constant Field Values

PARAM_MESSAGE_NUMBER

public static final String PARAM_MESSAGE_NUMBER

The name of the query parameter for the message number.

See Also:

Constant Field Values

PARAM_PART_ID

public static final String PARAM_PART_ID

The name of the query parameter for the part id.

See Also:

Constant Field Values

Constructor Detail

MailInboxPartServletPlugin

public MailInboxPartServletPlugin()

Method Detail

execute

public IPluginServletActionRetVal execute(IPluginServletActionParams params)
                                   throws FCPluginException

Description copied from interface: IPluginServletAction

The main method of this plugin.

When any exception other than FCPluginException is thrown, a generic HTML error page is returned to the client.

Specified by:

execute in interface IPluginServletAction

Parameters:

params - The parameters this plugin may make use of. Contains for example the URL parameters, the data of the HttpSession or the current Benutzer.

Returns:

The HTTP response code and the data to be sent as the response.

Throws:

FCPluginException - May be thrown when this plugin cannot handle the request. When this exception is thrown, a 404 HTTP response is returned to the client.

getName

public String getName()

Description copied from interface: IFCPlugin

Getter for the name of this plugin. This name may appear on the user interface.

Specified by:

getName in interface IFCPlugin

Specified by:

getName in interface INameProviding

Returns:

String The name of this plugin.