Squid
Squid caching proxy server
Overview
Design
- Super Type
- Service
Role | Concrete. (Objects can be created.) |
Instance Names | Unique |
Notification | false |
Template Directory | |
Data View | Children, proximity: 1 |
Logger Name | Squid |
Constraints
Allowed Child Dependencies
- SquidClient 1
- SquidHost 1
- SquidPort 1
1: These types have a Singleton constraint. Only one instance may be added as a resource.
Allowed Parent Dependencies
- Node
- Site
Attributes
Exported Attributes
Name | Property |
---|---|
squidBase | deployment-basedir |
squidHome | deployment-install-root |
Defaults for Imported Attributes
Name | Default |
---|---|
squidClient | /usr/sbin/squidclient |
squidHost | localhost |
squidPort | 3128 |
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.
Stop
Conditionally stops the JBoss Server
- Usage
- Stop
Workflow
Error Handler
Command |
stopServiceWrapper
wraps the jboss stop procedure and waits for stop event
- Usage
- stopServiceWrapper
Workflow
Error Handler
Command |
waitforStopEvent
waits for the service to shutdown
- Usage
- waitforStopEvent [-host <>] [-maxwait <45>] [-port <>]
Options
Option | Description |
---|---|
host | Squid host |
maxwait | Squid max wait for shutdown |
port | Squid port |
assertServiceIsDown
checks if the service is down
- Usage
- assertServiceIsDown [-host <>] [-port <>]
Options
Option | Description |
---|---|
host | Squid host |
port | Squid port |
assertServiceIsUp
checks if the service is running
- Usage
- assertServiceIsUp [-host <>] [-port <>]
Options
Option | Description |
---|---|
host | Squid host |
port | Squid port |
stopService
stops the squid service
- Usage
- stopService
killService
kills the squid service
- Usage
- killService
startService
starts the squid service
- Usage
- startService
purgeObject
purges an object from the squid cache
- Usage
- purgeObject
Related Types
The following types are defined for use with Squid.
SquidSetting
Overview
SquidSetting: Squid configuration setting
Design
- Super Type
- Setting
Role | Abstract. (Objects cannot be created.) |
Instance Names | Unique |
SquidPort
Overview
Design
- Super Type
- SquidSetting
Role | Concrete. (Objects can be created.) |
Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
Name | Property |
---|---|
squidPort | settingValue |
SquidHost
Overview
Design
- Super Type
- SquidSetting
Role | Concrete. (Objects can be created.) |
Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
Name | Property |
---|---|
squidHost | settingValue |
SquidClient
Overview
SquidClient: Location of the Squid client utility
Design
- Super Type
- SquidSetting
Role | Concrete. (Objects can be created.) |
Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
Name | Property |
---|---|
squidClient | settingValue |