com.openshift.client

Interface IDomain

All Superinterfaces:

IOpenShiftResource

All Known Implementing Classes:

DomainResource

public interface IDomain
extends IOpenShiftResource

Author:

André Dietisheim

Method Summary

Methods

Modifier and Type	Method and Description
IApplication	createApplication(String name, ICartridge cartridge)
IApplication	createApplication(String name, ICartridge cartridge, ApplicationScale scale)
IApplication	createApplication(String name, ICartridge cartridge, ApplicationScale scale, IGearProfile gearProfile) Creates a new application with the given name and the given cartridge/framework.
IApplication	createApplication(String name, ICartridge cartridge, IGearProfile gearProfile)
void	destroy() Destroys the current domain.
void	destroy(boolean force) Destroys the current domain, using the 'force' parameter to also destroy the domain applications.
IApplication	getApplicationByName(String name) Returns the application identified by the given name.
List<IApplication>	getApplications()
List<IApplication>	getApplicationsByCartridge(ICartridge cartridge)
List<String>	getAvailableCartridgeNames() Returns the list of cartridges that can be used to create a new application.
List<IGearProfile>	getAvailableGearProfiles() Returns the list of available gear size that the user can choose when creating a new application (application's gear size can't be changed after creation).
String	getId()
String	getSuffix() The domain suffix is the host part eg: 'rhcloud.com')
IUser	getUser() Returns the currently connected user that manages this domain.
boolean	hasApplicationByCartridge(ICartridge cartridge)
boolean	hasApplicationByName(String name) Returns true if the application identified by the given name exists in the domain.
void	rename(String id) Rename the current domain with the given id....
boolean	waitForAccessible(long timeout) Waits for the domain to become accessible.

Methods inherited from interface com.openshift.client.IOpenShiftResource

getCreationLog, hasCreationLog, refresh

Method Detail

getId

String getId()

Returns:

the domain id (formerly known as 'namespace'). A unique litteral identifier on OpenShift.

getSuffix

String getSuffix()

The domain suffix is the host part eg: 'rhcloud.com')

Returns:

rename

void rename(String id)
            throws OpenShiftException

Rename the current domain with the given id....

Parameters:

id -

Throws:

OpenShiftException

getUser

IUser getUser()
              throws OpenShiftException

Returns the currently connected user that manages this domain.

Returns:

Throws:

OpenShiftException

destroy

void destroy()
             throws OpenShiftException

Destroys the current domain. This method works only if it has not application.

Throws:

OpenShiftException

destroy

void destroy(boolean force)
             throws OpenShiftException

Destroys the current domain, using the 'force' parameter to also destroy the domain applications. The domain cannot be destroyed without setting 'force-true' if it still contains applications.

Parameters:

force -

Throws:

OpenShiftException

waitForAccessible

boolean waitForAccessible(long timeout)
                          throws OpenShiftException

Waits for the domain to become accessible. A domain is considered as accessible as soon as at least 1 application url in it resolves to a valid ip address.

Returns:

boolean true if at least 1 application within this domain resolves

Throws:

OpenShiftException

createApplication

IApplication createApplication(String name,
                             ICartridge cartridge,
                             ApplicationScale scale,
                             IGearProfile gearProfile)
                               throws OpenShiftException

Creates a new application with the given name and the given cartridge/framework. Optionally, adds scalability and uses a specific nodeProfile, otherwise (ie, null values), uses default

Parameters:

name -

cartridge -

scale - or null (will use default on openshift, ie, false)

nodeProfile - ("small", "micro", "medium", "large", "exlarge", "jumbo") or null (will use default on openshift, ie, 'small')

Returns:

Throws:

OpenShiftException

createApplication

IApplication createApplication(String name,
                             ICartridge cartridge,
                             ApplicationScale scale)
                               throws OpenShiftException

Throws:

OpenShiftException

createApplication

IApplication createApplication(String name,
                             ICartridge cartridge,
                             IGearProfile gearProfile)
                               throws OpenShiftException

Throws:

OpenShiftException

createApplication

IApplication createApplication(String name,
                             ICartridge cartridge)
                               throws OpenShiftException

Throws:

OpenShiftException

getApplications

List<IApplication> getApplications()
                                   throws OpenShiftException

Throws:

OpenShiftException

getAvailableCartridgeNames

List<String> getAvailableCartridgeNames()
                                        throws OpenShiftException

Returns the list of cartridges that can be used to create a new application.

Returns:

the list of cartridges that can be used to create a new application.

Throws:

OpenShiftException

getApplicationByName

IApplication getApplicationByName(String name)
                                  throws OpenShiftException

Returns the application identified by the given name.

Parameters:

name -

Returns:

Throws:

OpenShiftException

hasApplicationByName

boolean hasApplicationByName(String name)
                             throws OpenShiftException

Returns true if the application identified by the given name exists in the domain.

Parameters:

name -

Returns:

Throws:

OpenShiftException

getApplicationsByCartridge

List<IApplication> getApplicationsByCartridge(ICartridge cartridge)
                                              throws OpenShiftException

Throws:

OpenShiftException

hasApplicationByCartridge

boolean hasApplicationByCartridge(ICartridge cartridge)
                                  throws OpenShiftException

Throws:

OpenShiftException

getAvailableGearProfiles

List<IGearProfile> getAvailableGearProfiles()
                                            throws OpenShiftException

Returns the list of available gear size that the user can choose when creating a new application (application's gear size can't be changed after creation).

Returns:

Throws:

OpenShiftException