com.sun.faces.facelets.tag.jsf.core.PhaseListenerHandler Maven / Gradle / Ivy
The newest version!
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2017 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.dev.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 com.sun.faces.facelets.tag.jsf.core;
import com.sun.faces.facelets.tag.TagHandlerImpl;
import com.sun.faces.facelets.tag.jsf.ComponentSupport;
import com.sun.faces.facelets.util.ReflectionUtil;
import javax.el.ValueExpression;
import javax.faces.component.UIComponent;
import javax.faces.component.UIViewRoot;
import javax.faces.context.FacesContext;
import javax.faces.event.AbortProcessingException;
import javax.faces.event.PhaseEvent;
import javax.faces.event.PhaseId;
import javax.faces.event.PhaseListener;
import javax.faces.view.facelets.*;
import java.io.IOException;
import java.io.Serializable;
import java.util.List;
public class PhaseListenerHandler extends TagHandlerImpl {
private final static class LazyPhaseListener implements PhaseListener,
Serializable {
private static final long serialVersionUID = -6496143057319213401L;
private final String type;
private final ValueExpression binding;
public LazyPhaseListener(String type, ValueExpression binding) {
this.type = type;
this.binding = binding;
}
private PhaseListener getInstance() {
PhaseListener instance = null;
FacesContext faces = FacesContext.getCurrentInstance();
if (faces == null) {
return null;
}
if (this.binding != null) {
instance = (PhaseListener) binding.getValue(faces
.getELContext());
}
if (instance == null && type != null) {
try {
instance = (PhaseListener) ReflectionUtil.forName(
this.type).newInstance();
} catch (ClassNotFoundException | InstantiationException | IllegalAccessException e) {
throw new AbortProcessingException(
"Couldn't Lazily instantiate PhaseListener", e);
}
if (this.binding != null) {
binding.setValue(faces.getELContext(), instance);
}
}
return instance;
}
@Override
public void afterPhase(PhaseEvent event) {
PhaseListener pl = this.getInstance();
if (pl != null) {
pl.afterPhase(event);
}
}
@Override
public void beforePhase(PhaseEvent event) {
PhaseListener pl = this.getInstance();
if (pl != null) {
pl.beforePhase(event);
}
}
@Override
public PhaseId getPhaseId() {
PhaseListener pl = this.getInstance();
return (pl != null) ? pl.getPhaseId() : PhaseId.ANY_PHASE;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
LazyPhaseListener that = (LazyPhaseListener) o;
if (binding != null
? !binding.equals(that.binding)
: that.binding != null) {
return false;
}
if (type != null ? !type.equals(that.type) : that.type != null) {
return false;
}
return true;
}
@Override
public int hashCode() {
int result = type != null ? type.hashCode() : 0;
result = 31 * result + (binding != null ? binding.hashCode() : 0);
return result;
}
}
private final TagAttribute binding;
private final String listenerType;
private final TagAttribute typeAttribute;
public PhaseListenerHandler(TagConfig config) {
super(config);
this.binding = this.getAttribute("binding");
this.typeAttribute = this.getAttribute("type");
if (null != this.typeAttribute) {
String stringType = null;
if (!this.typeAttribute.isLiteral()) {
FacesContext context = FacesContext.getCurrentInstance();
FaceletContext ctx = (FaceletContext) context.getAttributes().get(FaceletContext.FACELET_CONTEXT_KEY);
stringType = (String) this.typeAttribute.getValueExpression(ctx, String.class).getValue(ctx);
} else {
stringType = this.typeAttribute.getValue();
}
checkType(stringType);
this.listenerType = stringType;
} else {
this.listenerType = null;
}
}
@Override
public void apply(FaceletContext ctx, UIComponent parent)
throws IOException {
if (ComponentHandler.isNew(parent)) {
UIViewRoot root = ComponentSupport.getViewRoot(ctx, parent);
if (root == null) {
throw new TagException(this.tag, "UIViewRoot not available");
}
ValueExpression b = null;
if (this.binding != null) {
b = this.binding.getValueExpression(ctx, PhaseListener.class);
}
PhaseListener pl = new LazyPhaseListener(this.listenerType, b);
List listeners = root.getPhaseListeners();
if (!listeners.contains(pl)) {
root.addPhaseListener(pl);
}
}
}
private void checkType(String type) {
try {
ReflectionUtil.forName(type);
} catch (ClassNotFoundException e) {
throw new TagAttributeException(typeAttribute,
"Couldn't qualify ActionListener", e);
}
}
}