001// Copyright 2004, 2005 The Apache Software Foundation
002//
003// Licensed under the Apache License, Version 2.0 (the "License");
004// you may not use this file except in compliance with the License.
005// 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
010// distributed under the License is distributed on an "AS IS" BASIS,
011// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012// See the License for the specific language governing permissions and
013// limitations under the License.
014
015package org.apache.tapestry;
016
017import org.apache.hivemind.ApplicationRuntimeException;
018
019/**
020 *  Exception thrown by a {@link IComponent component} or {@link org.apache.tapestry.engine.IEngineService}
021 *  that wishes to force the application to a particular page.  This is often used
022 *  to protect a sensitive page until the user is authenticated.
023 *
024 *  @author Howard Lewis Ship
025 **/
026
027public class PageRedirectException extends ApplicationRuntimeException
028{
029    private static final long serialVersionUID = -7693744317997065965L;
030    
031        private String _targetPageName;
032
033    public PageRedirectException(String targetPageName)
034    {
035        this(targetPageName, null, null, targetPageName);
036    }
037
038    public PageRedirectException(IPage page)
039    {
040        this(page.getPageName());
041    }
042
043    public PageRedirectException(
044        String message,
045        Object component,
046        Throwable rootCause,
047        String targetPageName)
048    {
049        super(message, component, null, rootCause);
050
051        _targetPageName = targetPageName;
052    }
053
054    public String getTargetPageName()
055    {
056        return _targetPageName;
057    }
058}