javax.faces.application.ConfigurableNavigationHandler Maven / Gradle / Ivy
Show all versions of javaee-web-api Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.faces.application;
import java.util.Map;
import java.util.Set;
import javax.faces.context.FacesContext;
import javax.faces.flow.Flow;
/**
* ConfigurableNavigationHandler
* extends the contract of {@link NavigationHandler} to allow runtime
* inspection of the {@link NavigationCase}s that make up the rule-base
* for navigation. An implementation compliant with the version of the
* specification in which this class was introduced (or a later version)
* must make it so that its NavigationHandler is an
* extension of this class.
*
* @since 2.0
*/
public abstract class ConfigurableNavigationHandler extends NavigationHandler {
/**
* Return the {@link NavigationCase}
* representing the navigation that would be taken had {@link
* NavigationHandler#handleNavigation} been called with the same
* arguments or null if there is no such case.
*
* @param context The {@link FacesContext} for the current request
* @param fromAction The action binding expression that was evaluated
* to retrieve the specified outcome, or null if the
* outcome was acquired by some other means
* @param outcome The logical outcome returned by a previous invoked
* application action (which may be null)
* @return the navigation case, or null.
* @throws NullPointerException if context
* is null
* @since 2.0
*/
public abstract NavigationCase getNavigationCase(FacesContext context,
String fromAction,
String outcome);
/**
* Return the {@link NavigationCase}
* representing the navigation that would be taken had {@link
* NavigationHandler#handleNavigation} been called with the same
* arguments or null if there is no such case. Implementations
* that comply the version of the specification in which this method
* was introduced must override this method. For compatibility with
* decorated implementations that comply with an earlier version of the
* specification, an implementation is provided that simply calls
* through to {@link #getNavigationCase(javax.faces.context.FacesContext, java.lang.String, java.lang.String)},
* ignoring the {@code toFlowDocumentId} parameter.
*
* @param context The {@link FacesContext} for the current request
* @param fromAction The action binding expression that was evaluated
* to retrieve the specified outcome, or null if the
* outcome was acquired by some other means
* @param outcome The logical outcome returned by a previous invoked
* application action (which may be null)
* @param toFlowDocumentId The value of the toFlowDocumentId property
* for the navigation case (which may be null)
* @return the navigation case, or null.
* @throws NullPointerException if context
* is null
* @since 2.2
*/
public NavigationCase getNavigationCase(FacesContext context,
String fromAction,
String outcome,
String toFlowDocumentId) {
return getNavigationCase(context, fromAction, outcome);
}
/**
* Return a Map<String,
* Set<NavigationCase>> where the keys are
* <from-view-id> values and the values are
* Set<NavigationCase> where each element in the
* Set is a NavigationCase that applies to that
* <from-view-id>. The implementation must
* support live modifications to this Map.
*
* @return a map with navigation cases.
* @since 2.0
*/
public abstract Map> getNavigationCases();
/**
* A convenience method to signal the
* JavaServer Faces implementation to perform navigation
* with the provided outcome. When the NavigationHandler is invoked,
* the current viewId is treated as the "from viewId" and the "from action"
* is null.
*
* @param outcome the provided outcome.
* @throws IllegalStateException if this method is called after
* this instance has been released
*/
public void performNavigation(String outcome) {
this.handleNavigation(FacesContext.getCurrentInstance(), null, outcome);
}
/**
* Called by the flow system to cause
* the flow to be inspected for navigation rules. For backward
* compatibility with earlier implementations, an empty method
* is provided.
*
* @param context the Faces context.
* @param flow the flow.
* @since 2.2
*/
public void inspectFlow(FacesContext context, Flow flow) {
}
}