org.webharvest.runtime.processors.plugins

Class MailPlugin

java.lang.Object

org.webharvest.runtime.processors.BaseProcessor

org.webharvest.runtime.processors.WebHarvestPlugin

org.webharvest.runtime.processors.plugins.MailPlugin

public class MailPlugin
extends WebHarvestPlugin

Mail sending processor.

Field Summary

Fields inherited from class org.webharvest.runtime.processors.BaseProcessor

elementDef

Constructor Summary

Constructors

Constructor and Description
MailPlugin()

Method Summary

Modifier and Type	Method and Description
static javax.activation.DataSource	createDataSourceOfVariable(Variable variable, String charset, String mimeType)
Variable	executePlugin(Scraper scraper, ScraperContext context) Mathod that actually executes processor.
String[]	getAttributeValueSuggestions(String attributeName)
Class[]	getDependantProcessors() Defines dependant subprocessors that are used inside this plugin and that will automatically be registered with this plugin.
org.apache.commons.mail.Email	getEmail()
String	getName() Defines name of the processor.
protected String	getNextAttachmentName()
String[]	getRequiredAttributes() This method should return all mandatory attribute names for the plugin processor.
String[]	getRequiredSubprocessors() This method should return all mandatory subprocessor names, or in other words all mandatory subtags that must be present in the body of this processor plugin.
String[]	getValidAttributes() This method should return all possible attribute names for the plugin processor.
String[]	getValidSubprocessors() This method should return all names of all allowed processors inside the body of this processor plugin.

Methods inherited from class org.webharvest.runtime.processors.WebHarvestPlugin

evaluateAttribute, evaluateAttributeAsBoolean, evaluateAttributeAsDouble, evaluateAttributeAsInteger, execute, executeBody, getAttributeDesc, getAttributes, getTagDesc, hasBody, setDef

Methods inherited from class org.webharvest.runtime.processors.BaseProcessor

debug, getBodyTextContent, getBodyTextContent, getBodyTextContent, getElementDef, getSubprocessors, run, setProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

MailPlugin

public MailPlugin()

Method Detail

createDataSourceOfVariable

public static javax.activation.DataSource createDataSourceOfVariable(Variable variable,
                                                                     String charset,
                                                                     String mimeType)
                                                              throws IOException

Throws:

IOException

getName

public String getName()

Description copied from class: WebHarvestPlugin

Defines name of the processor. Should be valid identifier. Processor's tag will use this name. For example, if this name is "myprocessor" in config file it will be used as <myprocessor...>...</myprocessor>

Specified by:

getName in class WebHarvestPlugin

Returns:

Name of the processor

executePlugin

public Variable executePlugin(Scraper scraper,
                              ScraperContext context)

Description copied from class: WebHarvestPlugin

Mathod that actually executes processor. Since one instance of this class may be used for multiple executions, creator of plugin is responsible for initiating local variables at the beginning of this method.

Specified by:

executePlugin in class WebHarvestPlugin

Returns:

Instance of variable as result of xecution.

getValidAttributes

public String[] getValidAttributes()

Description copied from class: WebHarvestPlugin

This method should return all possible attribute names for the plugin processor.

Overrides:

getValidAttributes in class WebHarvestPlugin

Returns:

Array of attribute names (case insensitive)

getRequiredAttributes

public String[] getRequiredAttributes()

Description copied from class: WebHarvestPlugin

This method should return all mandatory attribute names for the plugin processor.

Overrides:

getRequiredAttributes in class WebHarvestPlugin

Returns:

Array of attribute names (case insensitive)

getValidSubprocessors

public String[] getValidSubprocessors()

Description copied from class: WebHarvestPlugin

This method should return all names of all allowed processors inside the body of this processor plugin. If null is returned, then all subprocessors are allowed.

Overrides:

getValidSubprocessors in class WebHarvestPlugin

Returns:

Array of allowed subprocessor names (case insensitive)

getRequiredSubprocessors

public String[] getRequiredSubprocessors()

Description copied from class: WebHarvestPlugin

This method should return all mandatory subprocessor names, or in other words all mandatory subtags that must be present in the body of this processor plugin.

Overrides:

getRequiredSubprocessors in class WebHarvestPlugin

Returns:

Array of mandatory subprocessor names (case insensitive)

getDependantProcessors

public Class[] getDependantProcessors()

Description copied from class: WebHarvestPlugin

Defines dependant subprocessors that are used inside this plugin and that will automatically be registered with this plugin.

Overrides:

getDependantProcessors in class WebHarvestPlugin

Returns:

Array of subprocessor classes

getEmail

public org.apache.commons.mail.Email getEmail()

getAttributeValueSuggestions

public String[] getAttributeValueSuggestions(String attributeName)

Overrides:

getAttributeValueSuggestions in class WebHarvestPlugin

Parameters:

attributeName - Name of plugin attribute

Returns:

Array of valuee suggestions for specified attribute (this is used for auto-complete feature in IDE). null means nothing to suggest.

getNextAttachmentName

protected String getNextAttachmentName()