001/*
002 * (C) Copyright 2012 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 *     Antoine Taillefer <ataillefer@nuxeo.com>
018 *     Mickaƫl Schoentgen <mschoentgen@nuxeo.com>
019 */
020package org.nuxeo.drive.adapter;
021
022import org.nuxeo.drive.adapter.impl.DocumentBackedFileItem;
023import org.nuxeo.ecm.core.api.Blob;
024import org.nuxeo.ecm.core.api.DocumentModel;
025
026import com.fasterxml.jackson.annotation.JsonIgnore;
027
028/**
029 * Representation of a file, ie. a downloadable {@link FileSystemItem}.
030 * <p>
031 * In the case of a {@link DocumentModel} backed implementation, the backing document holds a binary content. Typically
032 * a File, Note or Picture.
033 *
034 * @author Antoine Taillefer
035 * @see DocumentBackedFileItem
036 */
037public interface FileItem extends FileSystemItem {
038
039    @JsonIgnore
040    Blob getBlob();
041
042    String getDownloadURL();
043
044    String getDigestAlgorithm();
045
046    String getDigest();
047
048    /** @since 11.1 */
049    long getSize();
050
051    boolean getCanUpdate();
052
053    void setBlob(Blob blob);
054
055}