org.apache.juneau.rest.vars.UrlVar 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.rest.*;
import org.apache.juneau.rest.annotation.*;
import org.apache.juneau.svl.*;
/**
* URL variable resolver.
*
*
* The format for this var is "$U{uri}" .
*
*
* The advantage of using this variable is that you can resolve URLs with special protocols such as
* "servlet:/xxx" .
*
*
* See {@link UriResolver} for the kinds of URIs that can be resolved.
*
* - {@link HtmlDoc#widgets() @HtmlDoc(widgets)}
*
*
*
* Uses the URI resolver returned by {@link RestRequest#getUriResolver()}.
*
*
See Also:
*
* - {@doc juneau-rest-server.SvlVariables}
*
*/
public class UrlVar extends SimpleVar {
private static final String SESSION_req = "req";
/** The name of this variable. */
public static final String NAME = "U";
/**
* Constructor.
*/
public UrlVar() {
super(NAME);
}
@Override /* Parameter */
public String resolve(VarResolverSession session, String key) {
RestRequest req = session.getSessionObject(RestRequest.class, SESSION_req, true);
return req.getUriResolver().resolve(key);
}
}