public class SessionHelper
extends java.lang.Object
Modifier and Type | Method | Description |
---|---|---|
void |
close() |
Closes resources associated with the current DeployableObject and DeploymentConfiguration.
|
protected void |
finalize() |
|
java.io.File |
getApplication() |
The application archive.
|
java.io.File |
getApplicationRoot() |
Root directory potentially containing "app" and "plan" subdirectories as
default locations for application files and deployment plan information.
|
WebLogicDeploymentConfiguration |
getConfiguration() |
The current configuration.
|
javax.enterprise.deploy.spi.TargetModuleID[] |
getDefaultJMSTargetModuleIDs(DomainMBean domain,
TargetMBean[] deploymentTargets,
java.lang.String appName,
java.lang.String name) |
Creates TargetModuleID objects for a JMS module contained withing this application.
|
WebLogicDeployableObject |
getDeployableObject() |
The root deployable object.
|
static WebLogicDeploymentManager |
getDeploymentManager(java.lang.String host,
java.lang.String port) |
Allocate a connected DeploymentManager.
|
static WebLogicDeploymentManager |
getDeploymentManager(java.lang.String host,
java.lang.String port,
java.lang.String userName,
java.lang.String password) |
Allocate a connected DeploymentManager.
|
static WebLogicDeploymentManager |
getDeploymentManager(java.lang.String protocol,
java.lang.String host,
java.lang.String port,
java.lang.String userName,
java.lang.String password) |
Allocate a connected DeploymentManager.
|
static WebLogicDeploymentManager |
getDeploymentManager(java.lang.String protocol,
java.lang.String host,
java.lang.String port,
java.lang.String path,
java.lang.String userName,
java.lang.String password,
java.lang.String idd) |
Allocate a connected DeploymentManager.
|
static WebLogicDeploymentManager |
getDisconnectedDeploymentManager() |
Allocate a disconnected DeploymentManager.
|
static SessionHelper |
getInstance(WebLogicDeploymentManager dm) |
get a SessionHelper for a DeploymentManager
|
ModuleInfo |
getModuleInfo() |
Collects module information based on an application's structure configuration.
|
java.io.File |
getPlan() |
The deployment plan.
|
java.io.File |
getPlandir() |
Override of external descriptors location
|
static WebLogicDeploymentManager |
getRemoteDeploymentManager(java.lang.String host,
java.lang.String port,
java.lang.String userName,
java.lang.String password) |
Allocate a connected DeploymentManager.
|
static WebLogicDeploymentManager |
getRemoteDeploymentManager(java.lang.String protocol,
java.lang.String host,
java.lang.String port,
java.lang.String userName,
java.lang.String password) |
Allocate a connected DeploymentManager.
|
static WebLogicDeploymentManager |
getRemoteDeploymentManager(java.lang.String protocol,
java.lang.String host,
java.lang.String port,
java.lang.String path,
java.lang.String userName,
java.lang.String password,
java.lang.String idd) |
Allocate a connected DeploymentManager.
|
javax.enterprise.deploy.spi.Target |
getTarget(TargetMBean target) |
Given a TargetMBean, returns a jsr88 Target object
|
void |
initializeConfiguration() |
Populates the configuration based on current values of this
object's properties.
|
void |
inspect() |
Creates DeployableObject's for the application without parsing most deployment descriptors.
|
boolean |
isFullInit() |
Indicates whether
initializeConfiguration() should perform a full initialization
of the session. |
boolean |
isUpdatePlanVersion() |
Indicates whether the plan version should be updated automatically prior to saving a new plan.
|
void |
saveApplicationRoot() |
Saves all application artifacts, using a new app root structure.
|
void |
savePlan() |
Saves new copy of deployment plan along with any external documents in the plan directory.
|
void |
setApplication(java.io.File application) |
Establishes location of the application.
|
void |
setApplicationRoot(java.io.File root) |
Establishes installation root for the application and plan information.
|
void |
setFullInit(boolean fullInit) |
Specifies the amount of work involved in
initializeConfiguration() . |
void |
setPlan(java.io.File plan) |
Establishes location of the deployment plan.
|
void |
setPlandir(java.io.File plandir) |
Override the plan directory implied by the application root or plan
|
void |
setUpdatePlanVersion(boolean updatePlanVersion) |
protected void finalize()
finalize
in class java.lang.Object
public void close()
The DeploymentManager is left alone. To release its resources
WebLogicDeploymentManager.release()
should be invoked.
public java.io.File getApplication()
public void setApplication(java.io.File application)
application
- specifies the location of the applications files.public java.io.File getPlan()
public void setPlan(java.io.File plan)
plan
- specifies the location of the deployment plan.public java.io.File getPlandir()
public void setPlandir(java.io.File plandir)
plandir
- public java.io.File getApplicationRoot()
public void setApplicationRoot(java.io.File root)
root
- is application installation root directory.public boolean isFullInit()
initializeConfiguration()
should perform a full initialization
of the session. A full initialization involves filling out all DConfigBeans for the application
configuration. The alternative is for initializeConfiguration()
to only access the
root elements. This is much faster for large applications.
The default is true.public void setFullInit(boolean fullInit)
initializeConfiguration()
.
This should be set to true (the default) if the goal is to look up and update individual elements in the
configuration descriptors. If the goal is to build a plan template, then this should be set to false.fullInit
- public boolean isUpdatePlanVersion()
public void setUpdatePlanVersion(boolean updatePlanVersion)
public static SessionHelper getInstance(WebLogicDeploymentManager dm)
public static WebLogicDeploymentManager getDisconnectedDeploymentManager() throws javax.enterprise.deploy.spi.exceptions.DeploymentManagerCreationException
javax.enterprise.deploy.spi.exceptions.DeploymentManagerCreationException
public static WebLogicDeploymentManager getDeploymentManager(java.lang.String protocol, java.lang.String host, java.lang.String port, java.lang.String userName, java.lang.String password) throws javax.enterprise.deploy.spi.exceptions.DeploymentManagerCreationException
javax.enterprise.deploy.spi.exceptions.DeploymentManagerCreationException
public static WebLogicDeploymentManager getDeploymentManager(java.lang.String host, java.lang.String port, java.lang.String userName, java.lang.String password) throws javax.enterprise.deploy.spi.exceptions.DeploymentManagerCreationException
javax.enterprise.deploy.spi.exceptions.DeploymentManagerCreationException
public static WebLogicDeploymentManager getDeploymentManager(java.lang.String protocol, java.lang.String host, java.lang.String port, java.lang.String path, java.lang.String userName, java.lang.String password, java.lang.String idd) throws javax.enterprise.deploy.spi.exceptions.DeploymentManagerCreationException
javax.enterprise.deploy.spi.exceptions.DeploymentManagerCreationException
public static WebLogicDeploymentManager getRemoteDeploymentManager(java.lang.String host, java.lang.String port, java.lang.String userName, java.lang.String password) throws javax.enterprise.deploy.spi.exceptions.DeploymentManagerCreationException
javax.enterprise.deploy.spi.exceptions.DeploymentManagerCreationException
public static WebLogicDeploymentManager getRemoteDeploymentManager(java.lang.String protocol, java.lang.String host, java.lang.String port, java.lang.String userName, java.lang.String password) throws javax.enterprise.deploy.spi.exceptions.DeploymentManagerCreationException
javax.enterprise.deploy.spi.exceptions.DeploymentManagerCreationException
public static WebLogicDeploymentManager getRemoteDeploymentManager(java.lang.String protocol, java.lang.String host, java.lang.String port, java.lang.String path, java.lang.String userName, java.lang.String password, java.lang.String idd) throws javax.enterprise.deploy.spi.exceptions.DeploymentManagerCreationException
javax.enterprise.deploy.spi.exceptions.DeploymentManagerCreationException
public static WebLogicDeploymentManager getDeploymentManager(java.lang.String host, java.lang.String port) throws javax.enterprise.deploy.spi.exceptions.DeploymentManagerCreationException
javax.enterprise.deploy.spi.exceptions.DeploymentManagerCreationException
public WebLogicDeployableObject getDeployableObject()
public WebLogicDeploymentConfiguration getConfiguration()
public void initializeConfiguration() throws javax.enterprise.deploy.spi.exceptions.ConfigurationException, java.io.IOException, javax.enterprise.deploy.spi.exceptions.InvalidModuleException
javax.enterprise.deploy.spi.exceptions.ConfigurationException
java.io.IOException
javax.enterprise.deploy.spi.exceptions.InvalidModuleException
public void inspect() throws java.io.IOException, javax.enterprise.deploy.spi.exceptions.InvalidModuleException, javax.enterprise.deploy.spi.exceptions.ConfigurationException
WebLogicDeployableObject.getDDBeanRoot()
.java.io.IOException
javax.enterprise.deploy.spi.exceptions.InvalidModuleException
javax.enterprise.deploy.spi.exceptions.ConfigurationException
public ModuleInfo getModuleInfo() throws java.io.IOException, javax.enterprise.deploy.spi.exceptions.ConfigurationException
java.io.IOException
javax.enterprise.deploy.spi.exceptions.ConfigurationException
public void savePlan() throws java.lang.IllegalStateException, javax.enterprise.deploy.spi.exceptions.ConfigurationException, java.io.FileNotFoundException
getPlan()
. The plan directory
is specified in the plan itself.java.lang.IllegalStateException
- if initializeConfiguration()
has not been invokedjavax.enterprise.deploy.spi.exceptions.ConfigurationException
- if there are problems with the application descriptorsjava.io.FileNotFoundException
- if the current plan is a directorypublic void saveApplicationRoot() throws java.io.IOException, javax.enterprise.deploy.spi.exceptions.ConfigurationException, java.lang.IllegalStateException
getApplicationRoot()
.java.io.IOException
- for any IO errorsjavax.enterprise.deploy.spi.exceptions.ConfigurationException
- if there are problems with the application descriptorsjava.lang.IllegalStateException
- if initializeConfiguration()
has not been invokedpublic javax.enterprise.deploy.spi.TargetModuleID[] getDefaultJMSTargetModuleIDs(DomainMBean domain, TargetMBean[] deploymentTargets, java.lang.String appName, java.lang.String name) throws javax.enterprise.deploy.spi.exceptions.ConfigurationException
domain
- is the DomainMBean providing access to the domian configurationdeploymentTargets
- is a list of targets where the application is to be deployedappName
- is the name the application will be deployed undername
- is the name of the JMS module, eg my-jms.xml. For a standalone JMS module this is the
module's filename. For an embedded JMS module, the name must match the name assigned to the module
in the weblogic-application.xml descriptor.javax.enterprise.deploy.spi.exceptions.ConfigurationException
public javax.enterprise.deploy.spi.Target getTarget(TargetMBean target)