oracle.jdeveloper.deploy.dt

Class Deployment

java.lang.Object

oracle.jdeveloper.deploy.dt.Deployment

public abstract class Deployment
extends java.lang.Object

Deployment Design-Time Facade This class provides an entry-point for executing deployment or accessing Design-Time information from within the GUI IDE. This class is not available in the headless versions of JDeveloper.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Deployment() Instantiated by JDeveloper.

Method Summary

Methods

Modifier and Type	Method and Description
static <T extends Profile> T	createDeploymentProfile(DataContainer container, java.lang.String profileName, java.lang.Class<T> profileClass) Deprecated.
static Profile	createDeploymentProfile(HashStructure hash, DataContainer container) Deprecated.
abstract void	deploy(Context context) Deploy a context using the default command.
abstract void	deploy(Context context, java.lang.Object command) Deploy a context using a specific command.
abstract Runnable	deployAsync(Context context) Deploy a context asynchronously.
abstract Runnable	deployAsync(Context context, java.lang.Object command) Deploy a context asynchronously using a specific command.
static DependableFactory	getDependableFactory() Deprecated. Use DependableFactory instead.
<T extends DeploymentOptions> T	getDeploymentOptions(java.lang.Class<T> optionsClass) Returns the current DeploymentOptions object used to configure environment-level options for deployment.
java.net.URL	getDeployOutputDir(java.net.URL projectURL) Returns the default deployment output directory as a URL, assuming a project-level deployment profile.
java.net.URL	getDeployOutputDir(java.net.URL containerURL, java.lang.Class<? extends DataContainer> profileContainerClass) Returns the default deployment output directory as an URL.
abstract ProfileElementInfo	getGalleryElement(java.lang.String profileId)
abstract ProfileElementInfo[]	getGalleryElements()
abstract ProfileElementInfo[]	getGalleryElements(java.lang.Class<? extends Profile> profileClass, boolean subTypes)
static Deployment	getInstance()
static java.util.logging.Logger	getLogger()
LogPage	getLogPage() Returns the LogPage used for deployment messages.
java.io.PrintStream	getLogPrintStream() Deprecated. Use getLogger() instead.
static java.io.PrintWriter	getLogPrintWriter() Deprecated. Use getLogger() instead.
static java.util.Map	getProjectProfiles(Project project) Deprecated. Use DeploymentProfiles.getProfiles() instead.
static java.util.Map	getWorkspaceProfiles(Workspace workspace) Deprecated.
abstract Profile	invokeNewDeploymentProfileWizard(Context context, ProfileType type) Invokes the ProfileWizard to let user create and persist a profile.
void	maybeShowLogPage()

Methods inherited from class java.lang.Object

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

Constructor Detail

Deployment

protected Deployment()

Instantiated by JDeveloper.

Method Detail

getGalleryElements

public abstract ProfileElementInfo[] getGalleryElements()

getGalleryElements

public abstract ProfileElementInfo[] getGalleryElements(java.lang.Class<? extends Profile> profileClass,
                                      boolean subTypes)

getGalleryElement

public abstract ProfileElementInfo getGalleryElement(java.lang.String profileId)

getInstance

public static Deployment getInstance()

deploy

public abstract void deploy(Context context)
                     throws DeployException

Deploy a context using the default command.

Parameters:

context - the element(s) that need to be deployed

Throws:

DeployException

deploy

public abstract void deploy(Context context,
          java.lang.Object command)
                     throws DeployException

Deploy a context using a specific command.

Parameters:

context - contains the element(s) that need to be deployed.

command - determines the specific deployment action.

Throws:

DeployException

deployAsync

public abstract Runnable deployAsync(Context context)
                              throws DeployException

Deploy a context asynchronously.

Parameters:

context - indicates the element(s) that need to be deployed

Returns:

a Runnable object that can be used to schedule the deployment task and monitor its progress.

Throws:

DeployException

deployAsync

public abstract Runnable deployAsync(Context context,
                   java.lang.Object command)
                              throws DeployException

Deploy a context asynchronously using a specific command.

Parameters:

context - indicates the element(s) that need to be deployed

command -

Returns:

