StatusJmx.java

/*
 * Copyright 2010 Capgemini Licensed under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package net.sf.appstatus.jmx;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import javax.servlet.ServletContext;

import net.sf.appstatus.core.IServletContextProvider;
import net.sf.appstatus.core.AppStatus;
import net.sf.appstatus.core.check.ICheckResult;

import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.jmx.export.annotation.ManagedAttribute;
import org.springframework.jmx.export.annotation.ManagedResource;
import org.springframework.web.context.ServletContextAware;

/**
 * JMX exposure of StatusChecker beans.
 * 
 * @author LABEMONT
 * 
 */
@ManagedResource(objectName = "AppStatus:bean=ServicesStatusChecker")
public class StatusJmx implements ApplicationContextAware, ServletContextAware {

  private AppStatus statusService = null;

  private ApplicationContext applicationContext;

  private ServletContext servletContext;

  public void setServletContext(ServletContext servletContext) {
    this.servletContext = servletContext;
  }

  @ManagedAttribute(description = "Status list", currencyTimeLimit = 15)
  public Map<String, String> getStatus() {
    Map<String, String> statusChecker = new HashMap<String, String>();
    for (ICheckResult result : statusService.checkAll(null)) {
      statusChecker.put(result.getProbeName(), formatCodeDisplay(result.getCode()));
    }
    return statusChecker;
  }

  @ManagedAttribute(description = "Full status list : display return code, description and resolution steps.", currencyTimeLimit = 15)
  public Map<String, List<String>> getFullStatus() {
    Map<String, List<String>> statusChecker = new HashMap<String, List<String>>();
    List<String> statusAttributs = null;
    for (ICheckResult result : statusService.checkAll(null)) {
      statusAttributs = new ArrayList<String>();
      statusAttributs.add(formatCodeDisplay(result.getCode()));
      statusAttributs.add(result.getDescription());
      statusAttributs.add(result.getResolutionSteps());
      statusChecker.put(result.getProbeName(), statusAttributs);
    }
    return statusChecker;
  }

  @ManagedAttribute(description = "The services properties")
  public Map<String, Map<String, String>> getServicesProperties() {
    return this.statusService.getProperties();
  }

  /**
   * Human readable code format.
   * 
   * @param code
   * @return the code from {@link ICheckResult} or the int code if not found
   */
  protected String formatCodeDisplay(int code) {
    String codeDisplay = "";
    switch (code) {
    case (ICheckResult.ERROR):
      codeDisplay = "ERROR";
      break;
    case (ICheckResult.OK):
      codeDisplay = "OK";
      break;
    default:
      codeDisplay = Integer.toString(code);
    }
    return codeDisplay;
  }

  /**
   * Load configuration from /status-jmx-conf.properties file.<br/>
   * If not found look for Spring beans.
   */
  public void init() {
    statusService = new AppStatus();

    statusService.setObjectInstanciationListener(new SpringBeanInstantiationListener(this.applicationContext));

    this.statusService.setServletContextProvider(new IServletContextProvider() {

      public ServletContext getServletContext() {
        return StatusJmx.this.servletContext;
      }
    });

    statusService.init();
  }

  public void setApplicationContext(ApplicationContext springApplicationContext) throws BeansException {
    this.applicationContext = springApplicationContext;
  }
}