Home / Middleware / Oracle Virtual Assembly Builder

Contents

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Documents
• Conventions

1 Overview of Oracle Virtual Assembly Builder Deployer

• 1.1 Introduction
• 1.2 Deployment Lifecycle
  • 1.2.1 Uploading Assembly Archives
    • 1.2.1.1 Versioning of Assembly Archives
  • 1.2.2 Deployment Phases
• 1.3 Deployer Architecture
• 1.4 Targets
• 1.5 Tags
• 1.6 Metadata-Driven Functionality

2 API Web Services

• 2.1 Operations
• 2.2 Administrative Operations
• 2.3 Usage and Lifecycle
• 2.4 Admin Web Service
  • 2.4.1 Context Path
  • 2.4.2 Query String Pattern
  • 2.4.3 Actions
  • 2.4.4 Error Handling
  • 2.4.5 XML Schema
• 2.5 Deployer Web Service
  • 2.5.1 Context Path
  • 2.5.2 Query String Pattern
  • 2.5.3 Actions
  • 2.5.4 Error Handling
  • 2.5.5 XML Schema

3 API Reference: Administrative Operations

• 3.1 Parameters in HTTP Query String
• 3.2 Response Content
• 3.3 AddTargetUser
• 3.4 CreateTarget
• 3.5 DeleteTarget
• 3.6 DescribeTargetConfigurations
• 3.7 DescribeTargetNames
• 3.8 DescribeTargetUsers
• 3.9 DescribeUserTargets
• 3.10 GetDefaultTarget
• 3.11 GetTargetType
• 3.12 RemoveTargetUsers
• 3.13 SetDefaultTarget

4 API Reference: Deployer Operations

• 4.1 Parameters in HTTP Query String
• 4.2 AddAssemblyUsers
• 4.3 CreateAssemblyInstance
• 4.4 CreateTags
• 4.5 DeleteAssemblyArchive
• 4.6 DeleteAssemblyInstance
• 4.7 DeleteAssemblyResources
• 4.8 DeleteDeploymentPlan
• 4.9 DeleteLogEvents
• 4.10 DeleteRequests
• 4.11 DeleteTags
• 4.12 DeployAssemblyInstance
• 4.13 DescribeAssemblyArchives
• 4.14 DescribeApplianceInstances
• 4.15 DescribeAssemblyInstances
• 4.16 DescribeAssemblyResources
• 4.17 DescribeAssemblyUsers
• 4.18 DescribeDeployer
• 4.19 DescribeLogEvents
• 4.20 DescribeRegistrations
• 4.21 DescribeRequests
• 4.22 DescribeScalingGroups
• 4.23 DescribeTags
• 4.24 DescribeTargets
• 4.25 DescribeVnets
• 4.26 DownloadAssemblyArchive
• 4.27 DownloadAssemblyMetadata
• 4.28 DownloadAssemblyResources
• 4.29 RedeployAssemblyInstance
• 4.30 RegisterAssemblyArchive
• 4.31 RemoveAssemblyUsers
• 4.32 RestartAssemblyInstance
• 4.33 ResumeAssemblyInstance
• 4.34 ScaleAppliance
• 4.35 StartAssemblyInstance
• 4.36 StopAssemblyInstance
• 4.37 SuspendAssemblyInstance
• 4.38 UndeployAssemblyInstance
• 4.39 UnregisterAssemblyArchive
• 4.40 UpdateAssemblyArchive
• 4.41 UploadAssemblyArchive
• 4.42 UploadAssemblyResources
• 4.43 UploadDeploymentPlan
• 4.44 ValidateAssemblyInstanceResources

5 Preparing to Develop using the Oracle Virtual Assembly Builder Plug-in SDK

• 5.1 Introduction
  • 5.1.1 What Does a Plug-in Do?
  • 5.1.2 Packaging and Distribution
• 5.2 Preparing to Develop a Plug-in
  • 5.2.1 Name the Plug-in
  • 5.2.2 Plug-in or Plug-in Extension
  • 5.2.3 Version the Plug-in
  • 5.2.4 Developing an Introspection Plug-in
• 5.3 Plug-in Architecture and Workflow
  • 5.3.1 Workflow
  • 5.3.2 How Does Your Plug-in Fit in
    • 5.3.2.1 Job Parameters
    • 5.3.2.2 Dehydration
    • 5.3.2.3 Rehydration
    • 5.3.2.4 Post-Deployment Operations
