wamblee.org Git - utils/blob - system/general/src/main/java/org/wamblee/system/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;
  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         enum Status {
  27                 NOT_STARTED, RUNNING, STOPPED
  28         }
  29
  30         /**
  31          * Gets the status of the component.
  32          * @return Status.
  33          */
  34         Status getStatus();
  35
  36         /**
  37          * Gets the name of the subsystem.
  38          * @return Subsystem name.
  39          */
  40         String getName();
  41
  42         /**
  43          * Gets a description of the provided interfaces.
  44          * @return Provided interfaces.
  45          */
  46         ProvidedInterface[] getProvidedServices();
  47
  48         /**
  49          * Gets a description of the required interfaces.
  50          * @return Required interfaces.
  51          */
  52         RequiredInterface[] getRequiredServices();
  53
  54
  55         /**
  56          * Initialises the subsytem by starting all the services that
  57          * it described as provided.
  58          * @param aContext Unique name for the subsystem.
  59          */
  60         void start(String aContext);
  61
  62         /**
  63          * Stops a subsystem.
  64          */
  65         void stop();
  66
  67         /**
  68          * Gets the list of running services in the subsystem.
  69          *
  70          * This method may only be called after the
  71          * {@link #initialize(String, Service[])} has been called.
  72          * @return
  73          */
  74         ProvidedInterface[] getRunningServices();
  75 }