wamblee.org Git - utils/blob - system/general/src/main/java/org/wamblee/system/core/Component.java

   1 /*
   2  * Copyright 2007 the original author or authors.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package org.wamblee.system.core;
  17
  18 /**
  19  * A component represents a part of a system that requires a
  20  * number of interfaces and provides a number of interfaces.
  21  *
  22  * @author Erik Brakkee
  23  */
  24 public interface Component {
  25
  26         /**
  27          * Gets the name of the subsystem.
  28          * @return Subsystem name.
  29          */
  30         String getName();
  31
  32         /**
  33          * Prepends the context with a super context.
  34          */
  35         void addContext(String aContext);
  36
  37         /**
  38          * Gets the fully qualified name of the component which includes
  39          * the context of the component.
  40          * This method can only be used after the component has started.
  41          * @return Qualified name.
  42          */
  43         String getQualifiedName();
  44
  45         /**
  46          * Gets a description of the provided interfaces.
  47          * @return Provided interfaces.
  48          */
  49         ProvidedInterface[] getProvidedInterfaces();
  50
  51         /**
  52          * Gets a description of the required interfaces.
  53          * @return Required interfaces.
  54          */
  55         RequiredInterface[] getRequiredInterfaces();
  56
  57
  58         /**
  59          * Initialises the subsytem by starting all the services that
  60          * it described as provided.
  61          */
  62         void start();
  63
  64         /**
  65          * Gets the list of running services in the subsystem.
  66          *
  67          * This method may only be called after the
  68          * {@link #initialize(String, Service[])} has been called.
  69          * @return
  70          */
  71         ProvidedInterface[] getRunningInterfaces();
  72
  73         /**
  74          * Stops a subsystem.
  75          */
  76         void stop();
  77 }