001// ***************************************************************************************************************************
002// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
003// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
004// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
005// * with the License.  You may obtain a copy of the License at                                                              *
006// *                                                                                                                         *
007// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
008// *                                                                                                                         *
009// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
010// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
011// * specific language governing permissions and limitations under the License.                                              *
012// ***************************************************************************************************************************
013package org.apache.juneau.rest.vars;
014
015import static org.apache.juneau.internal.StringUtils.*;
016
017import org.apache.juneau.internal.*;
018import org.apache.juneau.svl.*;
019
020/**
021 * URL-encoding variable resolver.
022 * 
023 * <p>
024 * The format for this var is <js>"$UE{uriPart}"</js>.
025 * 
026 * <p>
027 * This variable takes the contents inside the variable and replaces it with a value returned by calling
028 * {@link StringUtils#urlEncode(String)}).
029 * 
030 * <p>
031 * Since this is a {@link SimpleVar}, any variables contained in the result will be recursively resolved.
032 * Likewise, if the arguments contain any variables, those will be resolved before they are passed to this var.
033 * 
034 * <h5 class='section'>See Also:</h5>
035 * <ul>
036 *    <li class='link'><a class="doclink" href="../../../../../overview-summary.html#juneau-rest-server.SvlVariables">Overview &gt; juneau-rest-server &gt; SVL Variables</a>
037 * </ul>
038 */
039public class UrlEncodeVar extends SimpleVar {
040
041   /** The name of this variable. */
042   public static final String NAME = "UE";
043
044   /**
045    * Constructor.
046    */
047   public UrlEncodeVar() {
048      super(NAME);
049   }
050
051   @Override /* Parameter */
052   public String resolve(VarResolverSession session, String key) {
053      return urlEncode(key);
054   }
055}