Module org.eclipse.jgit

Package org.eclipse.jgit.transport

Enum Class UploadPack.RequestPolicy

java.lang.Object

java.lang.Enum<UploadPack.RequestPolicy>

org.eclipse.jgit.transport.UploadPack.RequestPolicy

All Implemented Interfaces:

Serializable, Comparable<UploadPack.RequestPolicy>, java.lang.constant.Constable

Enclosing class:

UploadPack

public static enum UploadPack.RequestPolicy
extends Enum<UploadPack.RequestPolicy>

Policy the server uses to validate client requests

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADVERTISED	Client may only ask for objects the server advertised a reference for.
ANY	Client may ask for any SHA-1 in the repository, implies REACHABLE_COMMIT_TIP.
REACHABLE_COMMIT	Client may ask for any commit reachable from a reference advertised by the server.
REACHABLE_COMMIT_TIP	Client may ask for any commit reachable from any reference, even if that reference wasn't advertised, implies REACHABLE_COMMIT and TIP.
TIP	Client may ask for objects that are the tip of any reference, even if not advertised.

Method Summary

Modifier and Type	Method	Description
boolean	implies(UploadPack.RequestPolicy implied)	Check if the current policy implies another, based on its bitmask.
static UploadPack.RequestPolicy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static UploadPack.RequestPolicy[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ADVERTISED

public static final UploadPack.RequestPolicy ADVERTISED

Client may only ask for objects the server advertised a reference for.

REACHABLE_COMMIT

public static final UploadPack.RequestPolicy REACHABLE_COMMIT

Client may ask for any commit reachable from a reference advertised by the server.

TIP

public static final UploadPack.RequestPolicy TIP

Client may ask for objects that are the tip of any reference, even if not advertised.

This may happen, for example, when a custom RefFilter is set.

Since:

3.1

REACHABLE_COMMIT_TIP

public static final UploadPack.RequestPolicy REACHABLE_COMMIT_TIP

Client may ask for any commit reachable from any reference, even if that reference wasn't advertised, implies REACHABLE_COMMIT and TIP.

Since:

3.1

ANY

public static final UploadPack.RequestPolicy ANY

Client may ask for any SHA-1 in the repository, implies REACHABLE_COMMIT_TIP.

Method Details

values

public static UploadPack.RequestPolicy[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static UploadPack.RequestPolicy valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

implies

public boolean implies(UploadPack.RequestPolicy implied)

Check if the current policy implies another, based on its bitmask.

Parameters:

implied - the implied policy based on its bitmask.

Returns:

true if the policy is implied.

Since:

6.10.1