com.openshift.internal.client

Class ApplicationResource

java.lang.Object

com.openshift.internal.client.AbstractOpenShiftResource

com.openshift.internal.client.ApplicationResource

All Implemented Interfaces:

IApplication, IOpenShiftResource

public class ApplicationResource
extends AbstractOpenShiftResource
implements IApplication

The Class Application.

Author:

André Dietisheim

Nested Class Summary

Nested classes/interfaces inherited from class com.openshift.internal.client.AbstractOpenShiftResource

AbstractOpenShiftResource.ServiceRequest

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ApplicationResource(ApplicationResourceDTO dto, ICartridge cartridge, DomainResource domain) Constructor...
protected	ApplicationResource(String name, String uuid, String creationTime, List<Message> creationLog, String applicationUrl, String gitUrl, IGearProfile gearProfile, ApplicationScale scale, ICartridge cartridge, List<String> aliases, Map<String,String> embeddedCartridgesInfos, Map<String,Link> links, DomainResource domain) Instantiates a new application.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAlias(String alias) Add application alias
List<IEmbeddedCartridge>	addEmbeddableCartridge(ICartridgeConstraint cartridgeConstraint) Adds the embeddable cartridges that match the given constraint.
IEmbeddedCartridge	addEmbeddableCartridge(IEmbeddableCartridge cartridge) Adds the given embedded cartridge to this application.
List<IEmbeddedCartridge>	addEmbeddableCartridges(Collection<IEmbeddableCartridge> cartridges) Adds all given embedded cartridges from this app, given their names.
void	destroy() Destroys this application (and removes it from the list of available applications)
boolean	equals(Object object)
List<String>	getAliases() Retrieve all application aliases
ApplicationScale	getApplicationScale() Returns true if scaling is enabled on this application (only set at creation time).
String	getApplicationUrl() Returns the url at which this application may be reached at.
ICartridge	getCartridge() Returns the cartridge (application type) that this app is running on.
String	getCartridge(String cartridgeName)
protected IOpenShiftConnection	getConnection()
Date	getCreationTime() Returns the timestamp at which this app was created.
void	getDescriptor()
IDomain	getDomain() Get the domain of the application.
IEmbeddedCartridge	getEmbeddedCartridge(IEmbeddableCartridge cartridge) Returns the embedded cartridge in this application.
IEmbeddedCartridge	getEmbeddedCartridge(String cartridgeName) Returns the embedded cartridge given its name.
List<IEmbeddedCartridge>	getEmbeddedCartridges() Returns all embedded cartridges.
Collection<IEmbeddedCartridge>	getEmbeddedCartridges(ICartridgeConstraint constraint) Returns the embedded cartridges in this application that match the given cartridge constraint.
List<String>	getEnvironmentProperties() Retrieves the list of environment properties.
List<IApplicationPortForwarding>	getForwardablePorts() Returns the list of forwardable ports on OpenShift for this application.
IGearProfile	getGearProfile() Returns true if scaling is enabled on this application (only set at creation time).
String	getGitUrl() Returns the uri at which the git repository of this application may be reached at.
String	getName() Returns the name of this application.
com.jcraft.jsch.Session	getSSHSession() Returns the SSH session that this application uses to connect to OpenShift.
String	getUUID() Returns the uuid of this application.
boolean	hasAlias(String name)
boolean	hasEmbeddedCartridge(IEmbeddableCartridge cartridge) Returns true if this application has an embedded cartridge.
boolean	hasEmbeddedCartridge(String cartridgeName) Returns true if this application has an embedded cartridge.
int	hashCode()
boolean	hasSSHSession() Returns true if the application was already provided with an SSH session, and this session is still valid (connected).
boolean	isPortFowardingStarted() Returns true if the port-forwarding has been started, false otherwise.
void	refresh() Refresh the application but reloading its content from OpenShift.
List<IApplicationPortForwarding>	refreshForwardablePorts() Refreshes the list of port-forwarding.
void	removeAlias(String alias) Remove application alias
void	removeEmbeddedCartridge(IEmbeddableCartridge cartridge) Removes the given embedded cartridge that is equal to the given embeddable cartridge.
protected void	removeEmbeddedCartridge(IEmbeddedCartridge embeddedCartridge) "callback" from the embeddedCartridge once it has been destroyed.
void	removeEmbeddedCartridges(Collection<IEmbeddableCartridge> cartridges) Removes the given embedded cartridges in this application that are equal to the given IEmbeddableCartridge.
void	removeEmbeddedCartridges(ICartridgeConstraint cartridgeConstraint) Removes the embeddable cartridges that match the given constraint.
void	restart() Restarts this application.
void	scaleDown() Scale down application
void	scaleUp() Scale up application
void	setSSHSession(com.jcraft.jsch.Session session) Sets the SSH session that this application will use to connect to OpenShift to perform some operations.
void	start() Starts this application.
List<IApplicationPortForwarding>	startPortForwarding()
void	stop() Stops this application.
void	stop(boolean force) Stops this application
List<IApplicationPortForwarding>	stopPortForwarding() Stop the port-forwarding for all ports.
String	toString()
boolean	waitForAccessible(long timeout) Waits for this application to become accessible on its public url.
Future<Boolean>	waitForAccessibleAsync(long timeout) Returns a Future that the caller can use to wait for the application to become accessible on its public url.

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

