com.openshift.client.cartridge
Interface ICartridge

All Known Subinterfaces:

IEmbeddableCartridge, IEmbeddedCartridge, IStandaloneCartridge

All Known Implementing Classes:

BaseCartridge, EmbeddableCartridge, EmbeddedCartridgeResource, StandaloneCartridge

public interface ICartridge

Author:

André Dietisheim

Field Summary

static char

NAME_VERSION_DELIMITER

Method Summary

String	getDescription() Returns a description for this cartridge
String	getDisplayName() Returns a (human readable, nice) display name for this cartridge
String	getName() Returns the name of this cartridge
URL	getUrl() Returns the url at which the code for this cartridge may get downloaded.
boolean	isDownloadable() Returns true if this is a downloadable cartridge whose code may be downloaded at the url returned by getUrl() (cartridge code will get downloaded upon creation).

Field Detail

NAME_VERSION_DELIMITER

static final char NAME_VERSION_DELIMITER

See Also:

Constant Field Values

Method Detail

getName

String getName()

Returns the name of this cartridge

Returns:

the name

getDisplayName

String getDisplayName()

Returns a (human readable, nice) display name for this cartridge

Returns:

the display name

getDescription

String getDescription()

Returns a description for this cartridge

Returns:

the description

isDownloadable

boolean isDownloadable()

Returns true if this is a downloadable cartridge whose code may be downloaded at the url returned by getUrl() (cartridge code will get downloaded upon creation). Examples:

• go standalone cartridge (https://github.com/smarterclayton/openshift-go-cart)
• redis embedded cartridge (https://github.com/smarterclayton/openshift-redis-cart)
• foreman embedded cartridge (https://github.com/ncdc/openshift-foreman-cartridge)

Returns:

true if this is a downloadable cartridge

See Also:

getUrl()

getUrl

URL getUrl()

Returns the url at which the code for this cartridge may get downloaded. Returns null if this is not a downloadable cartridge.

Returns:

the url if downloadable cartridge or null

See Also:

isDownloadable()