|
Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.1.2) Part Number E27170-02 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectweblogic.deploy.api.tools.SessionHelper
public class SessionHelper
Convenience methods for deployment tools based on the javax.enterprise.deploy package.
Method Summary | |
---|---|
void |
close()
Closes resources associated with the current DeployableObject and DeploymentConfiguration. |
protected void |
finalize()
|
File |
getApplication()
The application archive. |
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. |
TargetModuleID[] |
getDefaultJMSTargetModuleIDs(DomainMBean domain,
TargetMBean[] deploymentTargets,
String appName,
String name)
Creates TargetModuleID objects for a JMS module contained withing this application. |
WebLogicDeployableObject |
getDeployableObject()
The root deployable object. |
static WebLogicDeploymentManager |
getDeploymentManager(String host,
String port)
Allocate a connected DeploymentManager. |
static WebLogicDeploymentManager |
getDeploymentManager(String host,
String port,
String userName,
String password)
Allocate a connected DeploymentManager. |
static WebLogicDeploymentManager |
getDeploymentManager(String protocol,
String host,
String port,
String userName,
String password)
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. |
File |
getPlan()
The deployment plan. |
File |
getPlandir()
Override of external descriptors location |
static WebLogicDeploymentManager |
getRemoteDeploymentManager(String host,
String port,
String userName,
String password)
Allocate a connected DeploymentManager. |
static WebLogicDeploymentManager |
getRemoteDeploymentManager(String protocol,
String host,
String port,
String userName,
String password)
Allocate a connected DeploymentManager. |
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 SessionHelper.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(File application)
Establishes location of the application. |
void |
setApplicationRoot(File root)
Establishes installation root for the application and plan information. |
void |
setFullInit(boolean fullInit)
Specifies the amount of work involved in SessionHelper.initializeConfiguration() . |
void |
setPlan(File plan)
Establishes location of the deployment plan. |
void |
setPlandir(File plandir)
Override the plan directory implied by the application root or plan |
void |
setUpdatePlanVersion(boolean updatePlanVersion)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
protected void finalize()
finalize
in class Object
public void close()
The DeploymentManager is left alone. To release its resources
WebLogicDeploymentManager.release()
should be invoked.
public File getApplication()
public void setApplication(File application)
application
- specifies the location of the applications files.public File getPlan()
public void setPlan(File plan)
plan
- specifies the location of the deployment plan.public File getPlandir()
public void setPlandir(File plandir)
plandir
- public File getApplicationRoot()
public void setApplicationRoot(File root)
root
- is application installation root directory.public boolean isFullInit()
SessionHelper.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 SessionHelper.initializeConfiguration()
to only access the
root elements. This is much faster for large applications.
The default is true.
public void setFullInit(boolean fullInit)
SessionHelper.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 DeploymentManagerCreationException
DeploymentManagerCreationException
public static WebLogicDeploymentManager getDeploymentManager(String protocol, String host, String port, String userName, String password) throws DeploymentManagerCreationException
DeploymentManagerCreationException
public static WebLogicDeploymentManager getDeploymentManager(String host, String port, String userName, String password) throws DeploymentManagerCreationException
DeploymentManagerCreationException
public static WebLogicDeploymentManager getRemoteDeploymentManager(String host, String port, String userName, String password) throws DeploymentManagerCreationException
DeploymentManagerCreationException
public static WebLogicDeploymentManager getRemoteDeploymentManager(String protocol, String host, String port, String userName, String password) throws DeploymentManagerCreationException
DeploymentManagerCreationException
public static WebLogicDeploymentManager getDeploymentManager(String host, String port) throws DeploymentManagerCreationException
DeploymentManagerCreationException
public WebLogicDeployableObject getDeployableObject()
public WebLogicDeploymentConfiguration getConfiguration()
public void initializeConfiguration() throws ConfigurationException, IOException, InvalidModuleException
ConfigurationException
IOException
InvalidModuleException
public void inspect() throws IOException, InvalidModuleException, ConfigurationException
WebLogicDeployableObject.getDDBeanRoot()
.
IOException
InvalidModuleException
ConfigurationException
public ModuleInfo getModuleInfo() throws IOException, ConfigurationException
IOException
ConfigurationException
public void savePlan() throws IllegalStateException, ConfigurationException, FileNotFoundException
SessionHelper.getPlan()
. The plan directory
is specified in the plan itself.
IllegalStateException
- if SessionHelper.initializeConfiguration()
has not been invoked
ConfigurationException
- if there are problems with the application descriptors
FileNotFoundException
- if the current plan is a directorypublic void saveApplicationRoot() throws IOException, ConfigurationException, IllegalStateException
SessionHelper.getApplicationRoot()
.
IOException
- for any IO errors
ConfigurationException
- if there are problems with the application descriptors
IllegalStateException
- if SessionHelper.initializeConfiguration()
has not been invokedpublic TargetModuleID[] getDefaultJMSTargetModuleIDs(DomainMBean domain, TargetMBean[] deploymentTargets, String appName, String name) throws 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.
ConfigurationException
public Target getTarget(TargetMBean target)
|
Copyright 1996, 2013, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.1.2) Part Number E27170-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |