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

   1 /*
   2  * Copyright 2005-2010 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  * Property component that reads a property file and provides it to other
  31  * components through a provided interface. NOTE: when multiple property
  32  * components are used, disambiguation of provided and required interfaces is
  33  * needed.
  34  *
  35  * @author Erik Brakkee
  36  */
  37 public class PropertyComponent extends AbstractComponent<Properties> {
  38     private static ProvidedInterface PROPS = new DefaultProvidedInterface(
  39         "props", Properties.class);
  40
  41     private Properties props;
  42
  43     /**
  44      * Creates a new PropertyComponent object.
  45      *
  46      *
  47      */
  48     public PropertyComponent(String aName, InputResource aResource)
  49         throws IOException {
  50         this(aName, readProps(aResource));
  51     }
  52
  53     /**
  54      * Creates a new PropertyComponent object.
  55      *
  56      */
  57     public PropertyComponent(String aName, Properties aProps) {
  58         super(aName);
  59         props = aProps;
  60
  61         addProvidedInterface(PROPS);
  62     }
  63
  64     private static Properties readProps(InputResource aResource)
  65         throws IOException {
  66         Properties props = new Properties();
  67         props.load(aResource.getInputStream());
  68
  69         return props;
  70     }
  71
  72     @Override
  73     protected Properties doStart(Scope aScope) {
  74         addInterface(PROPS, props, aScope);
  75
  76         return props;
  77     }
  78
  79     @Override
  80     protected void doStop(Properties aRuntime) {
  81         // Empty
  82     }
  83 }