001: /*
002: * The contents of this file are subject to the Sapient Public License
003: * Version 1.0 (the "License"); you may not use this file except in compliance
004: * with the License. You may obtain a copy of the License at
005: * http://carbon.sf.net/License.html.
006: *
007: * Software distributed under the License is distributed on an "AS IS" basis,
008: * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
009: * the specific language governing rights and limitations under the License.
010: *
011: * The Original Code is The Carbon Component Framework.
012: *
013: * The Initial Developer of the Original Code is Sapient Corporation
014: *
015: * Copyright (C) 2003 Sapient Corporation. All Rights Reserved.
016: */
017:
018: package org.sape.carbon.core.component.startup;
019:
020: import org.sape.carbon.core.component.ComponentConfiguration;
021: import org.sape.carbon.core.config.Configuration;
022:
023: /**
024: * <p>Configuration interface for the Startup Service.</p>
025: *
026: * Copyright 2002 Sapient
027: * @since carbon 1.0
028: * @author Douglas Voet, January 2002
029: * @version $Revision: 1.15 $($Author: dvoet $ / $Date: 2003/05/05 21:21:14 $)
030: */
031: public interface StartupServiceConfiguration extends
032: ComponentConfiguration {
033:
034: /**
035: * <p>Gets the set of components that need to be started.</p>
036: *
037: * @return the set of components to be started
038: */
039: StartupComponentConfiguration[] getStartupComponent();
040:
041: /**
042: * Sets the list of components to be started.
043: *
044: * @param startupComponents components to started
045: */
046: void setStartupComponent(
047: StartupComponentConfiguration[] startupComponents);
048:
049: /**
050: * Gets a component from the list of startup components.
051: *
052: * @param index index of component to get
053: * @return the component at the given index
054: */
055: StartupComponentConfiguration getStartupComponent(int index);
056:
057: /**
058: * Replaces a component in the list of startup components.
059: *
060: * @param index index of component to replace
061: * @param startupComponents component to replace in the list
062: */
063: void setStartupComponent(int index,
064: StartupComponentConfiguration startupComponents);
065:
066: /**
067: * Adds a component to the list of startup components.
068: *
069: * @param newStartupService component to add to the list
070: */
071: void addStartupComponent(
072: StartupComponentConfiguration newStartupService);
073:
074: /**
075: * Interface defining a component to be processed by the
076: * startup service.
077: */
078: interface StartupComponentConfiguration extends Configuration {
079: /**
080: * Gets the location of the component to start.
081: *
082: * @return location of component to start
083: */
084: String getComponentName();
085:
086: /**
087: * Sets the location of the component to start.
088: *
089: * @param value location of component to start
090: */
091: void setComponentName(String value);
092:
093: /**
094: * Indicates if this component is enabled to be started by the service.
095: *
096: * @return if this component should be started
097: */
098: boolean isEnabled();
099:
100: /**
101: * Sets if this component is enabled to be started by the service.
102: *
103: * @param value if this component should be started
104: */
105: void setEnabled(boolean value);
106: }
107: }
|