wamblee.org Git - utils/blob - system/general/src/main/java/org/wamblee/system/components/PropertyComponent.java

   1 /*
   2  * Copyright 2008 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.components;
  17
  18 import org.wamblee.io.InputResource;
  19
  20 import org.wamblee.system.core.AbstractComponent;
  21 import org.wamblee.system.core.DefaultProvidedInterface;
  22 import org.wamblee.system.core.ProvidedInterface;
  23 import org.wamblee.system.core.Scope;
  24
  25 import java.io.IOException;
  26
  27 import java.util.Properties;
  28
  29
  30 /**
  31  * Property component that reads a property file and provides it to other
  32  * components through a provided interface.  NOTE: when multiple property
  33  * components are used, disambiguation of provided and required interfaces is
  34  * needed.
  35  *
  36  * @author Erik Brakkee
  37  */
  38 public class PropertyComponent extends AbstractComponent<Properties> {
  39     /**
  40      * DOCUMENT ME!
  41      */
  42     private static ProvidedInterface PROPS = new DefaultProvidedInterface("props",
  43             Properties.class);
  44
  45     /**
  46      * DOCUMENT ME!
  47      */
  48     private Properties props;
  49
  50     /**
  51      * Creates a new PropertyComponent object.
  52      *
  53      * @param aName DOCUMENT ME!
  54      * @param aResource DOCUMENT ME!
  55      *
  56      * @throws IOException DOCUMENT ME!
  57      */
  58     public PropertyComponent(String aName, InputResource aResource)
  59         throws IOException {
  60         this(aName, readProps(aResource));
  61     }
  62
  63     /**
  64      * Creates a new PropertyComponent object.
  65      *
  66      * @param aName DOCUMENT ME!
  67      * @param aProps DOCUMENT ME!
  68      */
  69     public PropertyComponent(String aName, Properties aProps) {
  70         super(aName);
  71         props = aProps;
  72
  73         addProvidedInterface(PROPS);
  74     }
  75
  76     /**
  77      * DOCUMENT ME!
  78      *
  79      * @param aResource DOCUMENT ME!
  80      *
  81      * @return DOCUMENT ME!
  82      *
  83      * @throws IOException DOCUMENT ME!
  84      */
  85     private static Properties readProps(InputResource aResource)
  86         throws IOException {
  87         Properties props = new Properties();
  88         props.load(aResource.getInputStream());
  89
  90         return props;
  91     }
  92
  93     /**
  94      * DOCUMENT ME!
  95      *
  96      * @param aScope DOCUMENT ME!
  97      *
  98      * @return DOCUMENT ME!
  99      */
 100     @Override
 101     protected Properties doStart(Scope aScope) {
 102         addInterface(PROPS, props, aScope);
 103
 104         return props;
 105     }
 106
 107     /**
 108      * DOCUMENT ME!
 109      *
 110      * @param aRuntime DOCUMENT ME!
 111      */
 112     @Override
 113     protected void doStop(Properties aRuntime) {
 114         // Empty
 115     }
 116 }