CarbonManagementServiceConfiguration


1   package org.sape.carbon.services.carbonmanagement;
2   
3   import org.sape.carbon.core.component.ComponentConfiguration;
4   
5   /**
6    * This interface defines the configuration of the
7    * DefaultCarbonManagementServiceImpl. Each component listed by the
8    * DontReconfigure array will not be reconfigured when
9    * refreshAllComponentConfigurations is called. Each entry in the
10   * DeploymentPropertyNames array will be returned by getDeploymentProperties.
11   *
12   * <br>Copyright 2002 Sapient
13   * @since carbon 1.2
14   * @author Douglas Voet, Dec 20, 2002
15   * @version $Revision: 1.3 $($Author: jreed $ / $Date: 2003/04/15 18:53:53 $)
16   */
17  public interface CarbonManagementServiceConfiguration
18      extends ComponentConfiguration {
19  
20      /**
21       * Gets the array of components that will not be reconfigured
22       * on a call to refreshAllComponentConfigurations.
23       *
24       * @return array of components that are not reconfigured
25       */
26      String  [] getDontReconfigure();
27  
28      /**
29       * Gets a components that will not be reconfigured
30       * on a call to refreshAllComponentConfigurations.
31       *
32       * @param index index of component in the array to return
33       * @return component at given index
34       */
35      String   getDontReconfigure(int index);
36  
37      /**
38       * Sets the array of components that will not be reconfigured
39       * on a call to refreshAllComponentConfigurations.
40       *
41       * @param componentNames array of components that are not reconfigured
42       */
43      void setDontReconfigure(String  [] componentNames);
44  
45      /**
46       * Replaces a component that will not be reconfigured
47       * on a call to refreshAllComponentConfigurations.
48       *
49       * @param index index of the component to replace
50       * @param componentName component that isn't reconfigured
51       */
52      void setDontReconfigure(int index, String   componentName);
53  
54      /**
55       * Adds a component that will not be reconfigured
56       * on a call to refreshAllComponentConfigurations.
57       *
58       * @param componentName component that isn't reconfigured
59       */
60      void addDontReconfigure(String   componentName);
61  
62      /**
63       * Gets the array of deployment property names.
64       *
65       * @return array of deployment property names
66       */
67      String  [] getDeploymentPropertyNames();
68  
69      /**
70       * Gets a deployment property name at the given index.
71       *
72       * @param index index of deployment property name to get
73       * @return deployment property name at given index
74       */
75      String   getDeploymentPropertyNames(int index);
76  
77      /**
78       * Sets the array of deployment property names.
79       *
80       * @param deploymentPropertyNames array of deployment property names
81       */
82      void setDeploymentPropertyNames(String  [] deploymentPropertyNames);
83  
84      /**
85       * Replaces a deployment property name
86       *
87       * @param index index of the component to replace
88       * @param deploymentPropertyName new deployment property name
89       */
90      void setDeploymentPropertyNames(int index, String   deploymentPropertyName);
91  
92      /**
93       * Adds a deployment property name
94       *
95       * @param deploymentPropertyName new deployment property name
96       */
97      void addDeploymentPropertyNames(String   deploymentPropertyName);
98  
99  }
100
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags