org.figure8.join.businessfacades.environment
Interface EnvironmentManager

All Known Implementing Classes:
DefaultEnvironmentManager

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.

Version:
$Revision: 1.4 $
Author:
Laurent Broudoux

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

saveLogicalEnvironment

void saveLogicalEnvironment(LogicalEnvironment environment)
                            throws DuplicateEntityException
Save a LogicalEnvironment within datastore (create or update)

Parameters:
environment - The logical environment to save
Throws:
DuplicateEntityException - if an environment with same key already exists

getLogicalEnvironments

java.util.List getLogicalEnvironments()
Retrieve all the defined logical environments.

Returns:
A list of org.figure8.join.businessobjects.environment.LogicalEnvironment objects

getLogicalEnvironment

LogicalEnvironment getLogicalEnvironment(long id)
Retrieve a logical environment using its entity identifier

Parameters:
id - The unique identifier of environment to retrieve
Returns:
The specified environment or null if not found

getLogicalEnvironment

LogicalEnvironment getLogicalEnvironment(java.lang.String key)
Retrieve a logical environment using its key

Parameters:
key - The key of environment to retrieve
Returns:
The specified environment or null if not found

getEnvironmentView

EnvironmentView getEnvironmentView(LogicalEnvironment environment)
Build an EnvironmentView object from a Logical environment instance. A view is a consolidated object aroung logical environmnet allowing to embbed related infos.

Parameters:
environment - The logical environemnt to get a view for
Returns:
The view object representing a logical environment and its consolidated informations.

getEnvironmentMapping

EnvironmentMapping getEnvironmentMapping(long id)
Retrieve an EnvironmentMapping using its unique identifier

Parameters:
id - The unique identifier of mapping to retrieve
Returns:
The EnvironmentMapping corresponding to this id or null if no one matches

getEnvironmentMappings

java.util.List getEnvironmentMappings(LogicalEnvironment environment)
Retrieve all the environment mappings for a LogicalEnvironment through time

Parameters:
environment - The logical environment to retrieve mappings for
Returns:
A List of EnvironmentMapping objects for this logical environmnet

getEnvironmentMappings

java.util.List getEnvironmentMappings(PhysicalEnvironment environment)
Retrieve all the environment mappings for a PhysicalEnvironment through time

Parameters:
environment - The physical environment to retrieve mappings for
Returns:
A list of EnvironmentMapping objects for this physical environment

getEnvironmentMappingAtDate

EnvironmentMapping getEnvironmentMappingAtDate(LogicalEnvironment environment,
                                               java.util.Date configDate)
Retrieve EnvironmentMapping that was active for an environment at specified date

Parameters:
environment - The LogicalEnvironment to retrieve mapping for
configDate - The date to retrieve active mapping
Returns:
The active EnvironmentMapping at date or null if no one was active

mapEnvironments

void mapEnvironments(LogicalEnvironment logicalEnv,
                     PhysicalEnvironment physicalEnv)
Create a new mapping of a logical environment onto a physical one. This closes all the other current active environment mappings for this 2 environments.

Parameters:
logicalEnv - The logical environment to map onto physical
physicalEnv - The physical environment to be mapped with logical

closeEnvironmentMapping

void closeEnvironmentMapping(EnvironmentMapping mapping)
Closes the specified EnvironmentMapping. This involves deactivating it and removing it from active mapping list within its related logical and physical environments.

Parameters:
mapping - The EnvironmentMapping to close

savePhysicalEnvironment

void savePhysicalEnvironment(PhysicalEnvironment environment)
                             throws DuplicateEntityException
Save a PhysicalEnvironment within datastore (create or update)

Parameters:
environment - The physical environment to save
Throws:
DuplicateEntityException - if an environment with same key already exists

getPhysicalEnvironments

java.util.List getPhysicalEnvironments()
Retrieve all the defined physical environments.

Returns:
A list of org.figure8.join.businessobjects.environment.PhysicalEnvironment objects

