oracle.jdeveloper.deploy

Class DeploymentManager

java.lang.Object

oracle.jdeveloper.deploy.DeploymentManager

public abstract class DeploymentManager
extends java.lang.Object

Entry-point into the Deployment Framework.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DeploymentManager()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addDeployerListener(int deploymentSequenceId, java.lang.Class<? extends Profile> profileClass, PlatformType platformType, DeployerListener listener) Add a generic listener into the Deployment framework.
static void	addDeployerListener(int deploymentSequenceId, java.lang.Class<? extends Profile> profileClass, PlatformType platformType, double priority, DeployerListener listener) Same as previous, takes an additional priority argument.
static void	addDeployerListener(ListenerCondition condition, DeployerListener listener, double priority) Same as the previous version, but also takes a priority float argument between 0 and 1 inclusive, where 0 meant the listener should be executed at the very end, after all other listeners
static Deployer	createDeployer(int deploymentSequenceId, DeployShell shell)
static java.lang.Runnable	createRunnable(int deploymentSequenceId, DeployShell shell) Creates a Runnable from a deployment sequence and shell.
static void	deploy(int deploymentSequenceId, Context context) Run an end-to-end deployment sequence synchronously.
static void	deploy(int deploymentSequenceId, Context context, DeployShellFactory factory) Deprecated.
static void	deploy(int deploymentSequenceId, Context context, DeployShellFactory factory, java.lang.Object lock) Deprecated.
static void	deploy(int deploymentSequenceId, DeployShell shell) Performs a synchronous deployment using supplied shell.
static Runnable	deploy(int deploymentSequenceId, DeployShell shell, java.lang.Object lock) Performs an asynchronous deployment using supplied shell.
DeployShell	getDefaultDeployShell(int deploySequence, Context context) Deprecated. Use DeployShellFactory.getInstance().create(...) instead.
static int	getDeploymentSequenceId(java.lang.String deploymentSequence) Get or create a Deployment Sequence Id from a string.
static java.lang.String	getDeploymentSequenceName(int sequenceId)
static oracle.jdevimpl.deploy.fwk.ListenerSupport	getProfileListenerSupport() Internal use only.
static void	registerDeployerFactory(java.lang.Class deployable, java.lang.Class parent, DeployerFactory factory) Registers a new Deployer factory with the Deployment Framework.
static void	registerDeployerFactory(MetaClass deployable, MetaClass parent, CustomMetaClass deployerFactory)
static void	registerDeployerFactory(MetaClass deployable, MetaClass parent, MetaClass factory)
static void	registerDeploymentModuleFactory(java.lang.String forClass, DeploymentModuleFactory factory)
static void	removeDeployerListener(DeployerListener listener)
static void	removeDeployerListener(ListenerCondition condition, DeployerListener listener)
static void	setDeploymentManager(oracle.jdevimpl.deploy.fwk.DeploymentManager impl)
static void	upgradeDeployerFactory(java.lang.Class clazz, DeployerFactory factory) Upgrades or extends an existing Factory.
static void	upgradeDeployerFactory(MetaClass deployable, CustomMetaClass deployerFactory)
static void	upgradeDeployerFactory(MetaClass deployable, MetaClass deployerFactory)
static void	upgradeDeploymentModuleFactory(java.lang.String forClass, DeploymentModuleFactory factory)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DeploymentManager

protected DeploymentManager()

Method Detail

addDeployerListener

public static void addDeployerListener(ListenerCondition condition,
                       DeployerListener listener,
                       double priority)

Same as the previous version, but also takes a priority float argument between 0 and 1 inclusive, where 0 meant the listener should be executed at the very end, after all other listeners

Parameters:

condition -

listener -

priority - value between 0 and 1, where 0 means least priority, execute at the end. It is an error to have more than one listener registered for priority 0 or 1.

addDeployerListener

public static void addDeployerListener(int deploymentSequenceId,
                       java.lang.Class<? extends Profile> profileClass,
                       PlatformType platformType,
                       DeployerListener listener)

Add a generic listener into the Deployment framework.

Parameters:

deploymentSequenceId -

profileClass -

platformType -

listener -

addDeployerListener

public static void addDeployerListener(int deploymentSequenceId,
                       java.lang.Class<? extends Profile> profileClass,
                       PlatformType platformType,
                       double priority,
                       DeployerListener listener)

Same as previous, takes an additional priority argument. When multiple listeners are registered for the same criteria, the priority determines the order in which they are fired.

Parameters:

deploymentSequenceId -

profileClass -

platformType -

priority - value between 0.0 and 1.0, 1 has higher priority than 0.

listener -

removeDeployerListener

public static void removeDeployerListener(ListenerCondition condition,
                          DeployerListener listener)

removeDeployerListener

public static void removeDeployerListener(DeployerListener listener)

getDeploymentSequenceId

public static int getDeploymentSequenceId(java.lang.String deploymentSequence)

Get or create a Deployment Sequence Id from a string.

Parameters:

deploymentSequence - a string for the deployment unit.

Returns:

a unique id.

getDeploymentSequenceName

public static java.lang.String getDeploymentSequenceName(int sequenceId)

registerDeployerFactory

public static void registerDeployerFactory(MetaClass deployable,
                           MetaClass parent,
                           MetaClass factory)
                                    throws MetadataException

Throws:

MetadataException

registerDeployerFactory

public static void registerDeployerFactory(MetaClass deployable,
                           MetaClass parent,
                           CustomMetaClass deployerFactory)
                                    throws MetadataException

