javax.faces.application.NavigationCase Maven / Gradle / Ivy
Show all versions of javax.faces-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.net.MalformedURLException;
import java.net.URL;
import java.util.Map;
import java.util.List;
import javax.el.ValueExpression;
import javax.el.ExpressionFactory;
import javax.faces.context.ExternalContext;
import javax.faces.context.FacesContext;
/**
*
* NavigationCase
* represents a <navigation-case> in the navigation
* rule base, as well as the <from-view-id> with
* which this <navigation-case> is a sibling.
*
* @since 2.0
*/
public class NavigationCase {
private final String fromViewId;
private final String fromAction;
private final String fromOutcome;
private final String condition;
private final String toViewId;
private final String toFlowDocumentId;
private final Map> parameters;
private final boolean redirect;
private final boolean includeViewParams;
private ValueExpression toViewIdExpr;
private ValueExpression conditionExpr;
private String toString;
private int hashCode;
// ------------------------------------------------------------ Constructors
/**
* Construct a new
* NavigationCase based on the provided arguments. See
* section JSF.7.4.2 for how a NavigationCase is used
* by the standard {@link ConfigurableNavigationHandler}
*
* @param fromViewId return from {@link #getFromViewId}
* @param fromAction return from {@link #getFromAction}
* @param fromOutcome return from {@link #getFromOutcome}
* @param condition A string to be interpreted as a
* ValueExpression by a call to {@link #getCondition}
* @param toViewId return from {@link #getToViewId}
* @param parameters return from {@link #getParameters}
* @param redirect return from {@link #isRedirect}
* @param includeViewParams return {@link #isIncludeViewParams}
*/
public NavigationCase(String fromViewId,
String fromAction,
String fromOutcome,
String condition,
String toViewId,
Map> parameters,
boolean redirect,
boolean includeViewParams) {
this.fromViewId = fromViewId;
this.fromAction = fromAction;
this.fromOutcome = fromOutcome;
this.condition = condition;
this.toViewId = toViewId;
this.toFlowDocumentId = null;
this.parameters = parameters;
this.redirect = redirect;
this.includeViewParams = includeViewParams;
}
/**
* Construct a new
* NavigationCase based on the provided arguments. See
* section JSF.7.4.2 for how a NavigationCase is used
* by the standard {@link ConfigurableNavigationHandler}
*
* @param fromViewId return from {@link #getFromViewId}
* @param fromAction return from {@link #getFromAction}
* @param fromOutcome return from {@link #getFromOutcome}
* @param condition A string to be interpreted as a
* ValueExpression by a call to {@link #getCondition}
* @param toViewId return from {@link #getToViewId}
* @param toFlowDocumentId the toFlow documentId.
* @param parameters return from {@link #getParameters}
* @param redirect return from {@link #isRedirect}
* @param includeViewParams return {@link #isIncludeViewParams}
*/
public NavigationCase(String fromViewId,
String fromAction,
String fromOutcome,
String condition,
String toViewId,
String toFlowDocumentId,
Map> parameters,
boolean redirect,
boolean includeViewParams) {
this.fromViewId = fromViewId;
this.fromAction = fromAction;
this.fromOutcome = fromOutcome;
this.condition = condition;
this.toViewId = toViewId;
this.toFlowDocumentId = toFlowDocumentId;
this.parameters = parameters;
this.redirect = redirect;
this.includeViewParams = includeViewParams;
}
// ---------------------------------------------------------- Public Methods
/**
* Construct an absolute URL to this
* NavigationCase instance using {@link
* javax.faces.application.ViewHandler#getActionURL} on the path
* portion of the url.
*
* @param context the {@link FacesContext} for the current request
* @return the action URL.
* @throws MalformedURLException if the process of constructing the
* URL causes this exception to be thrown.
*/
public URL getActionURL(FacesContext context) throws MalformedURLException {
ExternalContext extContext = context.getExternalContext();
return new URL(extContext.getRequestScheme(),
extContext.getRequestServerName(),
extContext.getRequestServerPort(),
context.getApplication().getViewHandler().getActionURL(context, getToViewId(context)));
}
/**
* Construct an absolute URL to this
* NavigationCase instance using {@link
* javax.faces.application.ViewHandler#getResourceURL} on the path
* portion of the url.
*
* @param context the {@link FacesContext} for the current request
* @return the resource URL.
* @throws MalformedURLException if the process of constructing the
* URL causes this exception to be thrown.
*/
public URL getResourceURL(FacesContext context) throws MalformedURLException {
ExternalContext extContext = context.getExternalContext();
return new URL(extContext.getRequestScheme(),
extContext.getRequestServerName(),
extContext.getRequestServerPort(),
context.getApplication().getViewHandler().getResourceURL(context, getToViewId(context)));
}
/**
* Construct an absolute URL suitable for a
* "redirect" to this NavigationCase instance using {@link
* javax.faces.application.ViewHandler#getRedirectURL} on the path
* portion of the url.
*
* @param context the {@link FacesContext} for the current request
* @return the redirect URL.
* @throws MalformedURLException if the process of constructing the
* URL causes this exception to be thrown.
*/
public URL getRedirectURL(FacesContext context) throws MalformedURLException {
ExternalContext extContext = context.getExternalContext();
return new URL(extContext.getRequestScheme(),
extContext.getRequestServerName(),
extContext.getRequestServerPort(),
context.getApplication().getViewHandler().getRedirectURL(context,
getToViewId(context),
SharedUtils.evaluateExpressions(context, getParameters()),
isIncludeViewParams()));
}
/**
* Construct an absolute URL suitable for a
* bookmarkable link to this NavigationCase instance using {@link
* javax.faces.application.ViewHandler#getBookmarkableURL} on the path
* portion of the url. This URL may include view parameters specified
* as metadata within the view.
*
* @param context the {@link FacesContext} for the current request
* @return the bookmarkable URL.
* @throws MalformedURLException if the process of constructing the
* URL causes this exception to be thrown.
*/
public URL getBookmarkableURL(FacesContext context) throws MalformedURLException {
ExternalContext extContext = context.getExternalContext();
return new URL(extContext.getRequestScheme(),
extContext.getRequestServerName(),
extContext.getRequestServerPort(),
context.getApplication().getViewHandler().getBookmarkableURL(context,
getToViewId(context),
getParameters(),
isIncludeViewParams()));
}
/**
* Return the
* <from-view-id> of the
* <navigation-rule> inside which this
* <navigation-case> is nested.
*
* @return the from viedId.
*/
public String getFromViewId() {
return fromViewId;
}
/**
* Return the <from-action>
* for this <navigation-case>
*
* @return the from action.
*/
public String getFromAction() {
return fromAction;
}
/**
* Return the <from-outcome>
* for this <navigation-case>
*
* @return the from outcome.
*/
public String getFromOutcome() {
return fromOutcome;
}
/**
* Evaluates the <to-view-id>
* for this <navigation-case>
*
* @param context the {@link FacesContext} for the current request
*
* @return the view ID that should be navigated to
*/
public String getToViewId(FacesContext context) {
if (toViewIdExpr == null) {
ExpressionFactory factory =
context.getApplication().getExpressionFactory();
toViewIdExpr = factory.createValueExpression(context.getELContext(),
toViewId,
String.class);
}
String result = (String) toViewIdExpr.getValue(context.getELContext());
if (result.charAt(0) != '/') {
result = '/' + result;
}
return result;
}
/**
* If this navigation case represents
* a flow invocation, this property is the documentId in which the flow
* whose id is given by the return from {@link #getFromOutcome()} is
* defined. Implementations must override this method to return
* the value defined in the corresponding application configuration resources
* element. The base implementation returns the empty string.
*
* @return the toFlow documentId.
* @since 2.2
*/
public String getToFlowDocumentId() {
return toFlowDocumentId;
}
/**
* Test if this navigation case has an
* associated <if> element.
*
* @return true if there's an <if>
* element associated with this <navigation-case>,
* otherwise false
*/
public boolean hasCondition() {
return (condition != null);
}
/**
*
Evaluates the
* <if> for this
* <navigation-case>, if any. The expression to
* be evaluated is passed into the constructor as a string. When
* the expression is evaluated, its value must be coerced into a
* boolean per the normal EL coercion rules.
*
* Note throws any exceptions encountered during the process of
* evaluating the expression or obtaining its value.
*
* @param context the {@link FacesContext} for the current request
*
* @return null if there is no <if> element
* associated with this <navigation-case>, otherwise
* return the evaluation result of the condition
*/
public Boolean getCondition(FacesContext context) {
if (conditionExpr == null && condition != null) {
ExpressionFactory factory =
context.getApplication().getExpressionFactory();
conditionExpr = factory.createValueExpression(context.getELContext(),
condition,
Boolean.class);
}
return ((conditionExpr != null)
? (Boolean) conditionExpr.getValue(context.getELContext())
: null);
}
/**
* Return the parameters to be included
* for navigation cases requiring a redirect. If no parameters are
* defined, null will be returned. The keys in the
* Map are parameter names. For each key, the
* corresponding value is a List of unconverted
* values.
*
* @return the list of parameters, or null
*/
public Map> getParameters() {
return parameters;
}
/**
* Return the
* <redirect> value for this
* <navigation-case>. This will be
* true if the new view should be navigated to via a
* {@link javax.faces.context.ExternalContext#redirect(String)}
*
* @return true if this is a redirect, false otherwise.
*/
public boolean isRedirect() {
return redirect;
}
/**
* Return the
* <redirect> value for this
* <navigation-case>. This will be
* true if the view parametets should be encoded into
* the redirect URL (only applies to redirect case)
*
* @return true if view parameters are to be included, false otherwise.
*/
public boolean isIncludeViewParams() {
return includeViewParams;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
NavigationCase that = (NavigationCase) o;
return (redirect == that.redirect
&& !(fromAction != null
? !fromAction.equals(that.fromAction)
: that.fromAction != null)
&& !(fromOutcome != null
? !fromOutcome.equals(that.fromOutcome)
: that.fromOutcome != null)
&& !(condition != null
? !condition.equals(that.condition)
: that.condition != null)
&& !(fromViewId != null
? !fromViewId.equals(that.fromViewId)
: that.fromViewId != null)
&& !(toViewId != null
? !toViewId.equals(that.toViewId)
: that.toViewId != null)
&& !(toFlowDocumentId != null
? !toFlowDocumentId.equals(that.toFlowDocumentId)
: that.toFlowDocumentId != null)
&& !(parameters != null
? !parameters.equals(that.parameters)
: that.parameters != null));
}
@Override
public int hashCode() {
if (hashCode == 0) {
int result = fromViewId != null ? fromViewId.hashCode() : 0;
result = 31 * result + (fromAction != null
? fromAction.hashCode()
: 0);
result = 31 * result + (fromOutcome != null
? fromOutcome.hashCode()
: 0);
result = 31 * result + (condition != null
? condition.hashCode()
: 0);
result = 31 * result + (toViewId != null ? toViewId.hashCode() : 0);
result = 31 * result + (toFlowDocumentId != null ? toFlowDocumentId.hashCode() : 0);
result = 31 * result + (redirect ? 1 : 0);
result = 31 * result + (parameters != null ? parameters.hashCode() : 0);
hashCode = result;
}
return hashCode;
}
@Override
public String toString() {
if (toString == null) {
StringBuilder sb = new StringBuilder(64);
sb.append("NavigationCase{");
sb.append("fromViewId='").append(fromViewId).append('\'');
sb.append(", fromAction='").append(fromAction).append('\'');
sb.append(", fromOutcome='").append(fromOutcome).append('\'');
sb.append(", if='").append(condition).append('\'');
sb.append(", toViewId='").append(toViewId).append('\'');
sb.append(", faces-redirect=").append(redirect);
sb.append(", includeViewParams=").append(includeViewParams).append('\'');
sb.append(", parameters=").append(((parameters != null) ? parameters.toString() : ""));
sb.append('}');
toString = sb.toString();
}
return toString;
}
}