com.openshift.client.cartridge

Interface IEmbeddedCartridge

All Superinterfaces:

ICartridge, IEmbeddableCartridge, IOpenShiftResource

All Known Implementing Classes:

EmbeddedCartridgeResource

public interface IEmbeddedCartridge
extends IOpenShiftResource, IEmbeddableCartridge

Interface to designate a cartridge that has been added and configured

Author:

André Dietisheim, Jeff Cantrill

Field Summary

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

NAME_10GEN_MMS_AGENT, NAME_CRON, NAME_HAPROXY, NAME_JENKINS_CLIENT, NAME_METRICS, NAME_MONGODB, NAME_MYSQL, NAME_PHPMYADMIN, NAME_POSTGRESQL, NAME_ROCKMONGO, NAME_SWITCHYARD

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

NAME_VERSION_DELIMITER

Method Summary

Modifier and Type	Method and Description
void	destroy() Destroys this cartridge (and removes it from the list of existing cartridges)
IApplication	getApplication() Returns the application this cartridge is embedded into.
CartridgeResourceProperties	getProperties() Returns the properties for this embedded cartridge
void	setAdditionalGearStorage(int size) set the additional gear storage for the cartridge to the given size.

Methods inherited from interface com.openshift.client.IOpenShiftResource

getCreationLog, getMessages, hasCreationLog, refresh

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

getDescription, getDisplayName, getName, getType, getUrl, isDownloadable, isObsolete

Method Detail

destroy

void destroy()
      throws OpenShiftException

Destroys this cartridge (and removes it from the list of existing cartridges)

Throws:

OpenShiftException

getApplication

IApplication getApplication()

Returns the application this cartridge is embedded into.

Returns:

application this is embedded into

getProperties

CartridgeResourceProperties getProperties()

Returns the properties for this embedded cartridge

Returns:

the resource properties

setAdditionalGearStorage

void setAdditionalGearStorage(int size)

set the additional gear storage for the cartridge to the given size.

Parameters:

size - The total additional gear storage for the cartridge in gigabytes