Constructor Detail

ApplicationResource

protected ApplicationResource(ApplicationResourceDTO dto,
                   ICartridge cartridge,
                   DomainResource domain)

Constructor...

Parameters:

dto -

cartridge -

domain -

ApplicationResource

protected ApplicationResource(String name,
                   String uuid,
                   String creationTime,
                   List<Message> creationLog,
                   String applicationUrl,
                   String gitUrl,
                   IGearProfile gearProfile,
                   ApplicationScale scale,
                   ICartridge cartridge,
                   List<String> aliases,
                   Map<String,String> embeddedCartridgesInfos,
                   Map<String,Link> links,
                   DomainResource domain)

Instantiates a new application.

Parameters:

name - the name

uuid - the uuid

creationTime - the creation time

creationLog - the creation log

applicationUrl - the application url

gitUrl - the git url

cartridge - the cartridge (type/framework)

aliases - the aliases

links - the links

domain - the domain this application belongs to

Throws:

DatatypeConfigurationException

Method Detail

getName

public String getName()

Description copied from interface: IApplication

Returns the name of this application.

Specified by:

getName in interface IApplication

Returns:

getApplicationScale

public ApplicationScale getApplicationScale()

Description copied from interface: IApplication

Returns true if scaling is enabled on this application (only set at creation time).

Specified by:

getApplicationScale in interface IApplication

Returns:

true if scaling is enabled on this application (only set at creation time).

getGearProfile

public IGearProfile getGearProfile()

Description copied from interface: IApplication

Returns true if scaling is enabled on this application (only set at creation time).

Specified by:

getGearProfile in interface IApplication

Returns:

true if scaling is enabled on this application (only set at creation time).

getUUID

public String getUUID()

Description copied from interface: IApplication

Returns the uuid of this application.

Specified by:

getUUID in interface IApplication

Returns:

the uuid of this application.

getCartridge

public ICartridge getCartridge()

Description copied from interface: IApplication

Returns the cartridge (application type) that this app is running on.

Specified by:

getCartridge in interface IApplication

Returns:

the cartridge of this application

getCreationTime

public Date getCreationTime()

Description copied from interface: IApplication

Returns the timestamp at which this app was created.

Specified by:

getCreationTime in interface IApplication

Returns:

the creation time

getDomain

public IDomain getDomain()

Description copied from interface: IApplication

Get the domain of the application.

Specified by:

getDomain in interface IApplication

Returns:

the domain

destroy

public void destroy()
             throws OpenShiftException

Description copied from interface: IApplication

Destroys this application (and removes it from the list of available applications)

Specified by:

destroy in interface IApplication

Throws:

OpenShiftException

See Also:

IUser#getApplications()

start

public void start()
           throws OpenShiftException

Description copied from interface: IApplication

Starts this application. Has no effect if this app is already running.

Specified by:

start in interface IApplication

Throws:

OpenShiftException

restart

public void restart()
             throws OpenShiftException

Description copied from interface: IApplication

Restarts this application.

