lens-server-api/src/main/java/org/apache/lens/server/api/query/DownloadResultUrlProvider.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.lens.server.api.query;

import org.apache.lens.api.LensConf;

import org.apache.hadoop.conf.Configuration;

/*
* The interface to implement for returning download url. This is embedded in the query competion email sent to the user
* */
public interface DownloadResultUrlProvider {

  /*
  @param : conf : server conf
  @param : qconf : query conf
  @param : queryHandle : the query handle
  @return : download url sent to user via email
  * */
  String getResultUrl(Configuration conf, LensConf qconf, String queryHandle);
}