RuntimeEnvironment.java revision 504
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] 77N/A * Copyright 2006 Sun Microsystems, Inc. All rights reserved. 58N/A * Use is subject to license terms. 77N/A * The RuntimeEnvironment class is used as a placeholder for the current 77N/A * configuration this execution context (classloader) is using. 58N/A * Get the one and only instance of the RuntimeEnvironment 773N/A * @return the one and only instance of the RuntimeEnvironment 664N/A * Creates a new instance of RuntimeEnvironment. Private to ensure a 58N/A * singleton pattern. 816N/A * Get the path to the where the index database is stored 58N/A * @return the path to the index database 99N/A * Get a file representing the index database 99N/A * @return the index database 296N/A * Set the path to where the index database is stored 335N/A * @param dataRoot the index database 58N/A * Get the path to where the sources are located 58N/A * @return path to where the sources are located 816N/A * Get a file representing the directory where the sources are located 816N/A * @return A file representing the directory where the sources are located 773N/A * Specify the source root 773N/A * @param sourceRoot the location of the sources 773N/A * @return true if we have projects 773N/A * Get all of the projects 773N/A * @return a list containing all of the projects (may be null) 773N/A * Set the list of the projects 773N/A * @param projects the list of projects to use 58N/A * subsequent calls to the RuntimeEnvironment from this thread will use 773N/A * the same configuration 773N/A * Get the context name of the web application 773N/A * @return the web applications context name 773N/A * Set the web context name 773N/A * @param urlPrefix the web applications context name 58N/A * Get the name of the ctags program in use 58N/A * @return the name of the ctags program in use 58N/A * Specify the CTags program to use 58N/A * @param ctags the ctags program to use 58N/A * Validate that I have a Exuberant ctags program I may use 58N/A * @return true if success, false otherwise 58N/A //Check if exub ctags is available 58N/A "\nPlease use option -c to specify path to a good Exuberant Ctags program");
77N/A "Please use option -c to specify path to a good Exuberant Ctags program");
77N/A "\nPlease use option -c to specify path to a good Exuberant Ctags program");
77N/A // reap the child process.. 99N/A // the process is still running??? just kill it.. 99N/A * Get the max time a SMC operation may use to avoid beeing cached 99N/A * @return the max time 125N/A * Specify the maximum time a SCM operation should take before it will 125N/A * @param historyReaderTimeLimit the max time in ms before it is cached 106N/A * Is history cache currently enabled? 106N/A * @return true if history cache is enabled 112N/A * Specify if we should use history cache or not 112N/A * @param useHistoryCache set false if you do not want to use history cache 129N/A * Should we generate HTML or not during the indexing phase 129N/A * @return true if HTML should be generated during the indexing phase 129N/A * Specify if we should generate HTML or not during the indexing phase 129N/A * @param generateHtml set this to true to pregenerate HTML 129N/A * Set if we should compress the xref files or not 129N/A * @param compressXref set to true if the generated html files should be 318N/A * Are we using copressed HTML files? 318N/A * @return true if the html-files should be compressed. false otherwise 144N/A * Get the map of external SCM repositories available 144N/A * @return A map containing all available SCMs 173N/A * Set the map of external SCM repositories 173N/A * @param repositories the repositories to use 253N/A * Set the project that is specified to be the default project to use. The 253N/A * default project is the project you will search (from the web application) 253N/A * if the page request didn't contain the cookie.. 253N/A * @param defaultProject The default project to use 296N/A * Get the project that is specified to be the default project to use. The 296N/A * default project is the project you will search (from the web application) 335N/A * if the page request didn't contain the cookie.. 335N/A * @return the default project (may be null if not specified) 335N/A * Chandan wrote the following answer on the opengrok-discuss list: 480N/A * "Traditionally search engines (specially spiders) think that large files 480N/A * are junk. Large files tend to be multimedia files etc., which text 480N/A * search spiders do not want to chew. So they ignore the contents of 480N/A * the file after a cutoff length. Lucene does this by number of words, 480N/A * which is by default is 10,000." 480N/A * By default OpenGrok will increase this limit to 60000, but it may be 480N/A * overridden in the configuration file 667N/A * @return The maximum words to index 833N/A * Set the number of words in a file Lucene will index. 833N/A * See getIndexWordLimit for a better description. 833N/A * @param indexWordLimit the number of words to index in a single file 843N/A * Is the verbosity flag turned on? 833N/A * @return true if we can print extra information 833N/A * Set the verbosity flag (to add extra debug information in output) 234N/A * @param verbose new value 640N/A * Specify if a search may start with a wildcard. Note that queries 640N/A * that start with a wildcard will give a significant impact on the 640N/A * @param allowLeadingWildcard set to true to activate (disabled by default) 639N/A * Is leading wildcards allowed? 639N/A * @return true if a search may start with a wildcard 639N/A * Returns the user page for the history listing 639N/A * @return the URL string fragment preceeding the username 639N/A * Sets the user page for the history listing 639N/A * @param userPage the URL fragment preceeding the username from history 234N/A * Returns the bug page for the history listing 234N/A * @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)