oracle.jdeveloper.deploy
Class DeployShell

java.lang.Object
  oracle.ide.util.Namespace
      oracle.jdeveloper.deploy.DeployShell

public final class DeployShell
extends Namespace

Nested Class Summary

static class

DeployShell.SequenceStack

Constructor Summary

DeployShell(Context context)
Creates a DeployShell seeded with specified Context.

DeployShell(Context context, java.io.PrintWriter log)
Creates a DeployShell using the specified PrintWriter for logging.

DeployShell(DeployShell shell)
Creates a DeployShell as a child of another shell.

Method Summary

boolean	findFlag(java.lang.String flag)
java.lang.String	getConnectionName() Deprecated.
Context	getContext()
DeployException	getDeployException()
DeploymentModuleFactory	getDeploymentModuleFactory() Returns a factory that can be used to create DeploymentModule(s) for this deployment-run.
DeployShellFactory	getDeployShellFactory() Returns the factory that created this DeployShell.
boolean	getFlag(java.lang.String flag)
java.io.PrintWriter	getLog() Deprecated. use getLogger() instead.
java.util.logging.Logger	getLogger()
oracle.jdeveloper.deploy.meta.Platform	getPlatform()
java.lang.String	getPlatformID() Deprecated.
boolean	getPrintTimeMessages()
DeployShell.SequenceStack	getSequenceStack()
boolean	isDeploying(int sequence) Test to check if the current code is executing as part of the particular sequence.
void	setContext(Context context)
void	setDeployException(DeployException exc)
void	setDeploymentModuleFactory(DeploymentModuleFactory factory)
void	setDeployShellFactory(DeployShellFactory factory) A DeployShell should have a reference to the factory that created it, in case more shells need to be created for deploying dependant modules.
void	setLog(java.io.PrintWriter log)
void	setLogger(java.util.logging.Logger logger)
void	setPlatform(oracle.jdeveloper.deploy.meta.Platform platform)
void	setPlatformID(java.lang.String platformID) Deprecated.
void	setPrintTimeMessages(boolean value)

Methods inherited from class oracle.ide.util.Namespace

contains, find, find, findAndReplace, get, get, get, getData, getParent, getRoot, isRoot, put, put, put, put, remove, setParent, toMap, translateKey

Methods inherited from class java.lang.Object

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

Constructor Detail

DeployShell

public DeployShell(Context context)

Creates a DeployShell seeded with specified Context.

DeployShell

public DeployShell(Context context,
                   java.io.PrintWriter log)

Creates a DeployShell using the specified PrintWriter for logging.

DeployShell

public DeployShell(DeployShell shell)

Creates a DeployShell as a child of another shell.

Parameters:

shell - the parent DeployShell

Method Detail

getConnectionName

@Deprecated
public java.lang.String getConnectionName()

Deprecated.

getFlag

public boolean getFlag(java.lang.String flag)

findFlag

public boolean findFlag(java.lang.String flag)

setContext

public void setContext(Context context)

getContext

public Context getContext()

setPlatformID

@Deprecated
public void setPlatformID(java.lang.String platformID)

Deprecated.

getPlatformID

@Deprecated
public java.lang.String getPlatformID()

Deprecated.

getPlatform

public oracle.jdeveloper.deploy.meta.Platform getPlatform()

setPlatform

public void setPlatform(oracle.jdeveloper.deploy.meta.Platform platform)

setDeployShellFactory

public void setDeployShellFactory(DeployShellFactory factory)

A DeployShell should have a reference to the factory that created it, in case more shells need to be created for deploying dependant modules.

Parameters:

factory -

getDeployShellFactory

public DeployShellFactory getDeployShellFactory()

Returns the factory that created this DeployShell. Guaranteed to be not-null.

Returns:

the DeployShellFactory that originally created this DeployShell.

getDeploymentModuleFactory

public DeploymentModuleFactory getDeploymentModuleFactory()

Returns a factory that can be used to create DeploymentModule(s) for this deployment-run. The factory returned may be a composite object, that may in turn delegate the create() task to one or more registered factories, however the caller need not be concerned with this.

Returns:

a DeploymentModuleFactory, null if no registered factory can handle the request.

setDeploymentModuleFactory

public void setDeploymentModuleFactory(DeploymentModuleFactory factory)

setLog

public void setLog(java.io.PrintWriter log)

getLog

@Deprecated
public java.io.PrintWriter getLog()

Deprecated. use getLogger() instead.

Guaranteed to return non-null.

setLogger

public void setLogger(java.util.logging.Logger logger)

getLogger

public java.util.logging.Logger getLogger()

setDeployException

public void setDeployException(DeployException exc)

getDeployException

public DeployException getDeployException()

setPrintTimeMessages

public void setPrintTimeMessages(boolean value)

getPrintTimeMessages

public boolean getPrintTimeMessages()

Returns:

boolean false, only if it is explicitly set.

getSequenceStack

public DeployShell.SequenceStack getSequenceStack()

isDeploying

public boolean isDeploying(int sequence)

Test to check if the current code is executing as part of the particular sequence. This method can be used to determine if any sequence-dependant actions need to be taken at the current point in the code. For example, given the deployment 'tree':

 DEPLOYMENT_SEQUENCE
  REMOTE_DEPLOY_SEQUENCE
   ASSEMBLY_SEQUENCE
    DEFAULT_SEQUENCE
     ARCHIVE_DEPLOYER
      ArchiveDeployer
   REMOTE_DEPLOYER
 

the following checks return true when done within ArchiveDeployer

 shell.isDeploying(DEPLOYMENT_SEQUENCE)
 shell.isDeploying(ASSEMBLY_SEQUENCE)
 shell.isDeploying(ARCHIVE_DEPLOYER)
 shell.isDeploying(REMOTE_DEPLOY_SEQUENCE)
 

whereas

 shell.isDeploying(REMOTE_DEPLOYER) // returns false
 

Parameters:

sequence -

Returns: