001/* 002 * Licensed to the Apache Software Foundation (ASF) under one or more 003 * contributor license agreements. See the NOTICE file distributed with 004 * this work for additional information regarding copyright ownership. 005 * The ASF licenses this file to You under the Apache License, Version 2.0 006 * (the "License"); you may not use this file except in compliance with 007 * the License. You may obtain a copy of the License at 008 * 009 * http://www.apache.org/licenses/LICENSE-2.0 010 * 011 * Unless required by applicable law or agreed to in writing, software 012 * distributed under the License is distributed on an "AS IS" BASIS, 013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 014 * See the License for the specific language governing permissions and 015 * limitations under the License. 016 */ 017package org.apache.juneau.commons.svl.vars; 018 019import org.apache.juneau.commons.settings.*; 020import org.apache.juneau.commons.svl.*; 021 022/** 023 * Environment variable variable resolver. 024 * 025 * <p> 026 * The format for this var is <js>"${E:envVar[:defaultValue]}"</js>. 027 * 028 * <h2 class='section'>Example:</h2> 029 * <p class='bjava'> 030 * <jc>// Create a variable resolver that resolves environment variables (e.g. "${E:PATH}")</jc> 031 * VarResolver <jv>varResolver</jv> = VarResolver.<jsm>create</jsm>().vars(EnvVariablesVar.<jk>class</jk>).build(); 032 * 033 * <jc>// Use it!</jc> 034 * System.<jsf>out</jsf>.println(<jv>varResolver</jv>.resolve(<js>"Environment variable PATH is set to ${E:PATH}"</js>)); 035 * </p> 036 * 037 * <p> 038 * Since this is a {@link SimpleVar}, any variables contained in the result will be recursively resolved. 039 * <br>Likewise, if the arguments contain any variables, those will be resolved before they are passed to this var. 040 * 041 * <h2 class='section'>See Also:</h2><ul> 042 * <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/MarshallSimpleVariableLanguage">Marshall Simple Variable Language</a> 043 * </ul> 044 */ 045public class EnvVariablesVar extends DefaultingVar { 046 private final SystemEnvPropertySource source = new SystemEnvPropertySource(); 047 048 049 /** The name of this variable. */ 050 public static final String NAME = "E"; 051 052 /** 053 * Constructor. 054 */ 055 public EnvVariablesVar() { 056 super(NAME); 057 } 058 059 /** 060 * Values from this source are never re-resolved: a value containing <c>${...}</c> is returned literally. 061 * 062 * @return Always <jk>false</jk>. 063 */ 064 @Override /* Overridden from Var */ 065 protected boolean allowRecurse() { 066 return false; 067 } 068 069 @Override /* Overridden from Var */ 070 public String resolve(VarResolverSession session, String varVal) { 071 var v = source.get(varVal); 072 return v.isPresent() ? v.value().orElse(null) : null; 073 } 074 075 /** 076 * Process environment variables are immutable for the lifetime of the JVM, so this var 077 * opts in to compile-time stable-value folding. 078 * 079 * <p> 080 * Compiled templates resolve {@code ${E:...}} references once at compile time and replace 081 * them with literal segments — the runtime dispatch is eliminated. 082 * 083 * @return Always {@code true}. 084 */ 085 @Override /* Overridden from Var */ 086 protected boolean isStable() { 087 return true; 088 } 089}