A B C E F G H I J L M N O P R S T V
All Classes All Packages

A

AbstractExecResultLogger<T> - Class in com.optum.sourcehawk.exec

A generic logger for logging results

AbstractExecResultLogger() - Constructor for class com.optum.sourcehawk.exec.AbstractExecResultLogger

B

build() - Method in class com.optum.sourcehawk.exec.ExecOptions.ExecOptionsBuilder

builder() - Static method in class com.optum.sourcehawk.exec.ExecOptions

C

com.optum.sourcehawk.exec - package com.optum.sourcehawk.exec

com.optum.sourcehawk.exec.config - package com.optum.sourcehawk.exec.config

com.optum.sourcehawk.exec.fix - package com.optum.sourcehawk.exec.fix

com.optum.sourcehawk.exec.scan - package com.optum.sourcehawk.exec.scan

ConfigurationException - Exception in com.optum.sourcehawk.exec

Exception thrown when error in parsing configuration

ConfigurationException(String) - Constructor for exception com.optum.sourcehawk.exec.ConfigurationException

Constructs an instance of this exception with the given message

configurationFileLocation(String) - Method in class com.optum.sourcehawk.exec.ExecOptions.ExecOptionsBuilder

The location of the configuration file, can be on the file system or a URL

ConfigurationReader - Class in com.optum.sourcehawk.exec

Utility class for reading and deserialization of configuration

Console - Class in com.optum.sourcehawk.exec

Console logging utility

Console.Err - Class in com.optum.sourcehawk.exec

Console logging to standard err

Console.Out - Class in com.optum.sourcehawk.exec

Console logging to standard out

contextualError(String, String, Object...) - Static method in class com.optum.sourcehawk.exec.Console.Out

Log an ERROR message to standard out in for the format "[ERROR] context :: message"

contextualInfo(String, String, Object...) - Static method in class com.optum.sourcehawk.exec.Console.Out

Log an INFO message to standard out in for the format "[INFO] context :: message"

contextualWarn(String, String, Object...) - Static method in class com.optum.sourcehawk.exec.Console.Out

Log a WARNING message to standard out in for the format "[WARN] context :: message"

convertFileEnforcerToFileResolver(Object) - Static method in class com.optum.sourcehawk.exec.ConfigurationReader

Convert the file enforcer to a file resolver

create() - Static method in class com.optum.sourcehawk.exec.scan.ScanResultLogger

create(boolean) - Static method in class com.optum.sourcehawk.exec.fix.FixResultLogger

E

enforcerResult(ExecOptions, String, Severity, EnforcerResult) - Static method in class com.optum.sourcehawk.exec.scan.ScanResultFactory

Create a scan result based on the file protocol and enforcer result

equals(Object) - Method in class com.optum.sourcehawk.exec.ExecOptions

error(String, Object...) - Static method in class com.optum.sourcehawk.exec.Console.Err

Log an error message to standard err

error(String, String) - Static method in class com.optum.sourcehawk.exec.fix.FixResultFactory

Create the fix result for situations where there is an error executing the fix

error(String, String) - Static method in class com.optum.sourcehawk.exec.scan.ScanResultFactory

Create the scan result for situations where there is an error executing the scan

ExecOptions - Class in com.optum.sourcehawk.exec

Execution options to be evaluated

ExecOptions.ExecOptionsBuilder - Class in com.optum.sourcehawk.exec

F

failOnWarnings(boolean) - Method in class com.optum.sourcehawk.exec.ExecOptions.ExecOptionsBuilder

Whether or not to fail on warnings

fileNotFound(FileProtocol) - Static method in class com.optum.sourcehawk.exec.fix.FixResultFactory

Generate a fix result for situations where the file is not found

fileNotFound(ExecOptions, FileProtocol) - Static method in class com.optum.sourcehawk.exec.scan.ScanResultFactory

Generate a scan result for situations where the file is not found

fileNotFound(ExecOptions, String, String) - Static method in class com.optum.sourcehawk.exec.scan.ScanResultFactory

Generate a scan result for situations where the file is not found

fix(ExecOptions, boolean) - Static method in class com.optum.sourcehawk.exec.fix.FixExecutor

Run the fix based on the provided options

FixExecutor - Class in com.optum.sourcehawk.exec.fix

Entry point into executing scans

FixResultFactory - Class in com.optum.sourcehawk.exec.fix

A factory for creating instances of FixResult

FixResultLogger - Class in com.optum.sourcehawk.exec.fix

A logger for fix results

flatten(String) - Static method in class com.optum.sourcehawk.exec.config.FlattenConfigExecutor

Run the flatten config based on the provided configuration file location

FlattenConfigExecutor - Class in com.optum.sourcehawk.exec.config

Entry point for executing Sourcehawk flatten command

FlattenConfigResultLogger - Class in com.optum.sourcehawk.exec.config

A logger for flatten config results

formatJson(T) - Method in class com.optum.sourcehawk.exec.AbstractExecResultLogger

Format the scan result for JSON output format

formatMarkdown(FixResult, Verbosity) - Method in class com.optum.sourcehawk.exec.fix.FixResultLogger

Format the result for markdown output format

formatMarkdown(ScanResult, Verbosity) - Method in class com.optum.sourcehawk.exec.scan.ScanResultLogger

Format the result for markdown output format

formatMarkdown(T, Verbosity) - Method in class com.optum.sourcehawk.exec.AbstractExecResultLogger

Format the result for markdown output format

formatTextMessages(FixResult) - Method in class com.optum.sourcehawk.exec.fix.FixResultLogger

