A B C D E F G H I J L M N O P R S T U V W

A

AbstractCdsMojo - Class in com.sap.cds.maven.plugin

An abstract base class for all CDS-related Mojos (Maven Old Java Object)

AbstractCdsMojo() - Constructor for class com.sap.cds.maven.plugin.AbstractCdsMojo

addDependency(Document, String, String, String) - Static method in class com.sap.cds.maven.plugin.util.PomUtils

Adds a dependency to given pom.xml DOM if it doesn't exist yet.

AddIntegrationTestMojo - Class in com.sap.cds.maven.plugin.add

Add an integration test module to the current CAP Java project.
Call mvn com.sap.cds:cds-maven-plugin:addIntegrationTest to add an integration test module.
It automatically detects the OData version of the CAP Java project and adds the corresponding integration test class.

Note: This goal can only be executed from the command line.

AddIntegrationTestMojo() - Constructor for class com.sap.cds.maven.plugin.add.AddIntegrationTestMojo

addModule(Document, String) - Static method in class com.sap.cds.maven.plugin.util.PomUtils

Adds a module to given pom.xml DOM if it doesn't exist yet.

AddSampleMojo - Class in com.sap.cds.maven.plugin.add

Add sample Java handler class, unit test, and CDS sample files to the current CAP Java project.
Call mvn com.sap.cds:cds-maven-plugin:addSample to add sample classes and CDS files.

Note: This goal can only be executed from the command line.

AddSampleMojo() - Constructor for class com.sap.cds.maven.plugin.add.AddSampleMojo

AddTargetPlatformMojo - Class in com.sap.cds.maven.plugin.add

Add a target platform cds-starter-${targetPlatform} to the dependencies of the current CAP Java project if missing.
Call mvn com.sap.cds:cds-maven-plugin:addTargetPlatform -DtargetPlatform=cloudfoundry to add Cloud Foundry target platform.

Note: This goal can only be executed from the command line.

AddTargetPlatformMojo() - Constructor for class com.sap.cds.maven.plugin.add.AddTargetPlatformMojo

archiveExtension - Variable in enum com.sap.cds.maven.plugin.util.Platform

Contains the Node.js archive extension.

ArchiveUtils - Class in com.sap.cds.maven.plugin.util

This class extracts *.zip and tar.gz archives to a given destination directory.

array(T...) - Static method in class com.sap.cds.maven.plugin.util.Utils

Creates an array with given arguments

B

buildContext - Variable in class com.sap.cds.maven.plugin.AbstractCdsMojo

BuildMojo - Class in com.sap.cds.maven.plugin.build

Performs a cds build with Java class generation by invoking the goals install-node, install-cdsdk, cds and generate of the cds-maven-plugin on current project.

BuildMojo() - Constructor for class com.sap.cds.maven.plugin.build.BuildMojo

C

CdsMojo - Class in com.sap.cds.maven.plugin.build

Execute CDS commands on the current CAP Java project.
Call mvn cds:cds or mvn com.sap.cds:cds-maven-plugin:cds on the command line to execute all configured CDS commands of the project in current directory.

Several CDS commands can be configured in one execution block and they’re executed in the specified order.

CdsMojo() - Constructor for class com.sap.cds.maven.plugin.build.CdsMojo

CdsMojoLogger - Interface in com.sap.cds.maven.plugin

This interface provides access to the logger used by all CDS Mojos.

CleanMojo - Class in com.sap.cds.maven.plugin.build

Clean generated files and directories of the previous build from the current CAP Java project.
Call mvn com.sap.cds:cds-maven-plugin:clean to execute cleaning from command line.

This goal deletes the following files and directories from the resource directory of the current CAP Java project: file: src/main/resources/**/csn.json file: src/main/resources/**/schema.sql directory: src/main/resources/**/edmx/ directory: ${codeOutputDirectory}

CleanMojo() - Constructor for class com.sap.cds.maven.plugin.build.CleanMojo

com.sap.cds.maven.plugin - package com.sap.cds.maven.plugin

com.sap.cds.maven.plugin.add - package com.sap.cds.maven.plugin.add

com.sap.cds.maven.plugin.build - package com.sap.cds.maven.plugin.build

com.sap.cds.maven.plugin.util - package com.sap.cds.maven.plugin.util

compareTo(Semver) - Method in class com.sap.cds.maven.plugin.util.Semver

Compares this Semver instance with another

createClassFromTemplate(File, String, String, String, boolean, TemplateService.TemplateVariable...) - Method in class com.sap.cds.maven.plugin.add.TemplateService

Creates a new Java class source file from a specified resource template.

createDir(String) - Static method in class com.sap.cds.maven.plugin.util.Utils

Creates a directory including all parent directories.

createFile(File) - Static method in class com.sap.cds.maven.plugin.util.Utils

