org.ow2.jonas.antmodular.jonasbase.bootstrap
Class JTask

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          org.ow2.jonas.antmodular.bootstrap.BootstrapTask
              org.ow2.jonas.antmodular.jonasbase.bootstrap.JTask

All Implemented Interfaces:

java.lang.Cloneable, BaseTaskItf

Direct Known Subclasses:

PropertyTask, Services, XMLSerializerTask

public class JTask
extends BootstrapTask
implements BaseTaskItf

Defines a common task.

Author:

Florent Benoit

Field Summary

static java.lang.String

SEPARATORS Property separators (4 spaces).

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

target, taskType, wrapper

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

description, location, project

Constructor Summary

JTask()

Method Summary

void	changeValueForKey(java.lang.String info, java.lang.String confDir, java.lang.String confFile, java.lang.String property, java.lang.String name, boolean add) Add a value for a specific property in a configuration file.
void	changeValueForKey(java.lang.String info, java.lang.String confDir, java.lang.String confFile, java.lang.String property, java.lang.String name, java.lang.String separators, boolean add) Add a value for a specific property in a configuration file.
protected java.lang.String	getConfigurationFile()
java.io.File	getDestDir() Gets the destination directory.
java.lang.String	getLogInfo() Gets logger info (to be displayed).
void	setConfigurationFile(java.lang.String configurationFile) Sets the configuration file.
void	setDestDir(java.io.File destDir)
void	setLogInfo(java.lang.String logInfo) Set the info to be displayed by the logger.
void	writePropsToFile(java.lang.String info, java.util.Properties props, java.io.File f) Write properties object to a file with some logging info.

Methods inherited from class org.ow2.jonas.antmodular.bootstrap.BootstrapTask

createClasspath, getBootstraptask, getBootstraptask, getBootstraptask, getDomainName, getJonasRoot, getMaven2Repository, getServerName, getTaskName, setCatalinaHome, setClasspath, setDomainName, setJettyHome, setJonasBase, setJonasRoot, setJvmopts, setServerName, setTaskName

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

bindToOwner, execute, getOwningTarget, getRuntimeConfigurableWrapper, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, 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

Methods inherited from interface org.ow2.jonas.antmodular.jonasbase.bootstrap.BaseTaskItf

execute, setJonasRoot

Field Detail

SEPARATORS

public static final java.lang.String SEPARATORS

Property separators (4 spaces).

See Also:

Constant Field Values

Constructor Detail

JTask

public JTask()

Method Detail

setConfigurationFile

public void setConfigurationFile(java.lang.String configurationFile)

Sets the configuration file.

Specified by:

setConfigurationFile in interface BaseTaskItf

Parameters:

configurationFile - The configurationFile to set.

setDestDir

public void setDestDir(java.io.File destDir)

Specified by:

setDestDir in interface BaseTaskItf

Parameters:

destDir - The destDir to set.

getLogInfo

public java.lang.String getLogInfo()

Gets logger info (to be displayed).

Specified by:

getLogInfo in interface BaseTaskItf

Returns:

logger info

See Also:

ant.jonasbase.BaseTaskItf

setLogInfo

public void setLogInfo(java.lang.String logInfo)

Set the info to be displayed by the logger.

Specified by:

setLogInfo in interface BaseTaskItf

Parameters:

logInfo - information to be displayed

See Also:

ant.jonasbase.BaseTaskItf

getDestDir

public java.io.File getDestDir()

Gets the destination directory.

Returns:

the destination directory

writePropsToFile

public void writePropsToFile(java.lang.String info,
                             java.util.Properties props,
                             java.io.File f)

Write properties object to a file with some logging info.

Parameters:

info - header for logging

props - Properties to write

f - file for writing

changeValueForKey

public void changeValueForKey(java.lang.String info,
                              java.lang.String confDir,
                              java.lang.String confFile,
                              java.lang.String property,
                              java.lang.String name,
                              boolean add)

Add a value for a specific property in a configuration file. The separator uses between the property name and the property value is the default separator value.

Parameters:

info - text to be displayed for header

confDir - configuration directory (can be JONAS_BASE/conf)

confFile - configuration file (can be jonas.properties)

property - which must be found in confFile

name - value for the property to add

add - if true, add it, else replace

changeValueForKey

public void changeValueForKey(java.lang.String info,
                              java.lang.String confDir,
                              java.lang.String confFile,
                              java.lang.String property,
                              java.lang.String name,
                              java.lang.String separators,
                              boolean add)

Add a value for a specific property in a configuration file.

Parameters:

info - text to be displayed for header

confDir - configuration directory (can be JONAS_BASE/conf)

confFile - configuration file (can be jonas.properties)

property - which must be found in confFile

name - value for the property to add

separators - separator using between the property name and the property value

add - if true, add it, else replace

getConfigurationFile

protected java.lang.String getConfigurationFile()

Returns:

the configurationFile.