<change id="UpdateAllResources">

         <api name="exec-property"/>

         <summary>Disable creation of resources cache</summary>

         <version major="1" minor="XXX"/>

         <date day="1" month="4" year="2013"/>

         <author login="jtulach"/>

         <compatibility addition="yes" binary="compatible" semantic="compatible" />

         <description>

             <p>

                 New <a href="architecture-summary.html#systemproperty-org.netbeans.core.update.all.resources">property API

                 </a> to control creation of <code>all-resources.data</code> cache

                 after start.

             </p>

         </description>

         <issue number="227802"/>

     </change>

      <api name="org.netbeans.core.update.all.resources" 

           category="devel" type="export" group="systemproperty">

          <p>

          Some applications built on top of NetBeans Platform expressed

          an option that certain files in caches, namely 

          <a href="@org-netbeans-bootstrap@/architecture-summary.html#java.io.File-all-resources.dat">

          all-resources.dat</a>

          can be too big and that this is not good for multi-user installation.

          To give such applications control over creation of this file, there

          is a property to (conditionally) disable the creation of the cache file.

          </p>

          <p>

          Change value of <code>org.netbeans.core.update.all.resources</code> property

          in launcher configuration file or provide it as a virtual machine

          parameter on command line.

          Set it to <code>never</code>, <code>always</code> or <code>missing</code>.

          The default is to regenerate and update the cache <em>always</em>. 

          Value <em>missing</em> means to generate

          the cache only if it has not been previously available (even in 

          installation location). Setting the value to <em>never</em> will

          never disable the creation of the cache after start completely.

          </p>

          <p>

          Changing default value of the property may be particulary useful when there is a shared

          installation of the application, there are many users with a home

          (and cache) directory on a slow (network) file system and it is 

          expected most of them won't install additional modules into their

          own user directory.

          </p>

      </api>

# possible values: always, never, missing

#NOI18N

UpdateAllResources=always

    static boolean updateAllResources() {

        String value = System.getProperty("org.netbeans.core.update.all.resources", "always");

        if (!"never".equals(value)) { // NOI18N

            if ("missing".equals(value)) { // NOI18N

                if (!org.netbeans.JarClassLoader.isArchivePopulated()) {

                    org.netbeans.JarClassLoader.saveArchive();

                    return true;

                }

            } else {

                assert "always".equals(value); // NOI18N

                org.netbeans.JarClassLoader.saveArchive();

                return true;

            }

        }

        return false;

    }

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 2013 Oracle and/or its affiliates. All rights reserved.

 *

 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.

 * Other names may be trademarks of their respective owners.

 *

 * 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

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. 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

 * nbbuild/licenses/CDDL-GPL-2-CP.  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. 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]"

 *

 * 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 do not 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.

 *

 * Contributor(s):

 *

 * Portions Copyrighted 2013 Sun Microsystems, Inc.

 */

package org.netbeans.core.startup;

import java.lang.reflect.Constructor;

import java.lang.reflect.Field;

import java.lang.reflect.Method;

import static junit.framework.Assert.assertTrue;

import org.netbeans.JarClassLoader;

import org.netbeans.Stamps;

import org.netbeans.junit.NbTestCase;

/**

 *

 * @author Jaroslav Tulach <jtulach@netbeans.org>

 */

public class UpdateAllResourcesTest extends NbTestCase{

    public UpdateAllResourcesTest(String name) {

        super(name);

    }

    @Override

    protected void setUp() throws Exception {

        clearWorkDir();

        System.setProperty("netbeans.user", getWorkDirPath());

        System.getProperties().remove("org.netbeans.core.update.all.resources");

        resetStamps();

    }

    public void testByDefaultTheArchiveIsUpdated() {

        assertTrue("Update was scheduled", Main.updateAllResources());

    }

    public void testNeverUpdate() {

        System.setProperty("org.netbeans.core.update.all.resources", "never");

        assertFalse("Update was not", Main.updateAllResources());

    }

    public void testUpdateAsNotPopulated() throws Exception {

        System.setProperty("org.netbeans.core.update.all.resources", "missing");

        populateCache(false);

        assertFalse("No previous all-resources.dat", JarClassLoader.isArchivePopulated());

        assertTrue("Performs the update", Main.updateAllResources());

    }

    public void testDontUpdateWhenPopulated() throws Exception {

        System.setProperty("org.netbeans.core.update.all.resources", "missing");

        populateCache(true);

        assertFalse("No need to update, everything is populated", Main.updateAllResources());

    }

    private static void populateCache(boolean prep) throws Exception {

        Method init = JarClassLoader.class.getDeclaredMethod("initializeCache");

        init.setAccessible(true);

        init.invoke(null);

        Field fld = JarClassLoader.class.getDeclaredField("archive");

        fld.setAccessible(true);

        Object obj = fld.get(null);

        assertNotNull("Archive is initialized", obj);

        Constructor<? extends Object> cnstr = obj.getClass().getDeclaredConstructor(boolean.class);

        cnstr.setAccessible(true);

        fld.set(null, cnstr.newInstance(prep));

        assertEquals("Previous all-resources.dat", prep, JarClassLoader.isArchivePopulated());

    }

    private static void resetStamps() throws Exception {

        final Method m = Stamps.class.getDeclaredMethod("main", String[].class);

        m.setAccessible(true);

        m.invoke(null, (Object) new String[]{"reset"});

    }

}

            <p>

            One can control creation of the <code>all-resources.dat</code> file in

            the user directory via 

            <a href="@org-netbeans-core-startup@/architecture-summary.html#systemproperty-org.netbeans.core.update.all.resources">

                org.netbeans.core.update.all.resources

            </a> property.

            </p>

    Archive(boolean prep) {

        gathering = false;

        active = false;

        prepopulated = prep;

    }

    final boolean isPopulated() {

        return prepopulated;

    }

    /** Check whether the archive has already been populated during 

     * previous executions.

     * 

     * @return true, if the archive is ready and non-empty

     * @since 1.XXX

     */

    public static boolean isArchivePopulated() {

        return archive != null && archive.isPopulated();

    }