Index (Jervis API Docs)

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _

A

addTrailingSlash(String, String) - Method in SimpleRestService: Meant for flexibly setting API URLs, this will enforce a trailing slash and optionaly a suffix such as an API version applied to the URL.
addTrailingSlash(String, String) - Method in SimpleRestServiceSupport: Meant for flexibly setting API URLs, this will enforce a trailing slash and optionaly a suffix such as an API version applied to the URL.
apiFetch(URL, Map, String, String) - Method in SimpleRestService: apiFetch() can be used to submit HTTP commands common to REST APIs.
apiFetch(String, Map, String, Map) - Method in SimpleRestServiceSupport: This method is provided for REST client development convenience.
AutoRelease - Class in net.gleske.jervis.tools: This utility class provides automatic release methods such as pattern matching and version bumping if given existing releases.
avoidTimingAttack(Integer, Closure) - Method in SecurityIO: This is a constant-time function intended to wrap security-sensitive code.

B

baseUrl() - Method in GitHub
baseUrl() - Method in GitHubAppCredential: Used for API access to issue tokens.
baseUrl() - Method in GitHubGraphQL: A method which returns the base URL for the GitHub v4 GraphQL API.
baseUrl() - Method in SimpleRestServiceSupport: A method for getting the API URL which will be used by apiFetch(java.lang.String, java.util.Map, java.lang.String, java.lang.String).
baseUrl() - Method in VaultAppRoleCredential: Returns the Vault URL.
baseUrl() - Method in VaultService: Resolves the API base URL to be used by SimpleRestService.apiFetch.
branches(String) - Method in GitHub: Get a list of branches for a project.
branches(String) - Method in JervisRemote: Query a remote project for a list of branches.

C

CipherMap - Class in net.gleske.jervis.tools: Strong encrypted storage backend used for encrypting a Map at rest.
CipherMap(File, Integer) - Constructor in CipherMap: Instantiates a new CipherMap object with the given private key.
copyAllKeys(String, String, Integer) - Method in VaultService: Recursively copies all secrets from the source location, srcPaht, to the destination location, destPath.
copySecret(Map, Map, Integer) - Method in VaultService: Copies the contents of secret from a source key to the destination key using location maps.

D

decodeBase64Bytes(String) - Method in SecurityIO: Decode a base64 String into Bytes.
decodeBase64String(String) - Method in SecurityIO: Decode a base64 String.
decodeBase64UrlBytes(String) - Method in SecurityIO: Decode a URL safe base64 String into Bytes.
decodeBase64UrlString(String) - Method in SecurityIO: Decode a URL safe base64 String into a String.
DecryptException - Class in net.gleske.jervis.exceptions: A type of SecurityException which is thrown when a decryption issue occurs.
DecryptException(String) - Constructor in DecryptException: Throw an exception relaying why decrypting a string failed.
decryptSecrets() - Method in LifecycleGenerator: Decrypts encrypted values stored in cipherlist.
decryptWithAES256(String, String, Integer) - Method in SecurityIO: Decrypts ciphertext with AES-256 using a passphrase.
decryptWithAES256Base64(String, String, String, Integer) - Method in SecurityIO: Takes Base64 encoded secret and IV and decrypts the provided Base64 encoded String data.
deletePath(String, Integer, Boolean) - Method in VaultService: Recursively deletes a path of keys including all child keys from a KV v1 or KV v2 secrets engine.
deleteSecret(String, Boolean) - Method in VaultService: Deletes data from a KV v1 or KV v2 secrets engine.
discoverKVMounts() - Method in VaultService: Query Vault to find all of the KV mounts.

E

encodeBase64(byte[]) - Method in SecurityIO: Encode raw Bytes into a base64 String.
encodeBase64Url(byte[]) - Method in SecurityIO: Encode raw Bytes into a URL safe base64 String.
EncryptException - Class in net.gleske.jervis.exceptions: A type of SecurityException which is thrown when an encryption issue occurs.
EncryptException(String) - Constructor in EncryptException: Throw an exception relaying why encrypting a string failed.
encryptWithAES256(String, String, Integer) - Method in SecurityIO: Encrypts String data with AES-256 using a passphrase.
encryptWithAES256Base64(String, String, String, Integer) - Method in SecurityIO: Takes Base64 encoded secret and IV and encrypts the provided String data.
EphemeralTokenCache - Class in net.gleske.jervis.remotes.creds: A flexible token cache with pluggable backend storage which encrypts the cache before storing it in the backend.
EphemeralTokenCache(String) - Constructor in EphemeralTokenCache: Creates an encrypted ephemeral token cache from a private key on disk.
EphemeralTokenCredential - Interface in net.gleske.jervis.remotes.interfaces: Provides a high level interface for ephemeral API tokens issued by a time-limited token issuing service.