Creates a file including all parent directories.

createFileFromTemplate(String, File, boolean, TemplateService.TemplateVariable...) - Method in class com.sap.cds.maven.plugin.add.TemplateService

Creates a new file from a specified resource template.

CURRENT - Static variable in enum com.sap.cds.maven.plugin.util.Platform

Contains the current Platform.

D

DirectoryWatcher - Class in com.sap.cds.maven.plugin.util

Watches a directory, including the sub-tree, for changes on files.

DirectoryWatcher(Path, DirectoryWatcher.FileChangedListener, CdsMojoLogger, List<String>, List<String>) - Constructor for class com.sap.cds.maven.plugin.util.DirectoryWatcher

Constructs a new DirectoryWatcher instance.

DirectoryWatcher.FileChangedListener - Interface in com.sap.cds.maven.plugin.util

An interface used to listen on file changed events.

download(String, File) - Method in class com.sap.cds.maven.plugin.util.Downloader

Performs a download from given URL.

download(String, File, String, String) - Method in class com.sap.cds.maven.plugin.util.Downloader

Performs a download from given URL by using the given credentials

Downloader - Class in com.sap.cds.maven.plugin.util

Used to download the Node archive from a given download URL.

Downloader(CdsMojoLogger) - Constructor for class com.sap.cds.maven.plugin.util.Downloader

Constructs a new Downloader instance.

Downloader(List<Proxy>, CdsMojoLogger) - Constructor for class com.sap.cds.maven.plugin.util.Downloader

Constructs a new Downloader instance.

E

ensureCliExecuted() - Method in class com.sap.cds.maven.plugin.AbstractCdsMojo

Ensures that the goal is executed from command line.

execute() - Method in class com.sap.cds.maven.plugin.add.AddIntegrationTestMojo

execute() - Method in class com.sap.cds.maven.plugin.add.AddSampleMojo

execute() - Method in class com.sap.cds.maven.plugin.add.AddTargetPlatformMojo

execute() - Method in class com.sap.cds.maven.plugin.build.BuildMojo

execute() - Method in class com.sap.cds.maven.plugin.build.CdsMojo

execute() - Method in class com.sap.cds.maven.plugin.build.CleanMojo

execute() - Method in class com.sap.cds.maven.plugin.build.GenerateMojo

execute() - Method in class com.sap.cds.maven.plugin.build.InstallCdsdkMojo

execute() - Method in class com.sap.cds.maven.plugin.build.InstallNodeMojo

execute() - Method in class com.sap.cds.maven.plugin.build.NpmMojo

execute() - Method in class com.sap.cds.maven.plugin.build.WatchMojo

execute() - Method in class com.sap.cds.maven.plugin.HelpMojo

execute(OutputStream, OutputStream, CdsMojoLogger) - Method in class com.sap.cds.maven.plugin.util.ProcessExecutor

executeAndGetResult(CdsMojoLogger) - Method in class com.sap.cds.maven.plugin.util.ProcessExecutor

Executes the process.

executeBuild() - Method in class com.sap.cds.maven.plugin.build.BuildMojo

extract(File, File) - Static method in class com.sap.cds.maven.plugin.util.ArchiveUtils

Extracts an archive to a destination directory

F

findDirectory(String, Collection<File>) - Static method in class com.sap.cds.maven.plugin.util.Utils

findExecutable(String, CdsMojoLogger) - Static method in class com.sap.cds.maven.plugin.util.Utils

Finds the location of given executable on local file-system.

findFile(String, Collection<File>) - Static method in class com.sap.cds.maven.plugin.util.Utils

findGoalExecution(Plugin, String) - Static method in class com.sap.cds.maven.plugin.AbstractCdsMojo

G

GenerateMojo - Class in com.sap.cds.maven.plugin.build

Generate Java Pojos for type-safe access to the CDS model.

This goal scans the resource directory for a csn.json file and uses it for Java source code generation.

GenerateMojo() - Constructor for class com.sap.cds.maven.plugin.build.GenerateMojo

getDownloadPath(String) - Method in enum com.sap.cds.maven.plugin.util.Platform

Calculates the relative Node.js download path.

getNodePath(String) - Method in enum com.sap.cds.maven.plugin.util.Platform

getNpmPath(String) - Method in enum com.sap.cds.maven.plugin.util.Platform

getNpxPath(String) - Method in enum com.sap.cds.maven.plugin.util.Platform

getPackageDir(File, String) - Static method in class com.sap.cds.maven.plugin.util.Utils

Returns the directory for a given Java package.

getResourceDirs(MavenProject) - Static method in class com.sap.cds.maven.plugin.util.Utils

Returns a list with all resource directories of a given Maven project.

getTopmostProjectDir() - Method in class com.sap.cds.maven.plugin.AbstractCdsMojo

