|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface EnvironmentManager
This is a business interface providing methods for manipulating the
different environments managed using the Join application.
Implementation of this methods should define how logical and physical
environments are created, updated and retrieved.
Method Summary | |
---|---|
void |
cancelDeployment(Deployment deployment,
java.lang.String comments)
Cancel a deployment process whether it is in preparation phase or in realization phase. |
void |
closeEnvironmentMapping(EnvironmentMapping mapping)
Closes the specified EnvironmentMapping. |
void |
createDeployment(Deployment deployment)
Create a Deployment informations : this is the beginning step of a Deployment lifecycle. |
void |
endDeployment(Deployment deployment,
java.lang.String comments)
End a deployment process : this is the final step into this process. |
Deployment |
getDeployment(long id)
Retrieve a Deployment using its unique identifier |
java.util.List |
getDeployments(LogicalEnvironment environment)
Retrieve all the deployments realized for a logical environment |
java.util.List |
getDeployments(PhysicalEnvironment environment)
Retrieve all the deployments realized onto a physical environment |
EnvironmentMapping |
getEnvironmentMapping(long id)
Retrieve an EnvironmentMapping using its unique identifier |
EnvironmentMapping |
getEnvironmentMappingAtDate(LogicalEnvironment environment,
java.util.Date configDate)
Retrieve EnvironmentMapping that was active for an environment at specified date |
java.util.List |
getEnvironmentMappings(LogicalEnvironment environment)
Retrieve all the environment mappings for a LogicalEnvironment through time |
java.util.List |
getEnvironmentMappings(PhysicalEnvironment environment)
Retrieve all the environment mappings for a PhysicalEnvironment through time |
EnvironmentView |
getEnvironmentView(LogicalEnvironment environment)
Build an EnvironmentView object from a Logical environment instance. |
LogicalEnvironment |
getLogicalEnvironment(long id)
Retrieve a logical environment using its entity identifier |
LogicalEnvironment |
getLogicalEnvironment(java.lang.String key)
Retrieve a logical environment using its key |
java.util.List |
getLogicalEnvironments()
Retrieve all the defined logical environments. |
PhysicalEnvironment |
getPhysicalEnvironment(long id)
Retrieve a physical environment using its entity identifier |
PhysicalEnvironment |
getPhysicalEnvironment(java.lang.String key)
Retrieve a physical environment using its key |
PhysicalEnvironment |
getPhysicalEnvironmentAtDate(java.lang.String key,
java.util.Date configDate)
Get a view representing physical environment configuration at a specified date |
java.util.List |
getPhysicalEnvironments()
Retrieve all the defined physical environments. |
PhysicalEnvironmentTrackingView |
getPhysicalEnvironmentTrackingView(java.lang.String key,
java.util.Date startDate,
java.util.Date endDate)
Get a configuration changes traking view for a specified physical environment on a specified time period (between start date and end date included). |
java.util.List |
getPreparingDeployments()
Get all the deployments being in preparation stage at that time |
java.util.List |
getRealizingDeployments()
Get all the deployments being in realization stage at that time |
void |
mapEnvironments(LogicalEnvironment logicalEnv,
PhysicalEnvironment physicalEnv)
Create a new mapping of a logical environment onto a physical one. |
void |
prepareDeployment(Deployment deployment)
Start preparation process of a Deployment : this is the second step of deployment lifecycle. |
void |
realizeDeployment(Deployment deployment)
Start the realization process of a Deployment : this is a step that must follow the "prepared" state of deployment. |
void |
saveDeployment(Deployment deployment)
Save a Deployment informations within datastore (create or update) |
void |
saveLogicalEnvironment(LogicalEnvironment environment)
Save a LogicalEnvironment within datastore (create or update) |
void |
savePhysicalEnvironment(PhysicalEnvironment environment)
Save a PhysicalEnvironment within datastore (create or update) |
Method Detail |
---|
void saveLogicalEnvironment(LogicalEnvironment environment) throws DuplicateEntityException
environment
- The logical environment to save
DuplicateEntityException
- if an environment with same key already existsjava.util.List getLogicalEnvironments()
org.figure8.join.businessobjects.environment.LogicalEnvironment
objectsLogicalEnvironment getLogicalEnvironment(long id)
id
- The unique identifier of environment to retrieve
LogicalEnvironment getLogicalEnvironment(java.lang.String key)
key
- The key of environment to retrieve
EnvironmentView getEnvironmentView(LogicalEnvironment environment)
EnvironmentView
object from a Logical environment instance. A view
is a consolidated object aroung logical environmnet allowing to embbed related infos.
environment
- The logical environemnt to get a view for
EnvironmentMapping getEnvironmentMapping(long id)
id
- The unique identifier of mapping to retrieve
java.util.List getEnvironmentMappings(LogicalEnvironment environment)
environment
- The logical environment to retrieve mappings for
EnvironmentMapping
objects for this logical environmnetjava.util.List getEnvironmentMappings(PhysicalEnvironment environment)
environment
- The physical environment to retrieve mappings for
EnvironmentMapping
objects for this physical environmentEnvironmentMapping getEnvironmentMappingAtDate(LogicalEnvironment environment, java.util.Date configDate)
environment
- The LogicalEnvironment to retrieve mapping forconfigDate
- The date to retrieve active mapping
EnvironmentMapping
at date or null if no one was activevoid mapEnvironments(LogicalEnvironment logicalEnv, PhysicalEnvironment physicalEnv)
logicalEnv
- The logical environment to map onto physicalphysicalEnv
- The physical environment to be mapped with logicalvoid closeEnvironmentMapping(EnvironmentMapping mapping)
mapping
- The EnvironmentMapping to closevoid savePhysicalEnvironment(PhysicalEnvironment environment) throws DuplicateEntityException
environment
- The physical environment to save
DuplicateEntityException
- if an environment with same key already existsjava.util.List getPhysicalEnvironments()
org.figure8.join.businessobjects.environment.PhysicalEnvironment
objectsPhysicalEnvironment getPhysicalEnvironment(long id)
id
- The unique identifier of environment to retrieve
PhysicalEnvironment getPhysicalEnvironment(java.lang.String key)
key
- The key of environment to retrieve
PhysicalEnvironment getPhysicalEnvironmentAtDate(java.lang.String key, java.util.Date configDate)
key
- The key of environment to retrieve a configuration view forconfigDate
- The date to get environment configuration
PhysicalEnvironmentTrackingView getPhysicalEnvironmentTrackingView(java.lang.String key, java.util.Date startDate, java.util.Date endDate)
key
- The key of environment to retrieve a tracking view forstartDate
- The date to start the configuration changes trackingendDate
- The date to end the configuration changes tracking
void saveDeployment(Deployment deployment)
deployment
- The deployment information to savevoid createDeployment(Deployment deployment) throws OperationNotAllowedException
deployment
- The deployment information to create
OperationNotAllowedException
- if deployment cannot be done depending on workflow rulesvoid prepareDeployment(Deployment deployment)
deployment
- The deployment to start preparation process forvoid realizeDeployment(Deployment deployment) throws OperationNotAllowedException
deployment
- The deployment to start realization process for
OperationNotAllowedException
- if deployment cannot be realized depending on workflow rulesvoid cancelDeployment(Deployment deployment, java.lang.String comments)
deployment
- The informations on deployment process to cancelcomments
- Comments on deployment cancellingvoid endDeployment(Deployment deployment, java.lang.String comments) throws OperationNotAllowedException
deployment
- The informations on deployment process to endcomments
- Comments on deployment end
OperationNotAllowedException
- if deployment cannot be ended depending on workflow rulesjava.util.List getPreparingDeployments()
Deployment
s having a status corresponding to preparation processjava.util.List getRealizingDeployments()
Deployment
s having a status corresponding to realization processjava.util.List getDeployments(LogicalEnvironment environment)
environment
- The LogicalEnvironment we wants deployments for
Deployment
s done for the specified logical environmentjava.util.List getDeployments(PhysicalEnvironment environment)
environment
- The PhysicalEnvironment we want deployments for
Deployment
s done onto the specified physical environmentDeployment getDeployment(long id)
id
- The identifier of deployment to retrieve
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |