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