public interface IDomain extends IOpenShiftResource
Modifier and Type | Method and Description |
---|---|
boolean |
canCreateApplicationWithEnvironmentVariables()
Returns
true if this domain can create application with environment variables. |
IApplication |
createApplication(String name,
ApplicationScale scale,
IGearProfile gearProfile,
String initialGitUrl,
int timeout,
Map<String,String> environmentVariable,
ICartridge... cartridges)
Creates a new application with the given name and the given cartridges.
|
IApplication |
createApplication(String name,
IStandaloneCartridge cartridge) |
IApplication |
createApplication(String name,
IStandaloneCartridge cartridge,
ApplicationScale scale) |
IApplication |
createApplication(String name,
IStandaloneCartridge cartridge,
ApplicationScale scale,
IGearProfile gearProfile) |
IApplication |
createApplication(String name,
IStandaloneCartridge cartridge,
ApplicationScale scale,
IGearProfile gearProfile,
String initialGitUrl)
Creates a new application with the given name and the given
cartridge/framework.
|
IApplication |
createApplication(String name,
IStandaloneCartridge cartridge,
ApplicationScale scale,
IGearProfile gearProfile,
String initialGitUrl,
int timeout,
IEmbeddableCartridge... cartridges)
Creates a new application with the given name and the given
cartridge/framework.
|
IApplication |
createApplication(String name,
IStandaloneCartridge cartridge,
ApplicationScale scale,
IGearProfile gearProfile,
String initialGitUrl,
int timeout,
Map<String,String> environmentVariable,
IEmbeddableCartridge... cartridges)
Creates a new application with the given name and the given
cartridge/framework.
|
IApplication |
createApplication(String name,
IStandaloneCartridge cartridge,
IGearProfile gearProfile) |
IApplication |
createApplication(String name,
IStandaloneCartridge cartridge,
String initialGitUrl) |
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(IStandaloneCartridge 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(IStandaloneCartridge 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....
|
getCreationLog, getMessages, hasCreationLog, refresh
String getId()
String getSuffix()
void rename(String id) throws OpenShiftException
id
- OpenShiftException
IUser getUser() throws OpenShiftException
OpenShiftException
void destroy() throws OpenShiftException
OpenShiftException
void destroy(boolean force) throws OpenShiftException
force
- OpenShiftException
boolean canCreateApplicationWithEnvironmentVariables()
true
if this domain can create application with environment variables. Returns false
otherwise.IApplication.getEnvironmentVariables()
IApplication createApplication(String name, IStandaloneCartridge cartridge) throws OpenShiftException
OpenShiftException
IApplication createApplication(String name, IStandaloneCartridge cartridge, String initialGitUrl) throws OpenShiftException
OpenShiftException
IApplication createApplication(String name, IStandaloneCartridge cartridge, ApplicationScale scale) throws OpenShiftException
OpenShiftException
IApplication createApplication(String name, IStandaloneCartridge cartridge, IGearProfile gearProfile) throws OpenShiftException
OpenShiftException
IApplication createApplication(String name, IStandaloneCartridge cartridge, ApplicationScale scale, IGearProfile gearProfile) throws OpenShiftException
OpenShiftException
IApplication createApplication(String name, IStandaloneCartridge cartridge, ApplicationScale scale, IGearProfile gearProfile, String initialGitUrl) throws OpenShiftException
name
- the name of the applicationcartridge
- the cartridge (the application type, ex. jbossas-7,
jbossews-2, php.5.2, etc.scale
- or null (will use default on openshift, ie, false)gearProfile
- available gear sizes from openshift api or
null (will use default on openshift, ie, 'small')initialGitUrl
- the git url for the initial template app to be usedOpenShiftException
IApplication createApplication(String name, IStandaloneCartridge cartridge, ApplicationScale scale, IGearProfile gearProfile, String initialGitUrl, int timeout, IEmbeddableCartridge... cartridges) throws OpenShiftException
name
- the name of the applicationcartridge
- the cartridge (the application type, ex. jbossas-7,
jbossews-2, php.5.2, etc.scale
- or null (will use default on openshift, ie, false)gearProfile
- available gear sizes from openshift api or
null (will use default on openshift, ie, 'small')initialGitUrl
- the git url for the initial template app to be usedtimeout
- the timeout value in millisecondscartridges
- the embeddable cartridges that shall get added to the new
application (the add-on cartridges mysql, mongodb, postgresql,
etc.)OpenShiftException
IApplication createApplication(String name, IStandaloneCartridge cartridge, ApplicationScale scale, IGearProfile gearProfile, String initialGitUrl, int timeout, Map<String,String> environmentVariable, IEmbeddableCartridge... cartridges) throws OpenShiftException
name
- the name of the applicationcartridge
- the cartridge (the application type, ex. jbossas-7,
jbossews-2, php.5.2, etc.scale
- or null (will use default on openshift)gearProfile
- available gear sizes from openshift api or
null (will use default on openshift, ie, 'small')initialGitUrl
- the git url for the initial template app to be usedtimeout
- the timeout value in millisecondsenvironmentVariable
- the environment variables to be added to the applicationcartridges
- the embeddable cartridges that shall get added to the new
application (the add-on cartridges mysql, mongodb, postgresql,
etc.)OpenShiftException
IApplication createApplication(String name, ApplicationScale scale, IGearProfile gearProfile, String initialGitUrl, int timeout, Map<String,String> environmentVariable, ICartridge... cartridges) throws OpenShiftException
name
- the application namescale
- the scaling (or null for default)gearProfile
- the gear profile (or null for default)initialGitUrl
- the git url for the initial template codetimeout
- the request timeoutenvironmentVariable
- the environment variables (or null for none)cartridges
- all (the standalone- and the embeddable) cartridgeOpenShiftException
List<IApplication> getApplications() throws OpenShiftException
OpenShiftException
List<String> getAvailableCartridgeNames() throws OpenShiftException
OpenShiftException
IApplication getApplicationByName(String name) throws OpenShiftException
name
- OpenShiftException
boolean hasApplicationByName(String name) throws OpenShiftException
name
- OpenShiftException
List<IApplication> getApplicationsByCartridge(IStandaloneCartridge cartridge) throws OpenShiftException
OpenShiftException
boolean hasApplicationByCartridge(IStandaloneCartridge cartridge) throws OpenShiftException
OpenShiftException
List<IGearProfile> getAvailableGearProfiles() throws OpenShiftException
OpenShiftException
Copyright © 2014 JBoss by Red Hat. All rights reserved.