001// ***************************************************************************************************************************
002// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
003// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
004// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
005// * with the License.  You may obtain a copy of the License at                                                              *
006// *                                                                                                                         *
007// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
008// *                                                                                                                         *
009// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
010// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
011// * specific language governing permissions and limitations under the License.                                              *
012// ***************************************************************************************************************************
013package org.apache.juneau.rest.widget;
014
015import org.apache.juneau.*;
016import org.apache.juneau.rest.*;
017
018/**
019 * Widget that places a powered-by-Apache message on the page.
020 *
021 * <p>
022 * The variable it resolves is <js>"$W{PoweredByApache}"</js>.
023 *
024 * <p>
025 * It produces a simple Apache icon floating on the right.
026 * Typically it's used in the footer of the page, as shown below in the <c>RootResources</c> from the examples:
027 *
028 * <p class='bcode'>
029 *    <ja>@RestResource</ja>(
030 *       path=<js>"/"</js>,
031 *       title=<js>"Root resources"</js>,
032 *       description=<js>"Example of a router resource page."</js>,
033 *       widgets={
034 *          PoweredByApache.<jk>class</jk>
035 *       },
036 *       htmldoc=<ja>@HtmlDoc</ja>(
037 *          footer=<js>"$W{PoweredByApache}"</js>
038 *       )
039 * </p>
040 *
041 * <p>
042 * It renders the following image:
043 * <img class='bordered' src='doc-files/PoweredByApacheWidget.png'>
044 *
045 * <ul class='seealso'>
046 *    <li class='link'>{@doc juneau-rest-server.HtmlDocAnnotation.PredefinedWidgets}
047 * </ul>
048 */
049public class PoweredByApache extends Widget {
050
051   /**
052    * Returns an Apache image tag hyperlinked to <js>"http://apache.org"</js>
053    */
054   @Override /* Widget */
055   public String getHtml(RestRequest req, RestResponse res) throws Exception {
056      UriResolver r = req.getUriResolver();
057      return "<a href='http://apache.org'><img style='float:right;padding-right:20px;height:32px' src='"+r.resolve("servlet:/htdocs/asf.png")+"'>";
058   }
059}
060
061