Format the result messages for text output

formatTextMessages(ScanResult) - Method in class com.optum.sourcehawk.exec.scan.ScanResultLogger

Format the result messages for text output

formatTextMessages(T) - Method in class com.optum.sourcehawk.exec.AbstractExecResultLogger

Format the result messages for text output

formatTextSummary(FixResult) - Method in class com.optum.sourcehawk.exec.fix.FixResultLogger

Format the summary for plain text output format

formatTextSummary(ScanResult) - Method in class com.optum.sourcehawk.exec.scan.ScanResultLogger

Format the summary for plain text output format

formatTextSummary(T) - Method in class com.optum.sourcehawk.exec.AbstractExecResultLogger

Format the summary for plain text output format

G

getConfigurationFileLocation() - Method in class com.optum.sourcehawk.exec.ExecOptions

The location of the configuration file, can be on the file system or a URL

getOutputFormat() - Method in class com.optum.sourcehawk.exec.ExecOptions

The scan output format

getRemoteRef() - Method in class com.optum.sourcehawk.exec.ExecOptions

The remote reference

getRepositoryFileReader() - Method in class com.optum.sourcehawk.exec.ExecOptions

Repository file reader

getRepositoryRoot() - Method in class com.optum.sourcehawk.exec.ExecOptions

The root of the repository in which files will be resolved relatively to

getTags() - Method in class com.optum.sourcehawk.exec.ExecOptions

The tags to filter the execution scope

getVerbosity() - Method in class com.optum.sourcehawk.exec.ExecOptions

The output verbosity

globalError(Throwable) - Static method in class com.optum.sourcehawk.exec.fix.FixResultFactory

Create the fix result for situations where there is an error executing the fix

globalError(Throwable) - Static method in class com.optum.sourcehawk.exec.scan.ScanResultFactory

Create the scan result for situations where there is an exception executing the scan

H

hashCode() - Method in class com.optum.sourcehawk.exec.ExecOptions

I

isFailOnWarnings() - Method in class com.optum.sourcehawk.exec.ExecOptions

Whether or not to fail on warnings

J

JSON_WRITER - Static variable in class com.optum.sourcehawk.exec.AbstractExecResultLogger

The JSON writer

L

log(FlattenConfigResult, Path) - Static method in class com.optum.sourcehawk.exec.config.FlattenConfigResultLogger

Log the result of the fix in the specified format

log(String) - Static method in class com.optum.sourcehawk.exec.Console.Out

Log a message to standard out

log(String, Object...) - Static method in class com.optum.sourcehawk.exec.Console.Err

Log a message to standard err

log(T, ExecOptions) - Method in class com.optum.sourcehawk.exec.AbstractExecResultLogger

Log the result in the specified format

M

MAPPER - Static variable in class com.optum.sourcehawk.exec.ConfigurationReader

The object mapper which is used to deserialize the configuration from file

N

noResolver(String, String) - Static method in class com.optum.sourcehawk.exec.fix.FixResultFactory

Create the fix result for situations when there is no resolver to fix the enforcer error

O

outputFormat(OutputFormat) - Method in class com.optum.sourcehawk.exec.ExecOptions.ExecOptionsBuilder

The scan output format

P

parseConfiguration(InputStream) - Static method in class com.optum.sourcehawk.exec.ConfigurationReader

Parse the configuration from the provided yaml string

parseConfiguration(Path) - Static method in class com.optum.sourcehawk.exec.ConfigurationReader

Parse the configuration from the provided file

parseFileEnforcer(Object) - Static method in class com.optum.sourcehawk.exec.ConfigurationReader

Parse the file enforcer

R

readConfiguration(Path, String) - Static method in class com.optum.sourcehawk.exec.ConfigurationReader

Read the configuration from the provided location

remoteRef(RemoteRef) - Method in class com.optum.sourcehawk.exec.ExecOptions.ExecOptionsBuilder

The remote reference

repositoryFileReader(RepositoryFileReader) - Method in class com.optum.sourcehawk.exec.ExecOptions.ExecOptionsBuilder

Repository file reader

repositoryRoot(Path) - Method in class com.optum.sourcehawk.exec.ExecOptions.ExecOptionsBuilder

The root of the repository in which files will be resolved relatively to

resolverResult(FileProtocol, ResolverResult, boolean) - Static method in class com.optum.sourcehawk.exec.fix.FixResultFactory

Create a fix result based on the file protocol and resolver result

S

scan(ExecOptions) - Static method in class com.optum.sourcehawk.exec.scan.ScanExecutor

Run the scan based on the provided options

ScanExecutor - Class in com.optum.sourcehawk.exec.scan

Entry point into executing scans

ScanResultFactory - Class in com.optum.sourcehawk.exec.scan

A factory for creating instances of ScanResult

ScanResultLogger - Class in com.optum.sourcehawk.exec.scan

A logger for scan results

T

tags(Collection<String>) - Method in class com.optum.sourcehawk.exec.ExecOptions.ExecOptionsBuilder

The tags to filter the execution scope

toBuilder() - Method in class com.optum.sourcehawk.exec.ExecOptions

toString() - Method in class com.optum.sourcehawk.exec.ExecOptions.ExecOptionsBuilder

toString() - Method in class com.optum.sourcehawk.exec.ExecOptions

Print a string representation of the exec options

V

verbosity(Verbosity) - Method in class com.optum.sourcehawk.exec.ExecOptions.ExecOptionsBuilder

The output verbosity

A B C E F G H I J L M N O P R S T V
All Classes All Packages