F

fetch(String) - Method in GitHub: Fetches a URL from GitHub API.
FilterByContext - Class in net.gleske.jervis.tools: Filter by context can provide a boolean result based on the conditions in which a project is being built combined with user-provided filters.
FilterByContext(Map, Map) - Constructor in FilterByContext
FilterByContextException - Class in net.gleske.jervis.exceptions: A group of exceptions that are thrown when undesireable script generation conditions occur.
FilterByContextException(String) - Constructor in FilterByContextException: Throw a FilterByContextException.
findAllKeys(String, Integer) - Method in VaultService: Recursively traverses the path for subkeys.

G

generateAll() - Method in LifecycleGenerator: Generate the build script which would be used in the Jenkins step.
generateSection(String) - Method in LifecycleGenerator: A generic function to generate code for different sections of the build script.
generateToolchainSection() - Method in LifecycleGenerator: Generate the toolchains shell script based on the Jervis YAML or taking defaults from the toolchains file.
GeneratorException - Class in net.gleske.jervis.exceptions: A group of exceptions that are thrown when undesireable script generation conditions occur.
GeneratorException(String) - Constructor in GeneratorException: Throw a GeneratorException.
getAllowBuild() - Method in FilterByContext: Evaluate the full list of complex filters provided by the user and provide a single result based on context of how a build was triggered and at what point in the Git workflow the job is building (pr, branch, or tag).
getAlwaysBuildExpression() - Method in FilterByContext: Get an expression which will always result in allowBuild returning true.
getApiUri() - Method in GitHubAppRsaCredential: Returns the API URL where this class will attempt to submit a GitHub app.
getApiUri() - Method in GitHubAppRsaCredentialImpl: The GitHub API URL for querying GitHub App API in case of self-hosted GitHub Enterprise.
getAppID() - Method in GitHubAppRsaCredential: Returns the GitHub App ID for the app installed into GitHub orgs and users.
getAppID() - Method in GitHubAppRsaCredentialImpl: The GitHub App ID for a GitHub credential.
getBranchRegexString() - Method in LifecycleGenerator: Get the regular expression which is used for branch filtering.
getBuildableMatrixAxes() - Method in PipelineGenerator: Returns a list of maps which are buildable matrices in a matrix build.
getCloneUrl() - Method in GitHub: Get the contents of gh_clone.
getCloneUrl() - Method in JervisRemote: Repositories will be cloned from this base Git URI.
getDefaultToolchainsEnvironment() - Method in PipelineGenerator: Get default toolchains environment.
getDefaultToolchainsScript() - Method in PipelineGenerator: Get default toolchains script.
getEnvironmentSecret(String, Integer, Boolean) - Method in VaultService: Returns a Map of key-value pairs compatible with bash environment variables.
getEnvironmentSecrets(List, Boolean) - Method in VaultService: Returns a Map of key-value pairs compatible with bash environment variables.
getExpiration() - Method in EphemeralTokenCache: Gets expiration of the token.
getExpiration() - Method in EphemeralTokenCredential: Returns when an issued ephemeral token will expire.
getFile(String, String, String) - Method in GitHub: Get the contents of a file from a project.
getFile(String, String, String) - Method in JervisRemote: Get the contents of a file in a remote git project for a given reference.
getFilteredBranchesList() - Method in LifecycleGenerator: Get a list of static branch names which is used for branch filtering.
getFolderListing(String, String, String) - Method in GitHub: Get the directory listing of a path from a project.
getFolderListing(String, String, String) - Method in JervisRemote: Get list a file path in a project for the given reference.
getFullBranchRegexString(List) - Method in LifecycleGenerator: Get the regular expression for all whitelisted branches.
getGh_token() - Method in GitHub: Retrieves the token used to authenticate with GitHub.
getGitHubJWT(String, Integer, Integer) - Method in SecurityIO: Get a JSON Web Token (JWT) meant for use with GitHub App Authentication.
getGqlData(String, String) - Method in GitHubGraphQL: Transforms a GraphQL query and variables into data which can be submitted with a POST request.
getHash() - Method in GitHubAppCredential: A hash of GitHubAppRsaCredential.getId and requested token scope.
getId() - Method in GitHubAppRsaCredential: Returns an ID unique to this credential to differentiate it from other credentials.
getId() - Method in GitHubAppRsaCredentialImpl: An ID unique to this credential.
getInstallation_id() - Method in GitHubAppCredential: If installation ID is not set, then it will automatically resolve an ID from app installations.
getJenkinsfile() - Method in LifecycleGenerator: Get the Jenkinsfile for a pipeline.
getJervisYamlFiles(String, List, List) - Method in GitHubGraphQL: Get Jervis YAML from a remote repository.
getLabels() - Method in LifecycleGenerator: Returns a groovy expression which Jenkins would use to pin a job to specific nodes.
getLifecycleDocumentation(String, String) - Method in SupportDocumentationGenerator: Return markdown documentation for a given OS supporting a language.
getLocationFromPath(String) - Method in VaultService: Given a path representing the full path including a mount and secret path, only the location relative to the parent mount is returned.
getLocationMapFromPath(String) - Method in VaultService: If given a full path to a secret in Vault, a location Map is returned.
getMatrix_fullName_by_friendly() - Method in LifecycleGenerator
getMountFromPath(String) - Method in VaultService: Given a path this method will return the Vault secrets mount.
getNextRelease(String, List<String>, String, String) - Method in AutoRelease: Gets a bumped version with a more loosely formed format.
getNextSemanticRelease(String, List<String>, String) - Method in AutoRelease: Provides automatically getting the next version for semantic versioning.
getObjectValue(Map, String, Object) - Method in YamlOperator: Get an object from a Map or return any object from defaultValue.
getOwner() - Method in GitHubAppRsaCredential: Returns the owner which installed the GitHub App.
getPathFromLocationMap(Map) - Method in VaultService: If given a location Map it will convert it to a String path for Vault APIs.
getPlainMap() - Method in CipherMap: Decrypts the encrypted map and returns the object.
getPrivateKey() - Method in GitHubAppRsaCredential: Returns the RSA private key for a GitHub App.
getPrivateKey() - Method in GitHubAppRsaCredentialImpl: A private key for a GitHub App necessary for signing JSON Web Tokens (JWT).
getPublishable(String) - Method in PipelineGenerator: Get a publishable item from the list of publishable items.
getPublishableItems() - Method in PipelineGenerator: Get a list of publishable items which show up in .jervis.yml.
getRenew_buffer() - Method in EphemeralTokenCache: Returns renew buffer for the current token.
getRenew_buffer() - Method in VaultAppRoleCredential: Returns renew buffer.
getRole_id() - Method in VaultRoleIdCredential: When implemented, this method should return a role ID used for authenticating with Vault.
getRole_id() - Method in VaultRoleIdCredentialImpl: Returns the Role ID used for approle authentication.
getRsa_keysize() - Method in SecurityIO: Returns the calculated RSA private key size in bits calculated from the key_pair.
getScriptFromTemplate(String, Map) - Method in AutoRelease: This method is for applying variables to a groovy template.
getSecret_id() - Method in VaultRoleIdCredential: When implemented, this method should return a secret ID used for authenticating with Vault.
getSecret_id() - Method in VaultRoleIdCredentialImpl: Returns the Secret ID used for approle authentication.
getSecret(String, Integer) - Method in VaultService: Get secret from a KV v1 or KV v2 secret engine.
getSecretPairsEnv() - Method in PipelineGenerator: Processes secret properties from .jervis.yml into two lists.
getStashMap(Map) - Method in PipelineGenerator: Returns a list of stashes from Jervis YAML to be stashed either serially or in this matrix axis for matrix builds.
getTextWithLock() - Method in LockableFile: Obtains an exclusive FileLock before reading the contents of a File.
getToken() - Method in EphemeralTokenCache: Gets the access token used for API authentication retrieved from the cache.
getToken() - Method in GitHubAppCredential: Get a valid GitHub App API token meant for cloning code or interacting with GitHub APIs.
getToken() - Method in GitHubGraphQL: Retrieves the token used to authenticate with GitHub.
getToken() - Method in ReadonlyTokenCredential: When implemented, this method should return a String that is a token to be used in API service authentication in Jervis remotes.
getToken() - Method in TokenCredential: When implemented, this method should return a String that is a token to be used in API service authentication in Jervis remotes.
getToken() - Method in VaultAppRoleCredential: This will lease a new token via AppRole and return the leased token.
getVault_url() - Method in VaultAppRoleCredential: Returns the Vault URL.
getVault_url() - Method in VaultCredential: When implemented, this method should return a String that is the URL to a HashiCorp Vault instance API endpoint.
getWebUrl() - Method in GitHub: Get the contents of gh_web.
getWebUrl() - Method in JervisRemote: A web interface to browse repository code.
getYaml() - Method in PipelineGenerator: Get Jervis YAML from the pipeline generator.
GitHub - Class in net.gleske.jervis.remotes: A simple class to interact with the GitHub v3 API for only the parts I need.
GitHubAppCredential - Class in net.gleske.jervis.remotes.creds: Provides GitHub App Credential for API authentication.
GitHubAppCredential(GitHubAppRsaCredential, EphemeralTokenCredential) - Constructor in GitHubAppCredential: Creates a new instance of a GitHubAppCredential meant to serve as an easy to use credential in API clients such as GitHubGraphQL and GitHub.
GitHubAppException - Class in net.gleske.jervis.exceptions: A group of exceptions that are thrown when net.gleske.jervis.remotes.GitHubAppCredential issues occur.
GitHubAppException(String) - Constructor in GitHubAppException: Throw a GitHubAppException.
GitHubAppRsaCredential - Interface in net.gleske.jervis.remotes.interfaces: Provides a high level interface for providing GitHub App credentials.
GitHubAppRsaCredentialImpl - Class in net.gleske.jervis.remotes.creds: A basic implementation of the GitHubAppRsaCredential.
GitHubAppRsaCredentialImpl(String, Closure, String) - Constructor in GitHubAppRsaCredentialImpl: Instantiates an RSA credential for a GitHub App used to generate API tokens.
GitHubGraphQL - Class in net.gleske.jervis.remotes: A simple class to interact with the GitHub v4 GraphQL API.

