org.nhindirect.common.audit.AuditorMBean Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of direct-common Show documentation

Direct Project common APIs. Includes instrumentation, auditing, and other utility APIs

There is a newer version: 8.0.0

/* 
Copyright (c) 2010, NHIN Direct Project
All rights reserved.

Authors:
   Greg Meyer      [email protected]
 
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 of the The NHIN Direct Project (nhindirect.org). 
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 HOLDER 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 org.nhindirect.common.audit;

import javax.management.openmbean.CompositeData;

/**
 * MBean interface for an {@link Auditor}
 * @author Greg Meyer
 *
 */
public interface AuditorMBean 
{
	/**
	 * Gets the number of events in the event the auditing system.
	 * @return The number of events in the event the auditing system.
	 */
	public Integer getEventCount();
	
	/**
	 * Gets the event data in the audit system.
	 * @param eventCount The number of events to retrieve.  Events are retrieved from the most recent event. 
	 * @return Event data in the audit system.
	 */
	public CompositeData[] getEvents(Integer eventCount);
	
	/**
	 * Gets the latest event to be written to the audit system.
	 * @return The latest event to be written to the audit system.
	 */
	public CompositeData getLastEvent();	
	
	/**
	 * Clears the audit repository.
	 */
	public void clear();
	
	
}