com.sap.pdms.commons.util.xs2.env

Class VcapApplication

java.lang.Object

com.sap.pdms.commons.util.xs2.env.VcapApplication

Direct Known Subclasses:

Xs2VcapApplication

public class VcapApplication
extends Object

A class representing the VCAP_APPLICATION environment variable of Cloud Foundry.

See Also:

Cloud Foundry Environment Variables

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VcapApplication.Limits Represents the resource limits imposed upon a Cloud Foundry application.

Constructor Summary

Constructors

Constructor and Description
VcapApplication()
VcapApplication(String applicationId, String applicationName, String name, List<String> applicationUris, List<String> uris, String applicationVersion, String version, String host, String instanceId, int instanceIndex, VcapApplication.Limits limits, int port, String startedAt, String start, long startedAtTimestamp, long stateTimestamp)

Method Summary

Modifier and Type	Method and Description
String	getApplicationId() GUID that identifies the application.
String	getApplicationName() The name assigned to the application when it was pushed.
List<String>	getApplicationUris() The URI(s) assigned to the application.
String	getApplicationVersion() GUID that identifies a version of the application that was pushed.
String	getHost() IP address of the application instance.
String	getInstanceId() GUID that identifies the application instance.
int	getInstanceIndex() Index number of the instance.
VcapApplication.Limits	getLimits() The memory, disk, and number of files permitted to the instance.
String	getName() The name assigned to the application when it was pushed.
int	getPort() Port of the application instance.
String	getStart() The last time the application was started.
String	getStartedAt() The last time the application was started.
long	getStartedAtTimestamp() Timestamp for the last time the application was started.
long	getStateTimestamp() The timestamp for the time at which the application achieved its current state.
List<String>	getUris() The URI(s) assigned to the application.
String	getVersion() GUID that identifies a version of the application that was pushed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VcapApplication

public VcapApplication()

VcapApplication

public VcapApplication(String applicationId,
                       String applicationName,
                       String name,
                       List<String> applicationUris,
                       List<String> uris,
                       String applicationVersion,
                       String version,
                       String host,
                       String instanceId,
                       int instanceIndex,
                       VcapApplication.Limits limits,
                       int port,
                       String startedAt,
                       String start,
                       long startedAtTimestamp,
                       long stateTimestamp)

Method Detail

getApplicationId

public String getApplicationId()

GUID that identifies the application.

Returns:

the application's GUID

getApplicationName

public String getApplicationName()

The name assigned to the application when it was pushed.

Returns:

the application name

getName

public String getName()

The name assigned to the application when it was pushed.

Returns:

the application name

getApplicationUris

public List<String> getApplicationUris()

The URI(s) assigned to the application.

Returns:

the application URI(s)

getUris

public List<String> getUris()

The URI(s) assigned to the application.

Returns:

the application URI(s)

getApplicationVersion

public String getApplicationVersion()

GUID that identifies a version of the application that was pushed. Each time an application is pushed or restarted, this value is updated.

Returns:

the version id of the application

getVersion

public String getVersion()

GUID that identifies a version of the application that was pushed. Each time an application is pushed or restarted, this value is updated.

Returns:

the version id of the application

getHost

public String getHost()

IP address of the application instance.

Returns:

the IP address of the application instance

getInstanceId

public String getInstanceId()

GUID that identifies the application instance.

Returns:

the GUID of the application instance

getInstanceIndex

public int getInstanceIndex()

Index number of the instance. You can access this value directly with the CF_INSTANCE_INDEX variable.

Returns:

the index number of the application instance

getLimits

public VcapApplication.Limits getLimits()

The memory, disk, and number of files permitted to the instance. Memory and disk limits are supplied when the application is deployed, either on the command line or in the application manifest. The number of files allowed is operator-defined.

Returns:

Limit instance containing the memory, disk space and number of files permitted to the instance

getPort

public int getPort()

Port of the application instance. You can access this value directly with the PORT variable.

Returns:

the port on which the application instance listens

getStartedAt

public String getStartedAt()

The last time the application was started.

Returns:

the last time the application was started

getStart

public String getStart()

The last time the application was started.

Returns:

the last time the application was started

getStartedAtTimestamp

public long getStartedAtTimestamp()

Timestamp for the last time the application was started.

Returns:

epoch timestamp of the last time the application was started

getStateTimestamp

public long getStateTimestamp()

The timestamp for the time at which the application achieved its current state.

Returns:

epoch timestamp of the time the application achieved its current state