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.Utils.*;
020
021import java.util.*;
022
023import org.apache.juneau.bean.swagger.*;
024import org.apache.juneau.common.utils.*;
025import org.apache.juneau.http.response.*;
026import org.apache.juneau.json.*;
027import org.apache.juneau.rest.*;
028import org.apache.juneau.serializer.*;
029import org.apache.juneau.svl.*;
030
031/**
032 * Rest info variable resolver.
033 *
034 * <p>
035 * The format for this var is <js>"$RS{key1[,key2...]}"</js>.
036 *
037 * <p>
038 * Used to resolve values returned by {@link RestRequest#getSwagger()}..
039 * <br>When multiple keys are used, returns the first non-null/empty value.
040 *
041 * <p>
042 * The possible values are:
043 * <ul>
044 *    <li><js>"contact"</js> - Value returned by {@link Info#getContact()}
045 *    <li><js>"description"</js> - Value returned by {@link Info#getDescription()}
046 *    <li><js>"externalDocs"</js> - Value returned by {@link Swagger#getExternalDocs()}
047 *    <li><js>"license"</js> - Value returned by {@link Info#getLicense()}
048 *    <li><js>"operationDescription"</js> - Value returned by {@link Operation#getDescription()}
049 *    <li><js>"operationSummary"</js> - Value returned by {@link Operation#getSummary()}
050 *    <li><js>"siteName"</js> - Value returned by {@link Info#getSiteName()}
051 *    <li><js>"tags"</js> - Value returned by {@link Swagger#getTags()}
052 *    <li><js>"termsOfService"</js> - Value returned by {@link Info#getTermsOfService()}
053 *    <li><js>"title"</js> - See {@link Info#getTitle()}
054 *    <li><js>"version"</js> - See {@link Info#getVersion()}
055 * </ul>
056 *
057 * <h5 class='section'>Example:</h5>
058 * <p class='bjava'>
059 *    String <jv>title</jv> = <jv>restRequest</jv>.getVarResolver().resolve(<js>"$RS{title}"</js>);
060 *    String <jv>titleOrDescription</jv> = <jv>restRequest</jv>.getVarResolver().resolve(<js>"$RS{title,description}"</js>);
061 * </p>
062 *
063 * <h5 class='section'>Notes:</h5><ul>
064 *    <li class='note'>
065 *       This variable resolver requires that a {@link RestRequest} bean be available in the session bean store.
066 *    <li class='note'>
067 *       For security reasons, nested and recursive variables are not resolved.
068 * </ul>
069 *
070 * <h5 class='section'>See Also:</h5><ul>
071 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/RestServerSvlVariables">SVL Variables</a>
072 * </ul>
073 */
074public class RequestSwaggerVar extends MultipartResolvingVar {
075
076   /** The name of this variable. */
077   public static final String NAME = "RS";
078
079   /**
080    * Constructor.
081    */
082   public RequestSwaggerVar() {
083      super(NAME);
084   }
085
086   @Override /* Var */
087   protected boolean allowNested() {
088      return false;
089   }
090
091   @Override /* Var */
092   protected boolean allowRecurse() {
093      return false;
094   }
095
096   @Override /* Var */
097   public String resolve(VarResolverSession session, String key) throws BasicHttpException, InternalServerError {
098      try {
099         RestRequest req = session.getBean(RestRequest.class).orElseThrow(InternalServerError::new);
100         Optional<Swagger> swagger = req.getSwagger();
101         WriterSerializer s = Json5Serializer.DEFAULT;
102         Optional<Operation> methodSwagger = req.getOperationSwagger();
103         char c = StringUtils.charAt(key, 0);
104         if (c == 'c') {
105            if ("contact".equals(key))
106               return swagger.map(Swagger::getInfo).map(x -> x == null ? null : x.getContact()).map(o -> s(o)).orElse(null);
107         } else if (c == 'd') {
108            if ("description".equals(key))
109               return swagger.map(Swagger::getInfo).map(x -> x == null ? null : x.getDescription()).orElse(null);
110         } else if (c == 'e') {
111            if ("externalDocs".equals(key))
112               return swagger.map(Swagger::getExternalDocs).map(ExternalDocumentation::toString).orElse(null);
113         } else if (c == 'l') {
114            if ("license".equals(key))
115               return swagger.map(Swagger::getInfo).map(x -> x == null ? null : x.getLicense()).map(o -> s(o)).orElse(null);
116         } else if (c == 'o') {
117            if ("operationDescription".equals(key))
118               return methodSwagger.map(Operation::getDescription).orElse(null);
119            if ("operationSummary".equals(key))
120               return methodSwagger.map(Operation::getSummary).orElse(null);
121         } else if (c == 'r') {
122            if ("siteName".equals(key))
123               return swagger.map(Swagger::getInfo).map(x -> x == null ? null : x.getSiteName()).orElse(null);
124         } else if (c == 't') {
125            if ("tags".equals(key))
126               return swagger.map(Swagger::getTags).map(x -> s.toString(x)).orElse(null);
127            if ("termsOfService".equals(key))
128               return swagger.map(Swagger::getInfo).map(x -> x == null ? null : x.getTermsOfService()).orElse(null);
129            if ("title".equals(key))
130               return swagger.map(Swagger::getInfo).map(x -> x == null ? null : x.getTitle()).orElse(null);
131         } else if (c == 'v') {
132            if ("version".equals(key))
133               return swagger.map(Swagger::getInfo).map(x -> x == null ? null : x.getVersion()).orElse(null);
134         }
135         return null;
136      } catch (Exception e) {
137         throw new InternalServerError(e);
138      }
139   }
140
141   @Override /* Var */
142   public boolean canResolve(VarResolverSession session) {
143      return session.getBean(RestRequest.class).isPresent();
144   }
145}