H

hasRegexFilter() - Method in LifecycleGenerator: This method makes it easy to detect if regular expressions are defined for branch filtering.
header(Map) - Method in GitHub
header(Map) - Method in GitHubAppCredential: Headers used for authentication.
header(Map) - Method in GitHubGraphQL: A method which sets authentication headers.
header(Map) - Method in SimpleRestServiceSupport: A method for getting authentication headers and other default headers used by apiFetch(java.lang.String, java.util.Map, java.lang.String, java.lang.String).
header(Map) - Method in VaultAppRoleCredential: Returns authentication headers used for API requests to Vault.
header(Map) - Method in VaultService: Resolves authentication headers to be used by SimpleRestService.apiFetch.

I

isDeletedSecret(String, Integer) - Method in VaultService: Check if a secret is deleted by attempting to retrieve it or check its status.
isExpired(Instant) - Method in EphemeralTokenCache: Checks if the provided time has passed.
isExpired() - Method in EphemeralTokenCredential: Checks if a token is expired.
isFilteredByRegex(String) - Method in LifecycleGenerator: Detect if this branch is already covered by a regex filter.
isFriendlyLabel(String) - Method in ToolchainValidator: Can a toolchain be used with a friendly label when Jenkins matrix axes are used?
isGenerateBranch(String) - Method in LifecycleGenerator: Is this a branch which will generate a job?
isInstanceFromList(Object, List<Class>) - Method in LifecycleGenerator: Check if an object is an instance of any of the classes in a list.
isMatched(String, String) - Method in AutoRelease: Matches a string against an expression.
isMatrixBuild() - Method in LifecycleGenerator: This will check if the loaded YAML is a matrix build.
isPipelineJob() - Method in LifecycleGenerator: Determine if this instance is compatible with pipeline multibranch jobs.
isRestricted(String) - Method in LifecycleGenerator: Given a project combination of org/project determine if a project is allowed to be generated for a platform combination.
isSecureField(def) - Method in SecurityIO: Checks to see if a field in the Jervis YAML is a secure field.
isSupportedPlatform() - Method in LifecycleGenerator: Checks if a job that is using a platform and toolchain which is supported in the loaded platforms file.
isUser(String) - Method in GitHub: Check with the GitHub API and determine if the passed in user is a User or an Organization.

