JBossZip

A JBoss Distribution Package

Overview
- Intent
- Problem
Design
Constraints
Attributes
- Exported Attributes
Commands
- assertPackageIsInstalled
- extract

Overview

JBossZip: A JBoss Distribution Package

Intent

To manage the installation of a JBoss Server via its zip based package distribution as part of the JBossServer deployment lifecycle.

Problem

A JBossServer deployment has to manage many dependencies. This dependency can be considered as fundamental and depending on operational procedures, the jboss server platform package can be automated thru this package module. Objects of this type can be assigned as a JBossServer package dependency in this case.

Design

Super Type: PlatformZip

Role	Concrete. (Objects can be created.)
Instance Names	Unique
Notification	false
Template Directory	${modules.dir}/JBossZip/templates
Data View	Children, proximity: 1
Logger Name	JBossZip

Constraints

Allowed Child Dependencies

Package

Allowed Parent Dependencies

Deployment

Allowed Property Values

Property	Allowed Values	Default	Enforced
package-install-root	${user.home}/jboss-${entity.attribute.jboss_version}	${user.home}/jboss-${entity.attribute.jboss_version}	false
package-repo-url	${framework.pkgRepo.uri}/${context.depot}/JBossZip/zips/FILENAME	${framework.pkgRepo.uri}/${context.depot}/JBossZip/zips/FILENAME	false
package-filetype	zip	zip	false
package-arch	noarch	noarch	false
package-install-rank	10	10	false

Attributes

Exported Attributes

Name	Property	Description
jboss_version	package-version	package-version property, the version of the JBoss distribution, maps to the jboss_version attribute. This value is referenced by the referring JBossServer deployment object.
jbossPackageBase	package-base

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.

assertPackageIsInstalled

Confirm the package process is installed.

Simply check for existence of the bin/run.sh and fail if it does not exist.

Usage: assertPackageIsInstalled [-basedir <>] [-depot <>] [-executable <>] [-installroot <>] [-name <>] [-nodeps] [-nodir] [-nomodule] [-nopackageinstall] [-noproperties] [-script <>] [-subdirs <>] [-type <>]

Options

Option	Description
basedir	instance directory
depot	project depot
executable	executable to run
installroot	package installroot
name	object name
nodeps	do not install dependencies
nodir	do not create directories
nomodule	do not update module
nopackageinstall	do not install package
noproperties	do not update properties
script	script to execute
subdirs	directory list
type	object type

extract

Extract the package archive.

check for the existence of run.sh and if not, we extract the jboss package. Upon extraction, ensure proper file permissions.

Usage: extract [-base <>] -filename <> [-filtersfile <>] -installroot <> -url <>

Options

Option	Description
base	base directory name of the installation root
filename	the installer filename
filtersfile	optional filtersfile passed in by the referring deployment
installroot	the installation root
url	the package repository url of the installer package