All Classes and Interfaces
Class
Description
What kind of file is this?
Class to hold code shared between various cache implementations,
notably
FileHistoryCache and FileAnnotationCache.Abstract class for all plug-ins working with LDAP.
Encapsulates the result of LDAP search, namely single object's
DN and attributes.
Represents an abstract implementation of
ObjectPool that defines the
procedure of returning an object to the pool.Represents an API for an aggregation of
NumLinesLOC.handles parsing the output of the
accurev annotate command
into an annotation object.Parse source history for a AccuRev Repository.
Access to an AccuRev repository (here an actual user workspace)
AccuRev requires that a user logs into their system before it can be used.
Represents an implementation of
AbstractSourceCodeAnalyzer for the
Ada programming language.Represents an implementation of
FileAnalyzerFactory to produce
AdaAnalyzer instances.Manages and provides Analyzers as needed.
Represents a utility class to show the user details of
AnalyzerGuru.Class representing file annotation, i.e., revision and author for the last
modification of each line in the file.
Annotation Cache Related Operations.
Holds serializable content for
Annotation.Class representing one line in the file.
Represents task associated with asynchronous API request.
Manages asynchronous API requests.
Represents an analyzer for assembly language.
Represents a factory to create
AsmAnalyzer instances.Enum for available authorization roles.
This class covers authorization entities used in opengrok.
Predicate specialized for the the plugin decisions.
Predicate specialized for the entity skipping decisions.
Serves for authorization of specific REST API endpoints.
Placeholder for performing authorization checks.
This is a subclass of
AuthorizationEntity and is a wrapper to a
IAuthorizationPlugin delegating the decision methods to the contained
plugin.Subclass of
AuthorizationEntity.Serves for specifying api's to be authorized by authorization stack.
BazaarAnnotationParser handles parsing the output of the
bzr blame
command into an annotation object.Access to a Bazaar repository.
Bazaar specific tag class with ability to compare itself with generic
HistoryEntry.
handles parsing the output of the
bzr tags command
into a set of tag entries.IntsHolder implementation by using the BitSet.handles parsing the output of the
bk annotate command
into an annotation object.Access to a BitKeeper repository.
BitKeeper specific tag class with ability to compare itself with generic HistoryEntry.
handles parsing the output of the
bk tags command
into a set of tag entries.Represents an API for a pool of objects that makes the
requesting threads wait if no object is available.
Helper class to split sequence of VCS changesets into number of intervals.
Represents a subclass of
AbstractObjectPool and implementation of
BlockingObjectPool with a defined limit of objects and a helper
to validate instances on AbstractObjectPool.release(java.lang.Object).Represents a functional interface for accepting buffers.
BytesRef data serializer for ChronicleMap.BytesRef data serializer for ChronicleMap.Analyzes a BZip2 file.
Cache interface for common cache related operations.
Exception thrown when retrieval or manipulation of cache data fails.
Helper functions for
HistoryCache and AnnotationCache implementations.An Analyzer for C/C++/Java type of files.
Represents a validator of a --canonicalRoot value.
Adapter for
ChronicleMap to expose only the necessary operations needed for most popular completion.ChronicleMap does not have the configuration stored in the file.handles parsing the output of the
cleartool annotate
command into an annotation object.Access to a ClearCase repository.
Represents a subclass of
ReentrantReadWriteLock that can return
ResourceLock instances.Command Time Out Type.
Merge 2 config files together.
Encapsulates configuration for LDAP plugins.
Placeholder class for all configuration variables.
History handling types for remote SCM repositories.
Callback that is called when configuration is changed.
Temporary hack to prevent
XMLDecoder to deserialize other than allowed classes.Represents a utility class to present some user-readable help regarding
Configuration.Represents an API for consuming a
Configuration instance along with
a specified value.Represents a container for Ada keywords and other string constants.
Holds static hash set containing the C keywords (copying for use by Asm for
now).
Holds static hash set containing the C keywords.
Holds static hash set containing Clojure 1.6 keywords.
C# keywords.
Represents a container for a set of Eiffel keywords.
Holds static hash set containing the Erlang keywords.
Holds static hash set containing the Fortran keywords.
Holds static hash set containing the Golang keywords.
Holds static hash set containing the Haskell keywords.
Represents a container for HCL keywords and other string constants.
Holds static hash set containing the Java keywords.
Holds JavaScript keywords from ECMA-262 10th Edition, June 2019.
Holds static hash set containing the Json (schema) keywords.
Holds static hash set containing the Kotlin keywords.
Holds static hash set containing Lisp keywords.
Holds static hash set containing the Lua keywords.
Holds static hash set containing the Pascal keywords.
Holds static hash set containing the Perl keywords.
Holds static hash set containing the Perl keywords.
PowerShell keyword hash.
Holds static hash set containing the Python keywords.
Represents a container for R keywords and other string constants.
Represents a container for Ruby keywords and other string constants.
Holds static hash set containing the Rust language keywords.
Holds static hash set containing the Scala keywords.
Shell keyword hash.
Holds static hash set containing the Swift keywords.
Holds static hash set containing Tcl keywords.
Represents a container for Terraform keywords and other string constants.
Represents a container for TypeScript Version 1.8 (January 2016) plus
ECMAScript (June 2019) keywords.
Represents a container for a set of SystemVerilog keywords.
Holds static hash set containing the Java keywords.
This is supposed to get the matching lines from sourcefile.
Represents an immutable settings instance for coordinating objects related
to producing context presentations.
Represents a subclass of
PassageFormatter that uses
PassageConverter.Makes sure that all cookies originating from the web application have the Same-site attribute set.
This decorator is to enable CORS for paths.
Provides Ctags by having a running subprocess of ctags.
Represents a reader of output from runs of ctags.
This should mimic
https://github.com/universal-ctags/ctags/blob/master/docs/format.rst or
http://ctags.sourceforge.net/FORMAT (for backwards compatibility).
Modified Apache Lucene's
PhraseQuery to allow to use CustomExactPhraseScorer and
CustomSloppyPhraseScorer.A custom query parser for OpenGrok.
handles parsing the output of the
cvs annotate command
into an annotation object.Access to a CVS repository.
An Analyzer for C++ files.
Holds static hash set containing the C keywords.
Print the index modifications to the standard output stream when running
in verbose mode.
Class that represents a single tag.
Represents a token stream from
Definitions.A simple container to store the data required to generate a view of diffs
for a certain versioned file.
Known diff display types.
Represents a pairing of
File along with supplemental
NullableNumLinesLOC.Represents a searcher to supplement metadata from the file-system with
per-file, OpenGrok-analyzed data.
Generate SCM history for directory by using the Index database.
Generates HTML listing of a Directory.
Represents an event raised when a language lexer indicates that a disjoint
span has changed.
Represents an implementation of
FileAnalyzerFactory.Matcher that detects a troff- or mandoc-like document.Annotated fields will be present in generated DTO object.
An Extremely Fast Tagged Attribute Read-only File System.
An Extremely Fast Tagged Attribute Read-only File Reader.
Represents an analyzer for the Eiffel language.
Represents a factory to create
EiffelAnalyzer instances.Analyzes ELF (Executable and Linking Format) files.
Represents a hint from a language lexer for emphasis of non-symbolic
matches.
Custom collector to collect error messages for list of projects and join them with comma.
Wrapper to Java Process API.
You should use the StreamHandler interface if you would like to process
the output from a process while it is running.
Wrapper around Reader to expand tabs to spaces in the input.
LDAP facade for testing.
Authorization plugin that returns false (not allowed) for all decisions.
Base class for all different File Analyzers.
Factory class which creates a
FileAnalyzer object and
provides information about this type of analyzers.Interface for matchers which map file contents to analyzer factories.
This class is meant to collect files that were touched in some way by SCM update.
Represents a transformer of lists of files and
NullableNumLinesLOC instances to zip them into a list of
DirectoryEntry instances.Represents an exception that occurs when an ineligible symbolic link is
encountered while evaluating a file system path.
Represents structured results from
ContextFormatter that can be
merged with other instances.An Analyzer for Fortran type of files.
Represents a container for Fortran-related utility methods.
Used by the webapp to serve the contents of files on /raw and /download.
A simple implementation of the getopt(3c).
Access to a Git repository.
Placeholder for the information about subgroups of projects and repositories.
Analyzes GZip files.
Represents a container for Haskell-related utility methods.
Represents an extension of
AbstractSourceCodeAnalyzer for the HCL
configuration language.Represents an extension of
FileAnalyzerFactory to produce
HCLAnalyzer instances.Represents an abstract base class for HCL lexers.
The purpose of this class is to provide
StreamHandler that limits the output
to specified number of lines.Class representing the history of a file.
it is supposed to get the matching lines from history log files.
Collect all information of a given revision.
Exception thrown when retrieval or manipulation of history information fails.
The HistoryGuru is used to implement an transparent layer to the various
source control systems.
Class for reading history entries in a way suitable for indexing by Lucene.
The hit class represents a single search hit.
Utility class to provide simple host/address methods.
Represents a container class for string constants related to production of
HTML.
Interface for authorization plug-ins.
Factory for analyzer that claims to analyze files which are mostly plain
text data, but ignores them.
This class maintains a list of directory names, SRC_ROOT
relative file paths (like "usr/src/uts"), and glob
patterns (like .make.*) which opengrok should ignore.
This class maintains a list of file names (like "cscope.out"), SRC_ROOT
relative file paths (like "usr/src/uts" or "usr/src/Makefile"), and glob
patterns (like .make.*) which should be ignored.
wrapper class for IgnoredFiles and IgnoredDirs.
Factory for analyzer that tells that image files can be displayed.
This filter allows the request in case it contains the correct authentication bearer token
(needs to come in via HTTPS) or it is coming from localhost or its path matches the list
of built in paths.
Represents a serializable gathering of some top-level metadata concerning the
operation of
IndexDatabase -- and persisted therein too -- which are
re-compared upon each indexing run since changes to them might require
re-indexing particular files or in certain cases all files.Represents a serializable gathering of some top-level metadata concerning the
operation of
IndexDatabase -- and persisted therein too -- which are
re-compared upon each indexing run since changes to them might require
re-indexing particular files or in certain cases all files.Represents a data-access object for
IndexAnalysisSettings.Represents a converter to upgrade earlier binary representations of
index-analysis-settings to the latest version.
The changes in an index database may be monitored through this interface.
Index checker.
Index check modes.
Common exception for all check modes.
This class is used to create / update the index databases.
wrapper for fatal errors during indexing.
Exception thrown when index document check fails.
Represents the associated data of a symlink indexed by
IndexDatabase.Creates and updates an inverted source index as well as generates Xref, file
stats etc., if specified in the options.
Represents a container for executors that enable parallelism for indexing
across projects and repositories and also within any
IndexDatabase
instance -- with global limits for all execution.Factory for IndexSearcher objects with search executor.
Exception thrown when index version does not match Lucene version.
Utility class to get information of the OpenGrok version.
Simple interface for querying if some data structure contains some
int value.A small utility class to provide common functionality related to
IO so that we don't need to duplicate the logic all over the place.
Class that presents the contents of an
Iterator as a Reader.Analyzes JAR, WAR, EAR (Java Archive) files.
Analyzes Java Class files.
Represents a subclass of
FileAnalyzerFactory that creates
JavaClassAnalyzer instances for files that have: 1) a CLASS file
extension; or 2) CAFEBABE magic along with a known
major_version (per
https://docs.oracle.com/javase/specs/jvms/se9/html/jvms-4.html ),
currently from JDK 1.1 (0x2D) to Java SE 9 (0x35).Represents an abstract base class for JavaScript lexers.
Represents an API for JFlex lexers that produce multiple types of derived
OpenGrok documents (e.g., cross-reference documents [xrefs] or Lucene search
documents [tokenizers]) from the same JFlex productions.
Represents an API for lexers created by JFlex for
%type int.Represents a base class for non-traditional xref lexers whose
cross-references are not straight-forward representations of source code but
instead are attempts to show derived presentations (e.g.
Represents an API for an extension of
JFlexLexer that needs to track
a state stack.Represents an abstract base class for resettable lexers that need to track
a state stack.
Represents an abstract base class for subclasses of
JFlexStateStacker that can publish as ScanningSymbolMatcher.Tokenizer which uses lex to identify tokens.
Represents a container for extracted, shared logic between
JFlexXref
and its backwardly-compatible cousin, JFlexNonXref.Converts Object to JSON.
Represents an API for mapping file specifications versus languages and
getting the ctags options representation (--langmap-<LANG> or
--map-<LANG>) thereof.
Represents an implementation of
LangMap using structures with natural
ordering of file specifications.Helper class for getting the latest revision of a file.
Represents a container for sanitizing methods for avoiding classifications as
taint bugs.
LazilyInstantiate is a quick class to make lazily instantiating
objects easy.Authorization plug-in to check user's LDAP attribute against whitelist.
Unchecked exception to be thrown when LDAP server pool is down.
Authorization plug-in to check if given user matches configured LDAP filter.
LDAP user represented as Distinguished Name and a set of attributes.
Authorization plug-in to extract user's LDAP attributes.
Represents a reader of source text to find end-of-line tokens -- in
accordance with
StringUtils.STANDARD_EOL -- in order to determine
line offsets but discarding line content.Represents a collection of metadata related to highlighting a single line
of code.
Base class for matching a line against terms.
Represents an event raised when a symbol matcher matches a string that
would not be published as a symbol and that can be linked within OpenGrok or
linked externally.
Represents a linkage type indicator from a language lexer for categorizing
non-symbolic matches.
Formats log in given pattern.
Factory for creating
Logger instances.Bridge for indirect injection of logger factory.
Utilities to maintain logging.
Represents one suggestion.
Represents a container for Lua-related utility methods.
Represents a container for OpenGrok's names of Lucene lock modes.
Analyzes mandoc files.
Represents an exception that occurs when
mandoc exits non-zero.Represents a wrapper to run mandoc binary to format manual page content.
Decode basic headers coming from the
mod_auth_mellon module
for Apache web server.
Access to a Mercurial repository.
Mercurial specific tag class with ability to compare itself with generic
HistoryEntry.
handles parsing the output of the
hg tags command
into a set of tag entries.Opengrok Message Level.
Encapsulates logic of meter registry setup and handling.
Handles handles parsing the output of the
mnt annotate command
into an annotation object.Access to a Monotone repository.
Represents an API for a listener for non-symbolic or non-indexed symbol
matching events.
Represents an immutable data object that associates a file with its analyzed
number-of-lines and lines-of-code or with null values.
Implementation of Writer that doesn't produce any ouput.
Represents an immutable data object that associates a file with its analyzed
number-of-lines and lines-of-code.
Represents an accumulator of net-deltas of #Lines and LOC for directories.
Represents a utility class for handling related to
NumLinesLOC.Represents an API for the mechanism to create
new objects to be used in an object pool.
Represents an API for a cached pool of objects.
Represents an API for validation of an object of the pool and for its
subsequently cleanup to invalidate it.
Represents an OpenGrok-customized tokenized text field to centralize settings
across all the analyzers.
Represents an OpenGrok-customized tokenized, text field with stored term
vectors to centralize settings across all the analyzers.
Represents a subclass of
UnifiedHighlighter with customizations for OpenGrok.Custom
PassageScorer used in OGKUnifiedHighlighter.ThreadFactory to be used throughout OpenGrok to make sure all threads have common prefix.
OptionParser is a class for command-line option analysis.
Decode Oracle SSO specific headers.
A simple container to lazy initialize common vars wrt.
Maps the
ParseException to a Response.Status.BAD_REQUEST status.Represents a container for Pascal-related utility methods.
Represents an object that can translate
Passage instances into
indexed LineHighlight instances, taking into account a configurable
number of leading and trailing lines of context for each match.Represents a gatekeeper that decides whether a particular file or directory
is acceptable for history or code analysis with respect to configuration of
ignored files and directories or of specified inclusive filtering.
Serves for authorization of REST API endpoints that have a path parameter
which is file path relative to source root.
Serves for authorization of REST API endpoints that have a path parameter.
Represents an event raised when a symbol matcher matches a path-like string
that would not be published as a symbol.
Tokenizer for paths filenames and extensions Input:
Represents a container for file system paths-related utility methods.
Represents the metadata for a pending file deletion.
Represents the metadata for a pending file renaming.
Represents the metadata for a pending symbolic linkage.
Represents an almost-wholly immutable tuple whose field data are used by
JFlexTokenizer to set attributes to be read while iterating a
token stream.Represents a comparator for
PendingToken that just compares the
instances' offsets.handles parsing the output of the
p4 annotate command
into an annotation object.Access to a Perforce repository.
Represents a highlighted phrase within a line -- possibly with bounds
indicating that the highlight begins or ends on another line.
Represents a
Comparator for PhraseHighlight.Interface for
Scorer of PhraseQuery which allows
to query the positions where the next term in the query should be.Analyzer for plain text files.
Represents a subclass of
FileAnalyzerFactory for plain-text
files in ASCII, UTF-8, or UTF-16.Class loader for plugins from .class and .jar files.
Plugin framework for plugins of type
PluginType.Simple interface for accessing the popularity data for specific terms.
Abstraction for the map to store the data for most popular completion.
Represents a container for PowerShell-related utility methods.
Validate that the annotated
Duration is not null and positive.Analyzes PowerShell scripts.
URL Prefixes usually tied to a certain servlet.
Matches a term against a prefix.
Progress reporting via logging.
Copy of
org.opengrok.indexer.util.Progress.Placeholder for the information that builds up a project.
Preprocessing of projects, repositories and groups for the UI.
Represents a container for Python-related utility methods.
Helper class that builds a Lucene query based on provided search terms for
the different fields.
Utility class used to extract the terms used in a query This class will not
find terms for MultiTermQuery, RangeQuery and PrefixQuery classes so the
caller must pass a rewritten query (see query.rewrite) to obtain a list of
expanded terms.
Represents a container for OpenGrok web query parameter names.
Represents an extension of
AbstractSourceCodeAnalyzer for the R
language.Represents an extension of
FileAnalyzerFactory to produce
RAnalyzer instances.Adds access to to a Razor Repository
A brief and simplistic overview of Razor
Razor uses the term 'Group' for what might traditionally be called a
repository, that is a collection of files and folders.
Virtualize RCS log as an input stream.
Access to an RCS repository.
Represents an API for overlaying a reader with another reader.
Represents a container for regex-related utility methods.
Access to a Git repository.
Represents a utility to show the user details of supported
Repository
types for -h,--help.An interface for an external repository.
This is a factory class for the different repositories.
Class to contain the common info for a repository.
Interface for finding enclosing Repository for a given Path, used by HistoryGuru.
This interface allows intercepting PathUtils.getRelativeToCanonical in order to measure the impact of caching.
RepositoryLookup uncached implementation (original logic taken from HistoryGuru.getRepository).
Repositories extending this class will benefit from per partes history
indexing which saves memory.
Represents an API for objects that can reset to an initial state without
any exceptions.
Represents an API for try-with-resources management of a
Lock.Simple RESTful client.
Represents an abstract base class for R lexers.
Represents an implementation of
AbstractSourceCodeAnalyzer for the
Ruby programming language.Represents an implementation of
FileAnalyzerFactory to produce
RubyAnalyzer instances.The RuntimeEnvironment class is used as a placeholder for the current
configuration this execution context (classloader) is using.
Represents a container for Rust-related utility methods.
Represents a container for Scala-related utility methods and patterns.
Used by both
RazorRepository and SCCSRepository to retrieve revisions of a file.This class gives access to repositories built on top of SCCS (including TeamWare).
handles parsing into Annotation object.
Get mapping of revision to author.
Represents an enumeration of changes to language scopes.
Represents an event raised when a language lexer indicates that scope has
changed.
Note: this class has a natural ordering that is inconsistent with equals.
A list-like container for JavasScript sources in JSP/HTML pages.
Script implementing the toHtml() method as an external script resource.
A script wrapper.
This is an encapsulation of the details on how to search in the index database.
Working set for a search basically to factor out/separate search related
complexity from UI design.
Builder Class for Search Helper.
Represents a helper class for accessing settings.
Analyzes Shell scripts/Conf files etc.
Sort orders recognized in the web UI.
Represents an event raised when a language lexer has seen source code.
Represents a splitter of source text into lines, where end-of-line tokens --
in accordance with
StringUtils.STANDARD_EOL -- are maintained instead
of being stripped.Represents a container for [PL]SQL-related utility methods.
Access to Surround SCM repository.
This class is handy for logging messages (and updating metrics)
about duration of a task.
Configuration for Statsd metrics emitted by the Indexer via
Statistics.API endpoint to check status of asynchronous requests.
This class lets you create
InputStreams that read data from a
specific source.Represents a subclass of
BreakIterator that breaks at standard
OpenGrok EOL -- namely \r\n, \n, or \r.Various String utility methods.
handles parsing the output of the
svn annotate
command into an annotation object.Access to a Subversion repository.
Provides an interface for accessing suggester functionality.
Annotated Api's checks if suggester is enabled and if not then returns
Response.Status.NOT_FOUND.Model classes for holding project name and path to its index directory.
Model class to hold the project name and its
IndexReader.Result suggestions data.
Binder for suggester related dependency injection.
The suggester specific configuration.
Endpoint for suggester related REST queries.
Represents processed
SuggesterQueryData.Query for possible suggestions of
FuzzyQuery.Query for possible suggestions of
PhraseQuery.Query for possible suggestions of
PrefixQuery.Query that selects the terms that could be used as suggestions.
Used for preserving the OpenGrok query building properties with special handling for the suggestions field which
uses
SuggesterQueryParser instead of OpenGrok's CustomQueryParser.Combines multiple query params for suggester into one concise class.
Parser for the raw
SuggesterQueryData.Query for possible suggestions of
TermRangeQuery.SuggestPosition type values.
Query for possible suggestions of
RegexpQuery.Suggester Service contract definition.
Implementation of
SuggesterService.Provides some useful utility methods to be used in suggester module.
Query for possible suggestions of
WildcardQuery.A simple container for search suggestions.
Filter which checks if suggester is enabled and if not then returns
Response.Status.NOT_FOUND.Implements hit summarization.
A document summary dynamically generated to match a query.
An ellipsis fragment within a summary.
A fragment of text within a summary.
A highlighted fragment of text within a summary.
Wrapper class over IndexSearcher which keeps SearcherManager around so
that we can simply return the indexSearcher to it.
Represents an event raised when a symbol matcher matches a string that
might be published as a symbol.
Represents an API for a listener for
SymbolMatchedEvents.Represents an API for a publisher for
SymbolMatchedEvents.Represents an identifier for a version control "commit" (also known as a
"changeset") where the version control system uses either monotonic, linear
revision numbering; or alternatively where OpenGrok uses "commit time" as a
proxy for ancestry.
Represents a utility class for creating a filename to operate in tandem with
an original filename by adding a new file extension but limiting the length
of the new filename to 255 UTF-8 encoded bytes if necessary by truncating
and packing in a Base64-encoded SHA-256 hash of the original file name.
Represents a utility class for creating a path to operate in tandem with
an original path by adding a new file extension but limiting the length
of the filename component of the new path to 255 UTF-8 encoded bytes if
necessary by truncating and packing in a Base64-encoded SHA-256 hash of the
original file name component.
Analyzes TAR files.
Represents an extension of
AbstractSourceCodeAnalyzer for the
Terraform configuration language.Represents an extension of
FileAnalyzerFactory to produce
TerraformAnalyzer instances.Represents an event raised when a symbol matcher matches a string that
would not be published as a symbol.
Implementation of timestamp decoding.
Analyzes [tn]roff files.
Authorization plugin that returns true (allowed) for all decisions.
Represents an analyzer for the TypeScript language.
Represents a container for utility methods concerned with URIs.
Represents the immutable return value of
UriUtils.trimUri(String, boolean, Pattern).Runtime exception thrown if there is any error in loading user decoder.
Authorization plug-in to extract user info from HTTP headers.
Get authenticated user principal and use it to create User object.
Class for useful functions.
Analyzes [tn]roff files.
Represents an analyzer for the SystemVerilog language.
Represents a factory to create
VerilogAnalyzer instances.This class implements portions of semantic versioning from version noted as
Runtime exception thrown if there is any error in loading opengrok version information file.
Error thrown if there is any error while initializing opengrok web app.
Initialize webapp context.
Runtime exception thrown instead IO Exception.
Represents the arguments for the
FileAnalyzer.writeXref(org.opengrok.indexer.analysis.WriteXrefArgs)
method.Analyzes HTML files.
Represents an API for lexers that write a cross-reference document.
Class to wrap Xref production with timeout.
Represents a
Reader wrapper that guards against implementations that
might return zero characters instead of properly blocking.Analyzes Zip files.
Represents an abstract base class for a ZIP archive
FileAnalyzerFactory.Matcher that can strictly check an "Extra field"
16-bit ID code.