org.apache.juneau.rest.vars.RequestVar 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.*;
import org.apache.juneau.internal.*;
import org.apache.juneau.rest.*;
import org.apache.juneau.svl.*;
/**
* Request attribute variable resolver.
*
*
* The format for this var is "$R{key1[,key2...]}" .
*
When multiple keys are used, returns the first non-null/empty value.
*
*
* The possible values are:
*
* "authorityPath" - Value returned by {@link RestRequest#getAuthorityPath()}
* "contextPath" - Value returned by {@link RestRequest#getContextPath()}
* "method" - Value returned by {@link RestRequest#getMethod()}
* "methodDescription" - Value returned by {@link RestRequest#getMethodDescription()}
* "methodSummary" - Value returned by {@link RestRequest#getMethodSummary()}
* "pathInfo" - Value returned by {@link RestRequest#getPathInfo()}
* "requestParentURI" - Value returned by {@link UriContext#getRootRelativePathInfoParent()}
* "requestURI" - Value returned by {@link RestRequest#getRequestURI()}
* "resourceDescription" - Value returned by {@link RestRequest#getResourceDescription()}
* "resourceTitle" - See {@link RestRequest#getResourceTitle()}
* "servletParentURI" - Value returned by {@link UriContext#getRootRelativeServletPathParent()}
* "servletPath" - See {@link RestRequest#getServletPath()}
* "servletURI" - See {@link UriContext#getRootRelativeServletPath()}
*
*
* Example:
*
* String resourceTitle = restRequest.resolveVars("$R{resourceTitle}" );
* String resourceTitleOrDescription = restRequest.resolveVars("$R{resourceTitle,resourceDescription}" );
*
*
* 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 RequestVar 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 = "R";
/**
* Constructor.
*/
public RequestVar() {
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);
char c = StringUtils.charAt(key, 0);
if (c == 'a') {
if ("authorityPath".equals(key))
return req.getAuthorityPath();
} else if (c == 'c') {
if ("contextPath".equals(key))
return req.getContextPath();
} else if (c == 'm') {
if ("method".equals(key))
return req.getMethod();
if ("methodDescription".equals(key))
return req.getMethodDescription();
if ("methodSummary".equals(key))
return req.getMethodSummary();
} else if (c == 'p') {
if ("pathInfo".equals(key))
return req.getPathInfo();
} else if (c == 'r') {
if ("requestParentURI".equals(key))
return req.getUriContext().getRootRelativePathInfoParent();
if ("requestURI".equals(key))
return req.getRequestURI();
if ("resourceDescription".equals(key))
return req.getResourceDescription();
if ("resourceTitle".equals(key))
return req.getResourceTitle();
} else if (c == 's') {
if ("servletClass".equals(key))
return req.getContext().getResource().getClass().getName();
if ("servletClassSimple".equals(key))
return req.getContext().getResource().getClass().getSimpleName();
if ("servletParentURI".equals(key))
return req.getUriContext().getRootRelativeServletPathParent();
if ("servletPath".equals(key))
return req.getServletPath();
if ("servletURI".equals(key))
return req.getUriContext().getRootRelativeServletPath();
if ("siteName".equals(key))
return req.getSiteName();
}
return req.getProperties().getString(key);
}
}