FileDocCategorySizeDatePackage
J2EECPhase.javaAPI DocGlassfish v2 API21886Thu Jun 07 10:45:38 BST 2007com.sun.enterprise.deployment.phasing

J2EECPhase

public class J2EECPhase extends DeploymentPhase
This class represents the J2EEC phase of the deployment process. An application or module is prepared using the deployer and then registered with the config and a corresponding mbean registered with the mbean server
author
Sandhya E

Fields Summary
public static final Logger
sLogger
Deployment Logger object for this class
private static com.sun.enterprise.util.i18n.StringManager
localStrings
string manager
Constructors Summary
public J2EECPhase(DeploymentContext deploymentCtx)
Creates a new instance of J2EECPhase

param
deploymentCtx DeploymentContext object

   

                    
       
        this.deploymentCtx = deploymentCtx;
        this.name = J2EEC;
Methods Summary
private java.lang.StringgetContextRoot(com.sun.enterprise.deployment.WebBundleDescriptor wbd)

        String contextRoot = wbd.getContextRoot();
        if (!contextRoot.startsWith("/")) {
            contextRoot = "/" + contextRoot;
        }
        return contextRoot;
private java.lang.StringgetGeneratedAppLocation(com.sun.enterprise.deployment.backend.DeploymentRequest request)

        String xmlDir = request.getDescriptor().getGeneratedXMLDirectory();
        // for upgrade scenario, we fall back to the original location
        if (xmlDir == null || !FileUtils.safeIsDirectory(xmlDir)) {
            xmlDir = DeploymentServiceUtils.getLocation(
                        request.getName(), request.getType());
        }
        return xmlDir;
protected com.sun.enterprise.deployment.backend.DeploymentEventgetPostPhaseEvent(com.sun.enterprise.deployment.backend.DeploymentEventInfo info)
Event that will be broadcasted at the end of the phase

return
DeploymentEvent

        //FIXME change the event type and include a eventSource
        return new DeploymentEvent(DeploymentEventType.POST_DEPLOY, info);
protected com.sun.enterprise.deployment.backend.DeploymentEventgetPrePhaseEvent(com.sun.enterprise.deployment.backend.DeploymentEventInfo info)
Event that will be broadcasted at the start of the phase

param
info deployment event info
return
DeploymentEvent

        //FIXME change the event type and include a eventSource
        return new DeploymentEvent(DeploymentEventType.PRE_DEPLOY, info );
private voidparseAndValidateSunResourcesXMLFiles(com.sun.enterprise.deployment.backend.DeploymentRequest req)

        List<Resource> resourceList = DeploymentServiceUtils.getResourceList(
            req, true, deploymentCtx);
        ResourceUtilities.getResourceConflictsWithDomainXML(
            resourceList, DeploymentServiceUtils.getConfigContext());
