net.webpdf.ant.task

Class TaskConfiguration

java.lang.Object

net.webpdf.ant.task.TaskConfiguration

public class TaskConfiguration
extends Object

This class bundles all parameters set in the top level webPDF task container.

Constructor Summary

Constructors

Constructor and Description
TaskConfiguration() Shall create a new task configuration, that shall be referenced by all sub tasks.

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.http.auth.Credentials	getCredentials() Returns credentials, that may be used to authenticate a user at the webPDF server.
URL	getServerURL() Returns the URL of the webPDF server.
IterativeTaskFileMap	getTaskFiles() The returned TaskFileCollection shall contain all files the current webPDf task shall be executed for.
boolean	isFailOnError() If this returns true, then a failing task must interrupt the currently executed webPDF task and shall prevent other sub tasks from being executed.
void	setCredentialsTask(org.apache.tools.ant.Task credentialsTask) Initializes the credentials, that shall be used for the authentication at the webPDF server.
void	setFailOnError(boolean failOnError) If set to true, a failing sub task shall instantly interrupt the execution of the webPDF task and shall prevent other sub tasks from being executed.
void	setServerUrl(String serverURl) Sets the URL of the webPDF server.

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskConfiguration

public TaskConfiguration()

Shall create a new task configuration, that shall be referenced by all sub tasks.

Method Detail

getTaskFiles

public IterativeTaskFileMap getTaskFiles()

The returned TaskFileCollection shall contain all files the current webPDf task shall be executed for.

Returns:

A collection of all files, that the current webPDF task shall be executed for.

setServerUrl

public void setServerUrl(String serverURl)

Sets the URL of the webPDF server.

Parameters:

serverURl - The url of the webPDF server.

getServerURL

public URL getServerURL()
                 throws MalformedURLException

Returns the URL of the webPDF server.

Returns:

The URL of the webPDF server.

Throws:

MalformedURLException - Is thrown if the given server url is invalid.

setFailOnError

public void setFailOnError(boolean failOnError)

If set to true, a failing sub task shall instantly interrupt the execution of the webPDF task and shall prevent other sub tasks from being executed. (DEFAULT is true)

Parameters:

failOnError - True to prevent further execution when a task has failed.

isFailOnError

public boolean isFailOnError()

If this returns true, then a failing task must interrupt the currently executed webPDF task and shall prevent other sub tasks from being executed.

Returns:

True must lead to a total failure, if a sub task fails.

setCredentialsTask

public void setCredentialsTask(org.apache.tools.ant.Task credentialsTask)

Initializes the credentials, that shall be used for the authentication at the webPDF server.

Parameters:

credentialsTask - The credentials task containing all necessary authentication information.

getCredentials

public org.apache.http.auth.Credentials getCredentials()

Returns credentials, that may be used to authenticate a user at the webPDF server.

Returns:

The credentials, that have been set previously and can be used to authenticate a user at the webPDF server.