Package org.eclipse.jgit.transport
Class RemoteRefUpdate
java.lang.Object
org.eclipse.jgit.transport.RemoteRefUpdate
Represent request and status of a remote ref update. Specification is
provided by client, while status is handled by
PushProcess
class, being read-only for
client.
Client can create instances of this class directly, basing on user
specification and advertised refs
(Connection
or through
Transport
helper methods. Apply this
specification on remote repository using
Transport.push(org.eclipse.jgit.lib.ProgressMonitor, java.util.Collection)
method.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
Represent current status of a remote ref update. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate ObjectId
private boolean
private Collection<RefSpec>
If set, the RemoteRefUpdate is a placeholder for the "matching" RefSpec to be expanded after the advertisements have been received in a push.private final boolean
private final Repository
private RefUpdate
private String
private final ObjectId
private final String
private final String
private RemoteRefUpdate.Status
private final TrackingRefUpdate
-
Constructor Summary
ConstructorsModifierConstructorDescription(package private)
RemoteRefUpdate
(Repository localDb, boolean forceUpdate, Collection<RefSpec> fetchSpecs) Creates a "placeholder" update for the "matching" RefSpec ":".RemoteRefUpdate
(Repository localDb, String srcRef, String remoteName, boolean forceUpdate, String localName, ObjectId expectedOldObjectId) Construct remote ref update request by providing an update specification.private
RemoteRefUpdate
(Repository localDb, String srcRef, ObjectId srcId, String remoteName, boolean forceUpdate, String localName, Collection<RefSpec> fetchSpecs, ObjectId expectedOldObjectId) RemoteRefUpdate
(Repository localDb, String srcRef, ObjectId srcId, String remoteName, boolean forceUpdate, String localName, ObjectId expectedOldObjectId) Construct remote ref update request by providing an update specification.RemoteRefUpdate
(Repository localDb, Ref srcRef, String remoteName, boolean forceUpdate, String localName, ObjectId expectedOldObjectId) Construct remote ref update request by providing an update specification.RemoteRefUpdate
(RemoteRefUpdate base, ObjectId newExpectedOldObjectId) Create a new instance of this object basing on existing instance for configuration. -
Method Summary
Modifier and TypeMethodDescriptionGet expected old object id(package private) Collection<RefSpec>
Retrieves the fetchRefSpec
s of thisRemoteRefUpdate
.Get message describing reasons of status when needed/possible; may be null.Get new object idGet name of remote ref to updateGet source revision as specified by user (in constructor)Get status of remote ref update operation.Get tracking branch update if localName was set in constructor.boolean
Whether user specified a local tracking branch for remote updateboolean
isDelete()
Whether this update is a deleting updateboolean
Whether some object is required to be advertised by remote side, as set in constructorboolean
Check whether update was fast-forward.boolean
Whether this update is forced regardless of old remote ref objectboolean
Tells whether thisRemoteRefUpdate
is a placeholder for a "matching"RefSpec
.(package private) void
(package private) void
setFastForward
(boolean fastForward) (package private) void
setMessage
(String message) (package private) void
setStatus
(RemoteRefUpdate.Status status) toString()
protected void
updateTrackingRef
(RevWalk walk) Update locally stored tracking branch with the new object.
-
Field Details
-
expectedOldObjectId
-
newObjectId
-
remoteName
-
trackingRefUpdate
-
srcRef
-
forceUpdate
private final boolean forceUpdate -
status
-
fastForward
private boolean fastForward -
message
-
localDb
-
localUpdate
-
fetchSpecs
If set, the RemoteRefUpdate is a placeholder for the "matching" RefSpec to be expanded after the advertisements have been received in a push.
-
-
Constructor Details
-
RemoteRefUpdate
public RemoteRefUpdate(Repository localDb, String srcRef, String remoteName, boolean forceUpdate, String localName, ObjectId expectedOldObjectId) throws IOException Construct remote ref update request by providing an update specification. Object is created with defaultRemoteRefUpdate.Status.NOT_ATTEMPTED
status and no message.- Parameters:
localDb
- local repository to push from.srcRef
- source revision - any string resolvable byRepository.resolve(String)
. This resolves to the new object that the caller want remote ref to be after update. Use null orObjectId.zeroId()
string for delete request.remoteName
- full name of a remote ref to update, e.g. "refs/heads/master" (no wildcard, no short name).forceUpdate
- true when caller want remote ref to be updated regardless whether it is fast-forward update (old object is ancestor of new object).localName
- optional full name of a local stored tracking branch, to update after push, e.g. "refs/remotes/zawir/dirty" (no wildcard, no short name); null if no local tracking branch should be updated.expectedOldObjectId
- optional object id that caller is expecting, requiring to be advertised by remote side before update; update will take place ONLY if remote side advertise exactly this expected id; null if caller doesn't care what object id remote side advertise. UseObjectId.zeroId()
when expecting no remote ref with this name.- Throws:
IOException
- when I/O error occurred during creatingTrackingRefUpdate
for local tracking branch or srcRef can't be resolved to any object.IllegalArgumentException
- if some required parameter was null
-
RemoteRefUpdate
public RemoteRefUpdate(Repository localDb, Ref srcRef, String remoteName, boolean forceUpdate, String localName, ObjectId expectedOldObjectId) throws IOException Construct remote ref update request by providing an update specification. Object is created with defaultRemoteRefUpdate.Status.NOT_ATTEMPTED
status and no message.- Parameters:
localDb
- local repository to push from.srcRef
- source revision. Use null to delete.remoteName
- full name of a remote ref to update, e.g. "refs/heads/master" (no wildcard, no short name).forceUpdate
- true when caller want remote ref to be updated regardless whether it is fast-forward update (old object is ancestor of new object).localName
- optional full name of a local stored tracking branch, to update after push, e.g. "refs/remotes/zawir/dirty" (no wildcard, no short name); null if no local tracking branch should be updated.expectedOldObjectId
- optional object id that caller is expecting, requiring to be advertised by remote side before update; update will take place ONLY if remote side advertise exactly this expected id; null if caller doesn't care what object id remote side advertise. UseObjectId.zeroId()
when expecting no remote ref with this name.- Throws:
IOException
- when I/O error occurred during creatingTrackingRefUpdate
for local tracking branch or srcRef can't be resolved to any object.IllegalArgumentException
- if some required parameter was null
-
RemoteRefUpdate
public RemoteRefUpdate(Repository localDb, String srcRef, ObjectId srcId, String remoteName, boolean forceUpdate, String localName, ObjectId expectedOldObjectId) throws IOException Construct remote ref update request by providing an update specification. Object is created with defaultRemoteRefUpdate.Status.NOT_ATTEMPTED
status and no message.- Parameters:
localDb
- local repository to push from.srcRef
- source revision to label srcId with. If null srcId.name() will be used instead.srcId
- The new object that the caller wants remote ref to be after update. Use null orObjectId.zeroId()
for delete request.remoteName
- full name of a remote ref to update, e.g. "refs/heads/master" (no wildcard, no short name).forceUpdate
- true when caller want remote ref to be updated regardless whether it is fast-forward update (old object is ancestor of new object).localName
- optional full name of a local stored tracking branch, to update after push, e.g. "refs/remotes/zawir/dirty" (no wildcard, no short name); null if no local tracking branch should be updated.expectedOldObjectId
- optional object id that caller is expecting, requiring to be advertised by remote side before update; update will take place ONLY if remote side advertise exactly this expected id; null if caller doesn't care what object id remote side advertise. UseObjectId.zeroId()
when expecting no remote ref with this name.- Throws:
IOException
- when I/O error occurred during creatingTrackingRefUpdate
for local tracking branch or srcRef can't be resolved to any object.IllegalArgumentException
- if some required parameter was null
-
RemoteRefUpdate
private RemoteRefUpdate(Repository localDb, String srcRef, ObjectId srcId, String remoteName, boolean forceUpdate, String localName, Collection<RefSpec> fetchSpecs, ObjectId expectedOldObjectId) throws IOException - Throws:
IOException
-
RemoteRefUpdate
Create a new instance of this object basing on existing instance for configuration. State (likegetMessage()
,getStatus()
) of base object is not shared. Expected old object id is set up from scratch, as this constructor may be used for 2-stage push: first one being dry run, second one being actual push.- Parameters:
base
- configuration base.newExpectedOldObjectId
- new expected object id value.- Throws:
IOException
- when I/O error occurred during creatingTrackingRefUpdate
for local tracking branch or srcRef of base object no longer can be resolved to any object.
-
RemoteRefUpdate
RemoteRefUpdate(Repository localDb, boolean forceUpdate, @NonNull Collection<RefSpec> fetchSpecs) Creates a "placeholder" update for the "matching" RefSpec ":".- Parameters:
localDb
- local repository to push fromforceUpdate
- whether non-fast-forward updates shall be allowedfetchSpecs
- The fetchRefSpec
s to use when this placeholder is expanded to determine remote tracking branch updates
-
-
Method Details
-
isMatching
public boolean isMatching()Tells whether thisRemoteRefUpdate
is a placeholder for a "matching"RefSpec
.- Returns:
true
if this is a placeholder,false
otherwise- Since:
- 6.1
-
getFetchSpecs
Collection<RefSpec> getFetchSpecs()Retrieves the fetchRefSpec
s of thisRemoteRefUpdate
.- Returns:
- the fetch
RefSpec
s, ornull
ifthis.
isMatching()
== false
-
getExpectedOldObjectId
Get expected old object id- Returns:
- expectedOldObjectId required to be advertised by remote side, as set in constructor; may be null.
-
isExpectingOldObjectId
public boolean isExpectingOldObjectId()Whether some object is required to be advertised by remote side, as set in constructor- Returns:
- true if some object is required to be advertised by remote side, as set in constructor; false otherwise.
-
getNewObjectId
Get new object id- Returns:
- newObjectId for remote ref, as set in constructor.
-
isDelete
public boolean isDelete()Whether this update is a deleting update- Returns:
- true if this update is deleting update; false otherwise.
-
getRemoteName
Get name of remote ref to update- Returns:
- name of remote ref to update, as set in constructor.
-
getTrackingRefUpdate
Get tracking branch update if localName was set in constructor.- Returns:
- local tracking branch update if localName was set in constructor.
-
getSrcRef
Get source revision as specified by user (in constructor)- Returns:
- source revision as specified by user (in constructor), could be
any string parseable by
Repository.resolve(String)
; can be null if specified that way in constructor - this stands for delete request.
-
hasTrackingRefUpdate
public boolean hasTrackingRefUpdate()Whether user specified a local tracking branch for remote update- Returns:
- true if user specified a local tracking branch for remote update; false otherwise.
-
isForceUpdate
public boolean isForceUpdate()Whether this update is forced regardless of old remote ref object- Returns:
- true if this update is forced regardless of old remote ref object; false otherwise.
-
getStatus
Get status of remote ref update operation.- Returns:
- status of remote ref update operation.
-
isFastForward
public boolean isFastForward()Check whether update was fast-forward. Note that this result is meaningful only after successful update (when status isRemoteRefUpdate.Status.OK
).- Returns:
- true if update was fast-forward; false otherwise.
-
getMessage
Get message describing reasons of status when needed/possible; may be null.- Returns:
- message describing reasons of status when needed/possible; may be null.
-
setExpectedOldObjectId
-
setStatus
-
setFastForward
void setFastForward(boolean fastForward) -
setMessage
-
updateTrackingRef
Update locally stored tracking branch with the new object.- Parameters:
walk
- walker used for checking update properties.- Throws:
IOException
- when I/O error occurred during update
-
toString
-