View Javadoc
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.lib;
44  
45  import java.security.MessageDigest;
46  import java.security.NoSuchAlgorithmException;
47  import java.text.MessageFormat;
48  
49  import org.eclipse.jgit.lfs.internal.LfsText;
50  
51  /**
52   * Misc. constants used throughout JGit LFS extension.
53   *
54   * @since 4.3
55   */
56  @SuppressWarnings("nls")
57  public final class Constants {
58  	/**
59  	 * lfs folder/section/filter name
60  	 *
61  	 * @since 4.6
62  	 */
63  	public static final String LFS = "lfs";
64  
65  	/**
66  	 * Hash function used natively by Git LFS extension for large objects.
67  	 *
68  	 * @since 4.6
69  	 */
70  	public static final String LONG_HASH_FUNCTION = "SHA-256";
71  
72  	/**
73  	 * A Git LFS large object hash is 256 bits, i.e. 32 bytes.
74  	 * <p>
75  	 * Changing this assumption is not going to be as easy as changing this
76  	 * declaration.
77  	 */
78  	public static final int LONG_OBJECT_ID_LENGTH = 32;
79  
80  	/**
81  	 * A Git LFS large object can be expressed as a 64 character string of
82  	 * hexadecimal digits.
83  	 *
84  	 * @see #LONG_OBJECT_ID_LENGTH
85  	 */
86  	public static final int LONG_OBJECT_ID_STRING_LENGTH = LONG_OBJECT_ID_LENGTH
87  			* 2;
88  
89  	/**
90  	 * LFS upload operation.
91  	 *
92  	 * @since 4.7
93  	 */
94  	public static final String UPLOAD = "upload";
95  
96  	/**
97  	 * LFS download operation.
98  	 *
99  	 * @since 4.7
100 	 */
101 	public static final String DOWNLOAD = "download";
102 
103 	/**
104 	 * LFS verify operation.
105 	 *
106 	 * @since 4.7
107 	 */
108 	public static final String VERIFY = "verify";
109 
110 	/**
111 	 * Prefix for all LFS related filters.
112 	 *
113 	 * @since 4.11
114 	 */
115 	public static final String ATTR_FILTER_DRIVER_PREFIX = "lfs/";
116 
117 	/**
118 	 * Create a new digest function for objects.
119 	 *
120 	 * @return a new digest object.
121 	 * @throws java.lang.RuntimeException
122 	 *             this Java virtual machine does not support the required hash
123 	 *             function. Very unlikely given that JGit uses a hash function
124 	 *             that is in the Java reference specification.
125 	 */
126 	public static MessageDigest newMessageDigest() {
127 		try {
128 			return MessageDigest.getInstance(LONG_HASH_FUNCTION);
129 		} catch (NoSuchAlgorithmException nsae) {
130 			throw new RuntimeException(MessageFormat.format(
131 					LfsText.get().requiredHashFunctionNotAvailable,
132 					LONG_HASH_FUNCTION), nsae);
133 		}
134 	}
135 
136 	static {
137 		if (LONG_OBJECT_ID_LENGTH != newMessageDigest().getDigestLength())
138 			throw new LinkageError(
139 					LfsText.get().incorrectLONG_OBJECT_ID_LENGTH);
140 	}
141 
142 	/**
143 	 * Content type used by LFS REST API as defined in <a href=
144 	 * "https://github.com/github/git-lfs/blob/master/docs/api/v1/http-v1-batch.md">
145 	 * https://github.com/github/git-lfs/blob/master/docs/api/v1/http-v1-batch.md</a>
146 	 */
147 	public static final String CONTENT_TYPE_GIT_LFS_JSON = "application/vnd.git-lfs+json";
148 
149 	/**
150 	 * "Arbitrary binary data" as defined in
151 	 * <a href="https://www.ietf.org/rfc/rfc2046.txt">RFC 2046</a>
152 	 */
153 	public static final String HDR_APPLICATION_OCTET_STREAM = "application/octet-stream";
154 }