1 /*
2 * Copyright (C) 2015, Matthias Sohn <matthias.sohn@sap.com>
3 * and other copyright owners as documented in the project's IP log.
4 *
5 * This program and the accompanying materials are made available
6 * under the terms of the Eclipse Distribution License v1.0 which
7 * accompanies this distribution, is reproduced below, and is
8 * available at http://www.eclipse.org/org/documents/edl-v10.php
9 *
10 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or
13 * without modification, are permitted provided that the following
14 * conditions are met:
15 *
16 * - Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 *
19 * - Redistributions in binary form must reproduce the above
20 * copyright notice, this list of conditions and the following
21 * disclaimer in the documentation and/or other materials provided
22 * with the distribution.
23 *
24 * - Neither the name of the Eclipse Foundation, Inc. nor the
25 * names of its contributors may be used to endorse or promote
26 * products derived from this software without specific prior
27 * written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 */
43 package org.eclipse.jgit.lfs.server;
44
45 import java.io.IOException;
46
47 import org.eclipse.jgit.annotations.Nullable;
48 import org.eclipse.jgit.lfs.lib.AnyLongObjectId;
49
50 /**
51 * Abstraction of a repository for storing large objects
52 *
53 * @since 4.3
54 */
55 public interface LargeFileRepository {
56
57 /**
58 * Get download action
59 *
60 * @param id
61 * id of the object to download
62 * @return Action for downloading the object
63 */
64 public Response.Action getDownloadAction(AnyLongObjectId id);
65
66 /**
67 * Get upload action
68 *
69 * @param id
70 * id of the object to upload
71 * @param size
72 * size of the object to be uploaded
73 * @return Action for uploading the object
74 */
75 public Response.Action getUploadAction(AnyLongObjectId id, long size);
76
77 /**
78 * Get verify action
79 *
80 * @param id
81 * id of the object to be verified
82 * @return Action for verifying the object, or {@code null} if the server
83 * doesn't support or require verification
84 */
85 public @Nullable Response.Action getVerifyAction(AnyLongObjectId id);
86
87 /**
88 * Get size of an object
89 *
90 * @param id
91 * id of the object
92 * @return length of the object content in bytes, -1 if the object doesn't
93 * exist
94 * @throws java.io.IOException
95 */
96 public long getSize(AnyLongObjectId id) throws IOException;
97 }