com.openshift.client

Interface IOpenShiftConnection

All Known Implementing Classes:

APIResource

public interface IOpenShiftConnection

Author:

Xavier Coulon, Andre Dietisheim

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.
void	setEnableSSLCertChecks(boolean doSSLChecks) Sets flag for enabling SSL certificate checks (i.e.
void	setProxyHost(String proxyHost) Deprecated.
void	setProxyPort(String proxyPort) Deprecated.
void	setProxySet(boolean proxySet) Deprecated.

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

setEnableSSLCertChecks

void setEnableSSLCertChecks(boolean doSSLChecks)

Sets flag for enabling SSL certificate checks (i.e. self-signed SSL certificates)

Parameters:

doSSLChecks -

setProxySet

@Deprecated
void setProxySet(boolean proxySet)

Deprecated.

Sets flag for using an HTTP proxy

Parameters:

proxySet -

setProxyHost

@Deprecated
void setProxyHost(String proxyHost)

Deprecated.

Sets the HTTP proxy hostname

Parameters:

proxyHost -

setProxyPort

@Deprecated
void setProxyPort(String proxyPort)

Deprecated.

Sets the HTTP proxy port

Parameters:

proxyPort -

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