Specified by:

restart in interface IApplication

Throws:

OpenShiftException

stop

public void stop()
          throws OpenShiftException

Description copied from interface: IApplication

Stops this application.

Specified by:

stop in interface IApplication

Throws:

OpenShiftException

stop

public void stop(boolean force)
          throws OpenShiftException

Description copied from interface: IApplication

Stops this application

Specified by:

stop in interface IApplication

Parameters:

force - : true to force stop, false otherwise

Throws:

OpenShiftException

getDescriptor

public void getDescriptor()

scaleDown

public void scaleDown()
               throws OpenShiftException

Description copied from interface: IApplication

Scale down application

Specified by:

scaleDown in interface IApplication

Throws:

OpenShiftException

scaleUp

public void scaleUp()
             throws OpenShiftException

Description copied from interface: IApplication

Scale up application

Specified by:

scaleUp in interface IApplication

Throws:

OpenShiftException

addAlias

public void addAlias(String alias)
              throws OpenShiftException

Description copied from interface: IApplication

Add application alias

Specified by:

addAlias in interface IApplication

Throws:

OpenShiftException

getAliases

public List<String> getAliases()

Description copied from interface: IApplication

Retrieve all application aliases

Specified by:

getAliases in interface IApplication

Returns:

application aliases in an unmodifiable collection

hasAlias

public boolean hasAlias(String name)

Specified by:

hasAlias in interface IApplication

removeAlias

public void removeAlias(String alias)
                 throws OpenShiftException

Description copied from interface: IApplication

Remove application alias

Specified by:

removeAlias in interface IApplication

Throws:

OpenShiftException

getGitUrl

public String getGitUrl()

Description copied from interface: IApplication

Returns the uri at which the git repository of this application may be reached at.

Specified by:

getGitUrl in interface IApplication

Returns:

the uri of the git repo of this application.

getApplicationUrl

public String getApplicationUrl()

Description copied from interface: IApplication

Returns the url at which this application may be reached at.

Specified by:

getApplicationUrl in interface IApplication

Returns:

the url of this application.

addEmbeddableCartridge

public List<IEmbeddedCartridge> addEmbeddableCartridge(ICartridgeConstraint cartridgeConstraint)
                                                throws OpenShiftException

Description copied from interface: IApplication

Adds the embeddable cartridges that match the given constraint.

Specified by:

addEmbeddableCartridge in interface IApplication

Parameters:

cartridgeConstraint - the constraint that determines what cartridges shall be added

Throws:

OpenShiftException - if no cartridge matches the constraint

addEmbeddableCartridge

public IEmbeddedCartridge addEmbeddableCartridge(IEmbeddableCartridge cartridge)
                                          throws OpenShiftException

Adds the given embedded cartridge to this application.

Specified by:

addEmbeddableCartridge in interface IApplication

Parameters:

cartridge - the embeddable cartridge that shall be added to this application

Throws:

OpenShiftException

addEmbeddableCartridges

public List<IEmbeddedCartridge> addEmbeddableCartridges(Collection<IEmbeddableCartridge> cartridges)
                                                 throws OpenShiftException

Description copied from interface: IApplication

Adds all given embedded cartridges from this app, given their names.

Specified by:

addEmbeddableCartridges in interface IApplication

Throws:

OpenShiftException

See Also:

#addEmbeddableCartridge(IEmbeddedCartridge), #removeEmbeddedCartridge(IEmbeddedCartridge)

removeEmbeddedCartridge

protected void removeEmbeddedCartridge(IEmbeddedCartridge embeddedCartridge)
                                throws OpenShiftException

"callback" from the embeddedCartridge once it has been destroyed.

Parameters:

embeddedCartridge -

Throws:

OpenShiftException

getEmbeddedCartridges

public List<IEmbeddedCartridge> getEmbeddedCartridges()
                                               throws OpenShiftException

Description copied from interface: IApplication

Returns all embedded cartridges.

Specified by:

getEmbeddedCartridges in interface IApplication

Returns:

all embedded cartridges.

Throws:

OpenShiftException

See Also:

IEmbeddedCartridge, #addEmbeddableCartridge(IEmbeddedCartridge), #removeEmbeddedCartridge(IEmbeddedCartridge)