private voidpopulateModuleIDs(com.sun.enterprise.deployment.backend.DeploymentStatus status, com.sun.enterprise.deployment.backend.DeploymentRequest request)
Populate the moduleID, subModuleID and ModuleType information. The returned data is constructed as follows: For example: a.ear contains b.jar, c.jar and d.war The entries in the DeploymentStatus additional properties are: (in key = value format) moduleid = a; a_moduletype = application; a_submoduleCount = 3; a_moduleid_0 = b; b_moduletype = ejb; a_moduleid_1 = c; c_moduletype = appclient; a_moduleid_2 = d; d_moduletype = web; d_contextroot= contextroot; Note that the actual construct of the submoduleID is a bit more complicated than what is in the example above. But the idea is the same.


        String sep = DeploymentStatus.KEY_SEPARATOR;

        //top module
        String key = DeploymentStatus.MODULE_ID;
        String moduleID = request.getName();
        status.addProperty(key, moduleID); //moduleID

        key =  com.sun.appserv.management.deploy.DeploymentStatus.MODULE_ID_KEY;
        status.addProperty(key, moduleID); //moduleID

        key = moduleID + sep + DeploymentStatus.MODULE_TYPE;
        ModuleType moduleType = request.getType().getModuleType();
        status.addProperty(key, String.valueOf(moduleType.getValue())); //moduleType

        //sub modules
        Application app = request.getDescriptor();
        if (app!=null) {
            if (!app.isVirtual()) {
                int counter = 0;
                for (Iterator it = app.getModules(); it.hasNext();) {
                    ModuleDescriptor md = (ModuleDescriptor) it.next();

                    key = moduleID + sep + 
                          DeploymentStatus.MODULE_ID + sep + 
                          String.valueOf(counter);
                    String subModuleID = moduleID + "#" + md.getArchiveUri();
                    status.addProperty(key, subModuleID); //subModuleID

                    key = subModuleID + sep + DeploymentStatus.MODULE_TYPE;
                    //subModuleType
                    status.addProperty(key, String.valueOf(md.getModuleType().getValue()));

                    if (ModuleType.WAR.equals(md.getModuleType())) {
                        WebBundleDescriptor wbd = 
                            (WebBundleDescriptor) md.getDescriptor();
                        key = subModuleID + sep + DeploymentStatus.CONTEXT_ROOT;
                        status.addProperty(key, getContextRoot(wbd)); //contextRoot
                    }
                    counter++;
                }

                key = moduleID + sep + DeploymentStatus.SUBMODULE_COUNT;
                status.addProperty(key, String.valueOf(counter)); //nums
            } else { //standalone module
                BundleDescriptor bd = app.getStandaloneBundleDescriptor();
                if (ModuleType.WAR.equals(bd.getModuleType())) {
                    WebBundleDescriptor wbd = (WebBundleDescriptor) bd;
                    key = moduleID + sep + DeploymentStatus.CONTEXT_ROOT;
                    status.addProperty(key, getContextRoot(wbd)); //contextRoot
                }
            }
        }
private voidpopulateStatusProperties(com.sun.enterprise.deployment.backend.DeploymentStatus status, com.sun.enterprise.deployment.backend.DeploymentRequest request)
This method populate the properties that will be returned from server to the client, including moduleID and list of wsdl files.

        DeploymentStatus mainStatus = status.getMainStatus();
        populateModuleIDs(mainStatus, request);
        if (request.getDescriptor() != null) {
            populateWsdlFilesForPublish(mainStatus, request); 
        }
