<fuego : engine>

Description

This is task provides the ability to configure and manage Fuego Engines.

It can start/stop/create/drop and do general management of Engines.

Example:

  <target name="start-engine" description="Start a Fuego Engine">

    <!-- Open a session to the Fuego directory -->
    <fuego:session
          passportref="fuego.passport"
              verbose="false"
          haltonerror="true" >

       <!-- Make sure the keystore is created (this is actually
               required only once per installation) -->
       <fuego:engine action="enable-location"
                     engineid="${fuego.engine}">
           <fuego:admin participant="${fuego.participant}"
                           password="${fuego.password}"/>
       </fuego:engine>

       <!-- Start the Engine -->
       <fuego:engine action="start" engineid="${fuego.engine}"/>

    </fuego:session>

  </target>
 

Parameters

Attribute Description Type Required?
newstopicconnectionfactory String No Only used if engine type is J2EE
connector Name of the database resource configuration. This is the configuration to use for the Engine's back-end database. String Yes when creating a new Engine (that is, action="create")
newstopicname String No Only used if engine type is J2EE
itemsqueuename String No Only used if engine type is J2EE
haltonerror Whether to stop the ant build process if an error occurs during the execution of this task. boolean No Default is true
sqlstatementsoutputfile File No Only needed if showSqlStatements is true.
type Specifies the type of engine to create. Is only required when action is "create". String No If not set, the default value is the type installed, or if there are more than one engine type installed, will fail.
propsfile File No Only needed if importProps is true.
homedir Home directory for the new Engine. File Yes when creating a new Engine configuration.
showsqlstatements This attribute is used as a modifier of create-database action when you wish to generate the DDL scripts for database structure instead of actually creating it. boolean No Defaults to false.
runtimeconnector String No If omitted, the value of connector is used.
onlydatabase boolean ?
enginefile Engine configuration file. File Yes when importing/exporting an Engine configuration.
engineid ID of the Fuego Engine to work on. String Yes
vmarguments Optional additional arguments to pass to the Java Virtual Machine. When specified, this arguments will override those on the Engine configuration (webconsole). String No If not set, the value specified via Web console will be used.
importprops boolean ?
logdir Log directory for the new Engine. File No Defaults to ${homedir}/log
action Specifies what action to execute:
  • create: Create a new Engine configuration.
  • delete: Delete an existing Engine configuration.
  • create-database: Create an Engine's back-end database structure.
  • recreatedatabase: Drop and Create an Engine's back-end database structure.
  • drop-database: Drop an Engine's back-end database structure.
  • import:
  • start: Start an Engine.
  • stop: Stop a running Engine.
  • status: Get status information about an Engine.
  • enable-location: Create a local "keystore" file that is required for other engine actions. This is needed only once per-Fuego installation.
  • clean-database: Clean the back-end database contents.
String ["create", "delete", "create-database", "recreate-database", "drop-database", "import", "start", "stop", "status", "enable-location", "clean-database", "modify-properties", "export", "create-archiving-database", "drop-archiving-database"] Yes
itemsqueueconnectionfactory String No Only used if engine type is J2EE
directoryconnector String No Only used if engine type is J2EE
arguments Optional additional arguments to the Fuego Engine. When specified, this arguments will override those on the Engine configuration (webconsole). String No If not set, the value specified via Web console will be used

Parameters accepted as nested elements

<engprops> ...

This element is a placeholder for a set of Property elements.
Attribute Description Type Required

<admin>

Represents the credentials for an "Administrator" user.

If it's used to represent a Fuego Directory administrator, then participant should be used for the participant id. For connections to other systems (like DBMSs) the user attribute will be used.

This element is required when action equals enable-location, create-database, clean-database or drop-database.

Attribute Description Type Required
participant ID of the Fuego Administrator participant. String Yes When used to connect to a Fuego Directory
user ID of the Administrator user. String Yes When used for connections not to the Fuego Directory
password User or participant's password. String Yes