View Javadoc
1   /*
2    * Copyright (C) 2016, Google Inc.
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  
44  package org.eclipse.jgit.internal.ketch;
45  
46  import org.eclipse.jgit.revwalk.FooterKey;
47  
48  /**
49   * Frequently used constants in a Ketch system.
50   */
51  public class KetchConstants {
52  	/**
53  	 * Default reference namespace holding {@link #ACCEPTED} and
54  	 * {@link #COMMITTED} references and the {@link #STAGE} sub-namespace.
55  	 */
56  	public static final String DEFAULT_TXN_NAMESPACE = "refs/txn/"; //$NON-NLS-1$
57  
58  	/** Reference name holding the RefTree accepted by a follower. */
59  	public static final String ACCEPTED = "accepted"; //$NON-NLS-1$
60  
61  	/** Reference name holding the RefTree known to be committed. */
62  	public static final String COMMITTED = "committed"; //$NON-NLS-1$
63  
64  	/** Reference subdirectory holding proposed heads. */
65  	public static final String STAGE = "stage/"; //$NON-NLS-1$
66  
67  	/** Footer containing the current term. */
68  	public static final FooterKey TERM = new FooterKey("Term"); //$NON-NLS-1$
69  
70  	/** Section for Ketch configuration ({@code ketch}). */
71  	public static final String CONFIG_SECTION_KETCH = "ketch"; //$NON-NLS-1$
72  
73  	/** Behavior for a replica ({@code remote.$name.ketch-type}) */
74  	public static final String CONFIG_KEY_TYPE = "ketch-type"; //$NON-NLS-1$
75  
76  	/** Behavior for a replica ({@code remote.$name.ketch-commit}) */
77  	public static final String CONFIG_KEY_COMMIT = "ketch-commit"; //$NON-NLS-1$
78  
79  	/** Behavior for a replica ({@code remote.$name.ketch-speed}) */
80  	public static final String CONFIG_KEY_SPEED = "ketch-speed"; //$NON-NLS-1$
81  
82  	private KetchConstants() {
83  	}
84  }