com.aol.micro.server.events.RequestEvents Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of micro-events Show documentation

Opinionated rest microservices

There is a newer version: 0.91.11

package com.aol.micro.server.events;

import com.aol.micro.server.events.RequestsBeingExecuted.AddQuery;
import com.aol.micro.server.events.RequestsBeingExecuted.RemoveQuery;
import com.aol.micro.server.events.RequestsBeingExecuted.RequestData;

/**
 * Factory class for creating Start and End events
 * 
 * @author johnmcclean
 *
 */
public class RequestEvents {

	/**
	 * Marks the start of a query identified by the provided correlationId
	 * 
	 * @param query  - Query data
	 * @param correlationId - Identifier
	 * @return Start event to pass to the Events systems EventBus
	 */
	public static  AddQuery start(T query, long correlationId){
		return start(query, correlationId,"default",null);
	}
	/**
	 *  Marks the start of a query identified by the provided correlationId, with additional query type and data parameters
	 * 
	 * @param query  - Query data
	 * @param correlationId - Identifier
	 * @param type - allows queries to be grouped by type
	 * @param additionalData - Any additional info about the reques to be rendered in the JSON view / rest endpoint
	 * @return Start event to pass to the Events systems EventBus
	 */
	public static  AddQuery start(T query, long correlationId, String type, Object additionalData){
		
		return new AddQuery(RequestData.builder().query(query).correlationId(correlationId)
		.type(type).additionalData(additionalData).build());
	}
	/**
	 * Marks the end of a query identified by the provided correlationId
	 * 
	 * @param query  - Query data
	 * @param correlationId - Identifier
	 * @return Finish event to pass to the Events systems EventBus
	 */
	public static  RemoveQuery finish(T query, long correlationId){
		return finish(query,correlationId,"default");
	}
	/**
	 * Marks the end of a query identified by the provided correlationId
	 * 
	 * @param query - Query data
	 * @param correlationId - Identifier
	 *  @param type - allows queries to be grouped by type
	 * @return
	 */
	public static  RemoveQuery finish(T query, long correlationId, String type){
		
		return new RemoveQuery<>(RequestData.builder().query(query).correlationId(correlationId)
		.type(type).build());
	}
	
}