org.microbean.helm.maven

Class ListReleasesMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.microbean.helm.maven.AbstractHelmMojo

org.microbean.helm.maven.AbstractReleaseMojo

org.microbean.helm.maven.ListReleasesMojo

All Implemented Interfaces:

ContextEnabled, Mojo

@Mojo(name="list")
public class ListReleasesMojo
extends AbstractReleaseMojo

Retrieves releases matching certain criteria and notifies registered listeners.

Author:

Laird Nelson

Field Summary

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

ROLE

Constructor Summary

Constructors

Constructor and Description
ListReleasesMojo() Creates a new ListReleasesMojo.

Method Summary

Modifier and Type	Method and Description
void	addReleaseDiscoveryListener(ReleaseDiscoveryListener listener) Adds a ReleaseDiscoveryListener that will be notified when a release is retrieved
protected void	execute(Callable<ReleaseManager> releaseManagerCallable) Performs a release-oriented task using a ReleaseManager available from the supplied Callable.
String	getFilter() Returns the regular expression by which releases will be filtered.
long	getLimit() Returns the maximum number of releases to retrieve.
String	getNamespace() Returns the namespace to which releases that are retrieved must belong.
String	getOffset() Returns the next release name from which listing should begin.
ReleaseDiscoveryListener[]	getReleaseDiscoveryListeners() Invokes the getReleaseDiscoveryListenersList() method and converts its return value to an array.
List<ReleaseDiscoveryListener>	getReleaseDiscoveryListenersList() Returns the List of ReleaseDiscoveryListeners whose elements will be notified when a release is retrieved.
Tiller.ListSort.SortBy	getSortBy() Returns a Tiller.ListSort.SortBy indicating how the result list should be sorted.
Tiller.ListSort.SortOrder	getSortOrder() Returns the Tiller.ListSort.SortOrder describing the order of the sorted result list.
List<StatusOuterClass.Status.Code>	getStatusCodes() Returns the List of Status.Code instances that describes the possible status codes a release must have in order to be considered for further listing.
void	removeReleaseDiscoveryListener(ReleaseDiscoveryListener listener) Removes a ReleaseDiscoveryListener from this GetHistoryMojo.
void	setFilter(String filter) Sets the regular expression by which releases will be filtered.
void	setLimit(long limit) Sets the maximum number of releases to retrieve.
void	setNamespace(String namespace) Sets the namespace to which releases that are retrieved must belong.
void	setOffset(String offset) Sets the next release name from which listing should begin.
void	setReleaseDiscoveryListenersList(List<ReleaseDiscoveryListener> releaseDiscoveryListeners) Installs the List of ReleaseDiscoveryListeners whose elements will be notified when a release is retrieved.
void	setSortBy(Tiller.ListSort.SortBy sortBy) Sets the Tiller.ListSort.SortBy indicating how the result list should be sorted.
void	setSortOrder(Tiller.ListSort.SortOrder sortOrder) Sets the Tiller.ListSort.SortOrder describing the order of the sorted result list.
void	setStatusCodes(List<StatusOuterClass.Status.Code> statusCodes) Sets the List of Status.Code instances that describes the possible status codes a release must have in order to be considered for further listing.

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

ListReleasesMojo

public ListReleasesMojo()

Creates a new ListReleasesMojo.

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 information about releases and notifies registered ReleaseDiscoveryListeners.

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

getFilter

public String getFilter()

Returns the regular expression by which releases will be filtered.

This method may return null.

Overrides of this method may return null.

Returns:

the regular expression by which releases will be filtered, or null

See Also:

setFilter(String)

setFilter

public void setFilter(String filter)

Sets the regular expression by which releases will be filtered.

Parameters:

filter - the regular expression by which releases will be filtered; may be null

See Also:

getFilter()

getLimit

public long getLimit()

Returns the maximum number of releases to retrieve.

Returns:

the maximum number of releases to retrieve

See Also:

setLimit(long)

setLimit

public void setLimit(long limit)

Sets the maximum number of releases to retrieve.

Parameters:

limit - the maximum number of releases to retrieve

See Also:

getLimit()

getNamespace

public String getNamespace()

Returns the namespace to which releases that are retrieved must belong.

This method may return null.

Overrides of this method are permitted to return null.

Returns:

the namespace to which releases that are retrieved must belong, or null

See Also:

setNamespace(String)

setNamespace

public void setNamespace(String namespace)

Sets the namespace to which releases that are retrieved must belong.

Parameters:

namespace - the namespace to which releases that are retrieved must belong; may be null

See Also:

getNamespace()

getOffset