J

JervisCredential - Interface in net.gleske.jervis.remotes.interfaces: Provides a way to call an external credential store in case there's an alternate means of storing and retrieving credentials.
JervisException - Class in net.gleske.jervis.exceptions: The base exception class for Jervis from which all other exceptions derive.
JervisException(String) - Constructor in JervisException: Throw a JervisException.
JervisRemote - Interface in net.gleske.jervis.remotes.interfaces: Provides a minimum standard interface a Jervis remote requires.

K

KeyPairDecodeException - Class in net.gleske.jervis.exceptions: A type of SecurityException which is thrown when an issue with generating key pairs occurs.
KeyPairDecodeException(String) - Constructor in KeyPairDecodeException: Throw an exception relaying why decoding a string possibly containing a PEM encoded X.509 private key failed.

L

leftShift(def) - Method in CipherMap: Load or append to this object enciphered text.
LifecycleBadValueInKeyException - Class in net.gleske.jervis.exceptions: A type of LifecycleValidationException which is thrown when there is a bad value in a lifecycles file key.
LifecycleBadValueInKeyException(String) - Constructor in LifecycleBadValueInKeyException: Throw an exception for a bad value in a key.
LifecycleGenerator - Class in net.gleske.jervis.lang: Generates the build scripts from the Jervis YAML.
LifecycleInfiniteLoopException - Class in net.gleske.jervis.exceptions: A type of LifecycleValidationException which is thrown when a lifecycles file keys reference in an infinite loop.
LifecycleInfiniteLoopException(String) - Constructor in LifecycleInfiniteLoopException: Throw an exception when lifecycle keys reference in an infinite loop.
LifecycleMissingKeyException - Class in net.gleske.jervis.exceptions: A type of LifecycleValidationException which is thrown when a lifecycles file key is referenced but missing.
LifecycleMissingKeyException(String) - Constructor in LifecycleMissingKeyException: Throw an exception when lifecycles file key is referenced but missing.
LIFECYCLES_SPEC - Field in WikiPages: A static reference to the lifecycles file spec wiki page.
LifecycleValidationException - Class in net.gleske.jervis.exceptions: A group of exceptions that are thrown when validation errors occur in the lifecycles file.
LifecycleValidationException(String) - Constructor in LifecycleValidationException: Throw a LifecycleValidationException.
LifecycleValidator - Class in net.gleske.jervis.lang: Validates the contents of a lifecycle file and provides quick access to supported languages.
listPath(String) - Method in VaultService: List a path in Vault to find KV secret entries.
loadLifecycles(String) - Method in LifecycleGenerator: Load a lifecycles file so that default scripts can be generated.
loadLifecyclesString(String) - Method in LifecycleGenerator: Load a lifecycles YAML String so that default scripts can be generated.
loadPlatforms(String) - Method in LifecycleGenerator: Load a platforms file so that advanced labels can be generated for multiple platforms.
loadPlatformsString(String) - Method in LifecycleGenerator: Load a platforms YAML String so that advanced labels can be generated for multiple platforms.
loadToolchains(String) - Method in LifecycleGenerator: Load a toolchains file so that default scripts can be generated.
loadToolchainsString(String) - Method in LifecycleGenerator: Load a toolchains YAML String so that default scripts can be generated.
loadYamlFile(String) - Method in LifecycleValidator: Load the YAML of a lifecycles file and parse it.
loadYamlFile(String) - Method in PlatformValidator: Load the YAML of a platforms file and parse it.
loadYamlFile(String) - Method in ToolchainValidator: Load the YAML of a toolchains file and parse it.
loadYamlFrom(File) - Method in YamlOperator: Given a file, this will load YAML from a File and return a Java object consisting of standard classes.
loadYamlString(String) - Method in LifecycleGenerator: Load Jervis YAML to be interpreted.
loadYamlString(String) - Method in LifecycleValidator: Parse the YAML which is the contents of a lifecycles file.
loadYamlString(String) - Method in PlatformValidator: Parse the YAML which is the contents of a platforms file.
loadYamlString(String) - Method in ToolchainValidator: Parse the YAML which is the contents of a toolchains file.
LockableFile - Class in net.gleske.jervis.tools: Provides extensions to File for exclusive file locking to guarantee serialized access to the File via FileLock.
LockableFile(String) - Constructor in LockableFile: Same as a File with extra functionality for creating exclusive locks on the File via FileLock.
lookupToken() - Method in VaultAppRoleCredential: Performs a lookup of the currently leased token and returns the response from Vault.