H

HelpMojo - Class in com.sap.cds.maven.plugin

Display help information on cds-maven-plugin.
Call mvn cds:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.

HelpMojo() - Constructor for class com.sap.cds.maven.plugin.HelpMojo

I

InstallCdsdkMojo - Class in com.sap.cds.maven.plugin.build

Install @sap/cds-dk in the current CAP Java project.
By default, this goal looks for an already installed @sap/cds-dk and skips installation if it was found.

InstallCdsdkMojo() - Constructor for class com.sap.cds.maven.plugin.build.InstallCdsdkMojo

InstallNodeMojo - Class in com.sap.cds.maven.plugin.build

Download and install a Node.js distribution on the local file system.
If the requested version is already installed, the download and installation is skipped.

This goal also recognizes proxy configurations in your ~/.m2/settings.xml.

InstallNodeMojo() - Constructor for class com.sap.cds.maven.plugin.build.InstallNodeMojo

isCliExecuted() - Method in class com.sap.cds.maven.plugin.AbstractCdsMojo

Indicates whether this goal is executed from command line or not.

isWindows() - Method in enum com.sap.cds.maven.plugin.util.Platform

J

join() - Method in class com.sap.cds.maven.plugin.util.DirectoryWatcher

Joins the watch thread and blocks until it's finished or interrupted.

L

logDebug(String, Object...) - Method in class com.sap.cds.maven.plugin.AbstractCdsMojo

logDebug(Throwable) - Method in class com.sap.cds.maven.plugin.AbstractCdsMojo

logDebug(String, Object...) - Method in interface com.sap.cds.maven.plugin.CdsMojoLogger

Writes a debug message to log.

logDebug(Throwable) - Method in interface com.sap.cds.maven.plugin.CdsMojoLogger

Writes a debug message to log.

logError(String, Object...) - Method in class com.sap.cds.maven.plugin.AbstractCdsMojo

logError(String, Throwable, Object...) - Method in class com.sap.cds.maven.plugin.AbstractCdsMojo

logError(Throwable) - Method in class com.sap.cds.maven.plugin.AbstractCdsMojo

logError(String, Object...) - Method in interface com.sap.cds.maven.plugin.CdsMojoLogger

Writes an error message to log.

logError(String, Throwable, Object...) - Method in interface com.sap.cds.maven.plugin.CdsMojoLogger

Writes an error message to log.

logError(Throwable) - Method in interface com.sap.cds.maven.plugin.CdsMojoLogger

Writes an error message to log.

logInfo(String, Object...) - Method in class com.sap.cds.maven.plugin.AbstractCdsMojo

logInfo(String, Object...) - Method in interface com.sap.cds.maven.plugin.CdsMojoLogger

Writes a debug message to log.

logWarn(String, Object...) - Method in class com.sap.cds.maven.plugin.AbstractCdsMojo

logWarn(String, Throwable, Object...) - Method in class com.sap.cds.maven.plugin.AbstractCdsMojo

logWarn(Throwable) - Method in class com.sap.cds.maven.plugin.AbstractCdsMojo

logWarn(String, Object...) - Method in interface com.sap.cds.maven.plugin.CdsMojoLogger

Writes a warning message to log.

logWarn(String, Throwable, Object...) - Method in interface com.sap.cds.maven.plugin.CdsMojoLogger

Writes a warning message to log.

logWarn(Throwable) - Method in interface com.sap.cds.maven.plugin.CdsMojoLogger

Writes a warning message to log.

M

mojoExecution - Variable in class com.sap.cds.maven.plugin.AbstractCdsMojo

The current MojoExecution.

N

node - Variable in enum com.sap.cds.maven.plugin.util.Platform

Contains name of node executable, either "node" or "node.exe".

NodeCacheResolver - Class in com.sap.cds.maven.plugin.build

A Node.js archive cache resolver using the local Maven repository as storage.

NodeCacheResolver(RepositorySystemSession) - Constructor for class com.sap.cds.maven.plugin.build.NodeCacheResolver

Constructs a new NodeCacheResolver instance.

nodeClassifier - Variable in enum com.sap.cds.maven.plugin.util.Platform

Contains the Node.js classifier: "linux-x64", "darwin-x64" or "win-x64"

npm - Variable in enum com.sap.cds.maven.plugin.util.Platform

Contains name of npm executable, either "npm" or "npm.cmd".

NpmMojo - Class in com.sap.cds.maven.plugin.build

Execute an npm command on the current CAP Java project.
Call mvn com.sap.cds:cds-maven-plugin:npm -Darguments="..." to execute npm command with given arguments.

NpmMojo() - Constructor for class com.sap.cds.maven.plugin.build.NpmMojo

npx - Variable in enum com.sap.cds.maven.plugin.util.Platform

