Index (kustomtrace 1.1.0 API)

A B C D E F G H I K N P R S T U V Y
All Classes and Interfaces|All Packages|Serialized Form

A

addDependent(Kustomization) - Method in class dev.zucca_ops.kustomtrace.model.GraphNode: Adds a Kustomization that depends on this node.
addNode(GraphNode) - Method in class dev.zucca_ops.kustomtrace.model.KustomGraph: Adds a GraphNode (like a Kustomization or KustomFile) to the graph.
addReference(ResourceReference) - Method in class dev.zucca_ops.kustomtrace.model.Kustomization: Adds a resolved reference to another graph node.
addResource(KustomResource) - Method in class dev.zucca_ops.kustomtrace.model.KustomFile: Adds a parsed Kubernetes resource to this file.

B

BASE - Enum constant in enum class dev.zucca_ops.kustomtrace.parser.ReferenceType
build() - Method in class dev.zucca_ops.kustomtrace.graph.KustomGraphBuilder: Scans the configured appsDir, builds all found Kustomizations and their referenced resources, and populates the internal KustomGraph.

C

COMPONENT - Enum constant in enum class dev.zucca_ops.kustomtrace.parser.ReferenceType
CONFIG_MAP - Enum constant in enum class dev.zucca_ops.kustomtrace.parser.ReferenceType
configMapGeneratorFiles() - Static method in class dev.zucca_ops.kustomtrace.parser.ReferenceExtractors: Deprecated.
Use ReferenceExtractors.generatorFiles().
containsNode(Path) - Method in class dev.zucca_ops.kustomtrace.model.KustomGraph: Checks if a node with the given path exists in the graph.

D

dependents - Variable in class dev.zucca_ops.kustomtrace.model.GraphNode
dev.zucca_ops.kustomtrace - package dev.zucca_ops.kustomtrace
dev.zucca_ops.kustomtrace.exceptions - package dev.zucca_ops.kustomtrace.exceptions
dev.zucca_ops.kustomtrace.graph - package dev.zucca_ops.kustomtrace.graph
dev.zucca_ops.kustomtrace.model - package dev.zucca_ops.kustomtrace.model
dev.zucca_ops.kustomtrace.parser - package dev.zucca_ops.kustomtrace.parser
directory() - Static method in class dev.zucca_ops.kustomtrace.parser.ReferenceExtractors: Returns a ReferenceExtractor for Kustomize fields (e.g., 'bases', 'components') that must reference directories.

E

equals(Object) - Method in record class dev.zucca_ops.kustomtrace.model.ResourceReference: Indicates whether some other object is "equal to" this one.
extract(Object, Path) - Method in interface dev.zucca_ops.kustomtrace.parser.ReferenceExtractor: Extracts and resolves file paths from a given YAML field value.
extract(Object, Path) - Method in enum class dev.zucca_ops.kustomtrace.parser.ReferenceType: Extracts and resolves file paths from the given YAML value using the ReferenceExtractor associated with this reference type.

F

fromDirectory(Path) - Static method in class dev.zucca_ops.kustomtrace.KustomTrace
fromYamlKey(String) - Static method in enum class dev.zucca_ops.kustomtrace.parser.ReferenceType: Retrieves a ReferenceType enum constant based on its YAML key.

G