hasEmbeddedCartridge

public boolean hasEmbeddedCartridge(String cartridgeName)
                             throws OpenShiftException

Description copied from interface: IApplication

Returns true if this application has an embedded cartridge. Returns false otherwise.

Specified by:

hasEmbeddedCartridge in interface IApplication

Returns:

true if there's an embedded cartridge with the given name

Throws:

OpenShiftException

See Also:

IEmbeddedCartridge, #addEmbeddableCartridge(IEmbeddedCartridge), #removeEmbeddedCartridge(IEmbeddedCartridge)

hasEmbeddedCartridge

public boolean hasEmbeddedCartridge(IEmbeddableCartridge cartridge)
                             throws OpenShiftException

Description copied from interface: IApplication

Returns true if this application has an embedded cartridge. Returns false otherwise.

Specified by:

hasEmbeddedCartridge in interface IApplication

Returns:

true if there's an embedded cartridge with the given name

Throws:

OpenShiftException

See Also:

IEmbeddedCartridge, #addEmbeddableCartridge(IEmbeddedCartridge), #removeEmbeddedCartridge(IEmbeddedCartridge)

getEmbeddedCartridge

public IEmbeddedCartridge getEmbeddedCartridge(IEmbeddableCartridge cartridge)
                                        throws OpenShiftException

Description copied from interface: IApplication

Returns the embedded cartridge in this application. Returns null if none was found.

Specified by:

getEmbeddedCartridge in interface IApplication

Returns:

the embedded cartridge

Throws:

OpenShiftException

getEmbeddedCartridges

public Collection<IEmbeddedCartridge> getEmbeddedCartridges(ICartridgeConstraint constraint)
                                                     throws OpenShiftException

Description copied from interface: IApplication

Returns the embedded cartridges in this application that match the given cartridge constraint.

Specified by:

getEmbeddedCartridges in interface IApplication

Parameters:

constraint - the constraint that the embedded cartridges shall match

Returns:

the matching embedded cartridges

Throws:

OpenShiftException

getEmbeddedCartridge

public IEmbeddedCartridge getEmbeddedCartridge(String cartridgeName)
                                        throws OpenShiftException

Description copied from interface: IApplication

Returns the embedded cartridge given its name. Returns null if none was found.

Specified by:

getEmbeddedCartridge in interface IApplication

Returns:

the embedded cartridge with the given name

Throws:

OpenShiftException

removeEmbeddedCartridges

public void removeEmbeddedCartridges(ICartridgeConstraint cartridgeConstraint)
                              throws OpenShiftException

Description copied from interface: IApplication

Removes the embeddable cartridges that match the given constraint.

Specified by:

removeEmbeddedCartridges in interface IApplication

Parameters:

cartridgeConstraint - the constraint that the cartridge shall match

Throws:

OpenShiftException - if no cartridge matches the constraint

removeEmbeddedCartridge

public void removeEmbeddedCartridge(IEmbeddableCartridge cartridge)
                             throws OpenShiftException

Description copied from interface: IApplication

Removes the given embedded cartridge that is equal to the given embeddable cartridge. Does nothing if the cartridge is not present in this application.

Specified by:

removeEmbeddedCartridge in interface IApplication

Parameters:

cartridge - the cartridge that shall be removed

Throws:

OpenShiftException

removeEmbeddedCartridges

public void removeEmbeddedCartridges(Collection<IEmbeddableCartridge> cartridges)
                              throws OpenShiftException

Description copied from interface: IApplication

Removes the given embedded cartridges in this application that are equal to the given IEmbeddableCartridge. Does nothing if the cartridge is not present in this application.

Specified by:

removeEmbeddedCartridges in interface IApplication

Parameters:

cartridges - the cartridges that shall get removed

Throws:

OpenShiftException

waitForAccessible

public boolean waitForAccessible(long timeout)
                          throws OpenShiftException

Description copied from interface: IApplication

Waits for this application to become accessible on its public url.

Specified by:

waitForAccessible in interface IApplication

Returns:

Throws:

OpenShiftException

See Also:

IApplication.getApplicationUrl()

waitForAccessibleAsync

