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