generatorFiles() - Static method in class dev.zucca_ops.kustomtrace.parser.ReferenceExtractors: Returns a ReferenceExtractor for extracting file paths from the envs and files fields of generator entries such as configMapGenerator and secretGenerator.
getAllAppFiles(Path) - Method in class dev.zucca_ops.kustomtrace.model.KustomGraph: Retrieves all file dependencies for a given application path.
getApps() - Method in class dev.zucca_ops.kustomtrace.model.Kustomization: Retrieves all "root" Kustomizations that this Kustomization contributes to.
getAppsWith(Path) - Method in class dev.zucca_ops.kustomtrace.KustomTrace
getContent() - Method in class dev.zucca_ops.kustomtrace.model.Kustomization: Returns the parsed content (YAML map) of this kustomization file.
getDependencies() - Method in class dev.zucca_ops.kustomtrace.model.Kustomization: Retrieves all file dependencies for this Kustomization.
getDependenciesFor(Path) - Method in class dev.zucca_ops.kustomtrace.KustomTrace
getDependents() - Method in class dev.zucca_ops.kustomtrace.model.GraphNode
getDisplayName() - Method in class dev.zucca_ops.kustomtrace.model.Kustomization: Provides a display name for this Kustomization, typically its kind and path.
getDisplayName() - Method in class dev.zucca_ops.kustomtrace.model.KustomResource: Generates a display name for the resource, combining its kind, name, and file path.
getFile() - Method in class dev.zucca_ops.kustomtrace.model.KustomResource
getGraph() - Method in class dev.zucca_ops.kustomtrace.KustomTrace
getKind() - Method in class dev.zucca_ops.kustomtrace.model.Kustomization: Returns the kind of this graph node.
getKind() - Method in class dev.zucca_ops.kustomtrace.model.KustomResource
getKind(Map<String, Object>) - Static method in class dev.zucca_ops.kustomtrace.parser.YamlParser: Safely extracts the 'kind' attribute as a String from a parsed YAML document.
getKustomFile(Path) - Method in class dev.zucca_ops.kustomtrace.model.KustomGraph: Retrieves a KustomFile from the graph, ensuring type safety.
getKustomization(Path) - Method in class dev.zucca_ops.kustomtrace.model.KustomGraph: Retrieves a Kustomization from the graph, ensuring type safety.
getKustomizationFileFromAppDirectory(Path) - Static method in class dev.zucca_ops.kustomtrace.parser.KustomizeFileUtil: Resolves an application path (directory or direct kustomization file path) to the actual Kustomization definition file.
getName() - Method in class dev.zucca_ops.kustomtrace.model.KustomResource
getNode(Path) - Method in class dev.zucca_ops.kustomtrace.model.KustomGraph: Retrieves a GraphNode from the graph by its path.
getPath() - Method in exception dev.zucca_ops.kustomtrace.exceptions.KustomException: Gets the file system path associated with this exception.
getPath() - Method in class dev.zucca_ops.kustomtrace.model.GraphNode
getRawReferences(Map<String, Object>) - Method in enum class dev.zucca_ops.kustomtrace.parser.ReferenceType: Retrieves raw reference values from a Kustomization content map for this reference type.
getReferences() - Method in class dev.zucca_ops.kustomtrace.model.Kustomization: Gets the list of resolved references to other graph nodes.
getResource() - Method in class dev.zucca_ops.kustomtrace.model.KustomFile: Gets the first Kubernetes resource found in this file, or a default "Undefined" resource if the file contains no parsed resources.
getResources() - Method in class dev.zucca_ops.kustomtrace.model.KustomFile: Gets all Kubernetes resources parsed from this file.
getRootApps() - Method in class dev.zucca_ops.kustomtrace.KustomTrace
getRootApps() - Method in class dev.zucca_ops.kustomtrace.model.KustomGraph: Gets all Kustomizations in the graph that are considered "root" applications (i.e., not depended upon by any other Kustomization).
getRootAppsWithFile(Path) - Method in class dev.zucca_ops.kustomtrace.model.KustomGraph: Gets all root Kustomizations that directly or indirectly reference the given file path.
getYamlKey() - Method in enum class dev.zucca_ops.kustomtrace.parser.ReferenceType: Gets the YAML key string associated with this reference type (e.g., "resources", "bases").
GraphNode - Class in dev.zucca_ops.kustomtrace.model: Abstract base class for nodes in the Kustomize dependency graph.
GraphNode(Path) - Constructor for class dev.zucca_ops.kustomtrace.model.GraphNode: Constructor to set the path for the graph node.
GraphNodeResolver - Class in dev.zucca_ops.kustomtrace.graph: Resolves file paths into Kustomize model objects like KustomFile, KustomResource, and Kustomization by parsing their content.
GraphNodeResolver() - Constructor for class dev.zucca_ops.kustomtrace.graph.GraphNodeResolver

