oracle.jdeveloper.deploy.cmd

Class DeployCommand

java.lang.Object

oracle.ide.controller.Command

oracle.jdeveloper.deploy.cmd.DeployCommand

All Implemented Interfaces:

Displayable, Element

Direct Known Subclasses:

DeployJarToAppServer, ProfileDeployCmd, UndeployFromAppServer

public abstract class DeployCommand
extends Command
implements Element

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DeployCommand.Callback An object that can inspect the DeployShell at various stages.
static class	DeployCommand.CommandInstantiationException
static class	DeployCommand.DefaultCallback A No-op implementation of Callback for use as a base-class.
static class	DeployCommand.Status

Field Summary

Fields inherited from class oracle.ide.controller.Command

CANCEL, context, EXECUTING, MULTI_NODE, NO_CHANGE, NO_UNDO, NORMAL, OK, type

Constructor Summary

Constructors

Constructor and Description
DeployCommand(HashStructure hash)
DeployCommand(int cmdId, int type, int sequenceId)

Method Summary

Methods

Modifier and Type	Method and Description
static DeployCommand	create(HashStructure hash) Deprecated.
Runnable	createRunnable()
protected void	deploy(DeployShell shell)
int	doit() Executes the actions associated with a specific command.
protected void	exception(java.lang.Exception e, DeployShell shell) Called when an exception is thrown from deployment.
protected void	finished(DeployShell shell) Called after deployment has finished running.
Attributes	getAttributes() This method returns an Attributes object that encodes the attributes of the Element.
java.util.Iterator<Element>	getChildren() This method is part of the Element interface to provide a convenient way of getting an Iterator over any contained child Elements without having to test the object's type with the instanceof operator or having to downcast to a more specific type.
<T extends DeploymentOptions> T	getDeploymentOptions(java.lang.Class<T> optionsClass)
protected DeployShellFactory	getDeployShellFactory()
javax.swing.Icon	getIcon() Returns an Icon that can be shown in association with this Displayable.
java.lang.String	getLongLabel() Returns a long label that can be displayed to the user.
Platform	getPlatform()
int	getSequenceId()
abstract java.lang.String	getShortLabel() Returns a short label that can be displayed to the user.
DeployCommandState	getState()
protected abstract java.lang.Class<? extends DeployCommandState>	getStateClass()
DeployCommand.Status	getStatus()
java.lang.String	getToolTipText() Returns the tool tip text to show when the mouse pointer pauses over a UI component that represents this Displayable.
protected abstract boolean	isReady()
boolean	isSynchronous() Will calling {code doIt()} run on current thread or another thread.
boolean	mayHaveChildren() This method is part of the Element interface to provide a convenient way of determining whether an object may have children without having to test the object's type with the instanceof operator or having to downcast to a more specific type.
protected DeployCommandState	newState()
protected DeployCommandState	newState(HashStructure hash)
protected void	prepare(DeployShell shell) Prepares for deployment.
void	setCallback(DeployCommand.Callback callback)
void	setContext(Context originalContext) Sets context associated with command.
<T extends DeploymentOptions> void	setDeploymentOptions(T options)
void	setPlatform(Platform platform)
void	setState(DeployCommandState state)
protected void	setStatus(DeployCommand.Status status)
void	setSynchronous(boolean sync)
protected DeployCommandState	state()
protected void	updateStatus()

Methods inherited from class oracle.ide.controller.Command

enableConfirmation, getAffectedNodes, getContext, getData, getId, getName, getProgressHandle, getType, isGlobal, setData, setTaskInfo, undo

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.ide.model.Element

getData

Methods inherited from interface oracle.ide.model.Displayable

toString

Constructor Detail

DeployCommand

public DeployCommand(int cmdId,
             int type,
             int sequenceId)

DeployCommand

public DeployCommand(HashStructure hash)

Method Detail

mayHaveChildren

public boolean mayHaveChildren()

Description copied from interface: Element

This method is part of the Element interface to provide a convenient way of determining whether an object may have children without having to test the object's type with the instanceof operator or having to downcast to a more specific type.

An implementation of Element that represents a leaf in a tree structure should return false from this method. An implementation of Element that could represent a non-leaf in a tree structure should return true from this method, even if it does not currently contain any children.

Specified by:

mayHaveChildren in interface Element

Returns:

true if this Element may contain child Elements.

getChildren

public java.util.Iterator<Element> getChildren()

Description copied from interface: Element

This method is part of the Element interface to provide a convenient way of getting an Iterator over any contained child Elements without having to test the object's type with the instanceof operator or having to downcast to a more specific type.

An implementation of Element that represents a leaf in a tree structure should return null from this method. An implementation of Element that could represent a non-leaf in a tree structure should return either an Iterator over the child Elements or null if there are no children.

Specified by:

getChildren in interface Element

Returns:

