AtgApacheServer

AtgApacheServer: Apache web server

Super Type: Service

Role	Concrete. (Objects can be created.)
Instance Names	Unique
Notification	false
Template Directory
Data View	Children, proximity: 1
Logger Name	AtgApacheServer

Allowed Child Dependencies

AtgApachePath ¹
AtgApachePidFile ¹
AtgApacheServerConfigFile ¹
AtgApacheStartCommand ¹
AtgApacheTimeout ¹
AtgApacheUser ¹
AtgConfigJar ¹
AtgModuleJar ¹
DefaultAllowMultiplePackageMatches¹
DefaultFailIfPackageNotReplaced¹
DefaultPackageName¹
DefaultPackageType¹

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

Allowed Parent Dependencies

AtgSite
Node
Updater

Exported Attributes

Name	Property
atgApacheHome	deployment-install-root
atgApacheServerRoot	deployment-basedir

Defaults for Imported Attributes

Name	Default
atgApachePath	/bin:/usr/bin
atgApachePidFile	${entity.attribute.atgApacheServerRoot}/logs/httpd.pid
atgApacheServerConfigFile	${entity.attribute.atgApacheServerRoot}/conf/httpd.conf
atgApacheStartCommand	start
atgApacheTimeout	60
atgApacheUser	${user.name}
defaultAllowMultiplePackageMatches	false
defaultFailIfPackageNotReplaced	true
defaultPackageName	^$
defaultPackageType	AtgConfigJar

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.

assertServiceIsDown

checks if service is down

Usage: assertServiceIsDown [-pidfile <>]

Options

Option	Description
pidfile	Location of the Apache server pid file

assertServiceIsUp

checks if process is running

Usage: assertServiceIsUp [-pidfile <>]

Options

Option	Description
pidfile	Location of the Apache server pid file

startService

start the service process

Usage: startService [-base <>] [-command <>] [-conf <>] [-home <>] [-path <>] [-pidfile <>] [-timeout <>] [-user <>]

Options

Option	Description
base	Location of the Apache base configuration
command	Command to use to start Apache
conf	Location of the Apache configuration file
home	Location of the Apache installation
path	PATH to use with the Apache server
pidfile	Location of the Apache server pid file
timeout	Timeout in seconds
user	user to start apache with

stopService

stops the service process

Usage: stopService [-base <>] [-conf <>] [-home <>] [-path <>] [-timeout <>] [-user <>]

Options

Option	Description
base	Location of the Apache base configuration
conf	Location of the Apache configuration file
home	Location of the Apache installation
path	PATH to use with the Apache server
timeout	Timeout in seconds
user	user to stop apache with

The following types are defined for use with AtgApacheServer.

AtgApacheSetting

Overview

AtgApacheSetting: Apache web server settings

Design

Super Type: Setting

Role	Abstract. (Objects cannot be created.)
Instance Names	Unique

Constraints

Allowed Parent Dependencies

AtgApacheServer

AtgApacheUser

Overview

AtgApacheUser: Period to wait (in seconds) before timing out Apache server start/stop commands

Design

Super Type: AtgApacheSetting

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

Attributes

Exported Attributes

Name	Property
atgApacheUser	settingValue

AtgApacheStartCommand

Overview

AtgApacheStartCommand: The command to use to start Apache via apachectl (usually "start" or "startssl")

Design

Super Type: AtgApacheSetting

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

Attributes

Exported Attributes

Name	Property
atgApacheStartCommand	settingValue

AtgApacheTimeout

Overview

AtgApacheTimeout: Period to wait (in seconds) before timing out Apache server start/stop commands

Design

Super Type: AtgApacheSetting

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

Attributes

Exported Attributes

Name	Property
atgApacheTimeout	settingValue