org.jboss.security.audit.AuditEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of picketbox

PicketBox is a security framework for Java Applications

There is a newer version: 5.1.0.Final

/*
 * JBoss, the OpenSource J2EE webOS
 *
 * Distributable under LGPL license.
 * See terms of license at gnu.org.
 */ 
package org.jboss.security.audit;
 
import java.util.Arrays;
import java.util.Collection;
import java.util.HashMap; 
import java.util.Map;

/**
 *  Holder of audit information
 *  @author Anil Saldhana
 *  @version $Revision$
 *  @since  Aug 21, 2006
 */
public class AuditEvent
{
   private String auditLevel = AuditLevel.INFO;
   
   private Map contextMap = new HashMap();
   
   private Exception underlyingException = null;
   
   public AuditEvent(String level)
   {
      this.auditLevel = level;
   }
   
   public AuditEvent(String level, Map map)
   {
      this(level);
      this.contextMap = map;
   }
   
   public AuditEvent(String level, Map map, Exception ex)
   {
      this(level,map);
      this.underlyingException = ex;
   }
   
   /**
    * Return the Audit Level
    * @return
    */
   public String getAuditLevel()
   {
      return this.auditLevel;
   }
   
   /**
    * Get the Contextual Map
    * @return Map that is final 
    */
   public Map getContextMap()
   {
      return contextMap;
   }
   
   /**
    * Set a non-modifiable Context Map
    * @param cmap Map that is final
    */
   public void setContextMap(final Map cmap)
   {
      this.contextMap = cmap;
   }
   
   /**
    * Get the Exception part of the audit
    * @return
    */
   public Exception getUnderlyingException()
   {
      return underlyingException;
   }

   /**
    * Set the exception on which an audit is happening
    * @param underlyingException
    */
   public void setUnderlyingException(Exception underlyingException)
   {
      this.underlyingException = underlyingException;
   }

   public String toString()
   {
      StringBuilder sbu  = new StringBuilder();
      sbu.append("[").append(auditLevel).append("]");
      sbu.append(dissectContextMap());
      return sbu.toString();
   }
   
   /**
    * Provide additional information about the entities in
    * the context map
    * @return
    */
   @SuppressWarnings("unchecked")
   private String dissectContextMap()
   {
      StringBuilder sbu  = new StringBuilder(); 
      if(contextMap != null)
      {
         for(String key:contextMap.keySet())
         { 
            sbu.append(key).append("=");
            Object obj = contextMap.get(key);
            if(obj instanceof Object[])
            {
               Object[] arr = (Object[])obj;
               obj = Arrays.asList(arr); 
            } 
            if(obj instanceof Collection)
            {
               Collection