org.netbeans.modules.derby.DerbyRegistration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org-netbeans-modules-derby
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.netbeans.modules.derby;

import java.io.File;
import java.io.IOException;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.openide.filesystems.FileObject;
import org.openide.filesystems.FileUtil;

/**
 * Registers installation of JavaDB by creating instance file in cluster config
 * directory. Designed to be called from installer.
 * The DerbyRegistration can called multiple times but only the first invocation
 * is stored.
 * 
 * Sample command line

 *
 * java -cp platform/core/core.jar:platform/lib/boot.jar:platform/lib/org-openide-modules.jar:
 *          platform/core/org-openide-filesystems.jar:platform/lib/org-openide-util.jar:
 *          platform/lib/org-openide-util-lookup.jar:ide/modules/org-netbeans-modules-derby.jar
 *             org.netbeans.modules.derby.DerbyRegistration nb /usr/local/share/java/jdk1.6.0_18/db
 *
 * @author Jiri Rechtacek
 * @see #main(args)
 */
public class DerbyRegistration {

    private static final String DERBY_REGISTRATION_DIR = "JavaDB"; // NOI18N
    private static final String DERBY_REGISTRATION_FILE = "registration_instance"; // NOI18N
    private static final String ATTR_DERBY_HOME = "javadb_installation_home"; // NOI18N
    private static final Logger LOGGER = Logger.getLogger(DerbyRegistration.class.getName());

    /**
     * Performs registration.
     *
     * Exit codes:

     * 

     *    2: could not find/create config/JavaDB folder
     *   
 3: could not find JavaDB installation home
     *   
 4: JavaDB installation doesn't contain expected libraries, i.e. lib/derbyclient.jar
     *   
 5: could not write registration FileObject
     * 
     * @param args command line arguments - cluster path and Derby home expected
     */
    public static void main(String[] args) throws IOException {
        if (args.length < 2) {
            System.out.println("Parameters:  ");
            System.exit(-1);
        }

        int status = registerDerbyInstallation(args[0], args[1]);
        System.exit(status);
    }

    private static int registerDerbyInstallation(String cluster, String derbyHome) throws IOException {
        LOGGER.log(Level.FINE, "Cluster for JavaDB registration is " + cluster);
        System.setProperty("netbeans.user", cluster); // NOI18N
        // check writable cluster
        FileObject javaDBRegistrationDir = FileUtil.getConfigFile(DERBY_REGISTRATION_DIR);

        if (javaDBRegistrationDir == null) {
            javaDBRegistrationDir = FileUtil.createFolder(FileUtil.getConfigRoot(), DERBY_REGISTRATION_DIR);
            if (javaDBRegistrationDir == null) {
                LOGGER.log(Level.INFO, "Cannot register the default JavaDB. The config/" + DERBY_REGISTRATION_DIR + " folder cannot be created."); // NOI18N
                return 2;
            }
        }

        // check if exists
        File derbyHomeFile = new File(derbyHome);
        if (!derbyHomeFile.exists()) {
            LOGGER.log(Level.INFO, "Cannot register the default JavaDB. " // NOI18N
                    + "The JavaDB installation directory " + derbyHome // NOI18N
                    + " does not exist."); // NOI18N
            return 3;
        }

        // check if solid JavaDB home
        if (! Util.isDerbyInstallLocation(derbyHomeFile)) {
            LOGGER.log(Level.INFO, "Cannot register the default JavaDB. " // NOI18N
                    + "The JavaDB installation directory " + derbyHome // NOI18N
                    + " does not contain expected libraries."); // NOI18N
            return 4;
        }

        FileObject registrationFO = FileUtil.getConfigFile(DERBY_REGISTRATION_DIR + "/" + DERBY_REGISTRATION_FILE); // NOI18N
        if (registrationFO == null) {
            try {
                registrationFO = javaDBRegistrationDir.createData(DERBY_REGISTRATION_FILE);
                registrationFO.setAttribute(ATTR_DERBY_HOME, derbyHome);
                LOGGER.log(Level.FINE, "New registration links to " + registrationFO.getAttribute(ATTR_DERBY_HOME)); // NOI18N
            } catch (IOException e) {
                LOGGER.log(Level.INFO, "Cannot register JavaDB, cause " + e.getLocalizedMessage(), e); // NOI18N
                return 5;
            }
        } else {
            LOGGER.log(Level.INFO, "The previous registration found. Links to " + registrationFO.getAttribute(ATTR_DERBY_HOME)); // NOI18N
        }

        return 0;
    }

    public static String getRegisteredDerbyHome () {
        FileObject registrationFO = FileUtil.getConfigFile(DERBY_REGISTRATION_DIR + "/" + DERBY_REGISTRATION_FILE); // NOI18N
        String home = (String) (registrationFO == null ? null : registrationFO.getAttribute(ATTR_DERBY_HOME));
        LOGGER.log(Level.FINE, "Registered home is " + home);
        return home;
    }

}