M

matrixExcludeFilter() - Method in LifecycleGenerator: This function generates a Jenkins groovy expression from Jervis YAML which will be used to exclude matrix build combinations.
matrixGetAxisValue(String) - Method in LifecycleGenerator: Get a value for a given axis for matrix building.

N

O

objToJson(def) - Method in SimpleRestService: A method for converting an object comprising of standard Java classes Map or List to a JSON String.
objToJson(Map) - Method in SimpleRestServiceSupport: A method for converting a HashMap of standard Java types to a JSON String.

P

padForAES256(byte[]) - Method in SecurityIO: Repeats the input bytes until enough bytes are provided for AES-256.
PIPELINE_SUPPORT - Field in WikiPages: A static reference to the pipeline support wiki page.
PipelineGenerator - Class in net.gleske.jervis.lang: This class offers helper forunctions for using Jervis in the context of a Jenkins pipeline global shared library.
PipelineGenerator(LifecycleGenerator) - Constructor in PipelineGenerator: Instantiates this class with a LifecycleGenerator which is used for helper functions when creating a pipeline job designed to support Jervis.
PipelineGeneratorException - Class in net.gleske.jervis.exceptions: A group of exceptions that are thrown when validation errors occur in the lifecycles file.
PipelineGeneratorException(String) - Constructor in PipelineGeneratorException: Throw a PipelineGeneratorException.
PlatformBadValueInKeyException - Class in net.gleske.jervis.exceptions: A type of PlatformValidationException which is thrown when there is a bad value in a platforms file key.
PlatformBadValueInKeyException(String) - Constructor in PlatformBadValueInKeyException: Throw an exception for a bad value in a key.
PlatformMissingKeyException - Class in net.gleske.jervis.exceptions: A type of PlatformValidationException which is thrown when a platforms file key is referenced but missing.
PlatformMissingKeyException(String) - Constructor in PlatformMissingKeyException: Throw an exception when platforms file key is referenced but missing.
PLATFORMS_SPEC - Field in WikiPages: A static reference to the platforms file spec wiki page.
PlatformValidationException - Class in net.gleske.jervis.exceptions: A group of exceptions that are thrown when validation errors occur in the platforms file.
PlatformValidationException(String) - Constructor in PlatformValidationException: Throw a PlatformValidationException
PlatformValidator - Class in net.gleske.jervis.lang: Validates the contents of a platforms file and provides quick access to supported platforms.
preloadYamlString(String) - Method in LifecycleGenerator: Preload Jervis YAML for the purpose of loading lifecycles files for other platforms and operating systems.

