edu.internet2.middleware.grouper.misc.GrouperInfo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of grouper Show documentation
Internet2 Groups Management Toolkit
There is a newer version: 5.12.2
/**
 * Copyright 2014 Internet2
 *
 * 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.
 */
/*
  Copyright (C) 2004-2007 University Corporation for Advanced Internet Development, Inc.
  Copyright (C) 2004-2007 The University Of Chicago

  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 edu.internet2.middleware.grouper.misc;
import java.io.PrintStream;
import java.util.Iterator;
import java.util.Properties;

import org.apache.commons.lang.StringUtils;
import org.apache.commons.logging.Log;

import edu.internet2.middleware.grouper.SubjectFinder;
import edu.internet2.middleware.grouper.cfg.GrouperConfig;
import edu.internet2.middleware.grouper.cfg.GrouperHibernateConfig;
import edu.internet2.middleware.grouper.ddl.GrouperDdlUtils;
import edu.internet2.middleware.grouper.util.GrouperUtil;
import edu.internet2.middleware.subject.Source;

/**
 * Report on system and configuration information.
 * 
 * @author  blair christensen.
 * @version $Id: GrouperInfo.java,v 1.4 2008-11-08 03:42:33 mchyzer Exp $
 * @since   1.1.0
 */
public class GrouperInfo {

  /** logger */
  @SuppressWarnings("unused")
  private static final Log LOG = GrouperUtil.getLog(GrouperInfo.class);


  // CONSTRUCTORS //

  /**
   * @param thePrintStream 
   * @param thePrintDbInfo 
   * @since     1.1.0
   */
  private GrouperInfo(PrintStream thePrintStream, boolean thePrintDbInfo) {

    this.out = thePrintStream;
    this.printSensitiveInfo = thePrintDbInfo;
  } 

  /** where to print info */
  private PrintStream out;
 
  /** if connect info should be printed */
  private boolean printSensitiveInfo;
  
  /**
   * Print system and configuration information to STDOUT.
   * 

   * 
   * % java edu.internet2.middleware.grouper.GrouperInfo
   * 
   * @param args 
   * @since   1.1.0
   */
  public static void main(String[] args) {
    grouperInfo(System.out, true);
  } // public static void main(args)


  /**
   * @param thePrintStream 
   * @param printSensitiveInfo 
   * 
   */
  public static void grouperInfo(PrintStream thePrintStream, boolean printSensitiveInfo) {
    GrouperInfo info = new GrouperInfo(thePrintStream, printSensitiveInfo);
    info._printSystemInfo();
    thePrintStream.println();
    info._printGrouperInfo();
    thePrintStream.println();
    info._printSubjectInfo();
    thePrintStream.println();
    info._printHibernateInfo();
  }


  // PRIVATE INSTANCE METHODS //

  /**
   * @param key 
   * @param val 
   * @since   1.2.0
   */
  private void _print(String key, String val) {
    if (val == null) {
      val = GrouperConfig.EMPTY_STRING;
    }
    this.out.println(key + ": " + val);
  }

  /**
   * @since   1.2.0
   */
  private void _printGrouperInfo() {
    String key = "privileges.access.cache.interface";
    this._print( key, GrouperConfig.retrieveConfig().propertyValueString(key) );
    key = "privileges.naming.cache.interface";
    this._print( key, GrouperConfig.retrieveConfig().propertyValueString(key) );
    key = "groups.wheel.use";
    this._print( key, GrouperConfig.retrieveConfig().propertyValueString(key) );
    key = "groups.wheel.group";
    this._print( key, GrouperConfig.retrieveConfig().propertyValueString(key) );
  } 

  /**
   * @since   1.2.0
   */
  private void _printHibernateInfo() {
    String key = null;
    if (this.printSensitiveInfo) {
      key = "hibernate.connection.username";
      this._print( key, GrouperHibernateConfig.retrieveConfig().propertyValueString(key) );
    }
    key = "hibernate.dialect";
    this._print( key, GrouperHibernateConfig.retrieveConfig().propertyValueString(key) );
    
    String connectionUrl = GrouperHibernateConfig.retrieveConfig().propertyValueString("hibernate.connection.url");
    
    key = "hibernate.connection.driver_class";
    this._print( key, GrouperDdlUtils.convertUrlToDriverClassIfNeeded(connectionUrl, GrouperHibernateConfig.retrieveConfig().propertyValueString(key)));
    if (this.printSensitiveInfo) {
      key = "hibernate.connection.url";
      this._print( key, GrouperHibernateConfig.retrieveConfig().propertyValueString(key) );
    }
    key = "hibernate.cache.provider_class";
    this._print( key, GrouperHibernateConfig.retrieveConfig().propertyValueString(key) );
  } 

  /**
   * @since   1.2.0
   */
  private void _printSubjectInfo() {
    Source    sa;
    Iterator  it  = SubjectFinder.getSources().iterator();
    while (it.hasNext()) {
      sa = it.next();
      if (this.printSensitiveInfo) {
        this.out.println(
            sa.printConfig() + " name="  + sa.getName()
        );
      } else {
        this.out.println(
            "source:"
            + " id="    + sa.getId()
            + " name="  + sa.getName()
            + " class=" + sa.getClass().getSimpleName()
          );
      }
    }
  } 


  /**
   * @return version timestamp
   */
  public static String versionTimestamp() {
    String buildTimestamp = null;
    try {
      buildTimestamp = GrouperCheckConfig.manifestProperty(GrouperInfo.class, new String[]{"Build-Timestamp"});
    } catch (Exception e) {
      //its ok, might not be running in jar
    }
    Properties properties = GrouperConfig.retrieveConfig().properties();
    
    String env = GrouperUtil.propertiesValue(properties, "grouper.env.name");
    env = StringUtils.defaultIfEmpty(env, "");
    String grouperStartup = "version: " + GrouperVersion.grouperContainerVersionOrMavenVersion()
      + ", build date: " + buildTimestamp + ", env: " + env;
    
    return grouperStartup;
  }

  /**
   * @since   1.2.0
   */
  private void _printSystemInfo() {
    Properties  props = System.getProperties();  
    this.out.println(versionTimestamp());
    String      key   = "os.name";
    this._print( key, props.getProperty(key, GrouperConfig.EMPTY_STRING) );
    key = "os.arch";
    this._print( key, props.getProperty(key, GrouperConfig.EMPTY_STRING) );
    key = "os.version";
    this._print( key, props.getProperty(key, GrouperConfig.EMPTY_STRING) );
    key = "java.version";
    this._print( key, props.getProperty(key, GrouperConfig.EMPTY_STRING) );
    key = "java.vendor";
    this._print( key, props.getProperty(key, GrouperConfig.EMPTY_STRING) );
    key = "java.class.path";
    this._print( key, props.getProperty(key, GrouperConfig.EMPTY_STRING) );
    long heapSize = Runtime.getRuntime().totalMemory();
    this._print("heapSize", GrouperUtil.byteCountToDisplaySize(heapSize));
    
    long heapMaxSize = Runtime.getRuntime().maxMemory();
    this._print("heapMaxSize", GrouperUtil.byteCountToDisplaySize(heapMaxSize));

    long heapFreeSize = Runtime.getRuntime().freeMemory();
    this._print("heapSizeFree", GrouperUtil.byteCountToDisplaySize(heapFreeSize));
    
  } 

}