an Iterator over any child Elements contained by this Element. If there are no children, null is returned.

getAttributes

public Attributes getAttributes()

Description copied from interface: Element

This method returns an Attributes object that encodes the attributes of the Element. Changing the attribute settings on the return object changes the element attributes. Subclasses should use their super class attributes object to define their own attributes. This allows subclasses to inherit their super class attributes. If a subclass does not wish to inherit attributes, they should first call getAttributes().clear() and define new attributes.

Specified by:

getAttributes in interface Element

getIcon

public javax.swing.Icon getIcon()

Description copied from interface: Displayable

Returns an Icon that can be shown in association with this Displayable. Typically the icon will be used in a tree control or list control. Therefore the icon must fit naturally within the space normally given to items within those controls. Such icons are usually 16x16 in size or, if there is a one-pixel transparent padding around the edge, 18x18 in size. It is strongly recommended that icons returned by this method be either 16x16 or 18x18 in size. If null is returned, the control may show a default icon, or it may show no icon, whichever is appropriate.

Specified by:

getIcon in interface Displayable

Returns:

the Icon to be displayed for the Displayable.

getToolTipText

public java.lang.String getToolTipText()

Description copied from interface: Displayable

Returns the tool tip text to show when the mouse pointer pauses over a UI component that represents this Displayable. In many cases it may be appropriate for this method to return the same value as Displayable.getLongLabel().

Specified by:

getToolTipText in interface Displayable

Returns:

the tooltip to show when the mouse pointer pauses over a UI component that represents this Displayable.

getLongLabel

public java.lang.String getLongLabel()

Description copied from interface: Displayable

Returns a long label that can be displayed to the user. Generally, the value of the returned String is considered translatable and should therefore be placed in an appropriate resource file. The long label differs from the short label essentially on length. Usually the long label will only be shown on-demand and in places where horizontal space is more available. Examples are the status bar and tooltips.

Specified by:

getLongLabel in interface Displayable

Returns:

a long descriptive label of the Displayable that can be shown to the user.

setPlatform

public void setPlatform(Platform platform)

getPlatform

public Platform getPlatform()

setContext

public void setContext(Context originalContext)

Description copied from class: Command

Sets context associated with command.

Overrides:

setContext in class Command

getSequenceId

public int getSequenceId()

setCallback

public void setCallback(DeployCommand.Callback callback)

getStatus

public DeployCommand.Status getStatus()

updateStatus

protected void updateStatus()

newState

protected DeployCommandState newState()

newState

protected DeployCommandState newState(HashStructure hash)

getStateClass

protected abstract java.lang.Class<? extends DeployCommandState> getStateClass()

setStatus

protected void setStatus(DeployCommand.Status status)

isReady

protected abstract boolean isReady()

doit

public int doit()
         throws java.lang.Exception

Description copied from class: Command

Executes the actions associated with a specific command. When a command executes successfully, implementations should return OK, otherwise, return CANCEL or any other non-zero value.

Specified by:

doit in class Command

Throws:

java.lang.Exception

createRunnable

public Runnable createRunnable()
                        throws DeployException

Throws:

DeployException

prepare

protected void prepare(DeployShell shell)

Prepares for deployment. This method is called just prior to starting the deployment process, and can be used to transfer configuration from the command to the DeployShell. The default version transfers the Platform if it has been set.

Use a wrapper to configure the shell.

Parameters:

shell -

See Also:

ShellAdapter

deploy

protected void deploy(DeployShell shell)
               throws java.lang.Exception

Throws:

java.lang.Exception

exception

protected void exception(java.lang.Exception e,
             DeployShell shell)

Called when an exception is thrown from deployment.

Parameters:

e -

shell -

finished

protected void finished(DeployShell shell)

Called after deployment has finished running.

Parameters:

shell -

getDeployShellFactory

protected DeployShellFactory getDeployShellFactory()

state

protected DeployCommandState state()

getShortLabel

public abstract java.lang.String getShortLabel()

Description copied from interface: Displayable

Returns a short label that can be displayed to the user. Generally, the value of the returned String is considered translatable and should therefore be placed in an appropriate resource file. When possible, the returned label should be reasonably short enough to show in the navigator or explorer windows but long enough to clearly identify and distinguish the Displayable.

Specified by:

getShortLabel in interface Displayable

Returns:

a short descriptive label of the Displayable that can be shown to the user.

getState

public DeployCommandState getState()

isSynchronous

public boolean isSynchronous()

Will calling {code doIt()} run on current thread or another thread.

Returns:

setSynchronous

public void setSynchronous(boolean sync)

Parameters:

sync - set to true to run on current thread

setState

public void setState(DeployCommandState state)

getDeploymentOptions

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

setDeploymentOptions

public <T extends DeploymentOptions> void setDeploymentOptions(T options)

create

@Deprecated
public static DeployCommand create(HashStructure hash)

Deprecated.