Q

R

randomBytes(int) - Method in SecurityIO: Returns a random of bytes.
randomBytesBase64(int) - Method in SecurityIO: Base64 encoded random bytes.
ReadonlyTokenCredential - Trait in net.gleske.jervis.remotes.creds: A read only credential interface which partially implements TokenCredential.
renewToken() - Method in VaultAppRoleCredential: Force a token renewal.
revokeToken() - Method in VaultAppRoleCredential: Revokes the current token in use by this auth client.
rsaDecrypt(String) - Method in SecurityIO: Uses RSA asymmetric encryption to decrypt a ciphertext String and outputs plain text.
rsaDecryptBytes(byte[]) - Method in SecurityIO: Uses RSA asymmetric encryption to decrypt enciphered bytes and returns plain bytes.
rsaEncrypt(String) - Method in SecurityIO: Uses RSA asymmetric encryption to encrypt a plain text String and outputs ciphertext.
rsaEncryptBytes(byte[]) - Method in SecurityIO: Uses RSA asymmetric encryption to encrypt a plain bytes and outputs enciphered bytes.

S

SECURE_SECRETS - Field in WikiPages: A static reference to the secure secrets in repositories wiki page.
SecurityException - Class in net.gleske.jervis.exceptions: A group of exceptions that are thrown when security issues occur.
SecurityException(String) - Constructor in SecurityException: Throw a SecurityException.
SecurityIO - Class in net.gleske.jervis.tools: A class to provide cryptographic features to Jervis such as RSA encryption and base64 encoding.
SecurityIO(String) - Constructor in SecurityIO: Instantiates the class and configures a private key for decryption.
sendGQL(String, Map, String, Map) - Method in GitHubGraphQL: A method for calling the GitHub v4 GraphQL API with a GraphQL query and variables.
setApprole_mount(String) - Method in VaultAppRoleCredential: Sets the approle_mount property and trims leading or trailing slash.
setCacheFile(String) - Method in EphemeralTokenCache: Set cache file location when the cache is saved to local disk.
setCacheLockFile(String) - Method in EphemeralTokenCache: Set cache lock file location when the cache is saved to local disk.
setCollect_settings_defaults(Map) - Method in PipelineGenerator: This method merges Map m with the existing map collect_settings_defaults.
setCredential(TokenCredential) - Method in GitHub
setExpiration(String) - Method in EphemeralTokenCache: Sets the expiration for a given token.
setExpiration(String) - Method in EphemeralTokenCredential: Sets when an ephemeral token will expire.
setFilters(def) - Method in FilterByContext: Sets a filter to be evaluated against a context.
setFolder_listing(List) - Method in LifecycleGenerator: This function sets the folder_listing and based on the listing conditionally sets lifecycle_key.
setGh_api(String) - Method in GitHub: Sets the gh_api property.
setGh_clone(String) - Method in GitHub: Sets the gh_clone property.
setGh_token(String) - Method in GitHub: Sets the token to be used by GitHub.
setGh_web(String) - Method in GitHub: Sets the gh_web and gh_api properties.
setHash(String) - Method in GitHubAppCredential: This method will throw an exception because the hash calculation is dynamic and must not be set.
setKey_pair(String) - Method in SecurityIO: Sets key_pair by decoding the String.
setLabel_stability(String) - Method in LifecycleGenerator: This function sets the label_stability property.
setLabel_sudo(String) - Method in LifecycleGenerator: This function sets the label_sudo property.
setLockWaitSleep(Integer) - Method in LockableFile
setMountVersions(Map) - Method in VaultService: Forces a specified secrets engine mount to be KV v1 or KV v2.
setOwner(String) - Method in GitHubAppRsaCredentialImpl: Sets the owner.
setPlainMap(Map) - Method in CipherMap: Encrypts the object and stores it for later retrieval as enciphered text.
setPrivateKey(String) - Method in LifecycleGenerator: Load an RSA private key in-memory rather than depending on a file existing on disk.
setRenew_buffer(Long) - Method in EphemeralTokenCache: Sets a renew buffer.
setResolvePrivateKey(Closure) - Method in GitHubAppRsaCredentialImpl: Setter for custom closure meant for private key lookup.
setRsaCredential(GitHubAppRsaCredential) - Method in GitHubAppCredential: Sets the RSA credential used for authentication.
setScope(Map) - Method in GitHubAppCredential: Sets the scope for issuing tokens.
setSecret(String, Map, Boolean) - Method in VaultService: Writes a secret to Vault KV v1 or KV v2 secrets engine.
setStashmap_preprocessor(Map) - Method in PipelineGenerator: This filter ensures an admin only sets proper closures for the stashmap_processor.
setToken(String) - Method in GitHubGraphQL: Sets the token to be used by GitHub.
setToken(String) - Method in ReadonlyTokenCredential: Implemented to do nothing.
setToken(String) - Method in TokenCredential: When implemented, this method should set the value of the token in a credential service.
sha256Sum(byte[]) - Method in SecurityIO: Calculates SHA-256 sum from a byte-array.
signRS256Base64Url(String) - Method in SecurityIO: Creates a URL safe base64 string of a signature using algorithm RS256.
SimpleRestService - Class in net.gleske.jervis.remotes: A simple class which makes using REST services like the GitHub API really easy.
SimpleRestServiceSupport - Trait in net.gleske.jervis.remotes: REST service classes can derive some default implementation from this trait.
SupportDocumentationGenerator - Class in net.gleske.jervis.beta: This is a utility class for Jervis admins to generate documentation on the fly for their specific environment.
SupportDocumentationGenerator(Map) - Constructor in SupportDocumentationGenerator
SUPPORTED_LANGUAGES - Field in WikiPages: A static reference to the supported languages wiki page.
SUPPORTED_TOOLS - Field in WikiPages: A static reference to the supported tools wiki page.
supportedLanguage(String) - Method in LifecycleValidator: Checks to see if a language is a supported language based on the lifecycles file.
supportedLanguage(String) - Method in ToolchainValidator: Checks to see if a language is a supported language based on the toolchains file.
supportedMatrix(String, String) - Method in ToolchainValidator: Checks to see if a toolchain is a supported build matrix based on a specific language.
supportedTool(String, String) - Method in ToolchainValidator: Check to see if a given tool is supported in the toolchain.
supportedToolchain(String) - Method in ToolchainValidator: Checks to see if a value is a supported toolchain based on the toolchains file.

