001/*
002 * (C) Copyright 2015 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *      Nelson Silva
018 */
019
020package org.nuxeo.ecm.media.publishing;
021
022import org.nuxeo.ecm.core.api.DocumentModel;
023import java.util.Map;
024
025/**
026 * @since 7.3
027 */
028public interface MediaPublishingService {
029
030    /**
031     * Return a list of the available media publishing services for the given document
032     */
033    String[] getAvailableProviders(DocumentModel doc);
034
035    /**
036     * Schedules an upload
037     * @param doc the Document to upload
038     * @param provider the id of the media publishing provider
039     * @return the id of the publishing work
040     */
041    String publish(DocumentModel doc, String provider, String account, Map<String, String> options);
042
043    /**
044     * Unpublish the media
045     *
046     * @since 7.4
047     */
048    void unpublish(DocumentModel doc, String provider);
049
050    /**
051     * Return the provider with the given name.
052     */
053    MediaPublishingProvider getProvider(String provider);
054}