H

hasDependent(Kustomization) - Method in class dev.zucca_ops.kustomtrace.model.GraphNode: Checks if the given Kustomization is a direct or indirect root application that this node contributes to.
hashCode() - Method in record class dev.zucca_ops.kustomtrace.model.ResourceReference: Returns a hash code value for this object.

I

inlinePathValue(String) - Static method in class dev.zucca_ops.kustomtrace.parser.ReferenceExtractors: Returns a ReferenceExtractor for resolving a file path found within an inline map structure, typically used in Kustomize patches (e.g., the 'path' field in a patch definition that points to a YAML fragment file).
InvalidContentException - Exception in dev.zucca_ops.kustomtrace.exceptions: Exception thrown when the content of a Kustomize file (e.g., kustomization.yaml, or a resource YAML/JSON) is found to be invalid or unparsable according to expected structure or syntax.
InvalidContentException(Path) - Constructor for exception dev.zucca_ops.kustomtrace.exceptions.InvalidContentException: Constructs a new InvalidContentException with a default message indicating invalid content for the specified file path.
InvalidContentException(Path, Throwable) - Constructor for exception dev.zucca_ops.kustomtrace.exceptions.InvalidContentException: Constructs a new InvalidContentException with an associated path, and cause.
InvalidReferenceException - Exception in dev.zucca_ops.kustomtrace.exceptions: Exception thrown when a reference in a Kustomization file is invalid, unresolvable, or malformed.
InvalidReferenceException(String) - Constructor for exception dev.zucca_ops.kustomtrace.exceptions.InvalidReferenceException: Constructs an InvalidReferenceException with a message.
InvalidReferenceException(String, Path) - Constructor for exception dev.zucca_ops.kustomtrace.exceptions.InvalidReferenceException: Constructs an InvalidReferenceException with a message and the path related to the invalid reference.
InvalidReferenceException(String, Path, boolean) - Constructor for exception dev.zucca_ops.kustomtrace.exceptions.InvalidReferenceException: Constructs an InvalidReferenceException with a message, path, and an explicit error/warning flag.
InvalidReferenceException(String, Path, Throwable) - Constructor for exception dev.zucca_ops.kustomtrace.exceptions.InvalidReferenceException: Constructs an InvalidReferenceException with a message, path, and a causing throwable.
isDirectory(Path) - Static method in class dev.zucca_ops.kustomtrace.parser.KustomizeFileUtil: Checks if the path exists and is a directory.
isError() - Method in exception dev.zucca_ops.kustomtrace.exceptions.InvalidReferenceException: Checks if this invalid reference represents a critical error.
isFile(Path) - Static method in class dev.zucca_ops.kustomtrace.parser.KustomizeFileUtil: Checks if the path exists and is a regular file.
isKustomFile() - Method in class dev.zucca_ops.kustomtrace.model.GraphNode
isKustomFile() - Method in class dev.zucca_ops.kustomtrace.model.KustomFile: Indicates that this node is a KustomFile.
isKustomFile() - Method in class dev.zucca_ops.kustomtrace.model.Kustomization: Indicates that this node is not a KustomFile.
isKustomization() - Method in class dev.zucca_ops.kustomtrace.model.GraphNode
isKustomization() - Method in class dev.zucca_ops.kustomtrace.model.KustomFile: Indicates that this node is not a Kustomization.
isKustomization() - Method in class dev.zucca_ops.kustomtrace.model.Kustomization: Indicates that this node is a Kustomization.
isKustomizationFileName(Path) - Static method in class dev.zucca_ops.kustomtrace.parser.KustomizeFileUtil: Checks if the path's filename is a standard Kustomization filename.
isReferenceKey(String) - Static method in enum class dev.zucca_ops.kustomtrace.parser.ReferenceType: Checks if a given YAML key corresponds to a known ReferenceType.
isRoot() - Method in class dev.zucca_ops.kustomtrace.model.Kustomization: Determines if this Kustomization is a root node (i.e., no other Kustomizations depend on it).
isValidKubernetesResource(Path) - Static method in class dev.zucca_ops.kustomtrace.parser.KustomizeFileUtil: Checks if the path likely represents a Kubernetes resource file (by extension) and is not a Kustomization file by name.

