com.adobe.forms.common.service.DataProviderBase Maven / Gradle / Ivy

Go to download
/*
 * ADOBE CONFIDENTIAL
 *   ___________________
 *
 *    Copyright 2016 Adobe Systems Incorporated
 *    All Rights Reserved.
 *
 *   NOTICE:  All information contained herein is, and remains
 *   the property of Adobe Systems Incorporated and its suppliers,
 *   if any.  The intellectual and technical concepts contained
 *   herein are proprietary to Adobe Systems Incorporated and its
 *   suppliers and are protected by all applicable intellectual property
 *   laws, including trade secret and copyright laws.
 *   Dissemination of this information or reproduction of this material
 *   is strictly forbidden unless prior written permission is obtained
 *   from Adobe Systems Incorporated.
 */
package com.adobe.forms.common.service;

/**
 * Base Interface to provide Data given a URL. The implementations should return the data data given the options
 */
public interface DataProviderBase {

    String DATA_PROVIDER_NAME = "dataprovidername";
    String DATA_PROVIDER_LABEL = "dataproviderlabel";
    String PROTOCOL_CRX="crx://";
    String PROTOCOL_HTTP="http://";
    String PROTOCOL_HTTPS="https://";
    String PROTOCOL_FILE="file://";

    /**
     * Returns the name of the service that can be used in the SERVICE protocol. i.e. service:///path
     * @return service name
     */
    public String getServiceName();

    /**
     * Description of the Service to be shown in the Dropdown where service selection is shown.
     * @return service description
     */
    public String getServiceDescription();
}