Preface

This document describes the functionality provided by the Oracle Service Bus (OSB) plugin.

See the Deployit Reference Manual for background information on Deployit and deployment concepts.

Overview

The OSB plugin is a Deployit plugin that adds capability for importing and deleting OSB projects.

Features

OSB Configuration (import and delete)
OSB Customization files (during import) with placeholders replacement

Requirements

Deployit requirements
- Deployit: version 3.6+
- WLS versions: from ALSB 3.0 to OSB 11gR5
- Other Deployit Plugins: WebLogic plugin version 3.6+
Infrastructural requirements
- WebLogic Domain user credentials
- User credentials for accessing the Host managing the WebLogic Administration Server.
- User credentials for accessing target Hosts of managed Servers (for NoStage mode)

Usage in Deployment Packages

The plugin works with the standard deployment package of DAR format. Please see the Packaging Manual for more details about the DAR format and the ways to compose one.

The following is a sample MANIFEST.MF file that can be used to create an OSB specific deployment package. It contains declarations for an osb.Configuration that contains two projects: project1 and project2

Manifest-Version: 1.0
Deployit-Package-Format-Version: 1.3
CI-Application: MyFrontEndServices
CI-Version: 2.0

Name: osbConfiguration
CI-Type: osb.Configuration
CI-projectNames-EntryValue-1: project1
CI-projectNames-EntryValue-1: project2

osb.Configuration is a folder that contains one jar file containing the projects and one or more customization files in xml.

Using the deployables and deployeds

The following table describes which deployable/container combinations are possible.

Deployable vs. Container table

Deployable	Container	Generated deployed
osb.Configuration	osb.Domain wls.Server	osb.DeployedConfiguration

The following table describes the effect a deployed has on it's container

Deployed Actions Table

Deployed	Actions performed for operations
	Create	Destroy	Modify
osb.Configuration	Import the projects in the OSB Domain	Delete the projects from the OSB Domain Import the projects in the OSB Domain

CI Reference

Configuration Item Overview

Deployable Configuration Items

CI	Description
osb.Configuration	Description unavailable

Deployed Configuration Items

CI	Description
osb.DeployedConfiguration	Deployed OSB Configuration

Topology Configuration Items

CI	Description
osb.Domain	OSB domain on the WebLogic server

Virtual Deployed Configuration Items

CI	Description
osb.ExtensibleDeployedArtifact	Description unavailable

Configuration Item Details

osb.Configuration

Hierarchy	generic.Folder >> udm.BaseDeployableFolderArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Taggable, udm.Deployable, udm.SourceArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FolderArtifact

Description unavailable

Public Properties
projectNames : SET_OF_STRING list of the projects
excludeFileNamesRegex : STRING Regular expression that matches file names that must be excluded from scanning
placeholders : SET_OF_STRING Placeholders detected in this artifact
scanPlaceholders : BOOLEAN = true Scan Placeholders
tags : SET_OF_STRING If set, this deployable will only be mapped automatically to containers with the same tag.

Hidden Properties
textFileNamesRegex : STRING = .+\.(cfg \| conf \| config \| ini \| properties \| props \| txt \| asp \| aspx \| htm \| html \| jsf \| jsp \| xht \| xhtml \| sql \| xml \| xsd \| xsl \| xslt) Regular expression that matches file names of text files

osb.DeployedConfiguration

Hierarchy	osb.ExtensibleDeployedArtifact >> wls.ExtensibleDeployedArtifact >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

Deployed OSB Configuration