public Future<Boolean> waitForAccessibleAsync(long timeout)
                                       throws OpenShiftException

Description copied from interface: IApplication

Returns a Future that the caller can use to wait for the application to become accessible on its public url.

Specified by:

waitForAccessibleAsync in interface IApplication

Returns:

Throws:

OpenShiftException

See Also:

IApplication.getApplicationUrl(), IApplication.waitForAccessible(long), IOpenShiftConnection.getExecutorService(), Future

getCartridge

public String getCartridge(String cartridgeName)
                    throws OpenShiftException

Specified by:

getCartridge in interface IApplication

Throws:

OpenShiftException

getConnection

protected IOpenShiftConnection getConnection()

refresh

public void refresh()
             throws OpenShiftException

Description copied from interface: IApplication

Refresh the application but reloading its content from OpenShift. At the same time, this operation automatically set the embedded cartridges back to an 'unloaded' state.

Specified by:

refresh in interface IApplication

Specified by:

refresh in interface IOpenShiftResource

Throws:

OpenShiftException

setSSHSession

public void setSSHSession(com.jcraft.jsch.Session session)

Description copied from interface: IApplication

Sets the SSH session that this application will use to connect to OpenShift to perform some operations. This SSH session must be initialized out of the library, since the user's SSH settings may depend on the runtime environment (Eclipse, etc.).

Specified by:

setSSHSession in interface IApplication

Parameters:

session - the SSH session

getSSHSession

public com.jcraft.jsch.Session getSSHSession()

Description copied from interface: IApplication

Returns the SSH session that this application uses to connect to OpenShift.

Specified by:

getSSHSession in interface IApplication

Returns:

the SSH session that this application uses to connect to OpenShift.

hasSSHSession

public boolean hasSSHSession()

Description copied from interface: IApplication

Returns true if the application was already provided with an SSH session, and this session is still valid (connected).

Specified by:

hasSSHSession in interface IApplication

Returns:

true if the application was already provided with an SSH session, and this session is still valid (connected).

isPortFowardingStarted

public boolean isPortFowardingStarted()
                               throws OpenShiftSSHOperationException

Description copied from interface: IApplication

Returns true if the port-forwarding has been started, false otherwise.

Specified by:

isPortFowardingStarted in interface IApplication

Returns:

true if the port-forwarding has been started, false otherwise.

Throws:

OpenShiftSSHOperationException

refreshForwardablePorts

public List<IApplicationPortForwarding> refreshForwardablePorts()
                                                         throws OpenShiftSSHOperationException

Description copied from interface: IApplication

Refreshes the list of port-forwarding. Started ones are kept as-is.

Specified by:

refreshForwardablePorts in interface IApplication

Returns:

the list of forwardable ports on OpenShift for this application.

Throws:

OpenShiftSSHOperationException

getForwardablePorts

public List<IApplicationPortForwarding> getForwardablePorts()
                                                     throws OpenShiftSSHOperationException

Description copied from interface: IApplication

Returns the list of forwardable ports on OpenShift for this application.

Specified by:

getForwardablePorts in interface IApplication

Returns:

the list of forwardable ports on OpenShift for this application.

Throws:

OpenShiftSSHOperationException

getEnvironmentProperties

public List<String> getEnvironmentProperties()
                                      throws OpenShiftSSHOperationException

Description copied from interface: IApplication

Retrieves the list of environment properties.

Specified by:

getEnvironmentProperties in interface IApplication

Returns:

he list of environment properties.

Throws:

OpenShiftSSHOperationException

startPortForwarding

public List<IApplicationPortForwarding> startPortForwarding()
                                                     throws OpenShiftSSHOperationException

Specified by:

startPortForwarding in interface IApplication

Returns:

the list of forwardable ports on OpenShift for this application.

Throws:

OpenShiftSSHOperationException

stopPortForwarding

public List<IApplicationPortForwarding> stopPortForwarding()
                                                    throws OpenShiftSSHOperationException

Description copied from interface: IApplication

Stop the port-forwarding for all ports.

Specified by:

stopPortForwarding in interface IApplication

Returns:

the list of forwardable ports on OpenShift for this application.

Throws:

OpenShiftSSHOperationException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object