K

KustomException - Exception in dev.zucca_ops.kustomtrace.exceptions: Base class for custom exceptions specific to the KustomTrace application.
KustomException(String, Path) - Constructor for exception dev.zucca_ops.kustomtrace.exceptions.KustomException: Constructs a new KustomException with the specified detail message and associated path.
KustomException(String, Path, Throwable) - Constructor for exception dev.zucca_ops.kustomtrace.exceptions.KustomException: Constructs a new KustomException with the path, and cause.
KustomFile - Class in dev.zucca_ops.kustomtrace.model: Represents a regular Kubernetes manifest file (e.g., YAML or JSON) as a node in the Kustomize dependency graph.
KustomFile(Path) - Constructor for class dev.zucca_ops.kustomtrace.model.KustomFile: Constructs a KustomFile node.
KustomGraph - Class in dev.zucca_ops.kustomtrace.model: Represents the complete graph of Kustomize resources and their relationships.
KustomGraph() - Constructor for class dev.zucca_ops.kustomtrace.model.KustomGraph
KustomGraphBuilder - Class in dev.zucca_ops.kustomtrace.graph: Builds a KustomGraph by scanning a directory structure for Kustomization files, resolving their contents, and establishing dependencies between them and other resources.
KustomGraphBuilder(Path) - Constructor for class dev.zucca_ops.kustomtrace.graph.KustomGraphBuilder: Constructs a KustomGraphBuilder.
Kustomization - Class in dev.zucca_ops.kustomtrace.model: Represents a Kustomization (typically a kustomization.yaml file) as a node in the Kustomize dependency graph.
Kustomization(Path, Map<String, Object>) - Constructor for class dev.zucca_ops.kustomtrace.model.Kustomization: Constructs a Kustomization node.
KustomizeFileUtil - Class in dev.zucca_ops.kustomtrace.parser: Utility methods for Kustomize file and path conventions.
KustomizeFileUtil() - Constructor for class dev.zucca_ops.kustomtrace.parser.KustomizeFileUtil
KustomResource - Class in dev.zucca_ops.kustomtrace.model: Represents a single Kubernetes resource (e.g., Deployment, Service) defined within a KustomFile.
KustomResource() - Constructor for class dev.zucca_ops.kustomtrace.model.KustomResource: Default constructor.
KustomResource(String, String, KustomFile) - Constructor for class dev.zucca_ops.kustomtrace.model.KustomResource: Constructs a KustomResource with specified name, kind, and containing file.
KustomTrace - Class in dev.zucca_ops.kustomtrace

N

NotAnAppException - Exception in dev.zucca_ops.kustomtrace.exceptions: Exception thrown when a given path is expected to represent or lead to a Kustomize application (i.e., a kustomization file or a directory containing one), but cannot be resolved as such.
NotAnAppException(Path) - Constructor for exception dev.zucca_ops.kustomtrace.exceptions.NotAnAppException: Constructs a NotAnAppException with a default message indicating the path is not a valid Kustomize application.

P

parseFile(Path) - Static method in class dev.zucca_ops.kustomtrace.parser.YamlParser: Parses a YAML file, potentially containing multiple YAML documents (separated by "---").
parseKustomizationFile(Path) - Static method in class dev.zucca_ops.kustomtrace.parser.YamlParser: Parses a Kustomization file, which is expected to be a single YAML document representing a map.
PATCH - Enum constant in enum class dev.zucca_ops.kustomtrace.parser.ReferenceType
PATCH_MERGE - Enum constant in enum class dev.zucca_ops.kustomtrace.parser.ReferenceType
path - Variable in exception dev.zucca_ops.kustomtrace.exceptions.KustomException: The file system path primarily associated with this exception, if applicable.
path - Variable in class dev.zucca_ops.kustomtrace.model.GraphNode

R

