org.microbean.helm.maven

Class GetReleaseContentMojo

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.GetReleaseContentMojo

All Implemented Interfaces:

ContextEnabled, Mojo

@Mojo(name="content")
public class GetReleaseContentMojo
extends AbstractSingleVersionedReleaseMojo

Retrieves the content of a release.

Author:

Laird Nelson

Field Summary

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

ROLE

Constructor Summary

Constructors

Constructor and Description
GetReleaseContentMojo() Creates a new GetReleaseContentMojo.

Method Summary

Modifier and Type	Method and Description
void	addReleaseContentListener(ReleaseContentListener listener) Adds a ReleaseContentListener that will be notified when a release's content is retrieved.
protected void	execute(Callable<ReleaseManager> releaseManagerCallable) Performs a release-oriented task using a ReleaseManager available from the supplied Callable.
ReleaseContentListener[]	getReleaseContentListeners() Invokes the getReleaseContentListenersList() method and converts its return value to an array.
List<ReleaseContentListener>	getReleaseContentListenersList() Returns the List of ReleaseContentListeners whose elements will be notified when the tests complete.
void	removeReleaseContentListener(ReleaseContentListener listener) Removes a ReleaseContentListener from this TestReleaseMojo.
void	setReleaseContentListenersList(List<ReleaseContentListener> releaseContentListeners) Installs the List of ReleaseContentListeners whose elements will be notified when a release's contents are 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

GetReleaseContentMojo

public GetReleaseContentMojo()

Creates a new GetReleaseContentMojo.

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 content of a particular version of a single release and notifies registers listeners.

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

addReleaseContentListener

public void addReleaseContentListener(ReleaseContentListener listener)

Adds a ReleaseContentListener that will be notified when a release's content is retrieved.

Parameters:

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

See Also:

removeReleaseContentListener(ReleaseContentListener), getReleaseContentListenersList()

removeReleaseContentListener

public void removeReleaseContentListener(ReleaseContentListener listener)

Removes a ReleaseContentListener from this TestReleaseMojo.

Parameters:

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

See Also:

addReleaseContentListener(ReleaseContentListener), getReleaseContentListenersList()

getReleaseContentListeners

public ReleaseContentListener[] getReleaseContentListeners()

Invokes the getReleaseContentListenersList() 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 ReleaseContentListeners

See Also:

getReleaseContentListenersList()

getReleaseContentListenersList

public List<ReleaseContentListener> getReleaseContentListenersList()

Returns the List of ReleaseContentListeners whose elements will be notified when the tests complete.

This method may return null.

Overrides of this method are permitted to return null.

Returns:

a List of ReleaseContentListeners, or null

See Also:

setReleaseContentListenersList(List), addReleaseContentListener(ReleaseContentListener), removeReleaseContentListener(ReleaseContentListener)

setReleaseContentListenersList

public void setReleaseContentListenersList(List<ReleaseContentListener> releaseContentListeners)

Installs the List of ReleaseContentListeners whose elements will be notified when a release's contents are retrieved.

Parameters:

releaseContentListeners - the List of ReleaseContentListeners whose elements will be notified when a release's contents are retrieved; may be null

See Also:

getReleaseContentListenersList(), addReleaseContentListener(ReleaseContentListener), removeReleaseContentListener(ReleaseContentListener)