PlatformJar

A platform jar package

Overview
- Intent
- Problem
Design
Constraints
- Allowed Property Values
Commands
- extract
- finish

Overview

PlatformJar: A platform jar package

Intent

Automates the installation of a jar to an application platform such as an appserver. This jar is meant to be treated as a library rather than a package that extracts itself at deployment time. Therefore this package gets deployed as is to the desired installation directory (installroot).

Problem

Often packages such as a jar library, need to be installed onto an existing software deployment. For example, a Tomcat server needs a jar to be deployed into its lib directory since this jar may not be part of the default installation. This package module solves this problem.

Design

Super Type: jar

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

Constraints

Allowed Property Values

Property	Allowed Values	Default	Enforced
package-filetype	jar	jar	true
package-repo-url	${framework.pkgRepo.uri}/${context.depot}/PlatformJar/jars/FILENAME	${framework.pkgRepo.uri}/${context.depot}/PlatformJar/jars/FILENAME	false
package-vendor	acme	acme	false

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.

extract

Extract the package archive.

overrides the jar extract command to ensure that no extraction actually occurs.

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

Options

Option	Description
base	package base name
filename	the filename
filtersfile	filtersfile
installroot	the install root
url	the repo url

finish

finish the extract of jar

overrides the Package finish command to ensure no post processing occurs.

Usage: finish -filename <> [-filtersfile <>] [-filtersfile <>] -installroot <> [-script <>] -url <>

Options

Option	Description
filename	the filename
filtersfile	filtersfile
filtersfile	property file
installroot	the install root
script	script to execute
url	the repo url