RuntimeEnvironment.java revision 77
58N/A * CDDL HEADER START 58N/A * The contents of this file are subject to the terms of the 58N/A * Common Development and Distribution License (the "License"). 58N/A * You may not use this file except in compliance with the License. 58N/A * language governing permissions and limitations under the License. 58N/A * When distributing Covered Code, include this CDDL HEADER in each 58N/A * If applicable, add the following below this CDDL HEADER, with the 58N/A * fields enclosed by brackets "[]" replaced with your own identifying 58N/A * information: Portions Copyright [yyyy] [name of copyright owner] 1291N/A * Copyright 2006 Sun Microsystems, Inc. All rights reserved. 1356N/A * Use is subject to license terms. 1016N/A * The RuntimeEnvironment class is used as a placeholder for the current 1436N/A * configuration this execution context (classloader) is using. 77N/A * Get the one and only instance of the RuntimeEnvironment 77N/A * @return the one and only instance of the RuntimeEnvironment 1327N/A * Creates a new instance of RuntimeEnvironment. Private to ensure a 1436N/A * Get the path to the where the index database is stored 1436N/A * @return the path to the index database 58N/A * Get a file representing the index database 65N/A * @return the index database 1026N/A * Set the path to where the index database is stored 129N/A * @param data the index database 1100N/A * @throws IOException if the path cannot be resolved 253N/A * Set the path to where the index database is stored 296N/A * @param dataRoot the index database 1416N/A * Get the path to where the sources are located 1185N/A * @return path to where the sources are located 993N/A * Get a file representing the directory where the sources are located 1185N/A * @return A file representing the directory where the sources are located 1185N/A * @param source the location of the sources 1436N/A * @throws IOException if the name cannot be resolved 1185N/A * @param sourceRoot the location of the sources 993N/A * @return true if we have projects 993N/A * Get all of the projects 993N/A * @return a list containing all of the projects (may be null) 58N/A * Set the list of the projects 58N/A * @param projects the list of projects to use 870N/A * subsequent calls to the RuntimeEnvironment from this thread will use 870N/A * the same configuration 129N/A * Get the context name of the web application 129N/A * @return the web applications context name 296N/A * Set the web context name 335N/A * @param urlPrefix the web applications context name 1185N/A * Get the name of the ctags program in use 58N/A * @return the name of the ctags program in use 1461N/A * Specify the CTags program to use 1185N/A * @param ctags the ctags program to use 1461N/A * Get the max time a SMC operation may use to avoid beeing cached 1185N/A * Specify the maximum time a SCM operation should take before it will 1185N/A * @param historyReaderTimeLimit the max time in ms before it is cached 1461N/A * Is history cache currently enabled? 1461N/A * @return true if history cache is enabled 1190N/A * Specify if we should use history cache or not 1461N/A * @param useHistoryCache set false if you do not want to use history cache 1185N/A * Should we generate HTML or not during the indexing phase 1185N/A * @return true if HTML should be generated during the indexing phase 58N/A * Specify if we should generate HTML or not during the indexing phase 58N/A * @param generateHtml set this to true to pregenerate HTML 58N/A * Get the map of external SCM repositories available 58N/A * @return A map containing all available SCMs 1461N/A * Set the map of external SCM repositories 1461N/A * @param repositories the repositories to use 1461N/A * Set the project that is specified to be the default project to use. The 1461N/A * default project is the project you will search (from the web application) 1461N/A * if the page request didn't contain the cookie.. 1461N/A * @param defaultProject The default project to use 1461N/A * Get the project that is specified to be the default project to use. The 1461N/A * default project is the project you will search (from the web application) 816N/A * if the page request didn't contain the cookie.. 816N/A * @return the default project (may be null if not specified) 816N/A * Read an configuration file and set it as the current configuration. 816N/A * @param file the file to read 816N/A * @throws IOException if an error occurs 58N/A * Write the current configuration to a file 58N/A * @param file the file to write the configuration into 58N/A * @throws IOException if an error occurs 58N/A * Write the current configuration to a socket 58N/A * @param host the host address to receive the configuration 58N/A * @param port the port to use on the host 773N/A * @throws IOException if an error occurs 773N/A * Try to stop the configuration listener thread 1436N/A * Start a thread to listen on a socket to receive new configurations 773N/A * @param endpoint The socket address to listen on 773N/A * @return true if the endpoint was available (and the thread was started)