com.openshift.client

Interface IOpenShiftConnection

All Known Implementing Classes:

APIResource

public interface IOpenShiftConnection

Author:

Xavier Coulon, Andre Dietisheim

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CLIENT_ID

Method Summary

Modifier and Type	Method and Description
List<ICartridge>	getCartridges() Returns all the available cartridges, embeddable and standalone ones.
List<ICartridge>	getCartridges(boolean includeObsolete) Returns all the available cartridges, embeddable and standalone ones.
List<IDomain>	getDomains() Returns the domains associated with the current OpenShift connection.
List<IEmbeddableCartridge>	getEmbeddableCartridges() Returns the available embeddable cartridges associated with the current OpenShift connection.
List<IEmbeddableCartridge>	getEmbeddableCartridges(boolean includeObsolete) Returns the available embeddable cartridges associated with the current OpenShift connection.
ExecutorService	getExecutorService() Returns the executor service instance that's available in this connection.
List<IQuickstart>	getQuickstarts() Returns the available quickstarts associated with the current OpenShift connection.
String	getServer() Returns the server this connection is bound to.
List<IStandaloneCartridge>	getStandaloneCartridges() Returns the available standalone cartridges associated with the current OpenShift connection.
List<IStandaloneCartridge>	getStandaloneCartridges(boolean includeObsolete) Returns the available standalone cartridges associated with the current OpenShift connection.
IUser	getUser() Returns the user associated with the current OpenShift connection.

Field Detail

DEFAULT_CLIENT_ID

static final String DEFAULT_CLIENT_ID

See Also:

Constant Field Values

Method Detail

getServer

String getServer()

Returns the server this connection is bound to.

Returns:

the server

getUser

IUser getUser()
       throws OpenShiftException

Returns the user associated with the current OpenShift connection.

Returns:

the user

Throws:

OpenShiftException

getDomains

List<IDomain> getDomains()
                  throws OpenShiftException

Returns the domains associated with the current OpenShift connection.

Returns:

the domains

Throws:

OpenShiftException

getStandaloneCartridges

List<IStandaloneCartridge> getStandaloneCartridges()
                                            throws OpenShiftException

Returns the available standalone cartridges associated with the current OpenShift connection. Obsolete cartridges are not reported.

Returns:

the available standalone cartridges

Throws:

OpenShiftException

getStandaloneCartridges

List<IStandaloneCartridge> getStandaloneCartridges(boolean includeObsolete)
                                            throws OpenShiftException

Returns the available standalone cartridges associated with the current OpenShift connection.

Parameters:

includeObsolete - include obsolete cartridges

Returns:

the available standalone cartridges

Throws:

OpenShiftException

getEmbeddableCartridges

List<IEmbeddableCartridge> getEmbeddableCartridges()
                                            throws OpenShiftException

Returns the available embeddable cartridges associated with the current OpenShift connection. Obsolete cartridges are not reported.

Returns:

the available embeddable cartridges

Throws:

OpenShiftException

getEmbeddableCartridges

List<IEmbeddableCartridge> getEmbeddableCartridges(boolean includeObsolete)
                                            throws OpenShiftException

Returns the available embeddable cartridges associated with the current OpenShift connection.

Parameters:

includeObsolete - include obsolete cartridges

Returns:

the available embeddable cartridges

Throws:

OpenShiftException

getCartridges

List<ICartridge> getCartridges()
                        throws OpenShiftException

Returns all the available cartridges, embeddable and standalone ones. Obsolete cartridges are not reported.

Returns:

the all the available cartridges

Throws:

OpenShiftException

getCartridges

List<ICartridge> getCartridges(boolean includeObsolete)
                        throws OpenShiftException

Returns all the available cartridges, embeddable and standalone ones.

Parameters:

includeObsolete - whether to include obsolete cartridges or not.

Returns:

the all the available cartridges

Throws:

OpenShiftException

getQuickstarts

List<IQuickstart> getQuickstarts()
                          throws OpenShiftException

Returns the available quickstarts associated with the current OpenShift connection.

Returns:

the available quickstarts

Throws:

OpenShiftException

getExecutorService

ExecutorService getExecutorService()

Returns the executor service instance that's available in this connection.

Returns:

the executor service instance for this connection

See Also:

ExecutorService, Executors