DeploymentServiceConfiguration


1   /*
2    * The contents of this file are subject to the Sapient Public License
3    * Version 1.0 (the "License"); you may not use this file except in compliance
4    * with the License. You may obtain a copy of the License at
5    * http://carbon.sf.net/License.html.
6    *
7    * Software distributed under the License is distributed on an "AS IS" basis,
8    * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
9    * the specific language governing rights and limitations under the License.
10   *
11   * The Original Code is The Carbon Component Framework.
12   *
13   * The Initial Developer of the Original Code is Sapient Corporation
14   *
15   * Copyright (C) 2003 Sapient Corporation. All Rights Reserved.
16   */
17  
18  package org.sape.carbon.services.deployment;
19  
20  import org.sape.carbon.core.component.ComponentConfiguration;
21  
22  import org.sape.carbon.services.deployment.namelookup.*;
23  
24  /**
25   * Configuration interface for the Deployment Service
26   *
27   * @since carbon 1.0
28   * @author Douglas Voet, April 2002
29   * @version $Revision: 1.8 $($Author: dvoet $ / $Date: 2003/09/24 20:31:11 $)
30   * <br>Copyright 2002 Sapient
31   */
32  public interface DeploymentServiceConfiguration
33      extends ComponentConfiguration {
34  
35      /**
36       * Gets the name of the root <code>Node</code> for deployments.  This
37       * name is an absolute path and must be a <code>Folder</code>.
38       * The the <code>LinkNode</code> to the
39       * current deployment configuration will be placed under this
40       * <code>Node</code>.  All environment <code>Node</code>s must be under
41       * this <code>Node</code> and the instance specific
42       * <code>Node</code>s must be under the environment <code>Node</code>s.
43       * <p>
44       * Example <code>Node</code> structure:<br>
45       * <pre>
46       * / (root)
47       *  +deployment
48       *  | +deployments
49       *  | | +development
50       *  | | | +eng1
51       *  | | | +eng2
52       *  | | | +eng3
53       *  | | +production
54       *  | | | +instance1
55       *  | | | +instance2
56       *  | | | +instance3
57       *  | | | +instance4
58       * </pre>
59       * In this scenario, this method would return
60       * "/deployment/deployments"
61       *
62       * @return String the node name
63       */
64      String   getDeploymentsNodeAbsoluteName();
65  
66      /**
67       * Sets the value of DeploymentsNodeAbsoluteName.
68       *
69       * @param name new value of DeploymentsNodeAbsoluteName
70       */
71      void setDeploymentsNodeAbsoluteName(String   name);
72  
73      /**
74       * Gets the name to be used for the <code>LinkNode</code> that will be
75       * used to link to the current deployment's configuration file.  This
76       * name should be used when accessing deployment specific configurations.
77       * For example, if the value of CurrentDeploymentNodeName were
78       * "CurrentDeployment" one would reference values in the current
79       * deployment like:<br>
80       * {/deployment/deployments/CurrentDeployment$PropertyName}<br>
81       * or<br>
82       * {/deployment/deployments/CurrentDeployment/subconfiguration$PropertyName}
83       *
84       * @return String
85       */
86      String   getCurrentDeploymentNodeName();
87  
88      /**
89       * Sets the value of CurrentDeploymentNodeName.
90       *
91       * @param name new value of CurrentDeploymentNodeName
92       */
93      void setCurrentDeploymentNodeName(String   name);
94  
95      /**
96       * Returns the name of the environment.
97       *
98       * @return name of the environment
99       */
100     String   getEnvironmentName();
101 
102     /**
103      * Sets the name of the environment.
104      *
105      * @param name the name of the environment
106      */
107     void setEnvironmentName(String   name);
108 
109     /**
110      * Returns the name of the instance.
111      *
112      * @return the name of the instance
113      */
114     String   getInstanceName();
115 
116     /**
117      * Sets the name of the instance.
118      *
119      * @param name the name of the instance
120      */
121     void setInstanceName(String   name);
122     
123     NameLookup getEnvironmentNameLookup();
124     
125     void setEnvironmentNameLookup(NameLookup environmentNameLookup);
126 
127     NameLookup getInstanceNameLookup();
128     
129     void setInstanceNameLookup(NameLookup instanceNameLookup);
130 }
131
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags