org.apache.juneau.rest.vars.SwaggerVar Maven / Gradle / Ivy
// ***************************************************************************************************************************
// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *
// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *
// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *
// * with the License. You may obtain a copy of the License at *
// * *
// * http://www.apache.org/licenses/LICENSE-2.0 *
// * *
// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
package org.apache.juneau.rest.vars;
import org.apache.juneau.rest.*;
import org.apache.juneau.svl.*;
/**
* Swagger attribute variable resolver.
*
*
* The format for this var is "$SS{key1[,key2...]}" .
*
When multiple keys are used, returns the first non-null/empty value.
*
*
* Example values:
*
* "info/title"
* "info/description"
* "info/contact/name"
*
*
* Notes:
*
* -
* This variable resolver requires that a {@link RestRequest} object be set as a context object on the resolver
* or a session object on the resolver session.
*
-
* For security reasons, nested and recursive variables are not resolved.
*
*
* See Also:
*
* - {@doc juneau-rest-server.SvlVariables}
*
*/
public class SwaggerVar extends MultipartResolvingVar {
/**
* The name of the session or context object that identifies the {@link RestRequest} object.
*/
public static final String SESSION_req = "req";
/** The name of this variable. */
public static final String NAME = "SS";
/**
* Constructor.
*/
public SwaggerVar() {
super(NAME);
}
@Override /* Var */
protected boolean allowNested() {
return false;
}
@Override /* Var */
protected boolean allowRecurse() {
return false;
}
@Override /* Parameter */
public String resolve(VarResolverSession session, String key) {
RestRequest req = session.getSessionObject(RestRequest.class, SESSION_req, true);
return req.getProperties().getString(key);
}
}