Configuration.java revision 1461
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 (c) 2007, 2012, Oracle and/or its affiliates. All rights reserved. 1356N/A * Portions Copyright 2011, 2012 Jens Elkner. 77N/A * Placeholder class for all configuration variables. Due to the multithreaded 77N/A * nature of the web application, each thread will use the same instance of the 77N/A * configuration object for each page request. Class and methods should have 1327N/A /** The property name used to obtain the ctags command to use. */ 1327N/A "org.opensolaris.opengrok.analysis.Ctags";
1327N/A /** The command to use if no ctags command was given explicitly */ 1356N/A /** Relative path wrt. servlet context to the default CSS to use */ 1436N/A * Should the history log be cached? 773N/A * The maximum time in milliseconds {@code HistoryCache.get()} can take 773N/A * before its result is cached. 1436N/A * Should the history cache be stored in a database? 1436N/A * Default project will be used, when no project is selected and no project 1436N/A * is in cookie, so basically only the first time you open the first page, 1436N/A * or when you clear your web cookies 1115N/A //if below is set, then we count how many files per project we need to process and print percentage of completion per project 1185N/A * Get the default tab size (number of space characters per tab character) 1185N/A * @return current tab size set. 1185N/A * @see Project#getTabSize() 1252N/A * @see org.opensolaris.opengrok.analysis.ExpandTabsReader 1185N/A * Set the default tab size (number of space characters per tab character) 1185N/A * @param tabSize tabsize to set. 1185N/A * @see Project#setTabSize(int) 1252N/A * @see org.opensolaris.opengrok.analysis.ExpandTabsReader 1461N/A * Get the depth of scanning for repositories in the directory tree relative 1461N/A * Set the depth of scanning for repositories in the directory tree relative 1461N/A * @param scanningDepth the scan depth to set. 1436N/A * Creates a new instance of Configuration 816N/A //defaults for an opengrok instance configuration 1419N/A // TODO generate relative search paths, get rid of -w <webapp> option to indexer ! 1419N/A // setUrlPrefix(".." + Prefix.SEARCH_R + '?'); 870N/A //below can cause an outofmemory error, since it is defaulting to NO LIMIT 1461N/A * Get the client command to use to access the repository for the given 1461N/A * fully quallified classname. 1461N/A * @param clazzName name of the targeting class 1461N/A * @return {@code null} if not yet set, the client command otherwise. 1461N/A * Set the client command to use to access the repository for the given 1461N/A * fully quallified classname. 1461N/A * @param clazzName name of the targeting class. If {@code null} this method 1461N/A * @param cmd the client command to use. If {@code null} the corresponding 1461N/A * entry for the given clazzName get removed. 1461N/A * @return the client command previously set, which might be {@code null}. 1461N/A * Get a map of repository class names with the corresponding CLI command to 1461N/A * access the repository it is able to handle. 1461N/A * Basically exists to satisfy bean/de|encoder stuff, only. 1461N/A * @return a unmodifyable map. 1461N/A * Set the map of repository class names with the corresponding CLI command 1461N/A * to access the repository it is able to handle. 1461N/A * Basically exists to satisfy bean/de|encoder stuff, only. 1461N/A * @param cmds the map to copy. 1461N/A * Get the name of the ctags program in use 1461N/A * @return the name of the ctags program in use 1461N/A * Specify the CTags program to use 1461N/A * @param ctags the ctags program to use 1461N/A * Get the number of search result pages, which should be cached in 1461N/A * @return the number of result pages to cache. 1461N/A * Set the number of search result pages, which should be cached in 1461N/A * @param cachePages the number of result pages to cache. 1461N/A * Get the number of hits to display on one search result page. 1461N/A * @return number of hits per page. 1461N/A * Set the number of hits to display on one search result page. 1461N/A * @param hitsPerPage number of hits per page to set. 773N/A * Should the history log be cached? 1436N/A * @return {@code true} if a {@code HistoryCache} implementation should be 1436N/A * used, {@code false} otherwise 773N/A * Set whether history should be cached. 773N/A * @param historyCache if {@code true} enable history cache 1436N/A * How long can a history request take before it's cached? If the time is 1436N/A * exceeded, the result is cached. This setting only affects 773N/A * {@code FileHistoryCache}. 773N/A * @return the maximum time in milliseconds a history request can take 1436N/A * Set the maximum time a history request can take before it's cached. This 1436N/A * setting is only respected if {@code FileHistoryCache} is used. 773N/A * @param historyCacheTime maximum time in milliseconds 773N/A * Should the history cache be stored in a database? If yes, 773N/A * {@code JDBCHistoryCache} will be used to cache the history; otherwise, 773N/A * {@code FileHistoryCache} is used. 773N/A * @return whether the history cache should be stored in a database 773N/A * Set whether the history cache should be stored in a database, and 773N/A * {@code JDBCHistoryCache} should be used instead of {@code 1436N/A * @param historyCacheInDB whether the history cached should be stored in a 1461N/A * @return a list containing all of the projects (may be null) 1461N/A * Set the list of the projects 1461N/A * @param projects the list of projects to use 1461N/A * Get the path to where the sources are located 1461N/A * @return path to where the sources are located 1461N/A * @param sourceRoot the location of the sources 1461N/A * Get the path to the where the index database is stored 1461N/A * @return the path to the index database 1461N/A * Set the path to where the index database is stored 1461N/A * @param dataRoot the index database 1461N/A * Get the map of known repositories. 1461N/A * @return a possible empty list including {@code null}. 1461N/A * Set the map of known repositories. 1461N/A * @param repositories the repositories to set. 1461N/A * Get the context name of the web application. 1461N/A * @return the web applications context name. 1252N/A * Set the URL prefix to be used by the {@link 1436N/A * as lexers (see {@link org.opensolaris.opengrok.analysis.JFlexXref}) when 1436N/A * they create output with html links. 1185N/A * @param urlPrefix prefix to use. 1461N/A * Set whether to generate hyper text cross reference (xref) files 1461N/A * offline (i.e. when indexing). If set to {@code false}, xref files are 1461N/A * created on the fly on demand and gets disposed when served to the client 1461N/A * - so saves disk space, but could be sightly slow and more resource 1461N/A * demanding for the servlet container. 1461N/A * @param generateHtml {@code true} to generate and cache xref files immediately. 1461N/A * Check, whether to generate and cache xref files immediately. 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) 1461N/A * if the page request didn't contain the cookie. 1461N/A * @return the default project (may be null if not specified) 1461N/A * Chandan wrote the following answer on the opengrok-discuss list: 1461N/A * "Traditionally search engines (specially spiders) think that large files 1461N/A * are junk. Large files tend to be multimedia files etc., which text 1461N/A * search spiders do not want to chew. So they ignore the contents of 1461N/A * the file after a cutoff length. Lucene does this by number of words, 1461N/A * which is by default is 10,000." 1461N/A * By default OpenGrok will increase this limit to 60000, but it may be 1461N/A * overridden in the configuration file 1461N/A * @return The maximum words to index 1461N/A * Set the number of words in a file Lucene will index. 1461N/A * See getIndexWordLimit for a better description. 1461N/A * @param indexWordLimit the number of words to index in a single file 1461N/A * Is the verbosity flag turned on? 1461N/A * @return true if we can print extra information 1461N/A * Set the verbosity flag (to add extra debug information in output) 1461N/A * Is the progress print flag turned on? 1461N/A * @return {@code true} if we can print per project progress % 1461N/A * Set the printing of progress % flag (user convenience). 1461N/A * @param enable {@code true} to enable progress printing. 1461N/A * Specify if a search may start with a wildcard. Note that queries 1461N/A * that start with a wildcard will give a significant impact on the 1461N/A * search performace (disabled by default). 1461N/A * @param allowLeadingWildcard set to {@code true} to activate 1461N/A * Is leading wildcards allowed? 1461N/A * @return {@code true} if a search may start with a wildcard 1461N/A * Check whether a quick context scan should be done. 1461N/A * @return {@code true} if quick scan should be made. 1461N/A * @see #setQuickContextScan(boolean) 1461N/A * If set to {@code true}, at most 1 MiB of a file gets read into a buffer 1461N/A * at once and than tokenized. Otherwise the whole file gets processed as 1461N/A * usual, i.e. the file content gets read on demand when tokenizing and the 1461N/A * whole file gets processed (no matter of its size). 1461N/A * @param quickContextScan if {@code true} enable quick scanning 1461N/A * Takes precedence over {@link #getIncludedNames()}. 1461N/A * @param ignoredNames stuff to ignore. If {@code null} defaults will be 1461N/A * Takes precedence over {@link #getIncludedNames()}. 1461N/A * @param includedNames stuff to index. {@code null} means everything. 1461N/A * @see #setIgnoredNames(IgnoredNames) 1461N/A * @return stuff to index. {@code null} means everything. 1461N/A * Sets the user page for the history listing 1461N/A * @param userPage the URL fragment preceeding the username from history 1461N/A * Returns the user page for the history listing 1461N/A * @return the URL string fragment preceeding the username 1461N/A * Sets the user page suffix for the history listing 1461N/A * @param userPageSuffix the URL fragment following the username from history 1461N/A * Returns the user page suffix for the history listing 1461N/A * @return the URL string fragment following the username 1461N/A * Sets the bug page for the history listing 1461N/A * @param bugPage the URL fragment preceeding the bug ID 1461N/A * Returns the bug page for the history listing 1461N/A * @return the URL string fragment preceeding the bug ID 1461N/A * Sets the bug regex for the history listing 1461N/A * @param bugPattern the regex to search history comments 1461N/A * Returns the bug regex for the history listing 1461N/A * @return the regex that is looked for in history comments 1461N/A * Returns the review(ARC) page for the history listing 1461N/A * @return the URL string fragment preceeding the review page ID 1461N/A * Sets the review(ARC) page for the history listing 1461N/A * @param reviewPage the URL fragment preceeding the review page ID 1461N/A * Returns the review(ARC) regex for the history listing 1461N/A * @return the regex that is looked for in history comments 1461N/A * Sets the review(ARC) regex for the history listing 1461N/A * @param reviewPattern the regex to search history comments 1461N/A * Get the name of the web app Look And Feel (LAF) theme to use. It gets 1461N/A * used to construct the stylesheet and image include links in web pages 1461N/A * and names a directory, which contains all this stuff. 1461N/A * @return the name of the web app LAF 1461N/A * Set the name of the web app Look And Feel (LAF) theme to use. It gets 1461N/A * used to construct the stylesheet and image include links in web pages 1461N/A * and names a directory, which contains all this stuff. 1461N/A * @param webappLAF the name of the web app LAF. If {@code null} the default 1461N/A * Check whether file histories should be retrieved from the related remote 1461N/A * repositories when needed. 1461N/A * @return {@code true} if fetch on demand is enabled. 1461N/A * Set whether file histories should be retrieved from the related remote 1461N/A * repositories when needed. 1461N/A * @param remoteScmSupported {@code true} if fetch on demand is enabled. 1461N/A * Check, whether the lucene index database should be optimized (compact 1461N/A * segments etc.) after indexing has been run. 1461N/A * @return {@code true} if optimization is enabled. 1461N/A * Set, whether the lucene index database should be optimized (compact 1461N/A * segments etc.) after indexing has been run. 1461N/A * @param optimizeDatabase {@code true} if optimization should be done. 1461N/A * Check, wheter lucene should lock index files when indexing to avoid 1461N/A * concurrent access, reading invalid data. 1461N/A * @return {@code true} if locking should be used. 1461N/A * Set wheter lucene should lock index files when indexing to avoid 1461N/A * concurrent access, reading invalid data. 1461N/A * @param useLuceneLocking {@code true} if locking should be used. 1461N/A * Set if we should compress the xref files or not. Applies to newly 1461N/A * application automatically detects, whether an xref file is compressed 1461N/A * and processes it properly. 1461N/A * @param compressXref set to {@code true} if generated xref html files 1461N/A * Set if we should compress generated xref html files? 1461N/A * @return {@code true} if the xref html files should be compressed. 1461N/A * Check, whether unversioned files should not be indexed. 1461N/A * If {@code true}, it takes precedence over {@link #getIncludedNames()}, 1461N/A * i.e. files are not indexed when unversioned, even if they match an 1461N/A * @return {@code true} if indexing of unversioned files is disabled. 1461N/A * Set, whether unversioned files should not be indexed. 1461N/A * If set to {@code true}, it takes precedence over {@link #getIncludedNames()}, 1461N/A * i.e. files are not indexed when unversioned, even if they match an 1461N/A * @param indexVersionedFilesOnly {@code true} to disable indexing of 1330N/A * Get the time, when this instance has been modified. If not explicitly set 1330N/A * or set to {@code 0}, it gets initialized with the time of the first call 1330N/A * @return time in milliseconds since 1 Jan 1970 00:00:00 GMT 1330N/A // since we use it for If-Last-Modified-Since evals, which has no 1330N/A // millis, we need to clear the milliseconds part 1330N/A * Set the time, when this configuration has been modified for the last time. 1330N/A * @param lastModified the time in milliseconds since 1 Jan 1970 00:00:00 GMT 1324N/A * Get the date of the last index update. 1324N/A * @return the time of the last index update. 1324N/A * Get the contents of a file or empty string if the file cannot be read. 1436N/A * should usually not happen 1324N/A * The name of the file relative to the <var>DATA_ROOT</var>, which should 1324N/A * be included into the footer of generated web pages. 1324N/A * Get the contents of the footer include file. 1324N/A * @return an empty string if it could not be read successfully, the 1324N/A * contents of the file otherwise. 1331N/A * @see #FOOTER_INCLUDE_FILE 1324N/A * The name of the file relative to the <var>DATA_ROOT</var>, which should 1324N/A * be included into the footer of generated web pages. 1324N/A * Get the contents of the footer include file. 1324N/A * @return an empty string if it could not be read successfully, the 1324N/A * contents of the file otherwise. 1331N/A * @see #HEADER_INCLUDE_FILE 1331N/A * The name of the file relative to the <var>DATA_ROOT</var>, which should 1331N/A * be included into the body of web app's "Home" page. 1331N/A * Get the contents of the body include file. 1331N/A * @return an empty string if it could not be read successfully, the 1331N/A * contents of the file otherwise. 1331N/A * @see Configuration#BODY_INCLUDE_FILE 1326N/A * The name of the eftar file relative to the <var>DATA_ROOT</var>, which 1326N/A * contains definition tags. 1326N/A * Get the eftar file, which contains definition tags. 1326N/A * @return {@code null} if there is no such file, the file otherwise. 1461N/A * Get the fully quallified class name of the history database driver to use. 1461N/A * @return the database driver class name. 1461N/A * Set the fully quallified class name of the history database driver to use. 1461N/A * @param databaseDriver the database driver class name to set. 1461N/A * Get the JDBC connection URL to use to connect to the history database. 1461N/A * @return the JDBC connection URL to use. 1461N/A * Set the JDBC connection URL to use to connect to the history database. 1461N/A * @param databaseUrl the JDBC connection URL to set. 1461N/A * Get the optional file to be used to handover additional options to the 1461N/A * @return {@code null} if not set, the options filename otherwise. 1461N/A * Set the file to be used to handover additional options to the ctags 1461N/A * @param filename the options filename to use. Might be {@code null}. 1461N/A * Get the pathnames of symlinks, which are allowed to be processed (e.g. 1461N/A * indexed, tokenized, etc.). 1461N/A * @return a possible empty set. 1461N/A * Set the pathnames of symlinks, which are allowed to be processed (e.g. 1461N/A * indexed, tokenized, etc.). 1461N/A * @param allowedSymlinks symlinks to allow. {@code null} means none. 1461N/A * Check whether e-mail addresses should be obfuscated in the xref. 1461N/A * @return {@code true} if obfuscation is needed. 1461N/A * Set whether e-mail addresses should be obfuscated in the xref. 1461N/A * @param obfuscate {@code true} if obfuscation is needed. 1461N/A * Should status.jsp print internal settings, like paths and database 1461N/A * @return {@code true} if status.jsp should show the configuration. 1461N/A * Set whether status.jsp should print internal settings. 1461N/A * @param chattyStatusPage {@code true} if internal settings should be printed. 234N/A * Write the current configuration to a file 234N/A * @param file the file to write the configuration into 234N/A * @throws IOException if an error occurs 1461N/A * Serialize this instance into an XML formatted string. 1461N/A * @return this instance as xml string 1461N/A * Read the file containing a serialized {@link Configuration} instance and 1461N/A * return the marshalled instance. 1461N/A * @param file the file to read 1461N/A * @return the un-serialized Configuration instance represented by the file. 1461N/A * Read the given string representing a in XML serialized {@link Configuration} 1461N/A * and return the marshalled instance. 1461N/A * @param xmlconfig serialized config to read. 1461N/A * @return the un-serialized Configuration instance represented by the string. 1461N/A * @throws IOException if the string cannot be decoded.