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.commons.utils.StringUtils.*;
020import static org.apache.juneau.commons.utils.ThrowableUtils.*;
021import static org.apache.juneau.commons.utils.Utils.*;
022
023import java.io.*;
024
025import org.apache.juneau.http.response.*;
026import org.apache.juneau.rest.*;
027import org.apache.juneau.serializer.*;
028import org.apache.juneau.svl.*;
029
030/**
031 * Serialized request attribute variable resolver.
032 *
033 * <p>
034 * The format for this var is <js>"$SA{contentType,key[,defaultValue]}"</js>.
035 *
036 * <p>
037 * This variable resolver requires that a {@link RestRequest} bean be available in the session bean store.
038 *
039 * <p>
040 * Since this is a {@link SimpleVar}, any variables contained in the result will be recursively resolved.
041 * Likewise, if the arguments contain any variables, those will be resolved before they are passed to this var.
042 *
043 * <h5 class='section'>See Also:</h5><ul>
044 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/RestServerSvlVariables">SVL Variables</a>
045 * </ul>
046 */
047public class SerializedRequestAttrVar extends StreamedVar {
048
049   /** The name of this variable. */
050   public static final String NAME = "SA";
051
052   /**
053    * Constructor.
054    */
055   public SerializedRequestAttrVar() {
056      super(NAME);
057   }
058
059   @Override /* Overridden from Var */
060   public boolean canResolve(VarResolverSession session) {
061      return session.getBean(RestRequest.class).isPresent();
062   }
063
064   @Override /* Overridden from Var */
065   public void resolveTo(VarResolverSession session, Writer w, String key) throws Exception {
066      var i = key.indexOf(',');
067      if (i == -1)
068         throw illegalArg("Invalid format for $SA var. Must be of the format $SA{contentType,key[,defaultValue]}");
069      var s2 = splita(key);
070      var req = session.getBean(RestRequest.class).orElseThrow(InternalServerError::new);
071      var o = req.getAttribute(key).orElse(key);
072      Serializer s = req.getOpContext().getSerializers().getSerializer(s2[0]);
073      if (nn(s))
074         s.serialize(w, o);
075   }
076
077   @Override /* Overridden from Var */
078   protected boolean allowNested() {
079      return false;
080   }
081
082   @Override /* Overridden from Var */
083   protected boolean allowRecurse() {
084      return false;
085   }
086}