getPhysicalEnvironment

PhysicalEnvironment getPhysicalEnvironment(long id)
Retrieve a physical environment using its entity identifier

Parameters:
id - The unique identifier of environment to retrieve
Returns:
The specified environment or null if not found

getPhysicalEnvironment

PhysicalEnvironment getPhysicalEnvironment(java.lang.String key)
Retrieve a physical environment using its key

Parameters:
key - The key of environment to retrieve
Returns:
The specified environment or null if not found

getPhysicalEnvironmentAtDate

PhysicalEnvironment getPhysicalEnvironmentAtDate(java.lang.String key,
                                                 java.util.Date configDate)
Get a view representing physical environment configuration at a specified date

Parameters:
key - The key of environment to retrieve a configuration view for
configDate - The date to get environment configuration
Returns:
A PhysicalEnvironment for requested date

getPhysicalEnvironmentTrackingView

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).

Parameters:
key - The key of environment to retrieve a tracking view for
startDate - The date to start the configuration changes tracking
endDate - The date to end the configuration changes tracking
Returns:
A PhysicalEnvrionmentTrakingView for requested tracking period

saveDeployment

void saveDeployment(Deployment deployment)
Save a Deployment informations within datastore (create or update)

Parameters:
deployment - The deployment information to save

createDeployment

void createDeployment(Deployment deployment)
                      throws OperationNotAllowedException
Create a Deployment informations : this is the beginning step of a Deployment lifecycle. Following steps may be chained automically or not depending on transitions policy.

Parameters:
deployment - The deployment information to create
Throws:
OperationNotAllowedException - if deployment cannot be done depending on workflow rules

prepareDeployment

void prepareDeployment(Deployment deployment)
Start preparation process of a Deployment : this is the second step of deployment lifecycle.

Parameters:
deployment - The deployment to start preparation process for

realizeDeployment

void realizeDeployment(Deployment deployment)
                       throws OperationNotAllowedException
Start the realization process of a Deployment : this is a step that must follow the "prepared" state of deployment.

Parameters:
deployment - The deployment to start realization process for
Throws:
OperationNotAllowedException - if deployment cannot be realized depending on workflow rules

cancelDeployment

void cancelDeployment(Deployment deployment,
                      java.lang.String comments)
Cancel a deployment process whether it is in preparation phase or in realization phase.

Parameters:
deployment - The informations on deployment process to cancel
comments - Comments on deployment cancelling

endDeployment

void endDeployment(Deployment deployment,
                   java.lang.String comments)
                   throws OperationNotAllowedException
End a deployment process : this is the final step into this process. Deployment will be then into a "done" state.

Parameters:
deployment - The informations on deployment process to end
comments - Comments on deployment end
Throws:
OperationNotAllowedException - if deployment cannot be ended depending on workflow rules

getPreparingDeployments

java.util.List getPreparingDeployments()
Get all the deployments being in preparation stage at that time

Returns:
A list of Deployments having a status corresponding to preparation process

getRealizingDeployments

java.util.List getRealizingDeployments()
Get all the deployments being in realization stage at that time

Returns:
A list of Deployments having a status corresponding to realization process

getDeployments

java.util.List getDeployments(LogicalEnvironment environment)
Retrieve all the deployments realized for a logical environment

Parameters:
environment - The LogicalEnvironment we wants deployments for
Returns:
A list of Deployments done for the specified logical environment

getDeployments

java.util.List getDeployments(PhysicalEnvironment environment)
Retrieve all the deployments realized onto a physical environment

Parameters:
environment - The PhysicalEnvironment we want deployments for
Returns:
A list of Deployments done onto the specified physical environment

getDeployment

Deployment getDeployment(long id)
Retrieve a Deployment using its unique identifier

Parameters:
id - The identifier of deployment to retrieve
Returns:
The corresponding deployment or null if no deployment has this identifier


Copyright © 2005-2008 Join. All Rights Reserved.