a Runnable object that can be used to schedule the deployment task and monitor its progress.v

Throws:

DeployException

invokeNewDeploymentProfileWizard

public abstract Profile invokeNewDeploymentProfileWizard(Context context,
                                       ProfileType type)

Invokes the ProfileWizard to let user create and persist a profile.

Parameters:

context - the Context in which to create.

type - the ProfileType to create. Pass null to allow all profiles.

Returns:

new Profile object if wizard completes successfully, otherwise null.

getDeploymentOptions

public <T extends DeploymentOptions> T getDeploymentOptions(java.lang.Class<T> optionsClass)

Returns the current DeploymentOptions object used to configure environment-level options for deployment.

getDeployOutputDir

public java.net.URL getDeployOutputDir(java.net.URL projectURL)

Returns the default deployment output directory as a URL, assuming a project-level deployment profile. For more details, see getDeployOutputDir( URL containerURL, int profileContainerType )

getDeployOutputDir

public java.net.URL getDeployOutputDir(java.net.URL containerURL,
                              java.lang.Class<? extends DataContainer> profileContainerClass)

Returns the default deployment output directory as an URL. The result of this method depends on what the user has specified in the IDE preferences. This directory only affects what directory is used by default when creating a deployment profile and setting the output URLs for JAR, WAR, and EAR files. Existing profiles are not modified when the user changes this IDE preference.

The containerURL is used if the user specifies a directory name that is relative to the project or application directory. This is the default setting and the subdirectory in the project or application where deployed output goes by default is named "deploy".

The profileContainerClass determines whether the project-level or application-level deployment output preferences are used. It should be the class oracle.ide.model.Workspace or oracle.ide.model.Project, depending on the level at which the deployment profile is being created.

If the user specifies an absolute directory for the deployment output directory, then that directory is returned directly and the containerURL parameter is not used.

getLogPage

public LogPage getLogPage()

Returns the LogPage used for deployment messages.

maybeShowLogPage

public void maybeShowLogPage()

getLogPrintWriter

@Deprecated
public static java.io.PrintWriter getLogPrintWriter()

Deprecated. Use getLogger() instead.

Returns a PrintWriter that is connected to the deployment log page. Any output sent to the PrintWriter will be sent to the deployment log page.

getLogger

public static java.util.logging.Logger getLogger()

getLogPrintStream

@Deprecated
public java.io.PrintStream getLogPrintStream()

Deprecated. Use getLogger() instead.

Returns a PrintWriter that is connected to the deployment log page. Any output sent to the PrintWriter will be sent to the deployment log page.

getProjectProfiles

@Deprecated
public static java.util.Map getProjectProfiles(Project project)

Deprecated. Use DeploymentProfiles.getProfiles() instead.

Returns a Map of profiles Profile contained in the given project.

getWorkspaceProfiles

@Deprecated
public static java.util.Map getWorkspaceProfiles(Workspace workspace)

Deprecated.

Returns an Map of profiles Profile contained in the given Application workspace.

createDeploymentProfile

@Deprecated
public static <T extends Profile> T createDeploymentProfile(DataContainer container,
                                                       java.lang.String profileName,
                                                       java.lang.Class<T> profileClass)

Deprecated.

Creates a Profile Profile of the specified name and type and associates it with a DataContainer.

Parameters:

container - the Project or Workspace with which to associate the Profile. A Profile can only be interpreted in the context of its associated Container.

profileName - a name for the Profile. The name may be used as a prefix or suffix for default property values in the Profile.

profileClass - the type of Profile to create.

Returns:

a Profile of type T, null if a Profile could not be created for whatever reason.

createDeploymentProfile

@Deprecated
public static Profile createDeploymentProfile(HashStructure hash,
                                         DataContainer container)
                                       throws java.lang.InstantiationException

Deprecated.

Creates a Profile from a HashStructure. This method is used to instantiate a Profile from a persisted HashStructure. The type of the Profile is stored as one of the values of the hash.

Parameters:

hash -

container -

Returns:

Throws:

java.lang.InstantiationException

getDependableFactory

@Deprecated
public static DependableFactory getDependableFactory()

Deprecated. Use DependableFactory instead.