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.rest.vars;
018
019import static org.apache.juneau.common.utils.StringUtils.*;
020
021import org.apache.juneau.common.utils.*;
022import org.apache.juneau.svl.*;
023
024/**
025 * URL-encoding variable resolver.
026 *
027 * <p>
028 * The format for this var is <js>"$UE{uriPart}"</js>.
029 *
030 * <p>
031 * This variable takes the contents inside the variable and replaces it with a value returned by calling
032 * {@link StringUtils#urlEncode(String)}).
033 *
034 * <p>
035 * Since this is a {@link SimpleVar}, any variables contained in the result will be recursively resolved.
036 * Likewise, if the arguments contain any variables, those will be resolved before they are passed to this var.
037 *
038 * <h5 class='section'>See Also:</h5><ul>
039 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/RestServerSvlVariables">SVL Variables</a>
040 * </ul>
041 */
042public class UrlEncodeVar extends SimpleVar {
043
044   /** The name of this variable. */
045   public static final String NAME = "UE";
046
047   /**
048    * Constructor.
049    */
050   public UrlEncodeVar() {
051      super(NAME);
052   }
053
054   @Override /* Var */
055   public String resolve(VarResolverSession session, String key) {
056      return urlEncode(key);
057   }
058}