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 import java.util.List;
  19
  20 /**
  21  * A component represents a part of a system that requires a
  22  * number of interfaces and provides a number of interfaces.
  23  *
  24  * The component interface provides the meta-data for a component.
  25  * After calling {@link #start(Scope)}, an actual runtime representation of the
  26  * component can be created which is independent of this component.
  27  * As a special case, the runtime representation may be identical to the
  28  * component instance but in general it is not. This allows a component to be
  29  * used as a factory for creating objects.
  30  *
  31  *
  32  * @author Erik Brakkee
  33  */
  34 public interface Component<Type> {
  35
  36         /**
  37          * Gets the name of the subsystem.
  38          * @return Subsystem name.
  39          */
  40         String getName();
  41
  42         /**
  43          * Prepends the context with a super context.
  44          */
  45         void addContext(String aContext);
  46
  47         /**
  48          * Getst the context.
  49          * @return Context or null if not set.
  50          */
  51         String getContext();
  52
  53         /**
  54          * Gets the fully qualified name of the component which includes
  55          * the context of the component.
  56          * This method can only be used after the component has started.
  57          * @return Qualified name.
  58          */
  59         String getQualifiedName();
  60
  61         /**
  62          * Gets a description of the provided interfaces.
  63          * @return Provided interfaces.
  64          */
  65         List<ProvidedInterface> getProvidedInterfaces();
  66
  67         /**
  68          * Gets a description of the required interfaces.
  69          * @return Required interfaces.
  70          */
  71         List<RequiredInterface> getRequiredInterfaces();
  72
  73
  74         /**
  75          * Initialises the subsystem by starting all the services that
  76          * it described as provided.
  77          * @param aScope Scope with external interface implementations that are available. The component
  78          *  must publish its runtime and its provided interfaces in this scope.
  79          * @return Gets an object representing the runtime of the component.
  80          */
  81         Type start(Scope aScope);
  82
  83         /**
  84          * Stops a component.
  85          * @param aRuntime THe runtime part of the component.
  86          */
  87         void stop(Type aRuntime);
  88 }