T

TokenCredential - Interface in net.gleske.jervis.remotes.interfaces: Abstracted token credential allows retrieving a token from an external credential store.
TokenException - Class in net.gleske.jervis.exceptions: A group of exceptions that are thrown when there are incompatible configurations around getting or setting tokens for service authentication.
TokenException(String) - Constructor in TokenException: Throw a TokenException.
ToolchainBadValueInKeyException - Class in net.gleske.jervis.exceptions: A type of ToolchainValidationException which is thrown when there is a bad value in a toolchains file key.
ToolchainBadValueInKeyException(String) - Constructor in ToolchainBadValueInKeyException: Throw an exception for a bad value in a key.
ToolchainMissingKeyException - Class in net.gleske.jervis.exceptions: A type of ToolchainValidationException which is thrown when a toolchains file key is referenced but missing.
ToolchainMissingKeyException(String) - Constructor in ToolchainMissingKeyException: Throw an exception when toolchains file key is referenced but missing.
TOOLCHAINS_SPEC - Field in WikiPages: A static reference to the toolchains file spec wiki page.
toolchainType(String) - Method in ToolchainValidator: Checks to see what type a toolchain is.
ToolchainValidationException - Class in net.gleske.jervis.exceptions: A group of exceptions that are thrown when validation errors occur in the toolchains file.
ToolchainValidationException(String) - Constructor in ToolchainValidationException: Throw a ToolchainValidationException
ToolchainValidator - Class in net.gleske.jervis.lang: Validates the contents of a toolchains file and provides quick access to supported matrices.
toString() - Method in CipherMap: Returns an encrypted object as text meant for storing at rest.
toString() - Method in GitHub: Get a human readable string for this type of remote.
toString() - Method in JervisRemote: This method is used by Jervis to output friendly messages including the remote.

