net.webpdf.ant

Class WebPDFTask

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

net.webpdf.ant.task.Task

net.webpdf.ant.WebPDFTask

All Implemented Interfaces:

Cloneable, TaskIntf, org.apache.tools.ant.TaskContainer

public class WebPDFTask
extends Task
implements org.apache.tools.ant.TaskContainer

This task is representing the top level of the webPDF ANT task. It shall contain all basic configurations necessary to connect to the webPDF server and shall share those connection details with all contained sub tasks.

Field Summary

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

Constructors

Constructor and Description
WebPDFTask() An instance of this class is representing the top level of the webPDF ANT task.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(org.apache.tools.ant.util.FileNameMapper fileNameMapper) This shall configure the mapper used by this task, to determine the name of the generated target file.
void	add(GroupTask task) This method shall add a bundled task to this task.
void	add(NTCredentials credentials) Provides credentials for windows platforms, containing username and password and optionally the name of the user's workstation and domain name.
void	add(org.apache.tools.ant.types.ResourceCollection resourceCollection) This shall add the given items as sources of this task.
void	add(UserCredentials credentials) Provides basic user credentials (username and password) for the authentication at the webPDF server.
void	add(Variable variable) Adds a variable to the group context.
void	addTask(org.apache.tools.ant.Task task) Method to add sub elements to this tag.
void	execute() Central method to execute a task and all it's sub tasks.
void	setFailOnError(boolean failOnError) This will set the failOnError flag.
void	setServerUrl(String serverUrl) This will initialize an URL pointing to the webPDF server.
void	setTargetDir(File targetDir) This will set the target directory all operation results shall be published to.
void	setTargetFile(File targetFile) This will set a single file all output shall be written to.
void	setTempDir(File tempDir) This shall define the temporary directory for this task.

Methods inherited from class net.webpdf.ant.task.Task

getFiles, getLogger, getTaskConfiguration, getVariables, setFiles, setTaskConfiguration

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

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

Constructor Detail

WebPDFTask

public WebPDFTask()

An instance of this class is representing the top level of the webPDF ANT task. It shall contain all basic configurations necessary to connect to the webPDF server and shall share those connection details with all contained sub tasks. It must be contained and is providing the basic context for all webservice calls.

It may contain either grouped operations or operation definitions themselves.

Method Detail

execute

public void execute()
             throws org.apache.tools.ant.BuildException

Central method to execute a task and all it's sub tasks. This method shall prepare and provide the needed context and shall execute it's sub tasks sequentially in an ordered fashion.

Specified by:

execute in interface TaskIntf

Specified by:

execute in class Task

Throws:

org.apache.tools.ant.BuildException - if something goes wrong with the build.

addTask

public void addTask(org.apache.tools.ant.Task task)

Method to add sub elements to this tag. This shall be used by ant access methods and shall treat each appended element according to it's type.

Specified by:

addTask in interface org.apache.tools.ant.TaskContainer

Parameters:

task - The sub task, that shall be added.

add

public void add(org.apache.tools.ant.types.ResourceCollection resourceCollection)

This shall add the given items as sources of this task. The defined operations shall be executed for each of those given sources.

It is not expected to use this method actively, as it is specifically defined for the access by ANT.

Parameters:

resourceCollection - A collection of resources, that shall be processed by this task.

add

public void add(org.apache.tools.ant.util.FileNameMapper fileNameMapper)

This shall configure the mapper used by this task, to determine the name of the generated target file. The resulting target name shall be chosen according to the rules defined in the mapper and depending on the name of the source file.

It is not expected to use this method actively, as it is specifically defined for the access by ANT.

Parameters:

fileNameMapper - The mapper defining naming conventions for target files of this task.

add

public void add(GroupTask task)

This method shall add a bundled task to this task. The group shall contain, define and configure a sequence of operations.

It is not expected to use this method actively, as it is specifically defined for the access by ANT.

Parameters:

task - A group task containing a sequence of webservice operations.

add

public void add(UserCredentials credentials)

Provides basic user credentials (username and password) for the authentication at the webPDF server.

Parameters:

credentials - The credentials task containing all necessary authentication information.

add

public void add(NTCredentials credentials)

Provides credentials for windows platforms, containing username and password and optionally the name of the user's workstation and domain name.

Parameters:

credentials - The credentials task containing all necessary authentication information.

add

public final void add(Variable variable)

Adds a variable to the group context. The variable and it's value shall only be known later on, when the group is executed.

Parameters:

variable - The variable, that shall be added.

setFailOnError

public void setFailOnError(boolean failOnError)

This will set the failOnError flag. If this flag is set to true, then a failure to execute any individual webservice will automatically interrupt the execution of the task. If set to false the failure shall be logged, but the task will attempt to execute following webservice calls, not interrupting the task.

It is not expected to use this method actively, as it is specifically defined for the access by ANT.

Parameters:

failOnError - A flag indicating whether a failure to execute a webservice shall interrupt the task and prevent the execution of following webservice operations.

setServerUrl

public void setServerUrl(String serverUrl)

This will initialize an URL pointing to the webPDF server. This information is required to locate the server. This shall only contain the address and port of the server - all further URL parts will be generated automatically. (i.e.: http://127.0.0.1:8080)

It is not expected to use this method actively, as it is specifically defined for the access by ANT.

Parameters:

serverUrl - An URL pointing to the webPDF server

setTargetDir

public void setTargetDir(File targetDir)

This will set the target directory all operation results shall be published to. "Operation result" is referring to the final result of called groups and will only include the results of individual webservice calls for independent and isolated operations.

It is not expected to use this method actively, as it is specifically defined for the access by ANT.

Parameters:

targetDir - The path operation results shall be placed at.

setTargetFile

public void setTargetFile(File targetFile)

This will set a single file all output shall be written to. Be aware, that this shall overwrite the given file for each completed sequence of operations defined in this task.

It is not expected to use this method actively, as it is specifically defined for the access by ANT.

Parameters:

targetFile - The file results shall be published to.

setTempDir

public void setTempDir(File tempDir)

This shall define the temporary directory for this task. Results that are generated in non terminal operation calls will be published to this directory and shall be deleted as soon as possible (Unless their deletion has been forbidden)

It is not expected to use this method actively, as it is specifically defined for the access by ANT.

Parameters:

tempDir - The directory temporary results, of non terminal operation calls, shall be published to.