Public Properties
container : CI<udm.Container> The container on which this deployed runs.
deploymentOrder : INTEGER = 100 By default, new applications and modules are configured with a Deployment Order value of 100
projectNames : SET_OF_STRING list of the projects
redeploymentStrategy : ENUM [CLASSIC, STOP_START, SIDE_BY_SIDE] = CLASSIC Indicates what redeployment strategy to use for upgrading the application
deployable : CI<udm.Deployable> The deployable that this deployed is derived from.
passphrase : STRING = PassPhrase OSB JarFile
placeholders : MAP_STRING_STRING A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
retireTimeout : INTEGER = -1 Timeout interval (in secs) before the previous application version is undeployed for side by side redeployment strategy
stageMode : ENUM [Stage, NoStage] = Stage Indicates whether the artifact will be deployed as staged or nostage mode
stagingDirectory : STRING Absolute directory path where the artifact will be uploaded and used by the servers for nostage deployment mode
versionIdentifier : STRING Version Identifier
versioned : BOOLEAN Indicates wither this artifact is to be deployed as a versioned application

Hidden Properties
configurationExtension : STRING = jar Configuration Extension
createOrder : INTEGER = 60 Create Order
createScript : STRING = osb/configuration/import.py Python script invoked to import this OSB configuration
createVerb : STRING = Import Create Verb
customizationFileExtension : STRING = xml Customization File Extension
destroyOrder : INTEGER = 40 Destroy Order
destroyScript : STRING = osb/configuration/delete.py Python script invoked to delete this OSB configuration
destroyVerb : STRING = Delete Destroy Verb
modifyOrder : INTEGER = 60 Modify Order
modifyScript : STRING = osb/configuration/import.py Python script invoked to modify this OSB configuration
modifyVerb : STRING = Upgrade Modify Verb
standardPropertiesNotToExpose : STRING = id, name, type, deployable, properties, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, destroyScript, destroyVerb, destroyOrder, startScript, startVerb, startOrder, stopScript, stopVerb, stopOrder, deploymentStrategy, placeholders, file, redeploymentStrategy, securityPermissions, inheritPermissions, exposeDeployedApplication, stopRetiredApplicationOrder, undeployRetiredApplicationOrder Standard Properties Not To Expose
startOrder : INTEGER = 90 Start Order
startScript : STRING = wls/application/start-application.py Start Script
startVerb : STRING = Start Start Verb
stopOrder : INTEGER = 10 Stop Order
stopRetiredApplicationOrder : INTEGER = 95 Stop Retired Application Order
stopScript : STRING = wls/application/stop-application.py Stop Script
stopVerb : STRING = Stop Stop Verb
undeployRetiredApplicationOrder : INTEGER = 98 Undeploy Retired Application Order
wlstPath : STRING = AppDeployments Wlst Path
exposeDeployedApplication : BOOLEAN = false flag to indicate whether the deployed application CI is to be injected to the python script execution context.

osb.Domain

Hierarchy	wls.Domain >> udm.BaseContainer >> udm.BaseConfigurationItem
Interfaces	udm.Taggable, python.PythonManagingContainer, wls.WlsContainer, python.PythonManagedContainer, udm.ConfigurationItem, udm.Container

OSB domain on the WebLogic server

Public Properties
adminServerName : STRING = AdminServer The name of the admin server
clusters : SET_OF_CI<wls.Cluster> WebLogic clusters belonging to domain
host : CI<overthere.Host> The host that runs the admin server
osbHome : STRING OSB Home directory
password : STRING Password which is used to login to the WebLogic Domain.
port : INTEGER = 7001 Port to be used by the AdminServer for this domain
startMode : ENUM [NodeManager, Script, WindowsService] = NodeManager Tells how a managed server is start and stop, default is NodeManager, others are Script or Windows Service
username : STRING Username which is used to login to the WebLogic Domain.
version : ENUM [WEBLOGIC_10, WEBLOGIC_11] = WEBLOGIC_10 Version of Oracle WebLogic Server
wlHome : STRING The location of the WebLogic Server installation
domainHome : STRING The location of the WebLogic domain. Defaults to '/../user_projects/domains/'
tags : SET_OF_STRING If set, only deployables with the same tag will be automatically mapped to this container.

