alvinalexander.com | career | drupal | java | mac | mysql | perl | scala | uml | unix  

Glassfish example source code file (ClientJarMakerThread.java)

This example Glassfish source code file (ClientJarMakerThread.java) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Java - Glassfish tags/keywords

boolean, boolean, client_jar_choices, default_choice, deploymentcontext, deploymentcontext, file, io, log, logging, properties, properties, rootdeploymentdescriptor, set, string, string, util, zipitem

The Glassfish ClientJarMakerThread.java source code

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package org.glassfish.appclient.server.core;

import org.glassfish.deployment.common.DeploymentException;
import com.sun.enterprise.deployment.Application;
import com.sun.enterprise.deployment.ApplicationClientDescriptor;
import com.sun.enterprise.deploy.shared.ArchiveFactory;
import org.glassfish.api.deployment.archive.ReadableArchive;
import org.glassfish.api.deployment.archive.WritableArchive;
import com.sun.enterprise.deployment.RootDeploymentDescriptor;
import com.sun.enterprise.deployment.util.ModuleDescriptor;
import com.sun.enterprise.deployment.util.DOLUtils;
import com.sun.enterprise.util.i18n.StringManager;
import com.sun.enterprise.util.io.FileUtils;
import com.sun.enterprise.util.zip.ZipItem;
import org.glassfish.internal.api.Globals;
import org.glassfish.api.deployment.DeploymentContext;
import org.glassfish.api.deployment.OpsParams;

import java.io.File;
import java.util.logging.Level;
import java.util.Properties;
import java.util.Set;

/**
 * This thread subclass is responsible for creating the client jar
 * file.
 *
 * @author Jerome Dochez
 */
public class ClientJarMakerThread extends Thread {

    private DeploymentContext dc;
    private File clientJar;
    private ZipItem[] clientStubs;
    private String clientJarChoice = null;
    
    private static StringManager localStrings = StringManager.getManager(ClientJarMakerThread.class );
    
    /** Creates a new instance of ClientJarMakerThread */
    public ClientJarMakerThread(DeploymentContext dc, File clientJar, 
                                ZipItem[] clientStubs, 
                                String clientJarChoice) {
        this.dc = dc;
        this.clientJar = clientJar;
        this.clientStubs = clientStubs;
        this.clientJarChoice = clientJarChoice;
    }
    
    public void run() {
        // first thing to do is to register ourselves in the 
        // client jar maker registry
        ClientJarMakerRegistry registry = ClientJarMakerRegistry.getInstance();
        
        String moduleID = dc.getCommandParameters(OpsParams.class).name();
        registry.register(moduleID, this);
        
        // now we build the client jar file 
        try {
            createClientJar(dc, clientJar, clientStubs, clientJarChoice);
        } catch(DeploymentException e) {
            // unfortunetely, we cannot provide failures feedback to the client
            // at this point, but we certainly need to log it.
            DOLUtils.getDefaultLogger().log(Level.SEVERE, 
                localStrings.getString("enterprise.deployment.error_creating_client_jar", 
                    e.getLocalizedMessage()) ,e);
        
        } finally {
            
            // we are done, unregister ouselves from the registry
            registry.unregister(moduleID);
        }
        
        // friendly log
        if (DOLUtils.getDefaultLogger().isLoggable(Level.FINE)) {
            DOLUtils.getDefaultLogger().fine("Created client jar file for " + moduleID + " at " + clientJar.getAbsolutePath());
        }
        
    }
   
    /**
     * this method is called from the thread to create the client jar or 
     * synchronously from the Deployer 
     */
    public static final void createClientJar(
        DeploymentContext dc, File clientJar, ZipItem[] clientStubs, 
        String clientJarChoice) throws DeploymentException {
        try {         
            ArchiveFactory archiveFactory = Globals.
                getDefaultHabitat().getComponent(ArchiveFactory.class);

            // client jar naming convension is <app-name>Client.jar
            WritableArchive target = archiveFactory.createArchive(clientJar);
            
            RootDeploymentDescriptor descriptor;

            Application app = dc.getModuleMetaData(Application.class);
 
            if (app.isVirtual()) {
                descriptor = app.getStandaloneBundleDescriptor();
            } else {
                descriptor = app;
            }

            ReadableArchive source = archiveFactory.openArchive(
                dc.getSourceDir());

            PEDeploymentFactoryImpl pe = new PEDeploymentFactoryImpl();
            Properties props = getPropertiesForClientJarMaker(
                CLIENT_JAR_CHOICES.getClientJarChoice(clientJarChoice),
                dc, descriptor);
            ClientJarMaker jarMaker = pe.getClientJarMaker(props);

            // copy xml files from generated directory archive to original 
            // directory archive so the created client jar contain 
            // processed xml files.
            if (FileUtils.safeIsDirectory(dc.getScratchDir("xml"))) {
                ReadableArchive source2 = archiveFactory.openArchive(
                    dc.getScratchDir("xml"));
                jarMaker.create(descriptor, source, source2, target, 
                    clientStubs, null);
                source2.close();
            } else {
                jarMaker.create(descriptor, source, target, clientStubs, null);
            }
            source.close();
            target.close();
        } catch(Exception e) {
            DeploymentException newE = new DeploymentException();
            newE.initCause(e);
            throw newE;
        }
    }

