com.openshift.internal.client

Class EmbeddedCartridgeResource

java.lang.Object

com.openshift.internal.client.AbstractOpenShiftResource

com.openshift.internal.client.EmbeddedCartridgeResource

All Implemented Interfaces:

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

Modifier and Type	Field and Description
protected static String	CRON
protected static String	GEN_MMS_AGENT
protected static String	JENKINS_CLIENT
protected static String	METRICS
protected static String	MONGO
protected static String	MYSQL
protected static String	PHPMYADMIN
protected static String	POSTGRES
protected static String	ROCKMONGO

Fields inherited from interface com.openshift.client.IEmbeddableCartridge

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EmbeddedCartridgeResource(String info, CartridgeResourceDTO dto, ApplicationResource application)
protected	EmbeddedCartridgeResource(String name, CartridgeType type, String info, Map<String,Link> links, List<Message> creationLog, 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()
String	getName()
protected CartridgeType	getType()
String	getUrl()
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, 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, hasCreationLog

Field Detail

JENKINS_CLIENT

protected static final String JENKINS_CLIENT

See Also:

Constant Field Values

MYSQL

protected static final String MYSQL

See Also:

Constant Field Values

PHPMYADMIN

protected static final String PHPMYADMIN

See Also:

Constant Field Values

METRICS

protected static final String METRICS

See Also:

Constant Field Values

POSTGRES

protected static final String POSTGRES

See Also:

Constant Field Values

MONGO

protected static final String MONGO

See Also:

Constant Field Values

ROCKMONGO

protected static final String ROCKMONGO

See Also:

Constant Field Values

CRON

protected static final String CRON

See Also:

Constant Field Values

GEN_MMS_AGENT

protected static final String GEN_MMS_AGENT

See Also:

Constant Field Values

Constructor Detail

EmbeddedCartridgeResource

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

EmbeddedCartridgeResource

protected EmbeddedCartridgeResource(String name,
                         CartridgeType type,
                         String info,
                         Map<String,Link> links,
                         List<Message> creationLog,
                         ApplicationResource application)

Method Detail

getName

public final String getName()

Specified by:

getName in interface IEmbeddableCartridge

Returns:

the name

getType

protected final CartridgeType getType()

Returns:

the type

getApplication

public final IApplication getApplication()

Returns:

the application

getUrl

public String getUrl()
              throws OpenShiftException

Specified by:

getUrl in interface IEmbeddedCartridge

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