org.microbean.helm.maven

Class AbstractSingleReleaseMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.microbean.helm.maven.AbstractHelmMojo

org.microbean.helm.maven.AbstractReleaseMojo

org.microbean.helm.maven.AbstractSingleReleaseMojo

All Implemented Interfaces:

ContextEnabled, Mojo

Direct Known Subclasses:

AbstractMutatingReleaseMojo, AbstractSingleVersionedReleaseMojo, GetHistoryMojo, TestReleaseMojo, UninstallReleaseMojo

public abstract class AbstractSingleReleaseMojo
extends AbstractReleaseMojo

An AbstractReleaseMojo that works on exactly one Helm release.

Author:

Laird Nelson

Field Summary

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSingleReleaseMojo() Creates a new AbstractSingleReleaseMojo.

Method Summary

Modifier and Type	Method and Description
String	getReleaseName() Returns the release name.
void	setReleaseName(String releaseName) Sets the release name.
protected void	validateReleaseName(String name) Validates the supplied name as a Helm release name.

Methods inherited from class org.microbean.helm.maven.AbstractReleaseMojo

createClient, createReleaseManager, createTiller, execute, execute, getClientConfiguration, getSkip, getTillerLabels, getTillerNamespace, getTillerPort, setClientConfiguration, setSkip, setTillerLabels, setTillerNamespace, setTillerPort, validateNamespace

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractSingleReleaseMojo

protected AbstractSingleReleaseMojo()

Creates a new AbstractSingleReleaseMojo.

Method Detail

getReleaseName

public String getReleaseName()

Returns the release name.

This method may return null.

Overrides of this method may return null.

Returns:

the release name, or null

See Also:

setReleaseName(String)

setReleaseName

public void setReleaseName(String releaseName)

Sets the release name.

Parameters:

releaseName - the name of the release; must not be null and must pass validation

See Also:

getReleaseName()

validateReleaseName

protected void validateReleaseName(String name)

Validates the supplied name as a Helm release name.

This implementation checks to see if the supplied name is non-null, not empty, and matches the value of the ReleaseManager.DNS_SUBDOMAIN_PATTERN field.

Parameters:

name - the release name to validate; must not be null

Throws:

IllegalArgumentException - if name is not valid