• 5.4 Metadata Overview
  • 5.4.1 Type of Metadata
    • 5.4.1.1 Appliance
    • 5.4.1.2 Atomic Assembly
  • 5.4.2 Appliances
    • 5.4.2.1 Scalability
  • 5.4.3 Assemblies
  • 5.4.4 Atomic Assemblies
  • 5.4.5 Properties
    • 5.4.5.1 Property Categories
    • 5.4.5.2 Property Groups
    • 5.4.5.3 Synthetic Properties
    • 5.4.5.4 Setting and Retrieving Properties
  • 5.4.6 Inputs and Outputs
    • 5.4.6.1 Output Connection Properties
    • 5.4.6.2 Connections
    • 5.4.6.3 External Resources
    • 5.4.6.4 Vnets
    • 5.4.6.5 Interfaces
  • 5.4.7 Content Resources
  • 5.4.8 File Set Definitions
    • 5.4.8.1 Exclusions
    • 5.4.8.2 Shared File Sets
• 5.5 Introspector Plug-in Extensions
  • 5.5.1 Semantics of Plug-in Extensions
  • 5.5.2 Restrictions on Plug-in Extensions
  • 5.5.3 Plug-in Extension Execution
  • 5.5.4 Plug-in Extension Implementation
  • 5.5.5 Plug-In Extension SPIF Service Activation
• 5.6 Support Services
  • 5.6.1 SPIF
    • 5.6.1.1 Class Loading
    • 5.6.1.2 Applications
    • 5.6.1.3 Services
    • 5.6.1.4 Creating a Service
    • 5.6.1.5 Service Activator
    • 5.6.1.6 Registering a Service
    • 5.6.1.7 Finding a Service
  • 5.6.2 Validation Framework
    • 5.6.2.1 File Set Capture Validation
    • 5.6.2.2 Platform and OS Validation
    • 5.6.2.3 Template Validation
  • 5.6.3 Plug-in Discovery and Installation
    • 5.6.3.1 Plug-in Location
    • 5.6.3.2 plugin.config File
  • 5.6.4 Implementing an IntrospectorPluginLocator Service
  • 5.6.5 Plug-in Backward Compatibility Requirements
  • 5.6.6 Plug-in Installation Guidelines
• 5.7 Utilities and Helpers
  • 5.7.1 OCM Registration
  • 5.7.2 OUI Central Inventory
  • 5.7.3 SSH
  • 5.7.4 Velocity
  • 5.7.5 Misc Utilities
• 5.8 Best Practices
  • 5.8.1 Avoid Modifying the Reference System
  • 5.8.2 Avoid Static Variables
  • 5.8.3 Do not Attempt to Access SPIF Services during ServiceActivator.start()
  • 5.8.4 Reserved Names and Naming Restrictions
    • 5.8.4.1 Appliance and Assembly Names
    • 5.8.4.2 Property Names
    • 5.8.4.3 Type
  • 5.8.5 Managing External Dependencies
• 5.9 Testing your Introspector Plug-in
  • 5.9.1 Dehydration Testing
  • 5.9.2 Rehydration Testing and Troubleshooting
    • 5.9.2.1 Deployment Lifecycle

6 Developing an Introspection Plug-in

• 6.1 Introduction
• 6.2 Tutorial 1: Oracle Virtual Assembly Builder Integration
  • 6.2.1 Creating a Project
  • 6.2.2 Creating an IntrospectorPlugin
  • 6.2.3 SPIF Service Activation
  • 6.2.4 Building the Tutorials
  • 6.2.5 Installing the Plug-in
  • 6.2.6 Executing an Introspector Plug-In
    • 6.2.6.1 abctl Command-Line User Interface
    • 6.2.6.2 Oracle Virtual Assembly Builder Studio
  • 6.2.7 Conclusion
• 6.3 Tutorial 2: Dehydration
• 6.4 Tutorial 3: Rehydration
• 6.5 Tutorial 4: Progress
• 6.6 Tutorial 5: Job Parameters
• 6.7 Sample Plug-in
• 6.8 Sample Plug-in Extension

7 Introspection Plug-in Module Reference

• 7.1 Introduction
• 7.2 External Common [oracle.as.assemblybuilder.external.common]
  • 7.2.1 Logging
  • 7.2.2 Exceptions
  • 7.2.3 Resources
• 7.3 Progress [oracle.as.assemblybuilder.progress]
• 7.4 Introspector [oracle.as.assemblybuilder.introspector.api]
• 7.5 Appliance [oracle.as.assemblybuilder.introspector.metadata.appliance.Appliance]
• 7.6 Assembly [oracle.as.assemblybuilder.introspector.metadata.assembly.Assembly]
• 7.7 Catalog [oracle.as.assemblybuilder.catalog.api]
• 7.8 Introspector Plug-In Util [oracle.as.assemblybuilder.introspector.plugin.util]

8 Sample Application: Web Service API

• 8.1 Sample Application

A Web Service Schema

• A.1 Schema