| Methods Summary |
|---|
| private void | addChildTargetModuleIDsToJ2EEUsingMBeans(SunTargetModuleID sunTargetModuleID, java.lang.String moduleID, com.sun.enterprise.admin.util.HostAndPort hostAndPort)Append child TargetModuleIDs to the J2EE module's TargetModuleID, navigating MBeans to do so.
Note that the result of this method is to add child IDs to the sunTargetModuleID. There is
no return value.
SunTarget sunTarget = (SunTarget) sunTargetModuleID.getTarget();
try {
MBeanServerConnection mbsc = getMBeanServerConnection();
/*
*Use the MBean to retrieve the ObjectNames of all children of this module on this target.
*/
ObjectName query = new ObjectName("com.sun.appserv:category=runtime,name=" + moduleID + ",J2EEServer=" + sunTarget.getAppServerInstance() + ",*");
Set mbeans = mbsc.queryNames(query, null);
/*
*Work through the child ObjectNames, adding appropriately-constructed SunTargetModuleIDs
*as children of the SunTargetModuleID of the parent J2EE module.
*/
for (Iterator itr = mbeans.iterator();itr.hasNext();) {
ObjectName module = (ObjectName) itr.next();
/*
*Retrieve the list of child module names of the module's ObjectName.
*/
String subModules[] = (String[]) mbsc.getAttribute(module, "modules");
for (int i = 0; i < subModules.length; i++) {
Set subModuleObjectNames = mbsc.queryNames(new ObjectName(subModules[i]), null);
if (subModuleObjectNames != null) {
/*
*The MBean returned some children, so iterate through them and prepare a sub TMID.
*/
for (Iterator subItr = subModuleObjectNames.iterator(); subItr.hasNext(); ) {
ObjectName aSubModule = (ObjectName) subItr.next();
SunTargetModuleID childTmid;
String aSubModuleName = aSubModule.toString();
if (aSubModuleName.indexOf("WebModule")!=-1) {
String id = moduleID + "#" + ((String) mbsc.getAttribute(aSubModule, "name"));
String path = (String) mbsc.getAttribute(aSubModule, "path");
childTmid = prepareWebChildTargetModuleID(id, sunTarget, hostAndPort, path);
} else {
String name = (String) mbsc.getAttribute(aSubModule, "name");
ModuleType moduleType = deriveModuleTypeFromModuleName(aSubModuleName);
childTmid = prepareNonWebChildTargetModuleID(moduleID, sunTarget, name, moduleType);
}
sunTargetModuleID.addChildTargetModuleID(childTmid);
childTmid.setParentTargetModuleID(sunTargetModuleID);
}
}
}
}
}
catch(Exception exp){
Print.dprintStackTrace(exp.getLocalizedMessage(), exp);
Print.dprint("***Exception occured while "+
"accessing mbean details: Keep continuing\n");
}
|
| private void | addToTargetModuleIDs(java.lang.String[] moduleIDs, javax.enterprise.deploy.shared.ModuleType type, SunTarget sunTarget, java.util.Collection resultingTMIDs)Augments a Collection of TargetModuleIDs with new entries for target module IDs of a given module type on the specified target.
for (int j = 0;j < moduleIDs.length;j++) {
// Get the host name and port where the application was deployed
HostAndPort webHost = getHostPort(moduleIDs[j], sunTarget);
/*
*Prepare a new target module ID object, initialize it, and add it to the result list.
*/
SunTargetModuleID tmid = new SunTargetModuleID(moduleIDs[j], sunTarget);
tmid.setModuleType(type);
resultingTMIDs.add((TargetModuleID) tmid);
/*
*Set additional information on the target module ID, depending on what type of
*module this is. For J2EE apps, this includes constructing sub TargetModuleIDs.
*/
try {
if (type.equals(ModuleType.EAR)) {
setJ2EEApplicationTargetModuleIDInfo(tmid, moduleIDs[j], webHost);
} else if (type.equals(ModuleType.WAR)) {
setWebApplicationTargetModuleIDInfo(tmid, moduleIDs[j], webHost);
}
}
catch(Exception exp){
Print.dprintStackTrace(exp.getLocalizedMessage(), exp);
Print.dprint("***Exception occured while "+ // NOI18N
"navigating or accessing admin proxies: Keep continuing\n"); // NOI18N
}
}
|
| private boolean | applicationsConfigMBeanIsPE()
boolean result;
MBeanServerConnection mbsc = getMBeanServerConnection();
ObjectName applicationsMBean = new ObjectName(applicationsMBeanName);
MBeanInfo info = mbsc.getMBeanInfo(applicationsMBean);
String className = info.getClassName();
result = ! className.endsWith(EE_APPLICATIONS_CONFIG_MBEAN_SUFFIX);
return result;
|
| private java.io.IOException | closeArchive(com.sun.enterprise.deployment.deploy.shared.AbstractArchive archive)Closes the specified archive, returning any IOException encountered in the process.
IOException errorIOE = null;
if (archive != null) {
try {
archive.close();
} catch (IOException ioe) {
errorIOE = ioe;
}
}
return errorIOE;
|
| private javax.enterprise.deploy.spi.status.ProgressObject | closeArchives(javax.enterprise.deploy.shared.CommandType commandType, com.sun.enterprise.deployment.deploy.shared.AbstractArchive moduleArchive, java.lang.String moduleArchiveSpec, com.sun.enterprise.deployment.deploy.shared.AbstractArchive planArchive, java.lang.String planArchiveSpec)Closes the module archive and the plan archive, if any, preparing a
ProgressObject if any error occurred.
ProgressObject errorPO = null;
IOException moduleIOE = closeArchive(moduleArchive);
IOException planIOE = closeArchive(planArchive);
IOException excForProgressObject = null;
String errorMsg = null;
/*
*If the module could not be closed, record the IOException resulting from the attempt for
*use in the error progress object returned to the caller.
*/
if (moduleIOE != null) {
excForProgressObject = moduleIOE;
/*
*If there was a problem with both the module archive and the plan archive,
*compose an appropriate message that says both failed.
*/
if (planIOE != null) {
errorMsg = localStrings.getLocalString(
"enterprise.deployapi.spi.errclosearchs",
"Could not close module archive {0} or deployment plan archive {1}",
new Object[] {moduleArchiveSpec, planArchiveSpec}
);
} else {
/*
*Either the plan was closed or there was no plan to close. To build
*a message about only the module archive.
*/
errorMsg = localStrings.getLocalString(
"enterprise.deployapi.spi.errclosemodulearch",
"Could not close module archive {0}",
new Object[] {moduleArchiveSpec}
);
}
} else if (planIOE != null) {
/*
*The module archive was closed fine. If the plan archive exists and
*could not be closed, compose an error message to that effect and
*record the IOException that occurred during the attempt to close the
*deployment plan archive for use in the error progress object returned
*to the caller.
*/
excForProgressObject = planIOE;
errorMsg = localStrings.getLocalString(
"enterprise.deployapi.spi.errcloseplanarch",
"Could not close deployment plan archive {0}",
new Object[] {planArchiveSpec}
);
}
/**
*If an error occurred trying to close either archive, build an error progress object
*for return to the caller.
*/
if (errorMsg != null) {
IOException ioe = new IOException(errorMsg);
ioe.initCause(excForProgressObject); // Only reflects the module exception if both occurred, but the msg describes both.
errorPO = prepareErrorProgressObject(commandType, ioe);
}
return errorPO;
|
| private java.lang.String | computeModuleID(com.sun.enterprise.deployment.deploy.shared.AbstractArchive moduleArchive)Computes a module ID for use during deployment. We use the file
name as default. If the archive is not available, i.e. using InputStream
to deploy, we return null and delay the defining of moduleID (to server
side).
/*
*Prefer the archive's path.
*/
String moduleID = null;
String UriPath = moduleArchive.getArchiveUri();
if ((UriPath != null) && (UriPath.length() > 0)) {
/*
*Use the archive path.
*/
moduleID = pathExcludingType(UriPath);
//Additional processing of the moduleID
moduleID = moduleID.replace(' ",'_");
// This moduleID will be later used to construct file path,
// replace the illegal characters in file name
// \ / : * ? " < > | with _
moduleID = moduleID.replace('\\", '_").replace('/", '_");
moduleID = moduleID.replace(':", '_").replace('*", '_");
moduleID = moduleID.replace('?", '_").replace('"", '_");
moduleID = moduleID.replace('<", '_").replace('>", '_");
moduleID = moduleID.replace('|", '_");
// This moduleID will also be used to construct an ObjectName
// to register the module, so replace additional special
// characters , = used in property parsing with -
moduleID = moduleID.replace(',", '_").replace('=", '_");
}
return moduleID;
|
| public javax.enterprise.deploy.spi.DeploymentConfiguration | createConfiguration(javax.enterprise.deploy.model.DeployableObject dObj)Retrieve the object that provides server-specific deployment
configuration information for the J2EE deployable component.
try {
SunDeploymentConfiguration deploymentConfiguration = new SunDeploymentConfiguration(dObj);
deploymentConfiguration.setDeploymentManager(this);
return deploymentConfiguration;
} catch(ConfigurationException e) {
InvalidModuleException ime = new InvalidModuleException(e.getMessage());
ime.initCause(e);
throw ime;
}
|
| private SunTarget | createSunTarget(SunTarget target, java.lang.String name, java.lang.String type)Initialize a new SunTarget with the original target plus added info.
SunTarget aTarget = new SunTarget(target);
aTarget.setAppServerInstance(name);
aTarget.setConnectionSource(getDasConnection());
aTarget.setTargetType(type);
return aTarget;
|
| private javax.enterprise.deploy.spi.status.ProgressObject | deploy(javax.enterprise.deploy.spi.Target[] targetList, java.io.InputStream moduleStream, java.io.InputStream deploymentPlanStream, java.util.Properties presetOptions)Deploy the specified module to the list of targets.
The deployment plan archive can be null.
/*
*Create archives for the module's input stream and, if present, the deployment plan's
*input stream, and then delegate to the variant of deploy that accepts archives as
*arguments.
*/
MemoryMappedArchive moduleArchive = null;
MemoryMappedArchive deploymentPlanArchive = null;
try {
moduleArchive = new MemoryMappedArchive(moduleStream);
if (deploymentPlanStream != null) {
deploymentPlanArchive = new MemoryMappedArchive(deploymentPlanStream);
}
return deploy(targetList, moduleArchive, deploymentPlanArchive, presetOptions);
} catch (Throwable e) {
String msg = localStrings.getLocalString(
"enterprise.deployapi.spi.errpreparearchstream",
"Could not prepare archives for module and/or deployment plan input streams");
IllegalArgumentException ex = new IllegalArgumentException(msg);
ex.initCause(e);
return prepareErrorProgressObject(CommandType.DISTRIBUTE, ex);
}
|
| private javax.enterprise.deploy.spi.status.ProgressObject | deploy(javax.enterprise.deploy.spi.Target[] targetList, java.io.File moduleArchive, java.io.File deploymentPlan, java.util.Properties presetOptions)Deploy the specified module to the list of targets.
The deployment plan archive can be null.
/*
*Create archives for the module file and, if present, the deployment plan file, and
*then delegate to the variant of deploy that accepts archives as arguments.
*/
AbstractArchive appArchive = null;
AbstractArchive planArchive = null;
ArchiveFactory archiveFactory = new ArchiveFactory();
try {
appArchive = archiveFactory.openArchive(toJarURI(moduleArchive));
if(deploymentPlan != null && deploymentPlan.length() != 0) {
planArchive = archiveFactory.openArchive(toJarURI(deploymentPlan));
if (planArchive == null) {
throw new IllegalArgumentException(localStrings.getLocalString(
"enterprise.deployapi.spi.noarchivisthandlesplan",
"No archivist is able to handle the deployment plan {0}",
new Object [] {deploymentPlan.getAbsolutePath()}
));
}
}
ProgressObject po = deploy(targetList, appArchive, planArchive, presetOptions);
return po;
} catch (Exception se) {
String msg = localStrings.getLocalString(
"enterprise.deployapi.spi.errpreparearchfile",
"Could not prepare archives for module and/or deployment plan files");
IllegalArgumentException ex = new IllegalArgumentException(msg);
ex.initCause(se);
return prepareErrorProgressObject(CommandType.DISTRIBUTE, ex);
} finally {
closeArchives(CommandType.DISTRIBUTE, appArchive, moduleArchive.getAbsolutePath(), planArchive, (deploymentPlan != null) ? deploymentPlan.getAbsolutePath() : null);
}
|
| private javax.enterprise.deploy.spi.status.ProgressObject | deploy(javax.enterprise.deploy.spi.Target[] targetList, com.sun.enterprise.deployment.deploy.shared.AbstractArchive moduleArchive, com.sun.enterprise.deployment.deploy.shared.AbstractArchive planArchive, java.util.Properties presetOptions)Deploy the specified module to the list of targets.
The deployment plan archive can be null.
verifyConnected();
String moduleID = null;
ProgressObject progressObj = null;
try {
String UriPath = moduleArchive.getArchiveUri();
moduleID = computeModuleID(moduleArchive);
Properties options = getProperties(UriPath, moduleID);
/*
*If any preset options were specified by the caller, use them to
*override or augment the just-assigned set.
*/
if (presetOptions != null) {
options.putAll(presetOptions);
}
progressObj = getDeploymentFacility().deploy(targetList, moduleArchive, planArchive, options);
} catch(Throwable e) {
/*
*Prepare a progress object with a deployment status "wrapper" around this exception.
*/
progressObj = prepareErrorProgressObject(CommandType.DISTRIBUTE, e);
}
return progressObj;
|
| private javax.enterprise.deploy.shared.ModuleType | deriveModuleTypeFromModuleName(java.lang.String moduleName)
ModuleType moduleType = null;
if (moduleName.indexOf("EJBModule")!=-1) {
moduleType = ModuleType.EJB;
} else if (moduleName.indexOf("AppClientModule")!=-1) {
moduleType = ModuleType.CAR;
} else {
moduleType = ModuleType.RAR;
}
return moduleType;
|
| public javax.enterprise.deploy.spi.status.ProgressObject | distribute(javax.enterprise.deploy.spi.Target[] targetList, java.io.File moduleArchive, java.io.File deploymentPlan)The distribute method performs three tasks; it validates the
deployment configuration data, generates all container specific
classes and interfaces, and moves the fully baked archive to
the designated deployment targets.
return deploy(targetList, moduleArchive, deploymentPlan, null /* presetOptions */);
|
| public javax.enterprise.deploy.spi.status.ProgressObject | distribute(javax.enterprise.deploy.spi.Target[] targetList, java.io.InputStream moduleArchive, java.io.InputStream deploymentPlan)The distribute method performs three tasks; it validates the
deployment configuration data, generates all container specific
classes and interfaces, and moves the fully baked archive to
the designated deployment targets.
return deploy(targetList, moduleArchive, deploymentPlan, null /* presetOptions */);
|
| public javax.enterprise.deploy.spi.status.ProgressObject | distribute(javax.enterprise.deploy.spi.Target[] targetList, javax.enterprise.deploy.shared.ModuleType type, java.io.InputStream moduleArchive, java.io.InputStream deploymentPlan)The distribute method performs three tasks; it validates the
deployment configuration data, generates all container specific
classes and interfaces, and moves the fully baked archive to
the designated deployment targets.
DeploymentProperties dProps = new DeploymentProperties();
dProps.setType(type);
return deploy(targetList, moduleArchive, deploymentPlan, (Properties)dProps);
|
| public javax.enterprise.deploy.spi.status.ProgressObject | distribute(javax.enterprise.deploy.spi.Target[] targetList, com.sun.enterprise.deployment.deploy.shared.Archive moduleArchive, com.sun.enterprise.deployment.deploy.shared.Archive deploymentPlan, java.lang.Object deploymentOptions)The distribute method performs three tasks; it validates the
deployment configuration data, generates all container specific
classes and interfaces, and moves the fully baked archive to
the designated deployment targets.
return null;
|
| private javax.enterprise.deploy.spi.status.ProgressObject | executeCommandUsingFacility(javax.enterprise.deploy.shared.CommandType commandType, javax.enterprise.deploy.spi.TargetModuleID[] targetModuleIDList)Perform the selected command on the DeploymentFacility using the specified target module IDs.
Several of the deployment facility methods have the same signature except for the name.
This method collects the pre- and post-processing around those method calls in one place, then
chooses which of the deployment facility methods to actually invoke based on the
command type provided as an argument.
verifyConnected();
try {
DeploymentFacility df = getDeploymentFacility();
/*
*Create a temporary collection based on the target module IDs to make it easier to deal
*with the different modules and the set of targets.
*/
TargetModuleIDCollection coll = new TargetModuleIDCollection(targetModuleIDList);
/*
*For each distinct module ID present in the list, ask the deployment facility to
*operate on that module on all the relevant targets.
*/
for (Iterator it = coll.iterator(); it.hasNext();) {
/*
*The iterator returns one work instance for each module present in the collection.
*Each work instance reflects one invocation of a method on the DeploymentFacility.
*/
DeploymentFacilityModuleWork work = (DeploymentFacilityModuleWork) it.next();
ProgressObject po = null;
if (commandType.equals(CommandType.START)) {
po = df.enable(work.targets(), work.getModuleID());
} else if (commandType.equals(CommandType.STOP)) {
po = df.disable(work.targets(), work.getModuleID());
} else if (commandType.equals(CommandType.UNDEPLOY)) {
po = df.undeploy(work.targets(), work.getModuleID());
} else {
throw new IllegalArgumentException(localStrings.getLocalString(
"enterprise.deployapi.spi.unexpcommand",
"Received unexpected deployment facility command ${0}",
new Object [] {commandType.toString()}
));
}
/*
*The new work instance needs to know about its own progress object, and the
*aggregate progress object needs to also.
*/
work.setProgressObject(po);
coll.getProgressObjectSink().sinkProgressObject(po);
}
/*
*Return the single progress object to return to the caller.
*/
return coll.getProgressObjectSink();
} catch (Throwable thr) {
return prepareErrorProgressObject(commandType, thr);
}
|
| public com.sun.enterprise.deployment.deploy.shared.WritableArchive | getArchive(java.net.URI path, java.lang.String name)Creates a new instance of WritableArchive which can be used to
store application elements in a layout that can be directly used by
the application server. Implementation of this method should carefully
return the appropriate implementation of the interface that suits
the server needs and provide the fastest deployment time.
An archive may already exist at the location and elements may be
read but not changed or added depending on the underlying medium.
if (path==null) {
// no particular path was provided, using tmp jar file
File root = File.createTempFile(name,".jar"); //NOI18N
path = root.toURI();
}
ArchiveFactory factory = new ArchiveFactory();
boolean exists = false;
if ((path.getScheme().equals("file")) || //NOI18N
(path.getScheme().equals("jar"))) { //NOI18N
File target = new File(path);
exists = target.exists();
} else {
return null;
}
if (exists) {
return factory.openArchive(path);
} else {
return factory.createArchive(path);
}
|
| public javax.enterprise.deploy.spi.TargetModuleID[] | getAvailableModules(javax.enterprise.deploy.shared.ModuleType moduleType, javax.enterprise.deploy.spi.Target[] targetList)Retrieve the list of all J2EE application modules running
or not running on the identified targets.
return getModules(moduleType, targetList, null, null);
|
| public java.util.Locale | getCurrentLocale()Returns the active locale this implementation of
javax.enterprise.deploy.spi subpackages is running.
return currentLocale;
|
| public javax.enterprise.deploy.shared.DConfigBeanVersionType | getDConfigBeanVersion()Returns the J2EE platform version number for which the
configuration beans are provided. The beans must have
been compiled with the J2SE version required by the J2EE
platform.
return DConfigBeanVersionType.V5;
|
| private com.sun.appserv.management.client.ConnectionSource | getDasConnection()Returns the cached DAS connection, creating it if needed.
This method should be called only if the SunDeploymentManager was instantiated using the
constructor that provides a target and a principal.
if (dasConnection == null) {
if (serverId == null) {
throw new IllegalStateException(localStrings.getLocalString(
"enterprise.deployapi.spi.targetorprinnotset",
"Attempted to connect to DAS management interface but target and/or principal have not been set"
));
}
TLSParams tlsParams = null;
if (serverId.isSecure()) {
X509TrustManager trustManager =
(X509TrustManager)serverId.getConnectionEnvironment().
get(DefaultConfiguration.TRUST_MANAGER_PROPERTY_NAME);
tlsParams = new TLSParams(trustManager, null);
}
dasConnection = new AppserverConnectionSource(
AppserverConnectionSource.PROTOCOL_HTTP,
serverId.getHostName(), serverId.getHostPort(),
serverId.getUserName(), serverId.getPassword(),
tlsParams, null);
}
return dasConnection;
|
| private java.lang.String | getDefaultHostName()
String defaultHostName = "localhost"; //NOI18N
try {
InetAddress host = InetAddress.getLocalHost();
defaultHostName = host.getCanonicalHostName();
} catch(UnknownHostException uhe) {
}
return defaultHostName;
|
| private com.sun.enterprise.admin.util.HostAndPort | getDefaultHostPort(com.sun.appserv.management.config.TemplateResolver resolver)
try {
return getDefaultHostPortUsingMBeans();
} catch (Throwable thr) {
IOException ioe = new IOException(localStrings.getLocalString(
"enterprise.deployapi.spi.errretrievedefaulthostport",
"Error retrieving default host and port"
));
ioe.initCause(thr);
throw ioe;
}
|
| private com.sun.enterprise.admin.util.HostAndPort | getDefaultHostPortUsingMBeans()Return HostAndPort for first listener, using proxies for navigation.
MBeanServerConnection mbsc = getMBeanServerConnection();
HostAndPort result = null;
Object[] params = new Object[] {Boolean.FALSE};
String[] signature = new String[]{ "boolean"};
ObjectName applicationsMBean = new ObjectName(applicationsMBeanName);
result = (HostAndPort) mbsc.invoke(applicationsMBean, "getHostAndPort", params, signature);
return result;
|
| public java.util.Locale | getDefaultLocale()Returns the default locale supported by this implementation of
javax.enterprise.deploy.spi subpackages.
return defaultLocale;
|
| private com.sun.enterprise.deployment.client.DeploymentFacility | getDeploymentFacility()Return a reference to a connected DeploymentFacility object. Instantiates and connects
one if needed.
if (this.deploymentFacility == null) {
this.deploymentFacility = DeploymentFacilityFactory.getDeploymentFacility();
this.deploymentFacility.connect(serverId);
}
return this.deploymentFacility;
|
| private com.sun.appserv.management.config.DomainConfig | getDomainConfigProxy()Returns the cached domain config proxy for this SDM's domain, creating it if needed.
if (domainConfigProxy == null) {
domainConfigProxy = getRootProxy().getDomainConfig();
}
return domainConfigProxy;
|
| private com.sun.enterprise.admin.util.HostAndPort | getHostPort(java.lang.String moduleID, SunTarget aTarget)For a given moduleID on a given Target, get Host and Port information
/*
*Navigate the proxies using either the stand-along server proxy or the cluster proxy, depending
*on the type of the target.
*/
DeployedItemRefConfig cfg = null;
/*
*In doing proxy-based template resolution, we'll locate a resolver - such as a stand-alone server config proxy -
*that can translate templates if we encounter any.
*/
TemplateResolver resolver = null;
if( ! aTarget.getTargetType().equals(TargetType.CLUSTER)) {
StandaloneServerConfig svrProxy =
(StandaloneServerConfig)getDomainConfigProxy().
getContainee(XTypes.STANDALONE_SERVER_CONFIG,
aTarget.getName());
cfg = (DeployedItemRefConfig)svrProxy.getContainee(
XTypes.DEPLOYED_ITEM_REF_CONFIG, moduleID);
resolver = svrProxy;
} else {
ClusterConfig clProxy = (ClusterConfig)getDomainConfigProxy().
getContainee(XTypes.CLUSTER_CONFIG, aTarget.getName());
cfg = (DeployedItemRefConfig)clProxy.getContainee(
XTypes.DEPLOYED_ITEM_REF_CONFIG, moduleID);
/*
*We cannot assign the resolver yet because the cluster config proxy itself cannot resolve templates.
*/
resolver = null;
}
// Get the list of virtual servers from the application-Ref
String vServers = cfg.getVirtualServers();
// if no virtual server configured, get default stuff
if(vServers == null) {
//FIXME - Need to assign resolver to something for cluster case to use proxy-based template resolution
return(getDefaultHostPort(resolver));
}
String [] vsList = vServers.split(" ,"); //NOI18N
if (vsList.length == 0) {
//FIXME - Need to assign resolver to something for cluster case to use proxy-based template resolution
return getDefaultHostPort(resolver);
}
/*
*Iterate through the available virtual servers. Stop when one has a legitimate
*(non-null) host and port value.
*/
HostAndPort answer = null;
for (int i = 0; (i < vsList.length) && (answer == null); i++) {
/*
*FIXME - need to find the resolver for this virtual server and then pass it as the 2nd
*argument next in order to use proxy-based template resolution.
*/
answer = getVirtualServerHostAndPort(vsList[i], resolver);
}
if (answer == null) {
answer = getDefaultHostPort(resolver);
}
return answer;
|
| private com.sun.enterprise.admin.util.HostAndPort | getHostPort(com.sun.appserv.management.config.HTTPListenerConfig listenerProxy, com.sun.appserv.management.config.TemplateResolver resolver)
String serverName = null;
int port = 0;
// return if listener is not enabled
if(!listenerProxy.getEnabled()) {
return null;
}
// return if listener is meant for asadmin only
// com.sun.enterprise.web.VirtualServer.ADMIN_VS
if(com.sun.enterprise.web.VirtualServer.ADMIN_VS.equals(
listenerProxy.getDefaultVirtualServer())) {
return null;
}
if(!listenerProxy.getSecurityEnabled()) {
serverName = listenerProxy.getServerName();
if (serverName == null || serverName.trim().equals("")) {
serverName = getDefaultHostName();
}
String portString = listenerProxy.getPort();
port = new Integer(getPropertyValueFromTemplate(portString, resolver)).intValue();
if(listenerProxy.getRedirectPort() != null) {
port = new Integer(getPropertyValueFromTemplate(listenerProxy.getRedirectPort(), resolver)).intValue();
}
}
HostAndPort hostPort = new HostAndPort(serverName, port);
return hostPort;
|
| private javax.management.MBeanServerConnection | getMBeanServerConnection()
return getDasConnection().getExistingMBeanServerConnection();
|
| private javax.enterprise.deploy.shared.ModuleType | getModuleTypeFor(java.lang.String moduleID)
MBeanServerConnection mbsc = getMBeanServerConnection();
ObjectName applicationsMBean = new ObjectName(applicationsMBeanName);
String[] signature = new String[] {"java.lang.String"};
Object[] params = new Object[] {moduleID};
Integer result = (Integer)
mbsc.invoke(applicationsMBean, "getModuleType", params, signature);
if (result == null) {
String msg = localStrings.getLocalString(
"enterprise.deployapi.spi.redeploy.modulenotfound",
"Module " + moduleID + " not found");
throw new IllegalArgumentException(msg);
}
return ModuleType.getModuleType(result.intValue());
|
| private javax.enterprise.deploy.spi.TargetModuleID[] | getModules(javax.enterprise.deploy.shared.ModuleType moduleType, javax.enterprise.deploy.spi.Target[] targetList, java.lang.String attribute, java.lang.Object status)Get all modules in the specified state from the targets specified in the
argument list.
verifyConnected();
if (moduleType==null) {
return null;
}
try {
Vector resultingTMIDs = new Vector();
for (int i = 0; i < targetList.length; i++) {
SunTarget aTarget = (SunTarget) targetList[i];
/*
*For each target, get names of all modules of expected state.
*/
String[] moduleNames = getModulesOnATarget(aTarget, moduleType, attribute, status);
/*
*Create the module ID and add it to the collection to be returned.
*/
addToTargetModuleIDs(moduleNames, moduleType, aTarget, resultingTMIDs);
}
/*
*Return an array of runtime type SunTargetModuleID [].
*/
TargetModuleID [] answer = (TargetModuleID []) resultingTMIDs.toArray(new SunTargetModuleID[0]);
return answer;
} catch(Exception e){
TargetException tg = new TargetException(localStrings.getLocalString(
"enterprise.deployapi.spi.errorgetreqmods",
"Error getting required modules"
));
tg.initCause(e);
throw tg;
}
|
| private java.lang.String[] | getModulesOnATarget(SunTarget aTarget, javax.enterprise.deploy.shared.ModuleType requiredType, java.lang.String attribute, java.lang.Object status)
Set modules = null;
// Get all deployed items in the given target
DeployedItemHelper helper = new DeployedItemHelper(getRootProxy());
if( ! aTarget.getTargetType().equals(TargetType.CLUSTER)) {
modules = helper.queryStandaloneServerDeployedItemObjectNames(aTarget.getName());
} else {
modules = helper.queryClusterDeployedItemObjectNames(aTarget.getName());
}
// if required to get only enabled / disabled modules, filter the received modules Set
if(attribute != null) {
modules = helper.filterByAttributeValue(modules, attribute, status);
}
// Now from this filtered set, get the modules of the required type
Vector modulesMatchingType = new Vector();
final String xtype = getXType(requiredType);
for(Iterator it = modules.iterator(); it.hasNext(); ) {
ObjectName objectName = (ObjectName) it.next();
String modId = objectName.getKeyProperty("name"); // NOI18N
AMX proxy = (AMX)getDomainConfigProxy().
getContainee(xtype, modId);
if (null != proxy) {
modulesMatchingType.add(modId);
}
}
String[] actualModules = null;
actualModules = (String []) modulesMatchingType.toArray(new String[0]);
return actualModules;
|
| public javax.enterprise.deploy.spi.TargetModuleID[] | getNonRunningModules(javax.enterprise.deploy.shared.ModuleType moduleType, javax.enterprise.deploy.spi.Target[] targetList)Retrieve the list of J2EE application modules distributed
to the identified targets and that are currently not
running on the associated server or servers.
return getModules(moduleType, targetList, ENABLED_ATTRIBUTE_NAME, Boolean.FALSE);
|
| protected java.util.Properties | getProperties(java.lang.String archiveName, java.lang.String moduleID)
DeploymentProperties dProps = new DeploymentProperties();
dProps.setArchiveName(archiveName);
dProps.setName(moduleID);
dProps.setEnable(false);
return (Properties)dProps;
|
| private java.lang.String | getPropertyValueFromTemplate(java.lang.String str, com.sun.appserv.management.config.TemplateResolver resolver)Checks if property got was a template (like ${listener-1});
If so, gets the value from the specified template resolver.
/*
*The resolver will tranlate the template if it can, returning the translation. It will return
*the input string unchanged if the string is not a template or if it is a template but the resolver
*cannot resolve it.
*/
String result = resolver.resolveTemplateString(str);
return result;
|
| private com.sun.appserv.management.client.ProxyFactory | getProxyFactory()Returns the cached ProxyFactory, creating one if needed.
if (proxyFactory == null) {
proxyFactory = ProxyFactory.getInstance(getDasConnection());
}
return proxyFactory;
|
| private com.sun.enterprise.deployment.util.DeploymentProperties | getRedeployOptions(java.lang.String moduleID)Return deployment options for the DeploymentFacility preset for the needs of redeployment.
These properties will be merged with and will override the options set for normal deployment.
DeploymentProperties deplProps = new DeploymentProperties();
deplProps.setForce(true);
deplProps.setName(moduleID);
return deplProps;
|
| private com.sun.appserv.management.DomainRoot | getRootProxy()Returns the cached root proxy, creating it if needed.
if (rootProxy == null) {
rootProxy = getProxyFactory().createDomainRoot();
}
rootProxy.waitAMXReady();
return rootProxy;
|
| public javax.enterprise.deploy.spi.TargetModuleID[] | getRunningModules(javax.enterprise.deploy.shared.ModuleType moduleType, javax.enterprise.deploy.spi.Target[] targetList)Retrieve the list of J2EE application modules distributed
to the identified targets and that are currently running
on the associated server or servers.
return getModules(moduleType, targetList, ENABLED_ATTRIBUTE_NAME, Boolean.TRUE);
|
| public java.util.Locale[] | getSupportedLocales()Returns an array of supported locales for this implementation.
return supportedLocales;
|
| public javax.enterprise.deploy.spi.Target[] | getTargets()Retrieve the list of deployment targets supported by
this DeploymentManager.
verifyConnected();
Target[] result = null;
try {
DomainConfig domainCfg = getDomainConfigProxy();
/*
*There is no single proxy that "owns" both clusters and stand-alone instances, the
*two types of targets. So
*visit the two mgr proxies to retrieve the names of all targets of either type.
*From there on, the names can be treated the same regardless of which config mgr proxy
*each came from.
*/
final Map standaloneServers =
domainCfg.getStandaloneServerConfigMap();
final Map clusters = domainCfg.getClusterConfigMap();
/*
*Build a single result containing SunTarget instances for either kind of target.
*/
Vector targets = new Vector();
for (Iterator it = standaloneServers.keySet().iterator(); it.hasNext(); ) {
targets.add(createSunTarget(target, (String)it.next(),
TargetType.STAND_ALONE_SERVER));
}
for (Iterator it = clusters.keySet().iterator(); it.hasNext(); ) {
targets.add(createSunTarget(target, (String)it.next(), TargetType.CLUSTER));
}
/*
*Convert the vector into a Target array with runtime type SunTarget [].
*/
result = (Target []) targets.toArray(new SunTarget[0]);
} catch (Throwable e) {
IllegalStateException ex = new IllegalStateException(e.getMessage());
ex.initCause(e);
throw ex;
}
return result;
|
| private com.sun.enterprise.admin.util.HostAndPort | getVirtualServerHostAndPort(java.lang.String vs, com.sun.appserv.management.config.TemplateResolver resolver)Return the HostAndPort for a specified virtual server, using either MBeans or proxies as indicated by
the private instance setting.
try {
return getVirtualServerHostAndPortUsingMBeans(vs);
} catch (Throwable thr) {
IOException ioe = new IOException(localStrings.getLocalString(
"enterprise.deployapi.spi.errretreivevirtualserverhostport",
"Error retrieving virtual server host and port"
));
ioe.initCause(thr);
throw ioe;
}
|
| private com.sun.enterprise.admin.util.HostAndPort | getVirtualServerHostAndPortUsingMBeans(java.lang.String vs)Return the HostAndPort for the specified virtual server name.
HostAndPort result = null;
MBeanServerConnection mbsc = getMBeanServerConnection();
Object[] params = new Object[] {vs, Boolean.FALSE};
String[] signature = new String[]{ "java.lang.String", "boolean"}; //NOI18N
ObjectName applicationsMBean = new ObjectName(applicationsMBeanName);
result = (HostAndPort) mbsc.invoke(applicationsMBean, "getVirtualServerHostAndPort", params, signature); //NOI18N
return result;
|
| private java.lang.String | getXType(javax.enterprise.deploy.shared.ModuleType moduleType)
String result = DeploymentClientUtils.mapModuleTypeToXType(moduleType);
return result;
|
| public boolean | isDConfigBeanVersionSupported(javax.enterprise.deploy.shared.DConfigBeanVersionType version)Returns 'true' if the configuration beans support the J2EE platform
version specified. It returns 'false' if the version is
not supported.
return version.getValue()==getDConfigBeanVersion().getValue();
|
| private boolean | isDisconnected()Report whether the deployment manager is currently disconnected from the DAS.
return target == null;
|
| public boolean | isLocaleSupported(java.util.Locale locale)Reports if this implementation supports the designated locale.
Locale[] locales = getSupportedLocales();
for (int i=0;i<locales.length;i++) {
if (locales[i].equals(locale))
return true;
}
return false;
|
| public boolean | isPE()Identifies the DAS to which the DeploymentManager is connected as a PE (as opposed to SE/EE) one.
boolean result;
try {
result = applicationsConfigMBeanIsPE();
return result;
} catch (Throwable thr) {
throw new RuntimeException(localStrings.getLocalString(
"enterprise.deployapi.spi.errcheckingtype",
"Error checking type of DAS"), thr); //NOI18N
}
|
| public boolean | isRedeploySupported()This method designates whether this platform vendor provides
application redeployment functionality. A value of true means
it is supported. False means it is not.
return true;
|
| private java.lang.String | pathExcludingType(java.lang.String path)Extract the name part of the path except for any file type at the end, following the "dot" character.
/*
*Use the last part of the path up to but not including the archive type.
*/
path = path.substring(path.lastIndexOf('/")+1);
if (path.lastIndexOf('.")!=-1) {
path = path.substring(0, path.lastIndexOf('."));
}
return path;
|
| private javax.enterprise.deploy.spi.status.ProgressObject | prepareErrorProgressObject(javax.enterprise.deploy.shared.CommandType commandType, java.lang.Throwable thr)Prepare a ProgressObject that reflects an error, with a related Throwable cause.
DeploymentStatus ds = new DeploymentStatusImplWithError(CommandType.DISTRIBUTE, thr);
SimpleProgressObjectImpl progressObj = new SimpleProgressObjectImpl(ds);
ProgressEvent event = new ProgressEvent(progressObj, null /*targetModuleID */, ds);
progressObj.fireProgressEvent(event);
return progressObj;
|
| private SunTargetModuleID | prepareNonWebChildTargetModuleID(java.lang.String id, SunTarget sunTarget, java.lang.String subModuleName, javax.enterprise.deploy.shared.ModuleType moduleType)
String moduleID = id + "#" + subModuleName;
SunTargetModuleID childTmid = new SunTargetModuleID(moduleID, sunTarget);
childTmid.setModuleType(moduleType);
return childTmid;
|
| private SunTargetModuleID | prepareWebChildTargetModuleID(java.lang.String id, SunTarget sunTarget, com.sun.enterprise.admin.util.HostAndPort hostAndPort, java.lang.String path)
id = id.replace(':",'#");
SunTargetModuleID childTmid = new SunTargetModuleID(id, sunTarget);
// Patchup code for fixing netbeans issue 6221411; Need to find a good solution for this and WSDL publishing
String host;
if(isPE()) {
host = childTmid.getConnectionInfo().getHostName();
} else {
host = hostAndPort.getHost();
}
// get the web url
URL webURL = new URL("http", host, hostAndPort.getPort(), path);
childTmid.setWebURL(webURL.toExternalForm());
childTmid.setModuleType(ModuleType.WAR);
return childTmid;
|
| public javax.enterprise.deploy.spi.status.ProgressObject | redeploy(javax.enterprise.deploy.spi.TargetModuleID[] moduleIDList, java.io.File moduleArchive, java.io.File deploymentPlan)(optional)
The redeploy method provides a means for updating currently
deployed J2EE applications. This is an optional method for
vendor implementation.
Redeploy replaces a currently deployed application with an
updated version. The runtime configuration information for
the updated application must remain identical to the application
it is updating.
When an application update is redeployed, all existing client
connections to the original running application must not be disrupted;
new clients will connect to the application update.
This operation is valid for TargetModuleIDs that represent a
root module. A root TargetModuleID has no parent. A root
TargetModuleID module and all its child modules will be redeployed.
A child TargetModuleID module cannot be individually redeployed.
The redeploy operation is complete only when this action for
all the modules has completed.
try {
/*
*To support multiple different modules in the module ID list, use a TargetModuleIDCollection to
*organize them and work on each module one at a time.
*/
TargetModuleIDCollection coll = new TargetModuleIDCollection(moduleIDList);
for (Iterator it = coll.iterator(); it.hasNext();) {
/*
*The iterator returns one work instance for each module present in the collection.
*/
DeploymentFacilityModuleWork work = (DeploymentFacilityModuleWork) it.next();
/*
*Set the name in the properties according to the moduleID. The module is the same for all the
*targets represented by this single work object.
*/
ProgressObject po = deploy(work.targets(), moduleArchive, deploymentPlan, getRedeployOptions(work.getModuleID()));
/*
*The work instance needs to know about its own progress object, and the
*aggregate progress object needs to also.
*/
work.setProgressObject(po);
coll.getProgressObjectSink().sinkProgressObject(po);
}
return coll.getProgressObjectSink();
} catch (Throwable e) {
return prepareErrorProgressObject(CommandType.REDEPLOY, e);
}
|
| public javax.enterprise.deploy.spi.status.ProgressObject | redeploy(javax.enterprise.deploy.spi.TargetModuleID[] moduleIDList, java.io.InputStream moduleArchive, java.io.InputStream deploymentPlan)(optional)
The redeploy method provides a means for updating currently
deployed J2EE applications. This is an optional method for
vendor implementation.
Redeploy replaces a currently deployed application with an
updated version. The runtime configuration information for
the updated application must remain identical to the application
it is updating.
When an application update is redeployed, all existing client
connections to the original running application must not be disrupted;
new clients will connect to the application update.
This operation is valid for TargetModuleIDs that represent a
root module. A root TargetModuleID has no parent. A root
TargetModuleID module and all its child modules will be redeployed.
A child TargetModuleID module cannot be individually redeployed.
The redeploy operation is complete only when this action for
all the modules has completed.
try {
/*
*To support multiple different modules in the module ID list, use a TargetModuleIDCollection to
*organize them and work on each module one at a time.
*/
TargetModuleIDCollection coll = new TargetModuleIDCollection(moduleIDList);
for (Iterator it = coll.iterator(); it.hasNext();) {
/*
*The iterator returns one work instance for each module present in the collection.
*/
DeploymentFacilityModuleWork work = (DeploymentFacilityModuleWork) it.next();
/*
*Set the name in the properties according to the moduleID. The module is the same for all the
*targets represented by this single work object.
*/
DeploymentProperties dProps = getRedeployOptions(work.getModuleID());
dProps.setType(getModuleTypeFor(work.getModuleID()));
ProgressObject po = deploy(work.targets(), moduleArchive, deploymentPlan, dProps);
/*
*The work instance needs to know about its own progress object, and the
*aggregate progress object needs to also.
*/
work.setProgressObject(po);
coll.getProgressObjectSink().sinkProgressObject(po);
}
return coll.getProgressObjectSink();
} catch (Throwable e) {
return prepareErrorProgressObject(CommandType.REDEPLOY, e);
}
|
| public void | release()The release method is the mechanism by which the tool signals
to the DeploymentManager that the tool does not need it to
continue running connected to the platform.
The tool may be signaling it wants to run in a disconnected
mode or it is planning to shutdown.
When release is called the DeploymentManager may close any
J2EE resource connections it had for deployment configuration
and perform other related resource cleanup. It should not
accept any new operation requests (i.e., distribute, start
stop, undeploy, redeploy. It should finish any operations
that are currently in process. Each ProgressObject associated
with a running operation should be marked as released (see
the ProgressObject).
/*
*Make sure multiple releases are handled gracefully.
*/
if ( ! isDisconnected() ) {
target.release();
target = null;
}
|
| public void | setDConfigBeanVersion(javax.enterprise.deploy.shared.DConfigBeanVersionType version)Set the configuration beans to be used to the J2EE platform
version specificed.
if (!isDConfigBeanVersionSupported(version)) {
throw new DConfigBeanVersionUnsupportedException(
localStrings.getLocalString(
"enterprise.deployapi.spi.dconfigbeanversionnotsupported", //NOI18N
"DConfigBean version {0} is not supported", //NOI18N
new Object[] {version.toString()}));
}
|
| private void | setJ2EEApplicationTargetModuleIDInfo(SunTargetModuleID tmid, java.lang.String moduleID, com.sun.enterprise.admin.util.HostAndPort hostAndPort)Attach child target module IDs to a J2EE application target module ID.
/*
*Only one of the following invocations is needed. As of this writing, we are
*choosing to use the "old" MBeans until the "new" MBean proxies offer the
*equivalent access.
*/
addChildTargetModuleIDsToJ2EEUsingMBeans(tmid, moduleID, hostAndPort);
|
| public void | setLocale(java.util.Locale locale)Set the active locale for this implementation of
javax.enterprise.deploy.spi subpackages to run.
for (int i=0;i<supportedLocales.length;i++) {
if (supportedLocales[i] == locale) {
currentLocale = locale;
return;
}
}
throw new UnsupportedOperationException(
localStrings.getLocalString("enterprise.deployapi.spi.localnotsupported", //NOI18N
"Locale {0} is not supported", new Object[] {locale})); //NOI18N
|
| public void | setServerConnectionEnvironment(com.sun.enterprise.deployment.client.ServerConnectionEnvironment env)Set additional env vars for the jmx https connector, provided
by the client. This method is expected to be called right after
the client retrieves the DeploymentManager, before
the client makes any calls on the DM that requires MBean Server
connection.
serverId.setConnectionEnvironment(env);
|
| private void | setWebApplicationTargetModuleIDInfo(SunTargetModuleID tmid, java.lang.String moduleID, com.sun.enterprise.admin.util.HostAndPort webHost)Set additional type-specific information on the target module ID.
SunTarget sunTarget = (SunTarget) tmid.getTarget();
/*
*Navigate to the Web app's proxy.
*/
WebModuleConfig webProxy = (WebModuleConfig)getDomainConfigProxy().
getContainee(XTypes.WEB_MODULE_CONFIG, moduleID);
String path = webProxy.getContextRoot();
if (!path.startsWith("/")) { //NOI18N
path = "/" + path; //NOI18N
}
// Patchup code for fixing netbeans issue 6221411; Need to find a good solution for this and WSDL publishing
String host;
if(isPE()) {
host = tmid.getConnectionInfo().getHostName();
} else {
host = webHost.getHost();
}
URL webURL = new URL("http", host, webHost.getPort(), path); //NOI18N
tmid.setWebURL(webURL.toExternalForm());
|
| public javax.enterprise.deploy.spi.status.ProgressObject | start(javax.enterprise.deploy.spi.TargetModuleID[] moduleIDList)Start the application running.
Only the TargetModuleIDs which represent a root module
are valid for being started. A root TargetModuleID has no parent.
A TargetModuleID with a parent can not be individually started.
A root TargetModuleID module and all its child modules will be
started.
return executeCommandUsingFacility(CommandType.START, moduleIDList);
|
| public javax.enterprise.deploy.spi.status.ProgressObject | stop(javax.enterprise.deploy.spi.TargetModuleID[] moduleIDList)Stop the application running.
Only the TargetModuleIDs which represent a root module
are valid for being stopped. A root TargetModuleID has no parent.
A TargetModuleID with a parent can not be individually stopped.
A root TargetModuleID module and all its child modules will be
stopped.
return executeCommandUsingFacility(CommandType.STOP, moduleIDList);
|
| private java.net.URI | toJarURI(java.io.File archiveFile)Convert a file spec into a jar URI.
This creates a URI acceptable to the rest of the processing. Using File.toURI alone omits the
authority from the result which causes problems later on. Plus, the scheme needs to be jar
for archive files; otherwise a URI with "file:" triggers deployment directory behavior.
URI archiveFileURI = archiveFile.toURI();
URI answer = new URI("jar", "" /* authority */, archiveFileURI.getSchemeSpecificPart(), null, null); //NOI18N
return answer;
|
| public javax.enterprise.deploy.spi.status.ProgressObject | undeploy(javax.enterprise.deploy.spi.TargetModuleID[] moduleIDList)Remove the application from the target server.
Only the TargetModuleIDs which represent a root module
are valid for undeployment. A root TargetModuleID has no parent.
A TargetModuleID with a parent can not be undeployed. A root
TargetModuleID module and all its child modules will be undeployed.
The root TargetModuleID module and all its child modules must
stopped before they can be undeployed.
return executeCommandUsingFacility(CommandType.UNDEPLOY, moduleIDList);
|
| private void | verifyConnected()Single method used by several public methods to make sure the deployment manager is
connected and, if not, throw the IllegalStateException.
if(isDisconnected()) {
throw new IllegalStateException(disconnectedMessage);
}
|
