org.microbean.helm.maven

Class GetReleaseStatusMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.microbean.helm.maven.AbstractHelmMojo

org.microbean.helm.maven.AbstractReleaseMojo

org.microbean.helm.maven.AbstractSingleReleaseMojo

org.microbean.helm.maven.AbstractSingleVersionedReleaseMojo

org.microbean.helm.maven.GetReleaseStatusMojo

All Implemented Interfaces:

ContextEnabled, Mojo

@Mojo(name="status")
public class GetReleaseStatusMojo
extends AbstractSingleVersionedReleaseMojo

Retrieves the status of a release version.

Author:

Laird Nelson

Field Summary

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

ROLE

Constructor Summary

Constructors

Constructor and Description
GetReleaseStatusMojo() Creates a new GetReleaseStatusMojo.

Method Summary

Modifier and Type	Method and Description
void	addReleaseStatusListener(ReleaseStatusListener listener) Adds a ReleaseStatusListener that will be notified when a release version's status is retrieved
protected void	execute(Callable<ReleaseManager> releaseManagerCallable) Performs a release-oriented task using a ReleaseManager available from the supplied Callable.
ReleaseStatusListener[]	getReleaseStatusListeners() Invokes the getReleaseStatusListenersList() method and converts its return value to an array.
List<ReleaseStatusListener>	getReleaseStatusListenersList() Returns the List of ReleaseStatusListeners whose elements will be notified when a release version's status is retrieved.
void	removeReleaseStatusListener(ReleaseStatusListener listener) Removes a ReleaseStatusListener from this GetReleaseStatusMojo.
void	setReleaseStatusListenersList(List<ReleaseStatusListener> releaseStatusListeners) Installs the List of ReleaseStatusListeners whose elements will be notified when a release version's status is retrieved.

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

getVersion, setVersion

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

getReleaseName, setReleaseName, validateReleaseName

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

createClient, createReleaseManager, createTiller, 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

GetReleaseStatusMojo

public GetReleaseStatusMojo()

Creates a new GetReleaseStatusMojo.

Method Detail

execute

protected void execute(Callable<ReleaseManager> releaseManagerCallable)
                throws Exception

Performs a release-oriented task using a ReleaseManager available from the supplied Callable.

This implementation retrieves the status for a given release at a particular version and notifies registered ReleaseStatusListeners.

Specified by:

execute in class AbstractReleaseMojo

Parameters:

releaseManagerCallable - the Callable that will provide a ReleaseManager; must not be null

Throws:

Exception - if an error occurs

addReleaseStatusListener

public void addReleaseStatusListener(ReleaseStatusListener listener)

Adds a ReleaseStatusListener that will be notified when a release version's status is retrieved

Parameters:

listener - the ReleaseStatusListener to add; may be null in which case no action will be taken

See Also:

removeReleaseStatusListener(ReleaseStatusListener), getReleaseStatusListenersList()

removeReleaseStatusListener

public void removeReleaseStatusListener(ReleaseStatusListener listener)

Removes a ReleaseStatusListener from this GetReleaseStatusMojo.

Parameters:

listener - the ReleaseStatusListener to remove; may be null in which case no action will be taken

See Also:

addReleaseStatusListener(ReleaseStatusListener), getReleaseStatusListenersList()

getReleaseStatusListeners

public ReleaseStatusListener[] getReleaseStatusListeners()

Invokes the getReleaseStatusListenersList() method and converts its return value to an array.

This method never returns null.

Overrides of this method must not return null.

Returns:

a non-null array of ReleaseStatusListeners

See Also:

getReleaseStatusListenersList()

getReleaseStatusListenersList

public List<ReleaseStatusListener> getReleaseStatusListenersList()

Returns the List of ReleaseStatusListeners whose elements will be notified when a release version's status is retrieved.

This method may return null.

Overrides of this method are permitted to return null.

Returns:

a List of ReleaseStatusListeners, or null

See Also:

setReleaseStatusListenersList(List), addReleaseStatusListener(ReleaseStatusListener), removeReleaseStatusListener(ReleaseStatusListener)

setReleaseStatusListenersList

public void setReleaseStatusListenersList(List<ReleaseStatusListener> releaseStatusListeners)

Installs the List of ReleaseStatusListeners whose elements will be notified when a release version's status is retrieved.

Parameters:

releaseStatusListeners - the List of ReleaseStatusListeners whose elements will be notified when a release status is retrieved; may be null

See Also:

getReleaseStatusListenersList(), addReleaseStatusListener(ReleaseStatusListener), removeReleaseStatusListener(ReleaseStatusListener)