Hidden Properties
configfwkLibs : SET_OF_STRING = [../modules/com.bea.common.configfwk_1.1.0.0.jar, modules/com.bea.common.configfwk_1.6.0.0.jar, ../modules/com.bea.common.configfwk_1.2.0.0.jar, modules/com.bea.common.configfwk_1.5.0.0.jar, ../modules/com.bea.common.configfwk_1.4.0.0.jar, ../modules/com.bea.common.configfwk_1.3.0.0.jar, ../modules/com.bea.common.configfwk_1.2.1.0.jar] All possible locations of the configfwk library relative to the OSB Home
pythonRuntimePath : STRING = osb/runtime Python Runtime Path
sbKernelLibs : SET_OF_STRING = [sb-kernel-impl.jar, sb-kernel-wls.jar, sb-kernel-api.jar] All possibly needed service bus kernel libraries relative to the OSB home
wlstTemplatePath : STRING = osb Path containing the wlst templates: wlst.sh.ftl (Unix) and wlst.cmd.ftl (Windows)
runWithDaemon : BOOLEAN = true Set to true to execute commands with the Python daemon

osb.ExtensibleDeployedArtifact

Hierarchy	wls.ExtensibleDeployedArtifact >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

Description unavailable

Public Properties
container : CI<udm.Container> The container on which this deployed runs.
deploymentOrder : INTEGER = 100 By default, new applications and modules are configured with a Deployment Order value of 100
redeploymentStrategy : ENUM [CLASSIC, STOP_START, SIDE_BY_SIDE] = CLASSIC Indicates what redeployment strategy to use for upgrading the application
deployable : CI<udm.Deployable> The deployable that this deployed is derived from.
placeholders : MAP_STRING_STRING A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
retireTimeout : INTEGER = -1 Timeout interval (in secs) before the previous application version is undeployed for side by side redeployment strategy
stageMode : ENUM [Stage, NoStage] = Stage Indicates whether the artifact will be deployed as staged or nostage mode
stagingDirectory : STRING Absolute directory path where the artifact will be uploaded and used by the servers for nostage deployment mode
versionIdentifier : STRING Version Identifier
versioned : BOOLEAN Indicates wither this artifact is to be deployed as a versioned application

Hidden Properties
createOrder : INTEGER = 70 Create Order
createScript : STRING = wls/application/deploy-application.py Create Script
createVerb : STRING = Deploy Create Verb
destroyOrder : INTEGER = 30 Destroy Order
destroyScript : STRING = wls/application/undeploy-application.py Destroy Script
destroyVerb : STRING = Undeploy Destroy Verb
modifyOrder : INTEGER = 60 Modify Order
modifyVerb : STRING = Upgrade Modify Verb
standardPropertiesNotToExpose : STRING = id, name, type, deployable, properties, container, createScript, createVerb, createOrder, modifyScript, modifyVerb, modifyOrder, destroyScript, destroyVerb, destroyOrder, startScript, startVerb, startOrder, stopScript, stopVerb, stopOrder, deploymentStrategy, placeholders, file, redeploymentStrategy, securityPermissions, inheritPermissions, exposeDeployedApplication, stopRetiredApplicationOrder, undeployRetiredApplicationOrder Standard Properties Not To Expose
startOrder : INTEGER = 90 Start Order
startScript : STRING = wls/application/start-application.py Start Script
startVerb : STRING = Start Start Verb
stopOrder : INTEGER = 10 Stop Order
stopRetiredApplicationOrder : INTEGER = 95 Stop Retired Application Order
stopScript : STRING = wls/application/stop-application.py Stop Script
stopVerb : STRING = Stop Stop Verb
undeployRetiredApplicationOrder : INTEGER = 98 Undeploy Retired Application Order
wlstPath : STRING = AppDeployments Wlst Path
exposeDeployedApplication : BOOLEAN = false flag to indicate whether the deployed application CI is to be injected to the python script execution context.
modifyScript : STRING Python script invoked to upgrade this Java EE artifact