QuicklyEngine.java

/*
 * #%L
 * ACS AEM Commons Bundle
 * %%
 * Copyright (C) 2013 Adobe
 * %%
 * 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.
 * #L%
 */

package com.adobe.acs.commons.quickly;

import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.SlingHttpServletResponse;
import org.apache.sling.commons.json.JSONException;
import org.apache.sling.commons.json.JSONObject;

import aQute.bnd.annotation.ProviderType;

@ProviderType
public interface QuicklyEngine {
    String CONFIG_RESULTS = "results";

    /**
     *
     * @param slingRequest the Request object
     * @param slingResponse the Response object
     * @param cmd the Command
     * @return
     * @throws JSONException
     */
    JSONObject execute(SlingHttpServletRequest slingRequest,
                       SlingHttpServletResponse slingResponse,
                       Command cmd) throws JSONException;
}