Package org.projectnessie.api.http

Interface HttpTreeApi

All Superinterfaces:

TreeApi

@Consumes("application/json")
@Path("trees")
public interface HttpTreeApi
extends TreeApi

Method Summary

Modifier and Type	Method	Description
void	assignReference(Reference.ReferenceType referenceType, String referenceName, String oldHash, Reference assignTo)	Update a reference's HEAD to point to a different commit.
Branch	commitMultipleOperations(String branchName, String hash, Operations operations)	Commit multiple operations against the given branch expecting that branch to have the given hash as its latest commit.
Reference	createReference(String sourceRefName, Reference reference)	Create a new reference.
void	deleteReference(Reference.ReferenceType referenceType, String referenceName, String hash)	Delete a named reference.
ReferencesResponse	getAllReferences(ReferencesParams params)	Get all references.
LogResponse	getCommitLog(String ref, CommitLogParams params)	Retrieve the commit log for a ref, potentially truncated by the backend.
Branch	getDefaultBranch()	Get details for the default reference.
EntriesResponse	getEntries(String refName, EntriesParams params)	Retrieve objects for a ref, potentially truncated by the backend.
Reference	getReferenceByName(GetReferenceParams params)	Get details of a particular ref, if it exists.
void	mergeRefIntoBranch(String branchName, String hash, Merge merge)	merge mergeRef onto ref.
void	transplantCommitsIntoBranch(String branchName, String hash, String message, Transplant transplant)	cherry pick a set of commits into a branch.

Method Detail

getAllReferences

@GET
@Produces("application/json")
ReferencesResponse getAllReferences(@BeanParam
                                    ReferencesParams params)

Description copied from interface: TreeApi

Get all references.

Specified by:

getAllReferences in interface TreeApi

Returns:

A ReferencesResponse instance containing all references.

getDefaultBranch

@GET
@Produces("application/json")
@Path("tree")
Branch getDefaultBranch()
                 throws NessieNotFoundException

Description copied from interface: TreeApi

Get details for the default reference.

Specified by:

getDefaultBranch in interface TreeApi

Throws:

NessieNotFoundException

createReference

@POST
@Produces("application/json")
@Path("tree")
Reference createReference(@QueryParam("sourceRefName")
                          String sourceRefName,
                          Reference reference)
                   throws NessieNotFoundException,
                          NessieConflictException

Description copied from interface: TreeApi

Create a new reference.

The type of reference, which can be either a Branch or Tag, determines the type of the reference to be created.

Reference.getName() defines the the name of the reference to be created, Reference.getHash() is the hash of the created reference, the HEAD of the created reference. sourceRefName is the name of the reference which contains Reference.getHash(), and must be present if Reference.getHash() is present.

Specifying no Reference.getHash() means that the new reference will be created "at the beginning of time".

Specified by:

createReference in interface TreeApi

Throws:

NessieNotFoundException

NessieConflictException

getReferenceByName

@GET
@Produces("application/json")
@Path("tree/{ref}")
Reference getReferenceByName(@BeanParam
                             GetReferenceParams params)
                      throws NessieNotFoundException

Description copied from interface: TreeApi

Get details of a particular ref, if it exists.

Specified by:

getReferenceByName in interface TreeApi

Throws:

NessieNotFoundException

getEntries

@GET
@Produces("application/json")
@Path("tree/{ref}/entries")
EntriesResponse getEntries(@PathParam("ref")
                           String refName,
                           @BeanParam
                           EntriesParams params)
                    throws NessieNotFoundException

Description copied from interface: TreeApi

Retrieve objects for a ref, potentially truncated by the backend.

Retrieves up to maxRecords objects for the given named reference (tag or branch). The backend may respect the given max records hint, but return less or more entries. Backends may also cap the returned entries at a hard-coded limit, the default REST server implementation has such a hard-coded limit.

Invoking getEntries() does not guarantee to return all commit log entries of a given reference, because the result can be truncated by the backend.

To implement paging, check EntriesResponse.isHasMore() and, if true, pass the value of EntriesResponse.getToken() in the next invocation of getEntries() as the pageToken parameter.

See org.projectnessie.client.StreamingUtil in nessie-client.

Specified by:

getEntries in interface TreeApi

