Coverage Report - org.codehaus.plexus.interpolation.EnvarBasedValueSource
 
Classes in this File Line Coverage Branch Coverage Complexity
EnvarBasedValueSource
100%
22/22
80%
8/10
2.2
 
 1  
 package org.codehaus.plexus.interpolation;
 2  
 
 3  
 /*
 4  
  * Copyright 2007 The Codehaus Foundation.
 5  
  *
 6  
  * Licensed under the Apache License, Version 2.0 (the "License");
 7  
  * you may not use this file except in compliance with the License.
 8  
  * You may obtain a copy of the License at
 9  
  *
 10  
  *      http://www.apache.org/licenses/LICENSE-2.0
 11  
  *
 12  
  * Unless required by applicable law or agreed to in writing, software
 13  
  * distributed under the License is distributed on an "AS IS" BASIS,
 14  
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 15  
  * See the License for the specific language governing permissions and
 16  
  * limitations under the License.
 17  
  */
 18  
 
 19  
 import org.codehaus.plexus.interpolation.os.OperatingSystemUtils;
 20  
 
 21  
 import java.io.IOException;
 22  
 import java.util.Properties;
 23  
 
 24  
 /**
 25  
  * {@link ValueSource} which resolves expressions against the environment variables
 26  
  * available from the underlying operating system (and possibly, the shell environment
 27  
  * that created the present Java process). If the expression starts with 'env.',
 28  
  * this prefix is trimmed before resolving the rest as an environment variable name.
 29  
  */
 30  
 public class EnvarBasedValueSource
 31  
     extends AbstractValueSource
 32  
 {
 33  
 
 34  
     private static Properties envarsCaseSensitive;
 35  
     private static Properties envarsCaseInsensitive;
 36  
 
 37  
     private final Properties envars;
 38  
     private final boolean caseSensitive;
 39  
 
 40  
     /**
 41  
      * Create a new value source for interpolation based on shell environment variables. In this
 42  
      * case, envar keys ARE CASE SENSITIVE.
 43  
      *
 44  
      * @throws IOException in case of an error.
 45  
      */
 46  
     public EnvarBasedValueSource() throws IOException
 47  
     {
 48  3
         this( true );
 49  3
     }
 50  
 
 51  
     /**
 52  
      * Create a new value source for interpolation based on shell environment variables.
 53  
      *
 54  
      * @param caseSensitive Whether the environment variable key should be treated in a
 55  
      *                      case-sensitive manner for lookups
 56  
      * @throws IOException in case of an error.
 57  
      */
 58  
     public EnvarBasedValueSource( boolean caseSensitive ) throws IOException
 59  
     {
 60  5
         super( false );
 61  5
         this.caseSensitive = caseSensitive;
 62  5
         this.envars = getEnvars( caseSensitive );
 63  5
     }
 64  
 
 65  
     private static synchronized Properties getEnvars( boolean caseSensitive )
 66  
         throws IOException
 67  
     {
 68  5
         if ( caseSensitive )
 69  
         {
 70  3
             if ( envarsCaseSensitive == null )
 71  
             {
 72  3
                 envarsCaseSensitive = OperatingSystemUtils.getSystemEnvVars( caseSensitive );
 73  
             }
 74  3
             return envarsCaseSensitive;
 75  
         }
 76  
         else
 77  
         {
 78  2
             if ( envarsCaseInsensitive == null )
 79  
             {
 80  2
                 envarsCaseInsensitive = OperatingSystemUtils.getSystemEnvVars( caseSensitive );
 81  
             }
 82  2
             return envarsCaseInsensitive;
 83  
         }
 84  
     }
 85  
 
 86  
     /**
 87  
      * If the expression starts with 'env.' then trim this prefix. Next, resolve
 88  
      * the (possibly trimmed) expression as an environment variable name against
 89  
      * the collection of environment variables that were read from the operating
 90  
      * system when this {@link ValueSource} instance was created.
 91  
      *
 92  
      * @param expression envar expression, like 'HOME' or 'env.HOME'
 93  
      * @return the environment variable value for the given expression
 94  
      */
 95  
     public Object getValue( String expression )
 96  
     {
 97  12
         String expr = expression;
 98  
 
 99  12
         if ( expr.startsWith( "env." ) )
 100  
         {
 101  7
             expr = expr.substring( "env.".length() );
 102  
         }
 103  
 
 104  12
         if ( !caseSensitive )
 105  
         {
 106  6
             expr = expr.toUpperCase();
 107  
         }
 108  
 
 109  12
         return envars.getProperty( expr );
 110  
     }
 111  
  
 112  
     /**
 113  
      * reset static variables acting as a cache for testing purposes only
 114  
      */
 115  
     static void resetStatics()
 116  
     {
 117  35
         envarsCaseSensitive = null;
 118  35
         envarsCaseInsensitive = null;
 119  35
     }
 120  
 
 121  
 }