com.openshift.internal.client.cartridge

Class BaseCartridge

java.lang.Object

com.openshift.internal.client.cartridge.BaseCartridge

All Implemented Interfaces:

ICartridge

Direct Known Subclasses:

EmbeddableCartridge, StandaloneCartridge

public class BaseCartridge
extends Object
implements ICartridge

A (base) cartridge for an OpenShift application.

Author:

Andre Dietisheim

See Also:

EmbeddableCartridge, StandaloneCartridge

Field Summary

Fields inherited from interface com.openshift.client.cartridge.ICartridge

NAME_VERSION_DELIMITER

Constructor Summary

Constructors

Modifier	Constructor and Description
	BaseCartridge(String name)
protected	BaseCartridge(String name, String displayName, String description, boolean obsolete) Constructor used when available cartridges are loaded from OpenShift
protected	BaseCartridge(String name, URL url)
protected	BaseCartridge(String name, URL url, String displayName, String description)
protected	BaseCartridge(String name, URL url, String displayName, String description, boolean obsolete)
	BaseCartridge(URL url)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDescription() Returns a description for this cartridge
String	getDisplayName() Returns a (human readable, nice) display name for this cartridge
protected String	getDisplayName(String displayName, URL url)
String	getName() Returns the name of this cartridge
CartridgeType	getType()
URL	getUrl() Returns the url at which the code for this cartridge may get downloaded.
int	hashCode()
boolean	isDownloadable() Returns true if this is a downloadable cartridge whose code may be downloaded at the url returned by ICartridge.getUrl() (cartridge code will get downloaded upon creation).
boolean	isObsolete() Returns true if this cartridge is obsolete, false otherwise.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BaseCartridge

public BaseCartridge(String name)

BaseCartridge

public BaseCartridge(URL url)

BaseCartridge

protected BaseCartridge(String name,
                        URL url)

BaseCartridge

protected BaseCartridge(String name,
                        String displayName,
                        String description,
                        boolean obsolete)

Constructor used when available cartridges are loaded from OpenShift

See Also:

APIResource#getEmbeddableCartridges()

BaseCartridge

protected BaseCartridge(String name,
                        URL url,
                        String displayName,
                        String description)

BaseCartridge

protected BaseCartridge(String name,
                        URL url,
                        String displayName,
                        String description,
                        boolean obsolete)

Method Detail

getDisplayName

protected String getDisplayName(String displayName,
                                URL url)

getName

public String getName()

Description copied from interface: ICartridge

Returns the name of this cartridge

Specified by:

getName in interface ICartridge

Returns:

the name

getDisplayName

public String getDisplayName()

Description copied from interface: ICartridge

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

Specified by:

getDisplayName in interface ICartridge

Returns:

the display name

getDescription

public String getDescription()

Description copied from interface: ICartridge

Returns a description for this cartridge

Specified by:

getDescription in interface ICartridge

Returns:

the description

isDownloadable

public boolean isDownloadable()

Description copied from interface: ICartridge

Returns true if this is a downloadable cartridge whose code may be downloaded at the url returned by ICartridge.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)

Specified by:

isDownloadable in interface ICartridge

Returns:

true if this is a downloadable cartridge

See Also:

ICartridge.getUrl()

getUrl

public URL getUrl()

Description copied from interface: ICartridge

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

Specified by:

getUrl in interface ICartridge

Returns:

the url if downloadable cartridge or null

See Also:

ICartridge.isDownloadable()

getType

public CartridgeType getType()

Specified by:

getType in interface ICartridge

isObsolete

public boolean isObsolete()

Description copied from interface: ICartridge

Returns true if this cartridge is obsolete, false otherwise.

Specified by:

isObsolete in interface ICartridge

Returns:

true if this cartridge is obsolete

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object