ReferenceExtractor - Interface in dev.zucca_ops.kustomtrace.parser: A functional interface for strategies that extract and resolve file path references from a given value, typically found within a Kustomization file's parsed content.
ReferenceExtractors - Class in dev.zucca_ops.kustomtrace.parser: Provides various strategies (ReferenceExtractor instances) for extracting and resolving file path references from different fields within Kustomization files.
ReferenceExtractors() - Constructor for class dev.zucca_ops.kustomtrace.parser.ReferenceExtractors
referenceType() - Method in record class dev.zucca_ops.kustomtrace.model.ResourceReference: Returns the value of the referenceType record component.
ReferenceType - Enum Class in dev.zucca_ops.kustomtrace.parser: Defines the different types of Kustomize fields that can contain references to other resources or Kustomization files.
resolveDependencies(Kustomization) - Method in class dev.zucca_ops.kustomtrace.graph.ResourceReferenceResolver: Resolves all known reference types (bases, resources, components, etc.) found within the content of a given Kustomization.
resource() - Method in record class dev.zucca_ops.kustomtrace.model.ResourceReference: Returns the value of the resource record component.
resource() - Static method in class dev.zucca_ops.kustomtrace.parser.ReferenceExtractors: Returns a ReferenceExtractor specifically for resolving references that must be direct Kubernetes resource files (not directories).
RESOURCE - Enum constant in enum class dev.zucca_ops.kustomtrace.parser.ReferenceType
resourceOrDirectory() - Static method in class dev.zucca_ops.kustomtrace.parser.ReferenceExtractors: Extractor for Kustomize 'resources' field entries.
ResourceReference - Record Class in dev.zucca_ops.kustomtrace.model: Represents a typed link from a Kustomization to another graph node.
ResourceReference(ReferenceType, GraphNode) - Constructor for record class dev.zucca_ops.kustomtrace.model.ResourceReference: Creates an instance of a ResourceReference record class.
ResourceReferenceResolver - Class in dev.zucca_ops.kustomtrace.graph: Resolves references found within a Kustomization file's content.
ResourceReferenceResolver(KustomGraphBuilder) - Constructor for class dev.zucca_ops.kustomtrace.graph.ResourceReferenceResolver: Constructs a ResourceReferenceResolver.

S

SECRET - Enum constant in enum class dev.zucca_ops.kustomtrace.parser.ReferenceType
setFile(KustomFile) - Method in class dev.zucca_ops.kustomtrace.model.KustomResource: Sets the KustomFile that contains this resource.
setKind(String) - Method in class dev.zucca_ops.kustomtrace.model.KustomResource: Sets the kind of this Kubernetes resource.
setName(String) - Method in class dev.zucca_ops.kustomtrace.model.KustomResource: Sets the name of this Kubernetes resource.

T

toString() - Method in class dev.zucca_ops.kustomtrace.model.KustomResource
toString() - Method in record class dev.zucca_ops.kustomtrace.model.ResourceReference: Returns a string representation of this record class.

U

UnreferencedFileException - Exception in dev.zucca_ops.kustomtrace.exceptions: Exception thrown when a file path is processed or expected to be part of the Kustomize graph (e.g., a modified file input to 'affected-apps') but is found to be unreferenced by any Kustomization within the analyzed structure.
UnreferencedFileException(Path) - Constructor for exception dev.zucca_ops.kustomtrace.exceptions.UnreferencedFileException: Constructs an UnreferencedFileException with a default message indicating the file at the specified path is not referenced.

V

valueOf(String) - Static method in enum class dev.zucca_ops.kustomtrace.parser.ReferenceType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class dev.zucca_ops.kustomtrace.parser.ReferenceType: Returns an array containing the constants of this enum class, in the order they are declared.

Y

YamlParser - Class in dev.zucca_ops.kustomtrace.parser: Utility class for parsing YAML files, particularly Kubernetes manifests and Kustomization files, using the SnakeYAML library.
YamlParser() - Constructor for class dev.zucca_ops.kustomtrace.parser.YamlParser

A B C D E F G H I K N P R S T U V Y
All Classes and Interfaces|All Packages|Serialized Form