JsfPerformancePhaseListener.java

/*
 *
 * Copyright (c) void.fm
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, this list
 * of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice, this
 * list of conditions and the following disclaimer in the documentation and/or
 * other materials provided with the distribution.
 *
 * Neither the name void.fm nor the names of its contributors may be
 * used to endorse or promote products derived from this software without specific
 * prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

package etm.contrib.integration.jee.jsf;

import etm.core.configuration.EtmManager;
import etm.core.monitor.EtmPoint;
import etm.core.util.Log;
import etm.core.util.LogAdapter;

import javax.faces.context.FacesContext;
import javax.faces.event.ExceptionQueuedEvent;
import javax.faces.event.PhaseEvent;
import javax.faces.event.PhaseId;
import javax.faces.event.PhaseListener;
import java.util.Iterator;

/**
 * A JSF phase listener that monitors overall request processing
 * and execution time per phase.
 *
 * @author void.fm
 * @version $Revision: 372 $
 */
public class JsfPerformancePhaseListener implements PhaseListener {

  private static final String CURRENT_PHASE_POINT = "ETM__CurrentPhasePoint";
  private static final LogAdapter LOG = Log.getLog(JsfPerformancePhaseListener.class);

  public JsfPerformancePhaseListener() {
    LOG.debug("Activated JSF phase performance monitoring.");
  }

  public void beforePhase(PhaseEvent event) {
    FacesContext facesContext = event.getFacesContext();

    EtmPoint oldPoint = (EtmPoint) facesContext.getAttributes().get(CURRENT_PHASE_POINT);
    if (oldPoint != null) {
      // do some cleanup, should never happen actually
      oldPoint.alterName(oldPoint.getName() + " - uncollected");
      oldPoint.collect();
    }

    String symbolicName = "JSF Phase " + event.getPhaseId().getOrdinal() + " - " + String.valueOf(event.getPhaseId());
    EtmPoint point = EtmManager.getEtmMonitor().createPoint(symbolicName);
    facesContext.getAttributes().put(CURRENT_PHASE_POINT, point);
  }

  public void afterPhase(PhaseEvent event) {
    FacesContext facesContext = event.getFacesContext();

    // stop recording current phase time
    EtmPoint point = (EtmPoint) facesContext.getAttributes().get(CURRENT_PHASE_POINT);

    if (point != null) {
      // alter name if we encounter an exception
      Iterator<ExceptionQueuedEvent> it = facesContext.getExceptionHandler().getUnhandledExceptionQueuedEvents().iterator();
      if (it.hasNext()) {
        ExceptionQueuedEvent exceptionQueuedEvent = it.next();
        point.alterName(point.getName() + " [" + exceptionQueuedEvent.getContext().getException().getClass().getSimpleName() + "]");
      }

      point.collect();
      facesContext.getAttributes().remove(CURRENT_PHASE_POINT);
    }


  }

  public PhaseId getPhaseId() {
    return PhaseId.ANY_PHASE;
  }


}