public String getOffset()

Returns the next release name from which listing should begin.

This method may return null.

Overrides of this method are permitted to return null.

Returns:

the next release name from which listing should begin, or null

See Also:

setOffset(String)

setOffset

public void setOffset(String offset)

Sets the next release name from which listing should begin.

Parameters:

offset - the next release name from which listing should begin; may be null

See Also:

getOffset()

getSortBy

public Tiller.ListSort.SortBy getSortBy()

Returns a Tiller.ListSort.SortBy indicating how the result list should be sorted.

This method may return null.

Overrides of this method may return null.

Returns:

a Tiller.ListSort.SortBy indicating how the result list should be sorted, or null

See Also:

setSortBy(Tiller.ListSort.SortBy)

setSortBy

public void setSortBy(Tiller.ListSort.SortBy sortBy)

Sets the Tiller.ListSort.SortBy indicating how the result list should be sorted.

Parameters:

sortBy - the Tiller.ListSort.SortBy indicating how the result list should be sorted; may be null

See Also:

getSortBy()

getSortOrder

public Tiller.ListSort.SortOrder getSortOrder()

Returns the Tiller.ListSort.SortOrder describing the order of the sorted result list.

This method may return null.

Overrides of this method are permitted to return null.

Returns:

the Tiller.ListSort.SortOrder describing the order of the sorted result list, or null

See Also:

setSortOrder(Tiller.ListSort.SortOrder)

setSortOrder

public void setSortOrder(Tiller.ListSort.SortOrder sortOrder)

Sets the Tiller.ListSort.SortOrder describing the order of the sorted result list.

Parameters:

sortOrder - the Tiller.ListSort.SortOrder describing the order of the sorted result list; may be null

See Also:

getSortOrder()

getStatusCodes

public List<StatusOuterClass.Status.Code> getStatusCodes()

Returns the List of Status.Code instances that describes the possible status codes a release must have in order to be considered for further listing.

This method may return null.

Overrides of this method are permitted to return null.

Returns:

a List of Status.Code instances that describes the possible status codes a release must have in order to be considered for further listing, or null

See Also:

setStatusCodes(List)

setStatusCodes

public void setStatusCodes(List<StatusOuterClass.Status.Code> statusCodes)

Sets the List of Status.Code instances that describes the possible status codes a release must have in order to be considered for further listing.

Parameters:

statusCodes - a List of Status.Code instances that describes the possible status codes a release must have in order to be considered for further listing; may be null

See Also:

getStatusCodes()

addReleaseDiscoveryListener

public void addReleaseDiscoveryListener(ReleaseDiscoveryListener listener)

Adds a ReleaseDiscoveryListener that will be notified when a release is retrieved

Parameters:

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

See Also:

removeReleaseDiscoveryListener(ReleaseDiscoveryListener), getReleaseDiscoveryListenersList()

removeReleaseDiscoveryListener

public void removeReleaseDiscoveryListener(ReleaseDiscoveryListener listener)

Removes a ReleaseDiscoveryListener from this GetHistoryMojo.

Parameters:

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

See Also:

addReleaseDiscoveryListener(ReleaseDiscoveryListener), getReleaseDiscoveryListenersList()

getReleaseDiscoveryListeners

public ReleaseDiscoveryListener[] getReleaseDiscoveryListeners()

Invokes the getReleaseDiscoveryListenersList() 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 ReleaseDiscoveryListeners

See Also:

getReleaseDiscoveryListenersList()

getReleaseDiscoveryListenersList

public List<ReleaseDiscoveryListener> getReleaseDiscoveryListenersList()

Returns the List of ReleaseDiscoveryListeners whose elements will be notified when a release is retrieved.

This method may return null.

Overrides of this method are permitted to return null.

Returns:

a List of ReleaseDiscoveryListeners, or null

See Also:

setReleaseDiscoveryListenersList(List), addReleaseDiscoveryListener(ReleaseDiscoveryListener), removeReleaseDiscoveryListener(ReleaseDiscoveryListener)

setReleaseDiscoveryListenersList

public void setReleaseDiscoveryListenersList(List<ReleaseDiscoveryListener> releaseDiscoveryListeners)

Installs the List of ReleaseDiscoveryListeners whose elements will be notified when a release is retrieved.

Parameters:

releaseDiscoveryListeners - the List of ReleaseDiscoveryListeners whose elements will be notified when a release is retrieved; may be null

See Also:

getReleaseDiscoveryListenersList(), addReleaseDiscoveryListener(ReleaseDiscoveryListener), removeReleaseDiscoveryListener(ReleaseDiscoveryListener)