org.polago.deployconf.task

Interface Task

All Known Implementing Classes:

AbstractTask, FilterTask, PropertiesTask

public interface Task

Describes a deployment task.

Method Summary

Modifier and Type	Method and Description
void	apply(InputStream source, OutputStream destination) Apply this Task by copying source to destination.
boolean	configureInteractively(InteractiveConfigurer configurer, boolean force) Configure the task by asking the user for inputs.
void	deserialize(org.jdom2.Element node) Load the task from a list of JDOM Elements.
String	getPath() Gets the Task Path.
String	getSerializedName() Gets the serialized Task Name.
boolean	isConfigured() Determine if the Task is completely configured.
void	merge(Task other) Merge another Task with this one.
void	serialize(org.jdom2.Element node) Serialize this Task to a JDOM Element.

Method Detail

getPath

String getPath()

Gets the Task Path.

Returns:

the Task path

getSerializedName

String getSerializedName()

Gets the serialized Task Name.

Returns:

the serialized name of this task

deserialize

void deserialize(org.jdom2.Element node)
          throws IOException

Load the task from a list of JDOM Elements.

Parameters:

node - the JDOM Element to use for configuring this instance

Throws:

IOException - indicating IO Error

merge

void merge(Task other)

Merge another Task with this one.

Parameters:

other - the other Task

isConfigured

boolean isConfigured()
              throws IOException

Determine if the Task is completely configured.

Returns:

true if the Task is completely configured

Throws:

IOException - indicating IO Error

configureInteractively

boolean configureInteractively(InteractiveConfigurer configurer,
                               boolean force)
                        throws Exception

Configure the task by asking the user for inputs.

Parameters:

configurer - the InteractiveConfigurer to use

force - if true, the Task is always configured

Returns:

true if the task was configured

Throws:

Exception - indicating processing failure

serialize

void serialize(org.jdom2.Element node)
        throws IOException

Serialize this Task to a JDOM Element.

Parameters:

node - the JDOM Element to serialize to

Throws:

IOException - indicating IO Error

apply

void apply(InputStream source,
           OutputStream destination)
    throws Exception

Apply this Task by copying source to destination.

Parameters:

source - the Input stream

destination - the Output stream

Throws:

Exception - indicating processing failure