org.ikasan.spec.wiretap.WiretapService Maven / Gradle / Ivy

Go to download
/* 
 * $Id$
 * $URL$
 *
 * ====================================================================
 * Ikasan Enterprise Integration Platform
 * 
 * Distributed under the Modified BSD License.
 * Copyright notice: The copyright for this software and a full listing 
 * of individual contributors are as shown in the packaged copyright.txt 
 * file. 
 * 
 * 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 of the ORGANIZATION 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.ikasan.spec.wiretap;

import java.util.Date;
import java.util.Set;

/**
 * This Service allows FlowEvents to be dumped out at runtime for later
 * retrieval and inspection
 * 
 * @author Ikasan Development Team
 */
public interface WiretapService
{
    /**
     * Allows previously stored FlowEvents to be searched for.
     * 
     * @param pageNo - page index into the greater result set
     * @param pageSize - how many results to return in the result
     * @param orderBy - The field to order by
     * @param orderAscending - Ascending flag
     * @param moduleNames - Set of names of modules to include in search - must
     *            contain at least one moduleName
     * @param moduleFlow - The name of Flow internal to the Module
     * @param componentName - The name of the component
     * @param eventId - The FlowEvent Id
     * @param payloadId - The Payload Id
     * @param fromDate - Include only events after fromDate
     * @param untilDate - Include only events before untilDate
     * @param payloadContent - The Payload content
     * 
     * @throws IllegalArgumentException - if moduleNames is null or empty
     * @return List of WiretapFlowEventHeader representing the result
     *         of the search
     */
    public PAGEDRESULT findWiretapEvents(int pageNo, int pageSize, String orderBy, boolean orderAscending, Set moduleNames,
            String moduleFlow, String componentName, String eventId, String payloadId, Date fromDate, Date untilDate, String payloadContent);

    /**
     * Allows previously stored FlowEvents to be searched for.
     *
     * @param pageNo - page index into the greater result set
     * @param pageSize - how many results to return in the result
     * @param orderBy - The field to order by
     * @param orderAscending - Ascending flag
     * @param moduleNames - Set of names of modules to include in search - must
     *            contain at least one moduleName
     * @param moduleFlow - The name of Flow internal to the Module
     * @param componentName - The name of the component
     * @param eventId - The FlowEvent Id
     * @param payloadId - The Payload Id
     * @param fromDate - Include only events after fromDate
     * @param untilDate - Include only events before untilDate
     * @param payloadContent - The Payload content
     *
     * @throws IllegalArgumentException - if moduleNames is null or empty
     * @return List of WiretapFlowEventHeader representing the result
     *         of the search
     */
    public PAGEDRESULT findWiretapEvents(int pageNo, int pageSize, String orderBy, boolean orderAscending, Set moduleNames,
                                         Set moduleFlow, Set componentName, String eventId, String payloadId, Date fromDate, Date untilDate, String payloadContent);

    /**
     * Retrieve a specific WiretapFlowEvent by Id
     * 
     * @param wiretapEventId - The id of the wiretap event to retrieve
     * @return WiretapFlowEvent
     */
    public WiretapEvent getWiretapEvent(IDENTIFIER wiretapEventId);

    /**
     * dumps a snapshot of an FlowEvent at runtime in the form of one
     * or more WiretapFlowEvents - one for every Payload
     * contained
     * 
     * @param event - FlowEvent to snapshot
     * @param componentName - name of the component
     * @param moduleName - name of the Module
     * @param flowName - name of the Flow
     * @param timeToLive - no of minutes from now until
     *            WiretapFlowEvents should expire
     */
    public void tapEvent(RUNTIMEEVENT event, String componentName, String moduleName, String flowName, Long timeToLive);

    /**
     * Causes all WiretapFlowEvents that are past their expiry to be
     * deleted
     */
    public void housekeep();
    
    /**
	 * Method to state that there are housekeepable records available.
	 * @return
	 */
	public boolean housekeepablesExist();

    /**
     * Save the wiretap event.
     *
     * @param event
     */
    public void save(WiretapEvent event);
}