Parameters:

deployable -

parent -

deployerFactory -

Throws:

MetadataException

registerDeployerFactory

public static void registerDeployerFactory(java.lang.Class deployable,
                           java.lang.Class parent,
                           DeployerFactory factory)
                                    throws MetadataException

Registers a new Deployer factory with the Deployment Framework.

Parameters:

clazz - the Profile class for which this Deployment Factory is being registered. Only one factory can be registered for a particular Profile class. Changes to a existing factory should be done using upgradeFactory().

parentClazz - the parent Profile to which this DeployerFactory should be chained. Requests not handled by this factory will be passed to the factory registerd for the parent Profile class.

factory - the DeployerFactory. If it is null, and parent is not null, an simple referral to the parent factory is created.

Throws:

MetadataException - if parent has not been registered, or if parent and factory are both null.

upgradeDeployerFactory

public static void upgradeDeployerFactory(MetaClass deployable,
                          MetaClass deployerFactory)
                                   throws MetadataException

Throws:

MetadataException

upgradeDeployerFactory

public static void upgradeDeployerFactory(MetaClass deployable,
                          CustomMetaClass deployerFactory)
                                   throws MetadataException

Throws:

MetadataException

upgradeDeployerFactory

public static void upgradeDeployerFactory(java.lang.Class clazz,
                          DeployerFactory factory)
                                   throws MetadataException

Upgrades or extends an existing Factory. Requests for clazz that are not handled by the new factory will be passed on to the old factory.

Parameters:

clazz -

factory -

Throws:

MetadataException

registerDeploymentModuleFactory

public static void registerDeploymentModuleFactory(java.lang.String forClass,
                                   DeploymentModuleFactory factory)
                                            throws MetadataException

Throws:

MetadataException

upgradeDeploymentModuleFactory

public static void upgradeDeploymentModuleFactory(java.lang.String forClass,
                                  DeploymentModuleFactory factory)
                                           throws MetadataException

Throws:

MetadataException

getDefaultDeployShell

@Deprecated
public DeployShell getDefaultDeployShell(int deploySequence,
                                           Context context)
                                  throws DeployException

Deprecated. Use DeployShellFactory.getInstance().create(...) instead.

Create and return a new DeployShell which can be used as a starting point for customizing the Deployment environment.

Parameters:

deploySequence -

context -

Throws:

DeployException

deploy

public static void deploy(int deploymentSequenceId,
          Context context)
                   throws java.lang.Exception

Run an end-to-end deployment sequence synchronously.

Parameters:

deploymentSequenceId -

Throws:

MetaDataException - if deployment could not be started because of a configuration error.

DeployException - if deployment was stopped or cancelled because of one or more errors.

java.lang.Exception - any other errors thrown during deployment.

deploy

public static void deploy(int deploymentSequenceId,
          DeployShell shell)
                   throws java.lang.Exception

Performs a synchronous deployment using supplied shell.

Parameters:

deploymentSequenceId -

shell -

Throws:

DeployException

MetadataException

java.lang.Exception

createRunnable

public static java.lang.Runnable createRunnable(int deploymentSequenceId,
                                DeployShell shell)

Creates a Runnable from a deployment sequence and shell. Running the returned Runnable object will execute the deployment process.

Parameters:

deploymentSequenceId - The Deployment sequence to be used for deployment.

shell - The DeployShell to be used for deployment

Returns:

a runnable object that will execute the deployment process.

createDeployer

public static Deployer createDeployer(int deploymentSequenceId,
                      DeployShell shell)
                               throws java.lang.Exception

Throws:

java.lang.Exception

deploy

public static Runnable deploy(int deploymentSequenceId,
              DeployShell shell,
              java.lang.Object lock)

Performs an asynchronous deployment using supplied shell. This method does not throw any exceptions, instead exceptions are set in the shell. Use a DeployerListener on a top level sequence to be notified of deployment events.

Parameters:

deploymentSequenceId -

shell -

lock - object that DeploymentManager should synchronize on when performing deployment. lock.notifyAll() will be invoked if deployment completes successfully. If lock is null, the Context (from the shell) will be used as the lock object.

deploy

@Deprecated
public static void deploy(int deploymentSequenceId,
                     Context context,
                     DeployShellFactory factory)
                   throws java.lang.Exception

Deprecated.

Run and end-to-end synchronous deployment sequence using the given factory to generate a DeployShell.

Parameters:

deploymentSequenceId -

context -

factory -

Throws:

DeployException

MetadataException

java.lang.Exception

deploy

@Deprecated
public static void deploy(int deploymentSequenceId,
                     Context context,
                     DeployShellFactory factory,
                     java.lang.Object lock)
                   throws DeployException,
                          MetadataException

Deprecated.

Run and end-to-end asynchronous deployment sequence using the given factory to generate a DeployShell. This method does not throw any exceptions, instead exceptions are set in the shell. Use a DeployerListener on a top level sequence to be notified of deployment events.

Parameters:

deploymentSequenceId -

context -

factory -

lock - object that DeploymentManager should synchronize on when performing deployment. lock.notifyAll() will be invoked when deployment completes (successfully or not). If lock is null, the Context from the shell will be used as the lock object.

Throws:

DeployException

MetadataException

getProfileListenerSupport

public static oracle.jdevimpl.deploy.fwk.ListenerSupport getProfileListenerSupport()

Internal use only.

Returns:

setDeploymentManager

public static void setDeploymentManager(oracle.jdevimpl.deploy.fwk.DeploymentManager impl)