com.novartis.opensource.yada.plugin.Bypass Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yada-api Show documentation
The newest version!
/**
 * Copyright 2016 Novartis Institutes for BioMedical Research Inc.
 * 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 com.novartis.opensource.yada.plugin;

import com.novartis.opensource.yada.YADAQuery;
import com.novartis.opensource.yada.YADAQueryResult;
import com.novartis.opensource.yada.YADARequest;

/**
 * The Bypass Plugin API is designed to enable processing of data and requests that almost completely 
 * circumvent (or override) the conventional YADA framework request/service process flow.
 * 
 * @author David Varon
 */
public interface Bypass {
	/**
	 * The public API for Bypass plugins
	 * @param yadaReq YADA request configuration
	 * @return String intended to be returned to the requestor, as content in a typical YADA response. 
	 * @throws YADAPluginException when the plugin execution fails
	 */
	public String engage(YADARequest yadaReq)
		throws YADAPluginException;
	
	/**
	 * The public API for QueryBypass
	 * @param yadaReq YADA request configuration
	 * @param yq the current {@link YADAQuery}
	 * @return a result object that will be integrated into the result set by the {@link com.novartis.opensource.yada.Service} object
	 * @throws YADAPluginException when plugin execution fails
	 */
	public YADAQueryResult engage(YADARequest yadaReq, YADAQuery yq)
	    throws YADAPluginException;
}