ControlTier Inc. > Open.ControlTier > ModuleForge.ControlTier
 
 
PDF -icon
PDF
Font size:      

AtgAppServer

An ATG application server

Overview

Open in Workbench AtgAppServer: An ATG application server

Design

Super Type
Service
Role Abstract. (Objects cannot be created.)
Instance Names Unique
Notification false
Template Directory ${modules.dir}/AtgAppServer/templates
Data View Children, proximity: 1
Logger Name AtgAppServer

Constraints

Allowed Child Dependencies

1: These types have a Singleton constraint. Only one instance may be added as a resource.

Allowed Parent Dependencies

Allowed Property Values

Property Allowed Values Default Enforced
deployment-install-root
  • /opt/Dynamo7/ATG2006.3
  • /opt/Dynamo7/ATG7.0
false
deployment-basedir
  • /opt/Dynamo7/ATG2006.3/home
  • /opt/Dynamo7/ATG7.0/home
false

Attributes

Exported Attributes

Name Property
dynamo_home deployment-basedir
dynamo_root deployment-install-root

Defaults for Imported Attributes

Name Default
dirlist data,j2ee/runtime,localconfig/atg,localconfig/atg/dynamo,logs/archives,pagebuild,sessionswap

Commands

Note
Commandline options displayed in square brackets "[]" are optional. If an option expects arguments, then angle brackets are shown after the option "<>". Any default value is shown within the brackets.

retryIsDownService

checks status repeatedly up to status_retrymax sleeping status_waitinterval

Usage
retryIsDownService [-dynamo_home <>] [-dynamo_root <>] [-name <>] [-status_retrymax <5>] [-status_waitinterval <60>]
Execution bash
Arguments echo define implementation here

Options

Option Description
dynamo_home the DYNAMO_HOME setting
dynamo_root the DYNAMO_ROOT setting
name the dynamo server name
status_retrymax max times to retry check
status_waitinterval seconds to wait before next check

assertServiceIsUp

Checks if dynamo is running

Usage
assertServiceIsUp [-basedir <>] [-name <>]
Execution bash
Arguments echo define implementation here

Options

Option Description
basedir server base dir
name server to check

updateDatastoreModelObject

updates the model with specified datastore object

Usage
updateDatastoreModelObject [-datastore <>]

Options

Option Description
datastore the datastore name

maybeKillService

calls retryIsDownService and if that fails calls killService

Usage
maybeKillService

Workflow

  1. retryIsDownService

Error Handler

Command

killService

stopAcceptingNewSessions

calls the rmi /atg/dynamo/admin/LoadControl.setAcceptingNewSessions(true) method to stop accepting new sessions

Usage
stopAcceptingNewSessions [-dynamo_root <>] [-failonerror <no>] [-name] [-rmiport <>]

Options

Option Description
dynamo_root dynamo installation root
failonerror Log a warning message, but do not stop the command if the rmi call does not succeed
name dynamo instance name
rmiport rmi listen port

Prepare

prepares and validates install

Usage
Prepare

Workflow

  1. mkdirStructure

Restart

Restarts the appserver

Usage
Restart

Workflow

invalidateCache

tells server to invalidate its cache

Usage
invalidateCache [-rmiport <>]

Options

Option Description
rmiport rmi control port

isNucleusRunning

searches dynamo.log for "Nucleus running" text

Usage
isNucleusRunning [-name <>]
Execution bash
Arguments echo define implementation here

Options

Option Description
name atg instance name

getDatastoreName

uses rmi task to lookup current datastore name

Usage
getDatastoreName [-rmiport <>]

Options

Option Description
rmiport the rmi port to run lookup

runStopDynamo

stop the service process

Usage
runStopDynamo [-dynamo_root <>] [-name <>]
Execution bash
Arguments echo define implementation here

Options

Option Description
dynamo_root the DYNAMO_ROOT setting
name the dynamo server name

Update

run the update cycle

Usage
Update

Workflow

  1. Stop
  2. Prepare
  3. Packages-Install
  4. Configure
  5. Start

mkdirStructure

creates directories and makes necessary symlinks

Usage
mkdirStructure [-dirlist <>] [-dynamo_root <>] [-name <>]
Execution bash
Arguments echo define implementation here

Options

Option Description
dirlist relative sub directory list
dynamo_root dynamo install root
name atg server name

stopService

stops the dynamo instance

Usage
stopService [-dynamo_root <>] [-name <>]

Workflow

  1. stopAcceptingNewSessions
  2. stopService

Error Handler

Command

maybeKillService

Options

Option Description
dynamo_root the dynamo install dir
name server name

switchDatastore

uses rmi task to switch datstore and updates model

Usage
switchDatastore -datastore <> [-rmiport <>]

Options

Option Description
datastore name of datastore
rmiport the rmi port to invoke switch call

startService

starts the dynamo instance

Usage
startService [-dynamo_root <>] [-java_home </usr/java>] [-name <>]
Execution bash
Arguments echo define implementation here

Options

Option Description
dynamo_root Dynamo install root
java_home Defines JAVA_HOME environment variable
name server name

startAcceptingNewSessions

calls the rmi /atg/dynamo/admin/LoadControl.setAcceptingNewSessions(true) method to start accepting new sessions

Usage
startAcceptingNewSessions [-rmiport <>]

Options

Option Description
rmiport rmi listen port

assertServiceIsDown

Checks if dynamo is down

Usage
assertServiceIsDown [-basedir <>] [-name <>]
Execution bash
Arguments echo define implementation here

Options

Option Description
basedir deployment basedir
name server to check

killService

kills the service process

Usage
killService [-dynamo_root <>] [-name <>]
Execution bash
Arguments echo define implementation here

Options

Option Description
dynamo_root the DYNAMO_ROOT setting
name the dyanamo server name

Related Types

The following types are defined for use with AtgAppServer.

AtgSwitchingDataStore

Overview

Open in Workbench AtgSwitchingDataStore: An ATG switching datastore configuration item

Design

Super Type
AtgAppServerSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
datastore settingValue

AtgDirlist

Overview

Open in Workbench AtgDirlist: The list of expected instance sub directories

Design

Super Type
AtgAppServerSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
dirlist settingValue

AtgAppServerSetting

Overview

Open in Workbench AtgAppServerSetting: an ATG setting

Design

Super Type
Setting
Role Concrete. (Objects can be created.)
Instance Names Unique

Constraints

Allowed Parent Dependencies

AtgAppServername

Overview

Open in Workbench AtgAppServername: The configuration name of the atg server

Design

Super Type
AtgAppServerSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
servername settingValue

AtgRmiPort

Overview

Open in Workbench AtgRmiPort: An RMI listen port

Design

Super Type
AtgAppServerSetting
Role Concrete. (Objects can be created.)
Instance Names Unique

Attributes

Exported Attributes
Name Property
rmiport settingValue