ActiveMQ
An ActiveMQ deployment
Overview
ActiveMQ:
An ActiveMQ deployment
Design
- Super Type
- Service
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
| Notification | false |
| Template Directory | |
| Data View | Children, proximity: 1 |
| Logger Name | ActiveMQ |
Constraints
Allowed Child Dependencies
- ActiveMQSetting
- ActiveMQZip 1
- JavaBin 1
- JavaHomePath1
- PlatformZip
1: These types have a Singleton constraint. Only one instance may be added as a resource.
Attributes
Exported Attributes
| Name | Property |
|---|---|
| activemqBase | deployment-basedir |
| activemqHome | deployment-install-root |
Defaults for Imported Attributes
| Name | Default |
|---|---|
| activemqMgmtStrategy | default |
| activemqRelease | 5.1 |
| javaHome | ${env.JAVA_HOME} |
| jmxPort | 1099 |
| openwirePort | 61616 |
| rmiServerPort | 2099 |
| sslPort | 61617 |
| stompPort | 61613 |
| timeout | 10 |
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.
Update
run the update cycle
- Usage
- Update
Workflow
- Stop
- Configure
- Start
Docs-Generate
generates all defined docs
- Usage
- Docs-Generate [-activemqbase <>] [-activemqhome <>] [-javaHome <>] [-timeout <>]
Options
| Option | Description |
|---|---|
| activemqbase | activemq instance dir |
| activemqhome | activemq instance dir |
| javaHome | java home |
| timeout | Timeout in seconds |
Prepare
builds the deployment objects
- Usage
- Prepare [-packagetype <PlatformZip>]
Workflow
- Packages-Install
- Configure
Options
| Option | Description |
|---|---|
| packagetype | Platform packages to install |
assertServiceIsDown
checks if the service is down
- Usage
- assertServiceIsDown [-openwireport <>]
Options
| Option | Description |
|---|---|
| openwireport | listening port |
assertServiceIsUp
checks if the service is running
- Usage
- assertServiceIsUp [-openwireport <>]
Options
| Option | Description |
|---|---|
| openwireport | listening port |
startService
starts the service
- Usage
- startService [-activemqbase <>] [-activemqhome <>] [-javahome <>] [-timeout <>]
Options
| Option | Description |
|---|---|
| activemqbase | activemq base |
| activemqhome | activemq home |
| javahome | jre install dir |
| timeout | Timeout in seconds |
stopService
starts the service
- Usage
- stopService [-activemqbase <>] [-activemqhome <>] [-javahome <>] [-timeout <>]
Options
| Option | Description |
|---|---|
| activemqbase | activemq base |
| activemqhome | activemq home |
| javahome | jre install dir |
| timeout | Timeout in seconds |
Related Types
The following types are defined for use with ActiveMQ.
ActiveMQSetting
Overview
ActiveMQSetting:
ActiveMQ configuration setting
Design
- Super Type
- Setting
| Role | Abstract. (Objects cannot be created.) |
| Instance Names | Unique |
ActivemqRelease
Overview
ActivemqRelease:
ActiveMQ Server Release
Design
- Super Type
- ActiveMQSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| activemqRelease | settingValue |
ActivemqMgmtStrategy
Overview
ActivemqMgmtStrategy:
Specifies the ActiveMQ Management Strategy
Design
- Super Type
- ActiveMQSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| activemqMgmtStrategy | settingValue |
ActiveMQJMXPort
Overview
ActiveMQJMXPort:
ActiveMQ JMX port
Design
- Super Type
- ActiveMQSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| jmxPort | settingValue |
ActiveMQOpenwirePort
Overview
ActiveMQOpenwirePort:
ActiveMQ Openwire port
Design
- Super Type
- ActiveMQSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| openwirePort | settingValue |
ActiveMQSSLPort
Overview
ActiveMQSSLPort:
ActiveMQ SSL port
Design
- Super Type
- ActiveMQSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| sslPort | settingValue |
ActiveMQStompPort
Overview
ActiveMQStompPort:
ActiveMQ Stomp port
Design
- Super Type
- ActiveMQSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| stompPort | settingValue |
ActiveMQRmiServerPort
Overview
ActiveMQRmiServerPort:
ActiveMQ RMI Server port
Design
- Super Type
- ActiveMQSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| rmiServerPort | settingValue |
ActiveMQTimeout
Overview
ActiveMQTimeout:
Shutdown timeout period in seconds
Design
- Super Type
- ActiveMQSetting
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
Constraints
Allowed Parent Dependencies
Attributes
Exported Attributes
| Name | Property |
|---|---|
| timeout | settingValue |