U

UnsupportedLanguageException - Class in net.gleske.jervis.exceptions: A type of GeneratorException which is thrown when an unsupported language lifecycle generation is attempted.
UnsupportedLanguageException(String) - Constructor in UnsupportedLanguageException: Throw an exception when an unsupported language lifecycle generation is attempted.
UnsupportedToolException - Class in net.gleske.jervis.exceptions: A type of GeneratorException which is thrown when an unsupported language lifecycle generation is attempted.
UnsupportedToolException(String) - Constructor in UnsupportedToolException: Throw an exception when an unsupported tool generation is attempted.
updateTokenWith(String, String, String) - Method in EphemeralTokenCache: A new token has been issued so this method will update the backend cache to store the new token.
updateTokenWith(String, String, String) - Method in EphemeralTokenCredential: Update all three properties with a repeatable unique hash provided in case backend caching is used.

V

validate_asBool() - Method in LifecycleValidator: Executes the validate() function but always returns a Boolean instead of throwing an exception upon failed validation.
validate_asBool() - Method in PlatformValidator: Executes the validate() function but always returns a Boolean instead of throwing an exception upon failed validation.
validate_asBool() - Method in ToolchainValidator: Executes the validate() function but always returns a Boolean instead of throwing an exception upon failed validation.
validate() - Method in LifecycleValidator: Validates the lifecycles file.
validate() - Method in PlatformValidator: Validates the platforms file.
validate() - Method in ToolchainValidator: Validates the toolchains file.
VaultAppRoleCredential - Class in net.gleske.jervis.remotes.creds: This provides HashiCorp Vault AppRole Authentication which issues rotating ephemeral tokens automatically.
VaultAppRoleCredential(String, VaultRoleIdCredential) - Constructor in VaultAppRoleCredential: The recommended way to establish a secured authenticated session with Vault.
VaultCredential - Interface in net.gleske.jervis.remotes.interfaces: Generic vault credential type that provides the minimum necessary implementation required by the VaultService class.
VaultException - Class in net.gleske.jervis.exceptions: A group of exceptions that are thrown when VaultService issues occur.
VaultException(String) - Constructor in VaultException: Throw a VaultException.
VaultRoleIdCredential - Interface in net.gleske.jervis.remotes.interfaces: A basic credential whose only purpose is to get a Role ID and Secret ID for HashiCorp Vault AppRole authentication.
VaultRoleIdCredentialImpl - Class in net.gleske.jervis.remotes.creds: A simple credential for instantiating a vault approle credentials.
VaultRoleIdCredentialImpl(String, String) - Constructor in VaultRoleIdCredentialImpl: Instantiate a role ID credential meant to be used with approle authentication.
VaultService - Class in net.gleske.jervis.remotes: Provides easy access to HashiCorp Vault Key-Value secrets engine.
VaultService(VaultCredential) - Constructor in VaultService: Authenticate with Vault using AppRole authentication via VaultAppRoleCredential.
verifyGitHubJWTPayload(String, Integer) - Method in SecurityIO: Verify a GitHub JWT is not expired by checking the signature and ensuring current time falls within issued at and expiration.
verifyJsonWebToken(String) - Method in SecurityIO: Use the loaded public key to verify the provided JSON web token (JWT).
verifyRS256Base64Url(String, String) - Method in SecurityIO: Verify data signed by RS256 Base64 URL encoded signature.

W

WikiPages - Class in net.gleske.jervis.exceptions: A simple class, whose only purpose is to house static strings referencing the Jervis wiki, to be used as helpful hints when throwing exceptions.
withLock(Closure) - Method in LockableFile: Creates an exclusive lock with the current LockableFile.
withLockedWriter(Closure) - Method in LockableFile: Obtains an exclusive FileLock before opening a file for writing.
writeObjToYaml(File, def) - Method in YamlOperator: Convert a POJO consisting of standard Java classes into YAML written in a file.

X

Y

YamlOperator - Class in net.gleske.jervis.tools: A utility class for centralizing basic YAML operations required by Jervis.