org.glassfish.embed.EmbeddedInfo Maven / Gradle / Ivy

Go to download
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 1997-2008 Sun Microsystems, Inc. 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.html
 * or glassfish/bootstrap/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 glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [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.embed;

import java.io.*;
import java.util.*;
import java.net.*;
import org.glassfish.api.deployment.archive.ReadableArchive;
import org.glassfish.embed.util.StringUtils;
import static org.glassfish.embed.ServerConstants.*;

/**
 * 
 * @author bnevins
 */
public class EmbeddedInfo {

    public EmbeddedInfo() {
        
    }
    
    public void addArchive(File f) {
        archives.add(f);
    }

    public void addScatteredWar(ScatteredWar sw) {
        throw new UnsupportedOperationException("Not yet implemented");
        //scatteredWars.add(sw);
    }
    
    public void addReadableArchive(ReadableArchive ra) {
        throw new UnsupportedOperationException("Not yet implemented");
        //readableArchives.add(ra);
    }
    
    public void setHttpPort(int port) {
        httpPort = port;
    }

    public void setDomainXmlUrl(URL dx) {
        domainXmlUrl = dx;
    }

    public void setServerName(String newName) {
        if(StringUtils.ok(newName))
            name = newName;
    }


    public void validate() throws EmbeddedException {

        /* bnevins 11-18-08, no longer require an app right away.
         if(!isDeployable())
            throw new EmbeddedException("nothing_to_do");
         */

        validateArchives();
        validatePort();
        validateFilesystem();
    }

    public void setFileSystemRoot(File f) throws EmbeddedException {
        EmbeddedFileSystem.setRoot(f);
    }

    @Override
    public String toString() {
        // TODO Finish it...
        StringBuilder sb = new StringBuilder("Dump of " + getClass().getName());
        sb.append('\n');
        sb.append("httpPort=").append(httpPort).append('\n');
        
        return sb.toString();
    }

    //////////////////////  pkg-private  //////////////////////
    
    String                  name             = ServerConstants.DEFAULT_SERVER_NAME;
    int                     httpPort         = ServerConstants.DEFAULT_HTTP_PORT;
    List              archives         = new LinkedList(); 
    List   readableArchives = new LinkedList();
    List      scatteredWars    = new LinkedList();
    URL                     domainXmlUrl;


    //////////////////////  all private below //////////////////////

    private void validateArchives() throws EmbeddedException {
        for(File f : archives) {
            // at least make sure it exists
            if(!f.exists())
                throw new EmbeddedException("no_such_file", f);
        }
    }

    private void validateFilesystem() {
        //throw new UnsupportedOperationException("Not yet implemented");
    }
    
    private void validatePort() throws EmbeddedException {
        if(httpPort < MIN_PORT || httpPort > MAX_PORT)
            throw new EmbeddedException("bad_port", MIN_PORT, MAX_PORT, httpPort);
    }

    private boolean isDeployable() {
        // is ther at least one deployable item?
        return 
                archives.size() > 0 || 
                readableArchives.size() > 0 || 
                scatteredWars.size() > 0;
    }

    //////////////////////   private variables  ////////////////////////////////
    
}