001/*
002 * Copyright (c) 2004-2010, Kohsuke Kawaguchi
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification, are permitted provided
006 * that the following conditions are met:
007 *
008 *     * Redistributions of source code must retain the above copyright notice, this list of
009 *       conditions and the following disclaimer.
010 *     * Redistributions in binary form must reproduce the above copyright notice, this list of
011 *       conditions and the following disclaimer in the documentation and/or other materials
012 *       provided with the distribution.
013 *
014 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS
015 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
016 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
017 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
018 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
019 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
020 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
021 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
022 */
023
024package org.kohsuke.stapler.jelly;
025
026import org.apache.commons.jelly.JellyTagException;
027import org.apache.commons.jelly.TagSupport;
028import org.apache.commons.jelly.XMLOutput;
029import org.kohsuke.stapler.Stapler;
030import org.kohsuke.stapler.StaplerResponse;
031import org.jvnet.maven.jellydoc.annotation.NoContent;
032import org.jvnet.maven.jellydoc.annotation.Required;
033
034import java.io.IOException;
035
036/**
037 * Sends HTTP redirect.
038 * 
039 * @author Kohsuke Kawaguchi
040 */
041@NoContent
042public class RedirectTag extends TagSupport {
043    private String url;
044
045    /**
046     * Sets the target URL to redirect to. This just gets passed
047     * to {@link StaplerResponse#sendRedirect2(String)}.
048     */
049    @Required
050    public void setUrl(String url) {
051        this.url = url;
052    }
053
054    public void doTag(XMLOutput output) throws JellyTagException {
055        try {
056            Stapler.getCurrentResponse().sendRedirect2(url);
057        } catch (IOException e) {
058            throw new JellyTagException("Failed to redirect to "+url,e);
059        }
060    }
061}
062