Contains name of npx executable, either "npx" or "npx.cmd".

O

of(String, String) - Static method in class com.sap.cds.maven.plugin.add.TemplateService.TemplateVariable

onChanged() - Method in interface com.sap.cds.maven.plugin.util.DirectoryWatcher.FileChangedListener

Signals that one of the included files has changed.

P

parse(File) - Static method in class com.sap.cds.maven.plugin.util.Utils

Parses a given xml file into a Document.

Platform - Enum in com.sap.cds.maven.plugin.util

This enum contains all supported platforms.

PLUGIN_KEY - Static variable in class com.sap.cds.maven.plugin.AbstractCdsMojo

The key of this plugin.

PomUtils - Class in com.sap.cds.maven.plugin.util

A utility class to manipulate pom.xml files.

prepareDestination(File, boolean) - Static method in class com.sap.cds.maven.plugin.util.Utils

ProcessExecutor - Class in com.sap.cds.maven.plugin.util

A class to execute subprocesses with a given command line in a specified working directory.

ProcessExecutor(File, CommandLine) - Constructor for class com.sap.cds.maven.plugin.util.ProcessExecutor

Constructs new ProcessExecutor instance.

ProcessExecutor(File, CommandLine, Map<String, String>, List<String>) - Constructor for class com.sap.cds.maven.plugin.util.ProcessExecutor

Constructs new ProcessExecutor instance.

project - Variable in class com.sap.cds.maven.plugin.AbstractCdsMojo

The current Maven project on which this goal is executed.

R

resolve(String) - Method in class com.sap.cds.maven.plugin.build.NodeCacheResolver

Returns a Node file handle according the given version.

resolveUnpacked(String) - Method in class com.sap.cds.maven.plugin.build.NodeCacheResolver

Returns a Node file handle according the given version.

runIfLockable(File, Runnable, int) - Static method in class com.sap.cds.maven.plugin.util.Utils

Runs the given Runnable if a lock could be acquired on given file.

S

scanDirectory(File, String...) - Method in class com.sap.cds.maven.plugin.AbstractCdsMojo

Scans the given directory for files satisfying the given glob pattern.

Semver - Class in com.sap.cds.maven.plugin.util

This class represents a semantic version information.

Semver(String) - Constructor for class com.sap.cds.maven.plugin.util.Semver

Constructs a new Semver instance with given version string.

session - Variable in class com.sap.cds.maven.plugin.AbstractCdsMojo

The current Maven execution session.

setExecutionFlag(File) - Static method in class com.sap.cds.maven.plugin.util.Utils

Sets execution flag at given file.

setExitValues(int[]) - Method in class com.sap.cds.maven.plugin.util.ProcessExecutor

setIfNotNull(Consumer<T>, T) - Static method in class com.sap.cds.maven.plugin.util.Utils

Calls a given setter with given value, if value isn't null.

setNpxExec(File) - Method in class com.sap.cds.maven.plugin.build.CdsMojo

Gets called to inject parameter "npxExec".

setProperty(String, File) - Method in class com.sap.cds.maven.plugin.AbstractCdsMojo

settings - Variable in class com.sap.cds.maven.plugin.AbstractCdsMojo

The global Maven settings, stored in ~/.m2/settings.xml.

splitByWhitespaces(String) - Static method in class com.sap.cds.maven.plugin.util.Utils

Splits the given string into tokens by using whitespace as delimiters.

start() - Method in class com.sap.cds.maven.plugin.util.DirectoryWatcher

Starts asynchronously watching for changes on the file system.

stop() - Method in class com.sap.cds.maven.plugin.util.DirectoryWatcher

Stops watching for changes on file system.

store(File, Document) - Static method in class com.sap.cds.maven.plugin.util.Utils

Serializes a given Document into a file.

T

TemplateService - Class in com.sap.cds.maven.plugin.add

This service creates files and Java classes from templates.

TemplateService() - Constructor for class com.sap.cds.maven.plugin.add.TemplateService

TemplateService.TemplateVariable - Class in com.sap.cds.maven.plugin.add

Holds key and value of a template variable.

toString() - Method in class com.sap.cds.maven.plugin.util.Semver

U

Utils - Class in com.sap.cds.maven.plugin.util

A helper class providing utility methods.

V

valueOf(String) - Static method in enum com.sap.cds.maven.plugin.util.Platform

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.sap.cds.maven.plugin.util.Platform

Returns an array containing the constants of this enum type, in the order they are declared.

W

WatchMojo - Class in com.sap.cds.maven.plugin.build

Starts a CAP Java NG application and watches for changes in the CDS model.

WatchMojo() - Constructor for class com.sap.cds.maven.plugin.build.WatchMojo

A B C D E F G H I J L M N O P R S T U V W