com.netflix.config
Interface DeploymentContext

All Known Implementing Classes:
ConfigurationBasedDeploymentContext, SimpleDeploymentContext

public interface DeploymentContext

An interface to define the deployment context of an application. All attributes are optional and may return null if unset.


Nested Class Summary
static class DeploymentContext.ContextKey
           
 
Method Summary
 java.lang.String getApplicationId()
           
 java.lang.String getDeploymentDatacenter()
           
 java.lang.String getDeploymentEnvironment()
           
 java.lang.String getDeploymentRegion()
           
 java.lang.String getDeploymentServerId()
           
 java.lang.String getDeploymentStack()
           
 java.lang.String getValue(DeploymentContext.ContextKey key)
           
 void setApplicationId(java.lang.String appId)
           
 void setDeploymentDatacenter(java.lang.String deployedAt)
           
 void setDeploymentEnvironment(java.lang.String env)
           
 void setDeploymentRegion(java.lang.String region)
           
 void setDeploymentServerId(java.lang.String serverId)
           
 void setDeploymentStack(java.lang.String stack)
           
 void setValue(DeploymentContext.ContextKey key, java.lang.String value)
           
 

Method Detail

getDeploymentEnvironment

java.lang.String getDeploymentEnvironment()
Returns:
the deployment environment. For example "test", "dev", "prod".

setDeploymentEnvironment

void setDeploymentEnvironment(java.lang.String env)

getDeploymentDatacenter

java.lang.String getDeploymentDatacenter()
Returns:
the name or ID of the data center.

setDeploymentDatacenter

void setDeploymentDatacenter(java.lang.String deployedAt)

getApplicationId

java.lang.String getApplicationId()

setApplicationId

void setApplicationId(java.lang.String appId)

setDeploymentServerId

void setDeploymentServerId(java.lang.String serverId)

getDeploymentServerId

java.lang.String getDeploymentServerId()

getDeploymentStack

java.lang.String getDeploymentStack()
Returns:
a vertical stack name where this application is deployed. The stack name can be used to affect the application's behavior.

getValue

java.lang.String getValue(DeploymentContext.ContextKey key)

setValue

void setValue(DeploymentContext.ContextKey key,
              java.lang.String value)

setDeploymentStack

void setDeploymentStack(java.lang.String stack)

getDeploymentRegion

java.lang.String getDeploymentRegion()
Returns:
region of the deployment. In EC2, this could be Amazon region "us-east-1", "us-west-1", etc.

setDeploymentRegion

void setDeploymentRegion(java.lang.String region)