RuntimeEnvironment.java revision 1100
349N/A * The contents of this file are subject to the terms of the 349N/A * Common Development and Distribution License (the "License"). 349N/A * You may not use this file except in compliance with the License. 349N/A * language governing permissions and limitations under the License. 349N/A * When distributing Covered Code, include this CDDL HEADER in each 349N/A * If applicable, add the following below this CDDL HEADER, with the 349N/A * fields enclosed by brackets "[]" replaced with your own identifying 349N/A * information: Portions Copyright [yyyy] [name of copyright owner] 349N/A * Copyright (c) 2006, 2010, Oracle and/or its affiliates. All rights reserved. 349N/A * The RuntimeEnvironment class is used as a placeholder for the current 349N/A * configuration this execution context (classloader) is using. 349N/A * Get the one and only instance of the RuntimeEnvironment 349N/A * @return the one and only instance of the RuntimeEnvironment 349N/A * Creates a new instance of RuntimeEnvironment. Private to ensure a 349N/A * Get the path to the where the index database is stored 349N/A * @return the path to the index database 349N/A * Get a file representing the index database 349N/A * @return the index database 349N/A * Set the path to where the index database is stored 349N/A * @param dataRoot the index database 349N/A * Get the path to where the sources are located 415N/A * @return path to where the sources are located 350N/A * Get a file representing the directory where the sources are located 350N/A * @return A file representing the directory where the sources are located 350N/A * Specify the source root 350N/A * @param sourceRoot the location of the sources 350N/A * Returns a path relative to source root. This would just be a simple 350N/A * substring operation, except we need to support symlinks outside the 349N/A * @param file A file to resolve * @param stripCount Number of characters past source root to strip * @throws IOException If an IO error occurs * @throws FileNotFoundException If the file is not relative to source root * @return Path relative to source root * @return true if we have projects * Get all of the projects * @return a list containing all of the projects (may be null) * Set the list of the projects * @param projects the list of projects to use * subsequent calls to the RuntimeEnvironment from this thread will use * Get the context name of the web application * @return the web applications context name * Set the web context name * @param urlPrefix the web applications context name * Get the name of the ctags program in use * @return the name of the ctags program in use * Specify the CTags program to use * @param ctags the ctags program to use * Validate that I have a Exuberant ctags program I may use * @return true if success, false otherwise "(tried running " +
"{0}" +
")\n" +
"Please use option -c to specify path to a good Exuberant Ctags program",
getCtags());
* Get the max time a SMC operation may use to avoid beeing cached * Specify the maximum time a SCM operation should take before it will * @param historyReaderTimeLimit the max time in ms before it is cached * Is history cache currently enabled? * @return true if history cache is enabled * Specify if we should use history cache or not * @param useHistoryCache set false if you do not want to use history cache * Should the history cache be stored in a database instead of in XML * @return {@code true} if the cache should be stored in a database * Set whether the history cache should be stored in a database. * @param store {@code true} if the cache should be stored in a database * Should we generate HTML or not during the indexing phase * @return true if HTML should be generated during the indexing phase * Specify if we should generate HTML or not during the indexing phase * @param generateHtml set this to true to pregenerate HTML * Set if we should compress the xref files or not * @param compressXref set to true if the generated html files should be * Are we using copressed HTML files? * @return true if the html-files should be compressed. false otherwise * Set the map of external SCM repositories * @param repositories the repositories to use * Set the project that is specified to be the default project to use. The * default project is the project you will search (from the web application) * if the page request didn't contain the cookie.. * @param defaultProject The default project to use * Get the project that is specified to be the default project to use. The * default project is the project you will search (from the web application) * if the page request didn't contain the cookie.. * @return the default project (may be null if not specified) * Chandan wrote the following answer on the opengrok-discuss list: * "Traditionally search engines (specially spiders) think that large files * are junk. Large files tend to be multimedia files etc., which text * search spiders do not want to chew. So they ignore the contents of * the file after a cutoff length. Lucene does this by number of words, * which is by default is 10,000." * By default OpenGrok will increase this limit to 60000, but it may be * overridden in the configuration file * @return The maximum words to index * Set the number of words in a file Lucene will index. * See getIndexWordLimit for a better description. * @param indexWordLimit the number of words to index in a single file * Is the verbosity flag turned on? * @return true if we can print extra information * Set the verbosity flag (to add extra debug information in output) * @param verbose new value * Specify if a search may start with a wildcard. Note that queries * that start with a wildcard will give a significant impact on the * @param allowLeadingWildcard set to true to activate (disabled by default) * Is leading wildcards allowed? * @return true if a search may start with a wildcard * Returns the user page for the history listing * @return the URL string fragment preceeding the username * Sets the user page for the history listing * @param userPage the URL fragment preceeding the username from history * Returns the user page suffix for the history listing * @return the URL string fragment following the username * Sets the user page suffix for the history listing * @param userPageSuffix the URL fragment following the username from history * Returns the bug page for the history listing * @return the URL string fragment preceeding the bug ID * Sets the bug page for the history listing * @param bugPage the URL fragment preceeding the bug ID * Returns the bug regex for the history listing * @return the regex that is looked for in history comments * Sets the bug regex for the history listing * @param bugPattern the regex to search history comments * Returns the review(ARC) page for the history listing * @return the URL string fragment preceeding the review page ID * Sets the review(ARC) page for the history listing * @param reviewPage the URL fragment preceeding the review page ID * Returns the review(ARC) regex for the history listing * @return the regex that is looked for in history comments * Sets the review(ARC) regex for the history listing * @param reviewPattern the regex to search history comments * Read an configuration file and set it as the current configuration. * @param file the file to read * @throws IOException if an error occurs * Write the current configuration to a file * @param file the file to write the configuration into * @throws IOException if an error occurs * Write the current configuration to a socket * @param host the host address to receive the configuration * @param port the port to use on the host * @throws IOException if an error occurs * Try to stop the configuration listener thread * Start a thread to listen on a socket to receive new configurations * @param endpoint The socket address to listen on * @return true if the endpoint was available (and the thread was started)