    private static Properties getPropertiesForClientJarMaker(
        CLIENT_JAR_CHOICES choice,
        DeploymentContext dc, RootDeploymentDescriptor descriptor) {
      
        boolean qualify = qualifyModuleClientFormat(dc, descriptor);

        Properties props = null;
        Boolean propertySetting = choice.useModuleClientJarMaker(qualify);

        if (propertySetting != null) {
            props = new Properties();
            props.setProperty(
                DeploymentImplConstants.USE_MODULE_CLIENT_JAR_MAKER, 
                propertySetting.toString());
        }
        return props;
    }

    /**
     * This method determines if the generated appclient jar should be in
     * the standalone appclient module format. There are 3 cases to create
     * the simpler version of the generated appclient:
     * 1) deployed module is a standalone appclient/ejb
     * 2) deployed module is an ear containing 0 or 1 appclient jar
     * 3) deployed module does not contain appclient that uses persistence unit
     */
    private static boolean qualifyModuleClientFormat
        (DeploymentContext dc, RootDeploymentDescriptor descriptor) {

        // create appclient format for standalone appclient module
        if (dc.getModuleMetaData(Application.class).isVirtual()) {
            return true;
        }

        Application app = Application.class.cast(descriptor);
        Set appClients = app.getApplicationClientDescriptors();
        if (appClients != null) {
    
            // create ear format of appclient if there are more than
            // one appclients in the ear file
            if (appClients.size() > 1) {
                return false;
            }

            if (!appClients.isEmpty()) {
                ApplicationClientDescriptor ac = 
                ApplicationClientDescriptor.class.cast(appClients.iterator().next());

                // checks to see if this appclient has entries for
                // message-destination-ref.  if so, use ear format
                Set msgDestRefs = ac.getMessageDestinationReferenceDescriptors();
                if (msgDestRefs != null && !msgDestRefs.isEmpty()) {
                    return false;
                }

                // checks to see if this appclient depends on a PU.
                // if so, use ear format
                Set entityMgrFacRefs = ac.getEntityManagerFactoryReferenceDescriptors();
                if (entityMgrFacRefs != null && !entityMgrFacRefs.isEmpty()) {
                    return false;
                }
            }
        }

        for (ModuleDescriptor md : app.getModules()) {
            // checks to see if any of the sub modules uses altDD
            // if so, use the application package format.  we could
            // also choose to override the original dd with the altDD,
            // but that might get very confusing when someone is trying
            // to debug.
            if (md.getAlternateDescriptor() != null) {
                return false;
            }
        }

        return true;
    }

    private static enum CLIENT_JAR_CHOICES {

        //original implementation, for comparing behavior regression
        USE_ORIGINAL_MAKER {
        public Boolean useModuleClientJarMaker(boolean qualify) {
            return null;}},

        //transitional default option. only turn on the generation of the
        //appclient module format
        USE_TRANSITION_MAKER {
        public Boolean useModuleClientJarMaker(boolean qualify) {
            return qualify == true ? Boolean.TRUE : null;}},

        //alternative default option. generate appclient module format
        //or the ear module format accordingly
        USE_COMBO_MAKER {
        public Boolean useModuleClientJarMaker(boolean qualify) {
            return new Boolean(qualify);}},

        //current default. generate only the ear module format, i.e. no 
        //optimization on certain deployed ear
        USE_EAR_MAKER {
        public Boolean useModuleClientJarMaker(boolean qualify) {
            return Boolean.FALSE;}};
       
        public abstract Boolean useModuleClientJarMaker(boolean qualify);
       
        public static CLIENT_JAR_CHOICES DEFAULT_CHOICE = USE_EAR_MAKER;
       
        public static CLIENT_JAR_CHOICES getClientJarChoice(String choice) {
            try {
                if (choice == null) {
                    return DEFAULT_CHOICE;
                }
                return valueOf(choice);
            } catch (IllegalArgumentException iae) {
                return DEFAULT_CHOICE;
            }
        }
    }
}

Other Glassfish examples (source code examples)

Here is a short list of links related to this Glassfish ClientJarMakerThread.java source code file:

... this post is sponsored by my books ...

#1 New Release!

FP Best Seller

 

new blog posts

 

Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.