com.openshift.internal.client

Class EmbeddedCartridgeResource

java.lang.Object

com.openshift.internal.client.AbstractOpenShiftResource

com.openshift.internal.client.EmbeddedCartridgeResource

All Implemented Interfaces:

ICartridge, IEmbeddableCartridge, IEmbeddedCartridge, IOpenShiftResource

public class EmbeddedCartridgeResource
extends AbstractOpenShiftResource
implements IEmbeddedCartridge

A cartridge that may be embedded into an application. This class is no enum since we dont know all available types and they may change at any time.

Author:

André Dietisheim

Nested Class Summary

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

AbstractOpenShiftResource.ServiceRequest

Field Summary

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

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

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

NAME_VERSION_DELIMITER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EmbeddedCartridgeResource(String info, CartridgeResourceDTO dto, ApplicationResource application)
protected	EmbeddedCartridgeResource(String name, String displayName, String description, CartridgeType type, String info, Map<String,Link> links, Messages messages, ApplicationResource application)

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() Destroys this cartridge (and removes it from the list of existing cartridges)
boolean	equals(Object obj) TODO: implement fully correct #equals and #hashcode.
IApplication	getApplication() Returns the application this cartridge is embedded into.
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
protected CartridgeType	getType()
String	getUrl() The url at which this cartridge may be reached
int	hashCode()
void	refresh() Refresh the resource and its list of children resources that were previously loaded
String	toString()

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

areLinksLoaded, getCreationLog, getLink, getMessages, getService, hasCreationLog

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.openshift.client.IOpenShiftResource

getCreationLog, getMessages, hasCreationLog

Constructor Detail

EmbeddedCartridgeResource

protected EmbeddedCartridgeResource(String info,
                         CartridgeResourceDTO dto,
                         ApplicationResource application)

EmbeddedCartridgeResource

protected EmbeddedCartridgeResource(String name,
                         String displayName,
                         String description,
                         CartridgeType type,
                         String info,
                         Map<String,Link> links,
                         Messages messages,
                         ApplicationResource application)

Method Detail

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

getType

protected CartridgeType getType()

getApplication

public IApplication getApplication()

Description copied from interface: IEmbeddedCartridge

Returns the application this cartridge is embedded into.

Specified by:

getApplication in interface IEmbeddedCartridge

Returns:

application this is embedded into

getUrl

public String getUrl()
              throws OpenShiftException

Description copied from interface: IEmbeddedCartridge

The url at which this cartridge may be reached

Specified by:

getUrl in interface IEmbeddedCartridge

Returns:

the url for this cartridge

Throws:

OpenShiftException

refresh

public void refresh()
             throws OpenShiftException

Description copied from interface: IOpenShiftResource

Refresh the resource and its list of children resources that were previously loaded

Specified by:

refresh in interface IOpenShiftResource

Throws:

OpenShiftException

destroy

public void destroy()
             throws OpenShiftException

Description copied from interface: IEmbeddedCartridge

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

Specified by:

destroy in interface IEmbeddedCartridge

Throws:

OpenShiftException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

TODO: implement fully correct #equals and #hashcode. The current implementation only ensures that EmbeddedCartridgeResource may be compared to EmbeddableCartridge.

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object