Throws:

NessieNotFoundException

getCommitLog

@GET
@Produces("application/json")
@Path("tree/{ref}/log")
LogResponse getCommitLog(@PathParam("ref")
                         String ref,
                         @BeanParam
                         CommitLogParams params)
                  throws NessieNotFoundException

Description copied from interface: TreeApi

Retrieve the commit log for a ref, potentially truncated by the backend.

Retrieves up to maxRecords commit-log-entries starting at the HEAD of the given named reference (tag or branch). The backend may respect the given max records hint, but return less or more entries. Backends may also cap the returned entries at a hard-coded limit, the default REST server implementation has such a hard-coded limit.

Invoking getCommitLog() does not guarantee to return all commit log entries of a given reference, because the result can be truncated by the backend.

To implement paging, check LogResponse.isHasMore() and, if true, pass the value of LogResponse.getToken() in the next invocation of getCommitLog() as the pageToken parameter.

See org.projectnessie.client.StreamingUtil in nessie-client.

Specified by:

getCommitLog in interface TreeApi

Throws:

NessieNotFoundException

assignReference

@PUT
@Path("{referenceType}/{referenceName}")
void assignReference(@PathParam("referenceType")
                     Reference.ReferenceType referenceType,
                     @PathParam("referenceName")
                     String referenceName,
                     @QueryParam("expectedHash")
                     String oldHash,
                     Reference assignTo)
              throws NessieNotFoundException,
                     NessieConflictException

Description copied from interface: TreeApi

Update a reference's HEAD to point to a different commit.

Specified by:

assignReference in interface TreeApi

Throws:

NessieNotFoundException

NessieConflictException

deleteReference

@DELETE
@Path("{referenceType}/{referenceName}")
void deleteReference(@PathParam("referenceType")
                     Reference.ReferenceType referenceType,
                     @PathParam("referenceName")
                     String referenceName,
                     @QueryParam("expectedHash")
                     String hash)
              throws NessieConflictException,
                     NessieNotFoundException

Description copied from interface: TreeApi

Delete a named reference.

Specified by:

deleteReference in interface TreeApi

Throws:

NessieConflictException

NessieNotFoundException

transplantCommitsIntoBranch

@POST
@Path("branch/{branchName}/transplant")
void transplantCommitsIntoBranch(@PathParam("branchName")
                                 String branchName,
                                 @QueryParam("expectedHash")
                                 String hash,
                                 @QueryParam("message")
                                 String message,
                                 Transplant transplant)
                          throws NessieNotFoundException,
                                 NessieConflictException

Description copied from interface: TreeApi

cherry pick a set of commits into a branch.

Specified by:

transplantCommitsIntoBranch in interface TreeApi

Throws:

NessieNotFoundException

NessieConflictException

mergeRefIntoBranch

@POST
@Path("branch/{branchName}/merge")
void mergeRefIntoBranch(@PathParam("branchName")
                        String branchName,
                        @QueryParam("expectedHash")
                        String hash,
                        Merge merge)
                 throws NessieNotFoundException,
                        NessieConflictException

Description copied from interface: TreeApi

merge mergeRef onto ref.

Specified by:

mergeRefIntoBranch in interface TreeApi

Throws:

NessieNotFoundException

NessieConflictException

commitMultipleOperations

@POST
@Path("branch/{branchName}/commit")
@Produces("application/json")
@Consumes("application/json")
Branch commitMultipleOperations(@PathParam("branchName")
                                String branchName,
                                @QueryParam("expectedHash")
                                String hash,
                                Operations operations)
                         throws NessieNotFoundException,
                                NessieConflictException

Description copied from interface: TreeApi

Commit multiple operations against the given branch expecting that branch to have the given hash as its latest commit. The hash in the successful response contains the hash of the commit that contains the operations of the invocation.

Specified by:

commitMultipleOperations in interface TreeApi

Parameters:

branchName - Branch to change, defaults to default branch.

hash - Expected hash of branch.

operations - Operations to apply

Returns:

updated Branch objects with the hash of the new HEAD

Throws:

NessieNotFoundException - if branchName could not be found

NessieConflictException - if the operations could not be applied to some conflict, which is either caused by a conflicting commit or concurrent commits.