public class ShellAdapter extends java.lang.Object implements ShellConstants
DeployShell
or Context
.
Sub-classes of this adapter may provide more specialized access methods for different types of deployment.JavaDeployment
Modifier and Type | Field and Description |
---|---|
protected Context |
context_ |
protected java.lang.Object |
lock_ |
protected DeployShell |
shell_ |
KEY_CONTEXT, KEY_DEPLOY_ELEMENT, KEY_DEPLOYMENT_OPTIONS, KEY_IS_HEADLESS, KEY_PLATFORM, KEY_PRINT_TIME_MESSAGES, KEY_RUNNABLE_OBJECT, KEY_STATEFUL_DEPLOYMENT, KEY_SUPPRESS_STARTFINISH_MESSAGES
Constructor and Description |
---|
ShellAdapter(Context context) |
ShellAdapter(DeployShell shell) |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
find(java.lang.String key)
Find a property in the current
DeployShell or Context . |
java.lang.Boolean |
findFlag(java.lang.String key,
boolean def)
Similar to
find(String) , looks for a Boolean value. |
java.lang.Object |
get(java.lang.String key)
Gets a value only from the current
DeployShell or Context , does not search parent shells. |
Context |
getContext() |
Element |
getDeployElement() |
DeployException |
getDeployException() |
DeploymentOptions |
getDeploymentOptions() |
<T extends DeploymentOptions> |
getDeploymentOptions(java.lang.Class<T> optionsClass) |
HashStructure |
getDeploymentOptionsHash() |
ProgressObject |
getDeploymentProgressObject() |
static ShellAdapter |
getInstance(Context context) |
static ShellAdapter |
getInstance(DeployShell shell) |
java.util.logging.Logger |
getLogger() |
DeploymentOptions |
getOrCreateDeploymentOptions() |
<T extends DeploymentOptions> |
getOrCreateDeploymentOptions(java.lang.Class<T> optionsClass) |
Platform |
getPlatform() |
boolean |
getPrintTimeMessages() |
Profile |
getProfile() |
ShellAdapter |
getRoot() |
DeployShell |
getShell()
Returns the underlying shell
|
boolean |
isDeploying(int sequence)
Find out if shell is deploying within the context of a parent sequence.
|
boolean |
isDeploying(int[] sequences)
Find out if shell is deploying within the context of multiple parent sequences.
|
boolean |
isHeadlessDeployment() |
boolean |
isProfileBasedDeployment() |
boolean |
isStatefulDeployment() |
boolean |
isSuppressDeploymentStartFinishMessage() |
protected ShellAdapter |
newAdapter(DeployShell shell) |
ShellAdapter |
newChildShell()
Creates a child
DeployShell and a new ShellAdapter for it. |
ShellAdapter |
newChildShell(Context context)
Same as
newChildShell() but creates the child DeployShell and
adapter with the given Context. |
void |
put(java.lang.String key,
java.lang.Object value) |
java.lang.Object |
remove(java.lang.String key) |
void |
setDeployElement(Element element) |
void |
setDeployException(DeployException e) |
void |
setDeploymentOptions(DeploymentOptions options) |
void |
setDeploymentOptions(HashStructure hash) |
void |
setLogger(java.util.logging.Logger logger) |
void |
setPlatform(Platform platform) |
void |
setPrintTimeMessages(boolean value) |
void |
setProfile(Profile p) |
void |
setStatefulDeployment(boolean stateful) |
void |
setSuppressDeploymentStartFinishMessage(boolean value)
Enable or disable printing leading and trailing messages to indicate
begin and end of each deployment.
|
protected final DeployShell shell_
protected final Context context_
protected final java.lang.Object lock_
public ShellAdapter(DeployShell shell)
public ShellAdapter(Context context)
public DeployShell getShell()
DeployShell
- if this adapter is built for a DeployShell
, otherwise null.public ProgressObject getDeploymentProgressObject()
public static ShellAdapter getInstance(DeployShell shell)
public static ShellAdapter getInstance(Context context)
public java.lang.Object find(java.lang.String key)
DeployShell
or Context
.
If this adapter is for a shell, it searches all parent shells, if this adapter is for a Context, it checks
just the Context.key
- public java.lang.Boolean findFlag(java.lang.String key, boolean def)
find(String)
, looks for a Boolean value.key
- def
- public java.lang.Object get(java.lang.String key)
DeployShell
or Context
, does not search parent shells.key
- public void put(java.lang.String key, java.lang.Object value)
public java.lang.Object remove(java.lang.String key)
public ShellAdapter getRoot()
public ShellAdapter newChildShell()
DeployShell
and a new ShellAdapter for it. The child inherits all
properties set in the parent Shell unless overridden. To override, use any of the
setXXX() methods on the child.public ShellAdapter newChildShell(Context context)
newChildShell()
but creates the child DeployShell
and
adapter with the given Context.context
- protected ShellAdapter newAdapter(DeployShell shell)
public Context getContext()
public Element getDeployElement()
public void setDeployElement(Element element)
public boolean isProfileBasedDeployment()
public void setLogger(java.util.logging.Logger logger)
public java.util.logging.Logger getLogger()
public Platform getPlatform()
public void setPlatform(Platform platform)
public Profile getProfile()
public void setProfile(Profile p)
public DeployException getDeployException()
public void setDeployException(DeployException e)
public boolean isDeploying(int sequence)
sequence
- public boolean isDeploying(int[] sequences)
sequences
- the order in which sequences should be found.public boolean isHeadlessDeployment()
public void setPrintTimeMessages(boolean value)
public boolean getPrintTimeMessages()
public boolean isSuppressDeploymentStartFinishMessage()
public void setSuppressDeploymentStartFinishMessage(boolean value)
Setting this value may be preferable when a Deployer
recurses into the Deployment framework, in which case it may be confusing to the
user to see two messages indicating start of deployment.
value
- public void setStatefulDeployment(boolean stateful)
public boolean isStatefulDeployment()
public void setDeploymentOptions(DeploymentOptions options)
public void setDeploymentOptions(HashStructure hash)
public <T extends DeploymentOptions> T getDeploymentOptions(java.lang.Class<T> optionsClass)
public <T extends DeploymentOptions> T getOrCreateDeploymentOptions(java.lang.Class<T> optionsClass)
public DeploymentOptions getDeploymentOptions()
public DeploymentOptions getOrCreateDeploymentOptions()
public HashStructure getDeploymentOptionsHash()