com.openshift.internal.client

Class StandaloneCartridgeResource

java.lang.Object

com.openshift.internal.client.AbstractOpenShiftResource

com.openshift.internal.client.StandaloneCartridgeResource

All Implemented Interfaces:

ICartridge, IDeployedStandaloneCartridge, IStandaloneCartridge, IOpenShiftResource

public class StandaloneCartridgeResource
extends AbstractOpenShiftResource
implements IStandaloneCartridge, IDeployedStandaloneCartridge

A deployed standalone cartridge.

Author:

Jeff Cantrill, Andre Dietisheim

Nested Class Summary

Nested classes/interfaces inherited from class com.openshift.internal.client.AbstractOpenShiftResource

AbstractOpenShiftResource.Parameters, AbstractOpenShiftResource.ServiceRequest

Field Summary

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

NAME_JBOSSAS, NAME_JBOSSEAP, NAME_JBOSSEWS, NAME_JENKINS, NAME_PERL, NAME_PHP, NAME_PYTHON, NAME_RUBY, NAME_ZEND

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

NAME_VERSION_DELIMITER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StandaloneCartridgeResource(CartridgeResourceDTO dto, ApplicationResource application)
protected	StandaloneCartridgeResource(String name, String displayName, String description, URL url, CartridgeType cartridgeType, boolean obsolete, ApplicationResource application, IRestService service, Map<String,Link> links, Messages messages)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	getAdditionalGearStorage() Returns the additional gear storage for this cartridge
String	getDescription() Returns a description for this cartridge
String	getDisplayName() Returns a (human readable, nice) display name for this cartridge
IGearGroup	getGearGroup() Returns the gear group that this cartridge is deployed on
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.
void	refresh() Refreshes the content of this embedded cartridge.
void	setAdditionalGearStorage(int size) set the additional gear storage for this cartridge to the given value
String	toString()

Methods inherited from class com.openshift.internal.client.AbstractOpenShiftResource

getCreationLog, getLink, getMessages, hasCreationLog, setLinks

Methods inherited from class java.lang.Object

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

Constructor Detail

StandaloneCartridgeResource

protected StandaloneCartridgeResource(CartridgeResourceDTO dto,
                                      ApplicationResource application)

StandaloneCartridgeResource

protected StandaloneCartridgeResource(String name,
                                      String displayName,
                                      String description,
                                      URL url,
                                      CartridgeType cartridgeType,
                                      boolean obsolete,
                                      ApplicationResource application,
                                      IRestService service,
                                      Map<String,Link> links,
                                      Messages messages)

Method Detail

setAdditionalGearStorage

public void setAdditionalGearStorage(int size)

set the additional gear storage for this cartridge to the given value

Specified by:

setAdditionalGearStorage in interface IDeployedStandaloneCartridge

Parameters:

size - The total size of storage in gigabytes for the gear

getAdditionalGearStorage

public int getAdditionalGearStorage()

Description copied from interface: IDeployedStandaloneCartridge

Returns the additional gear storage for this cartridge

Specified by:

getAdditionalGearStorage in interface IDeployedStandaloneCartridge

Returns:

getGearGroup

public IGearGroup getGearGroup()

Description copied from interface: IDeployedStandaloneCartridge

Returns the gear group that this cartridge is deployed on

Specified by:

getGearGroup in interface IDeployedStandaloneCartridge

Returns:

refresh

public void refresh()
             throws OpenShiftException

Refreshes the content of this embedded cartridge. Causes all embedded cartridges of the same application to get updated.

Specified by:

refresh in interface IOpenShiftResource

Throws:

OpenShiftException

See Also:

#update(CartridgeResourceDTO), ApplicationResource.refreshEmbeddedCartridges()

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

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

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

toString

public String toString()

Overrides:

toString in class Object