private voidpopulateWsdlFilesForPublish(com.sun.enterprise.deployment.backend.DeploymentStatus status, com.sun.enterprise.deployment.backend.DeploymentRequest request)
Populate the wsdl files entries to download (if any).


        ModuleType moduleType = request.getType().getModuleType();
        //only EAR, WAR and EJB archives could contain wsdl files for publish
        if (!(ModuleType.EAR.equals(moduleType) ||
              ModuleType.WAR.equals(moduleType) ||
              ModuleType.EJB.equals(moduleType))) {
            return;
        }

        String sep = DeploymentStatus.KEY_SEPARATOR;
        Application app = request.getDescriptor();
        String moduleID = request.getName();
        AbstractArchive moduleArchive = null;
        String key = null;
        String keyPrefix = null;

        FileArchive archive = new FileArchive();
        archive.open(RelativePathResolver.resolvePath(
                        getGeneratedAppLocation(request)));

        for (Iterator it = app.getWebServiceDescriptors().iterator(); 
                it.hasNext();) {
            WebService webService = (WebService) it.next();
            // No work needed if webservice is configured for URL publishing
            if (!webService.hasFilePublishing()) {
                continue;
            }

            // For file publishing, URL is a file URL for a directory
            String clientPublishURL = 
                    webService.getClientPublishUrl().toExternalForm();
            if (app.isVirtual()) { //standalone module
                keyPrefix = moduleID;
                moduleArchive = archive;
            }  else {
                ModuleDescriptor md = 
                        webService.getBundleDescriptor().getModuleDescriptor();
                keyPrefix = moduleID + "#" + md.getArchiveUri();
                moduleArchive = archive.getEmbeddedArchive(md.getArchiveUri());
            }

            key = keyPrefix + sep + DeploymentStatus.WSDL_PUBLISH_URL;
            status.addProperty(key, clientPublishURL);

            // Collect the names of all entries in or below the 
            // dedicated wsdl directory.
            BundleDescriptor bundle = webService.getBundleDescriptor();
            Enumeration entries = moduleArchive.entries(bundle.getWsdlDir());

            // Strictly speaking, we only need to write the files needed by 
            // imports of this web service's wsdl file.  However, it's not
            // worth actual parsing the whole chain just to figure this
            // out.  In the worst case, some unnecessary files under 
            // META-INF/wsdl or WEB-INF/wsdl will be written to the publish
            // directory.
            int counter = 0;
            while(entries.hasMoreElements()) {
                String name = (String) entries.nextElement();
                key = keyPrefix + sep + DeploymentStatus.WSDL_FILE_ENTRIES +
                            sep + String.valueOf(counter);
                status.addProperty(key, stripWsdlDir(name,bundle));

                //full path to the wsdl file location on the server
                String wsdlFileLocation = 
                        moduleArchive.getArchiveUri() + File.separator + 
                        name.replace('/", File.separatorChar);
                key = key + sep + DeploymentStatus.WSDL_LOCATION;
                status.addProperty(key, wsdlFileLocation);
                counter++;
            }
            key = keyPrefix + sep + DeploymentStatus.WSDL_FILE_ENTRIES 
                    + sep + DeploymentStatus.COUNT;
            status.addProperty(key, String.valueOf(counter));
        }
public voidrunPhase(DeploymentPhaseContext phaseCtx)
Phase specific execution logic will go in this method. Any phase implementing this class will provide its implementation for this method. preDeploy notifications are sent from the deployment backend(deployer) to the cmp module.

param
phaseCtx the DeploymentPhaseContext object

        boolean wasUnRegistered = false;
        String	type		= null;
        boolean   isApp		= false;
        boolean	isRedeploy	= false;
        int		actionCode	= -1;
        String	targetName  = null;
        DeploymentTarget target = null;
        DeploymentRequest req = phaseCtx.getDeploymentRequest();
        DeploymentStatus status = phaseCtx.getDeploymentStatus();

        Deployer deployer = null;
        try {
            DeploymentCallback callback = req.getDeploymentCallback();
            if (callback != null) {
                int percent = 0;
                DeploymentProgress progress = new DeploymentProgressImpl(
                    (byte)percent, "deployment started", null);
                callback.deploymentProgress(progress);
            }
        
            // set the current deployment status in deployment request
            // to J2EECPhase deployment status
            req.setCurrentDeploymentStatus(status);

            req.setDescriptor(deploymentCtx.getApplication(req.getName()));

            deployer = DeployerFactory.getDeployer(req);
            
            //prePhaseNotify(getPrePhaseEvent(deployer.getPreEventInfo()));
            if(req.isApplication())
                isApp = true;
            
            deployer.doRequestPrepare();
            
            // the isReDeploy() call *must* come after doRequestPrepare() for modules.
            if(req.isReDeploy()) {
                isRedeploy = true;

                //Re-record instrospect/instrument/verifier data if
                //any of the application is re-deployed
                if (AppVerification.doInstrument()) {
                    AppVerification.getInstrumentLogger().handleChangeInDeployment();
                }
            }
            
            if(isRedeploy) {
                // clear the deploymentCtx cache now
                deploymentCtx.removeApplication(req.getName());               
                req.setDescriptor(null);

                target = (DeploymentTarget)req.getTarget();
                
                // In the case of redeploy to domain,
                // no stop event will be sent.
                if(target != null && ! target.getName().equals("domain")) {
                    targetName = target.getName();
                
                    if(isApp) {
                        type = null;
                        actionCode	= BaseDeployEvent.APPLICATION_UNDEPLOYED;
                    }
                    else {
                        type = DeploymentServiceUtils.getModuleTypeString(req.getType());
                        actionCode	= BaseDeployEvent.MODULE_UNDEPLOYED;
                    }
                    DeploymentServiceUtils.multicastEvent(actionCode, req.getName(), type, req.getCascade(), req.isForced(),  targetName);
                    wasUnRegistered = true;
                }
            }
            
            deployer.doRequestFinish();

            // cache the updated application object in deployment context 
            deploymentCtx.addApplication(req.getName(), req.getDescriptor());
 
            parseAndValidateSunResourcesXMLFiles(req);

            // check if an abort operation has been issued
            // throw exception if true
            DeploymentServiceUtils.checkAbort(req.getName());

            // do all the config update at the end for easy rollback
            if(isRedeploy) {
                DeploymentServiceUtils.updateConfig(req);
            } else {
                DeploymentServiceUtils.addToConfig(req);
            }
 
            // set context roots on config bean
            ApplicationConfigHelper.resetAppContextRoots(
                DeploymentServiceUtils.getConfigContext(), req.getName(), 
                true);

            wasUnRegistered = false;	// addToConfig re-registered it...

            deployer.cleanup();
            
            // everything went fine
            status.setStageStatus(DeploymentStatus.SUCCESS);            
            
            // some useful information for clients...
            sLogger.log(Level.INFO, "deployed with " + DeploymentProperties.MODULE_ID + " = " + req.getName());
            populateStatusProperties(status, req);
            if (callback != null) {
                int percent = 100;
                DeploymentProgress progress2 = new DeploymentProgressImpl(
                    (byte)percent, "deployment finished", null);
                callback.deploymentProgress(progress2);
            }
         
        } catch(Throwable t) {
            String msg =
            localStrings.getString("enterprise.deployment.phasing.j2eec.error" );
            if (t.getCause()!= null) 
                msg += t.getCause().toString();

            // For any failure during the J2EEC phase (during fresh deploy or redeploy), cleanup the domain.xml
            // so that the config is left in a clean state without any hanging j2ee-app/module elements without
            // any app-refs;
            // the target==null check ensures that this code is done for 8.1 only thereby preserving same
            // behavior for 8.0 apps
            try {
                if (target == null) {
                    if (deployer != null) {
                        deployer.removePolicy();
                    }
                    DeploymentServiceUtils.removeFromConfig(req.getName(),
                        req.getType());
                }
            } catch (Exception eee){}

            if(isRedeploy && wasUnRegistered && t instanceof IASDeploymentException && req.getReRegisterOnFailure()) {
                // DBE rollback re-registered.  We need to notify to get it reloaded now.
                if(isApp)
                    actionCode = BaseDeployEvent.APPLICATION_DEPLOYED;
                else
                    actionCode = BaseDeployEvent.MODULE_DEPLOYED;
                
                try {
                    DeploymentServiceUtils.multicastEvent(actionCode, req.getName(), type, req.getCascade(), req.isForced(), targetName);
                }
                catch(Throwable t2) {
                    msg += t2;
                }
            }
            // log
            sLogger.log(Level.SEVERE, msg, t);
            
            // we now update our status
            status.setStageStatus(DeploymentStatus.FAILURE);
            if (t instanceof java.io.Serializable) {
                status.setStageException(t);
            } else {
                sLogger.severe(localStrings.getString("enterprise.deployment.phasing.exception_notserializable", t.getClass()));
                sLogger.severe(localStrings.getString("enterprise.deployment.phasing.exception_notforwarded", t.getMessage()));
            }
            status.setStageStatusMessage(t.getMessage());
        }
private java.lang.StringstripWsdlDir(java.lang.String entry, com.sun.enterprise.deployment.BundleDescriptor bundle)
Return the entry name without "WEB-INF/wsdl" or "META-INF/wsdl".

        String wsdlDir = bundle.getWsdlDir();
        return entry.substring(wsdlDir.length()+1);