Package com.linecorp.centraldogma.client

Interface CentralDogma

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

AbstractCentralDogma

public interface CentralDogma
extends AutoCloseable

Central Dogma client.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes underlying resources that may be used when making requests to the server such as health checking or dns queries.
CompletableFuture<Void>	createProject(String projectName)	Creates a project.
CompletableFuture<CentralDogmaRepository>	createRepository(String projectName, String repositoryName)	Creates a repository.
default <T> Watcher<T>	fileWatcher(String projectName, String repositoryName, Query<T> query)	Deprecated. Use WatcherRequest.start() via CentralDogmaRepository.watcher(Query).
<T, U> Watcher<U>	fileWatcher(String projectName, String repositoryName, Query<T> query, Function<? super T,? extends U> function)	Deprecated. Use WatcherRequest.start() via CentralDogmaRepository.watcher(Query).
<T, U> Watcher<U>	fileWatcher(String projectName, String repositoryName, Query<T> query, Function<? super T,? extends U> function, Executor executor)	Deprecated. Use WatcherRequest.start() via CentralDogmaRepository.watcher(Query).
CentralDogmaRepository	forRepo(String projectName, String repositoryName)	Returns a new CentralDogmaRepository that is used to send a request to the specified projectName and repositoryName.
CompletableFuture<List<Change<?>>>	getDiff(String projectName, String repositoryName, Revision from, Revision to, PathPattern pathPattern)	Retrieves the diffs of the files matched by the given PathPattern between two Revisions.
<T> CompletableFuture<Change<T>>	getDiff(String projectName, String repositoryName, Revision from, Revision to, Query<T> query)	Queries a file at two different revisions and returns the diff of the two Query results.
default CompletableFuture<Change<?>>	getDiff(String projectName, String repositoryName, Revision from, Revision to, String path)	Deprecated. Use DiffRequest.get(Revision, Revision) via CentralDogmaRepository.diff(String).
default CompletableFuture<List<Change<?>>>	getDiffs(String projectName, String repositoryName, Revision from, Revision to, String pathPattern)	Deprecated. Use DiffRequest.get(Revision, Revision) via CentralDogmaRepository.diff(PathPattern).
<T> CompletableFuture<Entry<T>>	getFile(String projectName, String repositoryName, Revision revision, Query<T> query)	Queries a file at the specified revision and path with the specified Query.
default CompletableFuture<Entry<?>>	getFile(String projectName, String repositoryName, Revision revision, String path)	Deprecated. Use FileRequest.get(Revision) via CentralDogmaRepository.file(String).
CompletableFuture<Map<String,Entry<?>>>	getFiles(String projectName, String repositoryName, Revision revision, PathPattern pathPattern)	Retrieves the files matched by the PathPattern.
default CompletableFuture<Map<String,Entry<?>>>	getFiles(String projectName, String repositoryName, Revision revision, String pathPattern)	Deprecated. Use FilesRequest.get(Revision) via CentralDogmaRepository.file(PathPattern).
default CompletableFuture<List<Commit>>	getHistory(String projectName, String repositoryName, Revision from, Revision to)	Deprecated. Use HistoryRequest.get(Revision, Revision) via CentralDogmaRepository.history().
default CompletableFuture<List<Commit>>	getHistory(String projectName, String repositoryName, Revision from, Revision to, PathPattern pathPattern)	Deprecated. Use HistoryRequest.get(Revision, Revision) via CentralDogmaRepository.history(PathPattern).
CompletableFuture<List<Commit>>	getHistory(String projectName, String repositoryName, Revision from, Revision to, PathPattern pathPattern, int maxCommits)	Retrieves the history of the files matched by the given PathPattern between two Revisions.
default CompletableFuture<List<Commit>>	getHistory(String projectName, String repositoryName, Revision from, Revision to, String pathPattern)	Deprecated. Use HistoryRequest.get(Revision, Revision) via CentralDogmaRepository.history(PathPattern).
default CompletableFuture<List<Change<?>>>	getPreviewDiffs(String projectName, String repositoryName, Revision baseRevision, Change<?>... changes)	Deprecated. Use PreviewDiffRequest.get(Revision) via CentralDogmaRepository.diff(Change[]).
CompletableFuture<List<Change<?>>>	getPreviewDiffs(String projectName, String repositoryName, Revision baseRevision, Iterable<? extends Change<?>> changes)	Retrieves the preview diffs, which are hypothetical diffs generated if the specified Changes were successfully pushed to the specified repository.
CompletableFuture<Map<String,EntryType>>	listFiles(String projectName, String repositoryName, Revision revision, PathPattern pathPattern)	Retrieves the list of the files matched by the given PathPattern.
default CompletableFuture<Map<String,EntryType>>	listFiles(String projectName, String repositoryName, Revision revision, String pathPattern)	Deprecated. Use FilesRequest.list(Revision) via CentralDogmaRepository.file(PathPattern).
CompletableFuture<Set<String>>	listProjects()	Retrieves the list of the projects.
CompletableFuture<Set<String>>	listRemovedProjects()	Retrieves the list of the removed projects, which can be unremoved.
CompletableFuture<Set<String>>	listRemovedRepositories(String projectName)	Retrieves the list of the removed repositories, which can be unremoved.
CompletableFuture<Map<String,RepositoryInfo>>	listRepositories(String projectName)	Retrieves the list of the repositories.
<T> CompletableFuture<MergedEntry<T>>	mergeFiles(String projectName, String repositoryName, Revision revision, MergeQuery<T> mergeQuery)	Retrieves the merged entry of the specified MergeQuery at the specified revision.
default CompletableFuture<MergedEntry<?>>	mergeFiles(String projectName, String repositoryName, Revision revision, MergeSource... mergeSources)	Deprecated. Use MergeRequest.get(Revision) via CentralDogmaRepository.merge(MergeSource...).
default CompletableFuture<MergedEntry<?>>	mergeFiles(String projectName, String repositoryName, Revision revision, Iterable<MergeSource> mergeSources)	Deprecated. Use MergeRequest.get(Revision) via CentralDogmaRepository.merge(Iterable).
CompletableFuture<Revision>	normalizeRevision(String projectName, String repositoryName, Revision revision)	Converts the relative revision number to the absolute revision number. e.g.
CompletableFuture<Void>	purgeProject(String projectName)	Purges a project that was removed before.
CompletableFuture<Void>	purgeRepository(String projectName, String repositoryName)	Purges a repository that was removed before.
default CompletableFuture<PushResult>	push(String projectName, String repositoryName, Revision baseRevision, Author author, String summary, Change<?>... changes)	Deprecated. Use CommitRequest.push(Revision) via CentralDogmaRepository.commit(String, Change...).
default CompletableFuture<PushResult>	push(String projectName, String repositoryName, Revision baseRevision, Author author, String summary, Iterable<? extends Change<?>> changes)	Deprecated. Use CommitRequest.push(Revision) via CentralDogmaRepository.commit(String, Iterable).
default CompletableFuture<PushResult>	push(String projectName, String repositoryName, Revision baseRevision, Author author, String summary, String detail, Markup markup, Change<?>... changes)	Deprecated. Use CommitRequest.push(Revision) via CentralDogmaRepository.commit(String, Change...).
CompletableFuture<PushResult>	push(String projectName, String repositoryName, Revision baseRevision, Author author, String summary, String detail, Markup markup, Iterable<? extends Change<?>> changes)	Deprecated. Use CommitRequest.push(Revision) via CentralDogmaRepository.commit(String, Iterable).
default CompletableFuture<PushResult>	push(String projectName, String repositoryName, Revision baseRevision, String summary, Change<?>... changes)	Deprecated. Use CommitRequest.push(Revision) via CentralDogmaRepository.commit(String, Change...).
default CompletableFuture<PushResult>	push(String projectName, String repositoryName, Revision baseRevision, String summary, Iterable<? extends Change<?>> changes)	Deprecated. Use CommitRequest.push(Revision) via CentralDogmaRepository.commit(String, Iterable).
default CompletableFuture<PushResult>	push(String projectName, String repositoryName, Revision baseRevision, String summary, String detail, Markup markup, Change<?>... changes)	Deprecated. Use CommitRequest.push(Revision) via CentralDogmaRepository.commit(String, Change...).
CompletableFuture<PushResult>	push(String projectName, String repositoryName, Revision baseRevision, String summary, String detail, Markup markup, Iterable<? extends Change<?>> changes)	Pushes the specified Changes to the repository.
CompletableFuture<Void>	removeProject(String projectName)	Removes a project.
CompletableFuture<Void>	removeRepository(String projectName, String repositoryName)	Removes a repository.
default Watcher<Revision>	repositoryWatcher(String projectName, String repositoryName, String pathPattern)	Deprecated. Use WatcherRequest.start() via CentralDogmaRepository.watcher(PathPattern).
<T> Watcher<T>	repositoryWatcher(String projectName, String repositoryName, String pathPattern, Function<Revision,? extends T> function)	Deprecated. Use WatcherRequest.start() via CentralDogmaRepository.watcher(PathPattern).
<T> Watcher<T>	repositoryWatcher(String projectName, String repositoryName, String pathPattern, Function<Revision,? extends T> function, Executor executor)	Deprecated. Use WatcherRequest.start() via CentralDogmaRepository.watcher(PathPattern).
CompletableFuture<Void>	unremoveProject(String projectName)	Unremoves a project.
CompletableFuture<CentralDogmaRepository>	unremoveRepository(String projectName, String repositoryName)	Unremoves a repository.
default <T> CompletableFuture<Entry<T>>	watchFile(String projectName, String repositoryName, Revision lastKnownRevision, Query<T> query)	Deprecated. Use WatchRequest.start(Revision) via CentralDogmaRepository.watch(Query).
default <T> CompletableFuture<Entry<T>>	watchFile(String projectName, String repositoryName, Revision lastKnownRevision, Query<T> query, long timeoutMillis)	Deprecated. Use WatchRequest.start(Revision) via CentralDogmaRepository.watch(Query).
<T> CompletableFuture<Entry<T>>	watchFile(String projectName, String repositoryName, Revision lastKnownRevision, Query<T> query, long timeoutMillis, boolean errorOnEntryNotFound)	Waits for the file matched by the specified Query to be changed since the specified lastKnownRevision.
CompletableFuture<Revision>	watchRepository(String projectName, String repositoryName, Revision lastKnownRevision, PathPattern pathPattern, long timeoutMillis, boolean errorOnEntryNotFound)	Waits for the files matched by the specified PathPattern to be changed since the specified lastKnownRevision.
default CompletableFuture<Revision>	watchRepository(String projectName, String repositoryName, Revision lastKnownRevision, String pathPattern)	Deprecated. Use WatchFilesRequest.start(Revision) via CentralDogmaRepository.watch(PathPattern).
default CompletableFuture<Revision>	watchRepository(String projectName, String repositoryName, Revision lastKnownRevision, String pathPattern, long timeoutMillis)	Deprecated. Use CentralDogmaRepository.watch(PathPattern) and WatchFilesRequest.start(Revision).
CompletableFuture<Void>	whenEndpointReady()	Returns a CompletableFuture which is completed when the initial endpoints of this client are ready.

Method Details

forRepo

CentralDogmaRepository forRepo(String projectName,
 String repositoryName)

Returns a new CentralDogmaRepository that is used to send a request to the specified projectName and repositoryName.

createProject

CompletableFuture<Void> createProject(String projectName)

Creates a project.

removeProject

CompletableFuture<Void> removeProject(String projectName)

Removes a project. A removed project can be unremoved using unremoveProject(String).

purgeProject

CompletableFuture<Void> purgeProject(String projectName)

Purges a project that was removed before.

unremoveProject

CompletableFuture<Void> unremoveProject(String projectName)

Unremoves a project.

listProjects

CompletableFuture<Set<String>> listProjects()

Retrieves the list of the projects.

Returns:

a Set that contains the names of the projects

listRemovedProjects

CompletableFuture<Set<String>> listRemovedProjects()

Retrieves the list of the removed projects, which can be unremoved.

Returns:

a Set that contains the names of the removed projects

createRepository

CompletableFuture<CentralDogmaRepository> createRepository(String projectName,
 String repositoryName)

Creates a repository.

removeRepository

CompletableFuture<Void> removeRepository(String projectName,
 String repositoryName)

Removes a repository. A removed repository can be unremoved using unremoveRepository(String, String).

purgeRepository

CompletableFuture<Void> purgeRepository(String projectName,
 String repositoryName)

Purges a repository that was removed before.

unremoveRepository

CompletableFuture<CentralDogmaRepository> unremoveRepository(String projectName,
 String repositoryName)

Unremoves a repository.

listRepositories

CompletableFuture<Map<String,RepositoryInfo>> listRepositories(String projectName)

Retrieves the list of the repositories.

Returns:

a Map of repository name and RepositoryInfo pairs

listRemovedRepositories

CompletableFuture<Set<String>> listRemovedRepositories(String projectName)

Retrieves the list of the removed repositories, which can be unremoved.

Returns:

a Set that contains the names of the removed repositories

normalizeRevision

CompletableFuture<Revision> normalizeRevision(String projectName,
 String repositoryName,
 Revision revision)

Converts the relative revision number to the absolute revision number. e.g. -1 -> 3

Returns:

the absolute Revision

listFiles

@Deprecated
default CompletableFuture<Map<String,EntryType>> listFiles(String projectName,
 String repositoryName,
 Revision revision,
 String pathPattern)

Deprecated.

Use FilesRequest.list(Revision) via CentralDogmaRepository.file(PathPattern).

Retrieves the list of the files matched by the given path pattern.

Returns:

a Map of file path and type pairs

listFiles

CompletableFuture<Map<String,EntryType>> listFiles(String projectName,
 String repositoryName,
 Revision revision,
 PathPattern pathPattern)

Retrieves the list of the files matched by the given PathPattern. This method is equivalent to calling:

 CentralDogma dogma = ...
 dogma.forRepo(projectName, repositoryName)
      .files(pathPattern)
      .list(revision);
 

Returns:

a Map of file path and type pairs

getFile

@Deprecated
default CompletableFuture<Entry<?>> getFile(String projectName,
 String repositoryName,
 Revision revision,
 String path)

Deprecated.

Use FileRequest.get(Revision) via CentralDogmaRepository.file(String).

Retrieves the file at the specified revision and path. This method is a shortcut of getFile(projectName, repositoryName, revision, Query.identity(path). Consider using getFile(String, String, Revision, Query) with Query.ofText(String) or Query.ofJson(String) if you already know the file type.

Returns:

the Entry at the given path

getFile

<T> CompletableFuture<Entry<T>> getFile(String projectName,
 String repositoryName,
 Revision revision,
 Query<T> query)

Queries a file at the specified revision and path with the specified Query. This method is equivalent to calling:

 CentralDogma dogma = ...
 dogma.forRepo(projectName, repositoryName)
      .file(query)
      .get(revision);
 

Returns:

the Entry that is matched by the given Query

getFiles

@Deprecated
default CompletableFuture<Map<String,Entry<?>>> getFiles(String projectName,
 String repositoryName,
 Revision revision,
 String pathPattern)

Deprecated.

Use FilesRequest.get(Revision) via CentralDogmaRepository.file(PathPattern).

Retrieves the files matched by the path pattern.

Returns:

a Map of file path and Entry pairs

getFiles

CompletableFuture<Map<String,Entry<?>>> getFiles(String projectName,
 String repositoryName,
 Revision revision,
 PathPattern pathPattern)

Retrieves the files matched by the PathPattern. This method is equivalent to calling:

 CentralDogma dogma = ...
 dogma.forRepo(projectName, repositoryName)
      .file(pathPattern)
      .get(revision);
 

Returns:

a Map of file path and Entry pairs

mergeFiles

@Deprecated
default CompletableFuture<MergedEntry<?>> mergeFiles(String projectName,
 String repositoryName,
 Revision revision,
 MergeSource... mergeSources)

Deprecated.

Use MergeRequest.get(Revision) via CentralDogmaRepository.merge(MergeSource...).

Retrieves the merged entry of the specified MergeSources at the specified revision. Only JSON entry merge is currently supported. The JSON files are merged sequentially as specified in the mergeSources.

Note that only ObjectNode is recursively merged traversing the children. Other node types are simply replaced.

Returns:

the MergedEntry which contains the result of the merge

mergeFiles

@Deprecated
default CompletableFuture<MergedEntry<?>> mergeFiles(String projectName,
 String repositoryName,
 Revision revision,
 Iterable<MergeSource> mergeSources)

Deprecated.

Use MergeRequest.get(Revision) via CentralDogmaRepository.merge(Iterable).

Retrieves the merged entry of the specified MergeSources at the specified revision. Only JSON entry merge is currently supported. The JSON files are merged sequentially as specified in the mergeSources.

Note that only ObjectNode is recursively merged traversing the children. Other node types are simply replaced.

Returns:

the MergedEntry which contains the result of the merge

mergeFiles

<T> CompletableFuture<MergedEntry<T>> mergeFiles(String projectName,
 String repositoryName,
 Revision revision,
 MergeQuery<T> mergeQuery)

Retrieves the merged entry of the specified MergeQuery at the specified revision. Only JSON entry merge is currently supported. The JSON files are merged sequentially as specified in the MergeQuery. This method is equivalent to calling:

 CentralDogma dogma = ...
 dogma.forRepo(projectName, repositoryName)
      .merge(mergeQuery)
      .get(revision);
 

Note that only ObjectNode is recursively merged traversing the children. Other node types are simply replaced.

Returns:

the MergedEntry which contains the result of the merge

getHistory

@Deprecated
default CompletableFuture<List<Commit>> getHistory(String projectName,
 String repositoryName,
 Revision from,
 Revision to)

Deprecated.

Use HistoryRequest.get(Revision, Revision) via CentralDogmaRepository.history().

Retrieves the history of the repository between two Revisions. This method is a shortcut of getHistory(projectName, repositoryName, from, to, "/**"). Note that this method does not retrieve the diffs but only metadata about the changes. Use getDiff(String, String, Revision, Revision, Query) or getDiff(String, String, Revision, Revision, PathPattern) to retrieve the diffs.

Returns:

a List that contains the Commits of the specified repository

getHistory

@Deprecated
default CompletableFuture<List<Commit>> getHistory(String projectName,
 String repositoryName,
 Revision from,
 Revision to,
 String pathPattern)

Deprecated.

Use HistoryRequest.get(Revision, Revision) via CentralDogmaRepository.history(PathPattern).

Retrieves the history of the files matched by the given path pattern between two Revisions.

Note that this method does not retrieve the diffs but only metadata about the changes. Use getDiff(String, String, Revision, Revision, Query) or getDiff(String, String, Revision, Revision, PathPattern) to retrieve the diffs.

Returns:

a List that contains the Commits of the files matched by the given PathPattern in the specified repository

getHistory

@Deprecated
default CompletableFuture<List<Commit>> getHistory(String projectName,
 String repositoryName,
 Revision from,
 Revision to,
 PathPattern pathPattern)

Deprecated.

Use HistoryRequest.get(Revision, Revision) via CentralDogmaRepository.history(PathPattern).

Retrieves the history of the files matched by the given PathPattern between two Revisions.

Note that this method does not retrieve the diffs but only metadata about the changes. Use DiffRequest to retrieve the diffs.

Returns:

a List that contains the Commits of the files matched by the given PathPattern in the specified repository

getHistory

CompletableFuture<List<Commit>> getHistory(String projectName,
 String repositoryName,
 Revision from,
 Revision to,
 PathPattern pathPattern,
 int maxCommits)

Retrieves the history of the files matched by the given PathPattern between two Revisions. This method is equivalent to calling:

 CentralDogma dogma = ...
 dogma.forRepo(projectName, repositoryName)
      .history(pathPattern)
      .maxCommits(maxCommits)
      .get(from, to);
 

Note that this method does not retrieve the diffs but only metadata about the changes. Use DiffRequest to retrieve the diffs.

Returns:

a List that contains the Commits of the files matched by the given PathPattern in the specified repository

getDiff

@Deprecated
default CompletableFuture<Change<?>> getDiff(String projectName,
 String repositoryName,
 Revision from,
 Revision to,
 String path)

Deprecated.

Use DiffRequest.get(Revision, Revision) via CentralDogmaRepository.diff(String).

Returns the diff of a file between two Revisions. This method is a shortcut of getDiff(projectName, repositoryName, from, to, Query.identity(path)). Consider using getDiff(String, String, Revision, Revision, Query) with Query.ofText(String) or Query.ofJson(String) if you already know the file type.

Returns:

the Change that contains the diff of the given path between the specified two revisions

getDiff

<T> CompletableFuture<Change<T>> getDiff(String projectName,
 String repositoryName,
 Revision from,
 Revision to,
 Query<T> query)

Queries a file at two different revisions and returns the diff of the two Query results. This method is equivalent to calling:

 CentralDogma dogma = ...
 dogma.forRepo(projectName, repositoryName)
      .diff(query)
      .get(from, to);
 

Returns:

the Change that contains the diff of the file matched by the given query between the specified two revisions

getDiff

CompletableFuture<List<Change<?>>> getDiff(String projectName,
 String repositoryName,
 Revision from,
 Revision to,
 PathPattern pathPattern)

Retrieves the diffs of the files matched by the given PathPattern between two Revisions.

 CentralDogma dogma = ...
 dogma.forRepo(projectName, repositoryName)
      .diff(pathPattern)
      .get(from, to);
 

Returns:

a List of the Changes that contain the diffs between the files matched by the given PathPattern between two revisions.

getDiffs

@Deprecated
default CompletableFuture<List<Change<?>>> getDiffs(String projectName,
 String repositoryName,
 Revision from,
 Revision to,
 String pathPattern)

Deprecated.

Use DiffRequest.get(Revision, Revision) via CentralDogmaRepository.diff(PathPattern).

Retrieves the diffs of the files matched by the given path pattern between two Revisions.

Returns:

a List of the Changes that contain the diffs between the files matched by the given PathPattern between two revisions.

getPreviewDiffs

@Deprecated
default CompletableFuture<List<Change<?>>> getPreviewDiffs(String projectName,
 String repositoryName,
 Revision baseRevision,
 Change<?>... changes)

Deprecated.

Use PreviewDiffRequest.get(Revision) via CentralDogmaRepository.diff(Change[]).

Retrieves the preview diffs, which are hypothetical diffs generated if the specified Changes were successfully pushed to the specified repository. This operation is useful for pre-checking if the specified Changes will be applied as expected without any conflicts.

Returns:

the diffs which would be committed if the specified Changes were pushed successfully

getPreviewDiffs

CompletableFuture<List<Change<?>>> getPreviewDiffs(String projectName,
 String repositoryName,
 Revision baseRevision,
 Iterable<? extends Change<?>> changes)

Retrieves the preview diffs, which are hypothetical diffs generated if the specified Changes were successfully pushed to the specified repository. This operation is useful for pre-checking if the specified Changes will be applied as expected without any conflicts. This method is equivalent to calling:

 CentralDogma dogma = ...
 dogma.forRepo(projectName, repositoryName)
      .diff(changes)
      .get(baseRevision);
 

Returns:

the diffs which would be committed if the specified Changes were pushed successfully

push

@Deprecated
default CompletableFuture<PushResult> push(String projectName,
 String repositoryName,
 Revision baseRevision,
 String summary,
 Change<?>... changes)

Deprecated.

Use CommitRequest.push(Revision) via CentralDogmaRepository.commit(String, Change...).

Pushes the specified Changes to the repository.

Returns:

the PushResult which tells the Revision and timestamp of the new Commit

push

@Deprecated
default CompletableFuture<PushResult> push(String projectName,
 String repositoryName,
 Revision baseRevision,
 String summary,
 Iterable<? extends Change<?>> changes)

Deprecated.

Use CommitRequest.push(Revision) via CentralDogmaRepository.commit(String, Iterable).

Pushes the specified Changes to the repository.

Returns:

the PushResult which tells the Revision and timestamp of the new Commit

push

@Deprecated
default CompletableFuture<PushResult> push(String projectName,
 String repositoryName,
 Revision baseRevision,
 String summary,
 String detail,
 Markup markup,
 Change<?>... changes)

Deprecated.

Use CommitRequest.push(Revision) via CentralDogmaRepository.commit(String, Change...).

Pushes the specified Changes to the repository.

Returns:

the PushResult which tells the Revision and timestamp of the new Commit

push

CompletableFuture<PushResult> push(String projectName,
 String repositoryName,
 Revision baseRevision,
 String summary,
 String detail,
 Markup markup,
 Iterable<? extends Change<?>> changes)

Pushes the specified Changes to the repository. This method is equivalent to calling:

 CentralDogma dogma = ...
 dogma.forRepo(projectName, repositoryName)
      .commit(summary, changes)
      .detail(detail, markup)
      .push(baseRevision);
 

Returns:

the PushResult which tells the Revision and timestamp of the new Commit

push

@Deprecated
default CompletableFuture<PushResult> push(String projectName,
 String repositoryName,
 Revision baseRevision,
 Author author,
 String summary,
 Change<?>... changes)

Deprecated.

Use CommitRequest.push(Revision) via CentralDogmaRepository.commit(String, Change...).

Pushes the specified Changes to the repository.

Returns:

the PushResult which tells the Revision and timestamp of the new Commit

push

@Deprecated
default CompletableFuture<PushResult> push(String projectName,
 String repositoryName,
 Revision baseRevision,
 Author author,
 String summary,
 Iterable<? extends Change<?>> changes)

Deprecated.

Use CommitRequest.push(Revision) via CentralDogmaRepository.commit(String, Iterable).

Pushes the specified Changes to the repository.

Returns:

the PushResult which tells the Revision and timestamp of the new Commit

push

@Deprecated
default CompletableFuture<PushResult> push(String projectName,
 String repositoryName,
 Revision baseRevision,
 Author author,
 String summary,
 String detail,
 Markup markup,
 Change<?>... changes)

Deprecated.

Use CommitRequest.push(Revision) via CentralDogmaRepository.commit(String, Change...).

Pushes the specified Changes to the repository.

Returns:

the PushResult which tells the Revision and timestamp of the new Commit

push

@Deprecated
CompletableFuture<PushResult> push(String projectName,
 String repositoryName,
 Revision baseRevision,
 Author author,
 String summary,
 String detail,
 Markup markup,
 Iterable<? extends Change<?>> changes)

Deprecated.

Use CommitRequest.push(Revision) via CentralDogmaRepository.commit(String, Iterable).

Pushes the specified Changes to the repository.

Returns:

the PushResult which tells the Revision and timestamp of the new Commit

watchRepository

@Deprecated
default CompletableFuture<Revision> watchRepository(String projectName,
 String repositoryName,
 Revision lastKnownRevision,
 String pathPattern)

Deprecated.

Use WatchFilesRequest.start(Revision) via CentralDogmaRepository.watch(PathPattern).

Waits for the files matched by the specified pathPattern to be changed since the specified lastKnownRevision. If no changes were made within 1 minute, the returned CompletableFuture will be completed with null.

Returns:

the latest known Revision which contains the changes for the matched files. null if the files were not changed for 1 minute since the invocation of this method. Even before the timeout, the watch may return null earlier due to issues such as server restart.

watchRepository

@Deprecated
default CompletableFuture<Revision> watchRepository(String projectName,
 String repositoryName,
 Revision lastKnownRevision,
 String pathPattern,
 long timeoutMillis)

Deprecated.

Use CentralDogmaRepository.watch(PathPattern) and WatchFilesRequest.start(Revision).

Waits for the files matched by the specified pathPattern to be changed since the specified lastKnownRevision. If no changes were made within the specified timeoutMillis, the returned CompletableFuture will be completed with null. It is recommended to specify the largest timeoutMillis allowed by the server.

Returns:

the latest known Revision which contains the changes for the matched files. null if the files were not changed for timeoutMillis milliseconds since the invocation of this method. Even before the timeout, the watch may return null earlier due to issues such as server restart.

watchRepository

CompletableFuture<Revision> watchRepository(String projectName,
 String repositoryName,
 Revision lastKnownRevision,
 PathPattern pathPattern,
 long timeoutMillis,
 boolean errorOnEntryNotFound)

Waits for the files matched by the specified PathPattern to be changed since the specified lastKnownRevision. If no changes were made within the specified timeoutMillis, the returned CompletableFuture will be completed with null. It is recommended to specify the largest timeoutMillis allowed by the server. This method is equivalent to calling:

 CentralDogma dogma = ...
 dogma.forRepo(projectName, repositoryName)
      .watch(pathPattern)
      .timeoutMillis(timeoutMillis)
      .errorOnEntryNotFound(errorOnEntryNotFound)
      .start(lastKnownRevision);
 

Returns:

the latest known Revision which contains the changes for the matched files. null if the files were not changed for timeoutMillis milliseconds since the invocation of this method. Even before the timeout, the watch may return null earlier due to issues such as server restart. EntryNotFoundException is raised if the target does not exist.

watchFile

@Deprecated
default <T> CompletableFuture<Entry<T>> watchFile(String projectName,
 String repositoryName,
 Revision lastKnownRevision,
 Query<T> query)

Deprecated.

Use WatchRequest.start(Revision) via CentralDogmaRepository.watch(Query).

Waits for the file matched by the specified Query to be changed since the specified lastKnownRevision. If no changes were made within 1 minute, the returned CompletableFuture will be completed with null.

Returns:

the Entry which contains the latest known Query result. null if the file was not changed for 1 minute since the invocation of this method. Even before the timeout, the watch may return null earlier due to issues such as server restart.

watchFile

@Deprecated
default <T> CompletableFuture<Entry<T>> watchFile(String projectName,
 String repositoryName,
 Revision lastKnownRevision,
 Query<T> query,
 long timeoutMillis)

Deprecated.

Use WatchRequest.start(Revision) via CentralDogmaRepository.watch(Query).

Waits for the file matched by the specified Query to be changed since the specified lastKnownRevision. If no changes were made within the specified timeoutMillis, the returned CompletableFuture will be completed with null. It is recommended to specify the largest timeoutMillis allowed by the server.

Returns:

the Entry which contains the latest known Query result. null if the file was not changed for timeoutMillis milliseconds since the invocation of this method. Even before the timeout, the watch may return null earlier due to issues such as server restart.

watchFile

<T> CompletableFuture<Entry<T>> watchFile(String projectName,
 String repositoryName,
 Revision lastKnownRevision,
 Query<T> query,
 long timeoutMillis,
 boolean errorOnEntryNotFound)

Waits for the file matched by the specified Query to be changed since the specified lastKnownRevision. If the file does not exist and errorOnEntryNotFound is true, the returned CompletableFuture will be completed exceptionally with EntryNotFoundException. If no changes were made within the specified timeoutMillis, the returned CompletableFuture will be completed with null. It is recommended to specify the largest timeoutMillis allowed by the server. This method is equivalent to calling:

 CentralDogma dogma = ...
 dogma.forRepo(projectName, repositoryName)
      .watch(query)
      .timeoutMillis(timeoutMillis)
      .errorOnEntryNotFound(errorOnEntryNotFound)
      .start(lastKnownRevision);
 

Returns:

the Entry which contains the latest known Query result. null if the file was not changed for timeoutMillis milliseconds since the invocation of this method. Even before the timeout, the watch may return null earlier due to issues such as server restart. EntryNotFoundException is raised if the target does not exist.

fileWatcher

@Deprecated
default <T> Watcher<T> fileWatcher(String projectName,
 String repositoryName,
 Query<T> query)

Deprecated.

Use WatcherRequest.start() via CentralDogmaRepository.watcher(Query).

Returns a Watcher which notifies its listeners when the result of the given Query becomes available or changes. e.g:

 Watcher<JsonNode> watcher = client.fileWatcher("foo", "bar", Query.ofJson("/baz.json"));

 watcher.watch((revision, content) -> {
     assert content instanceof JsonNode;
     ...
 });

fileWatcher

@Deprecated
<T,
U> Watcher<U> fileWatcher(String projectName,
 String repositoryName,
 Query<T> query,
 Function<? super T,? extends U> function)

Deprecated.

Use WatcherRequest.start() via CentralDogmaRepository.watcher(Query).

Returns a Watcher which notifies its listeners after applying the specified Function when the result of the given Query becomes available or changes. e.g:

 Watcher<MyType> watcher = client.fileWatcher(
         "foo", "bar", Query.ofJson("/baz.json"),
         content -> new ObjectMapper().treeToValue(content, MyType.class));

 watcher.watch((revision, myValue) -> {
     assert myValue instanceof MyType;
     ...
 });

Note that Function by default is executed by a blocking task executor so that you can safely call a blocking operation.

fileWatcher

@Deprecated
<T,
U> Watcher<U> fileWatcher(String projectName,
 String repositoryName,
 Query<T> query,
 Function<? super T,? extends U> function,
 Executor executor)

Deprecated.

Use WatcherRequest.start() via CentralDogmaRepository.watcher(Query).

Returns a Watcher which notifies its listeners after applying the specified Function when the result of the given Query becomes available or changes. e.g:

 Watcher<MyType> watcher = client.fileWatcher(
         "foo", "bar", Query.ofJson("/baz.json"),
         content -> new ObjectMapper().treeToValue(content, MyType.class), executor);

 watcher.watch((revision, myValue) -> {
     assert myValue instanceof MyType;
     ...
 });

repositoryWatcher

@Deprecated
default Watcher<Revision> repositoryWatcher(String projectName,
 String repositoryName,
 String pathPattern)

Deprecated.

Use WatcherRequest.start() via CentralDogmaRepository.watcher(PathPattern).

Returns a Watcher which notifies its listeners when the specified repository has a new commit that contains the changes for the files matched by the given pathPattern. e.g:

 Watcher<Revision> watcher = client.repositoryWatcher("foo", "bar", "/*.json");

 watcher.watch(revision -> {
     ...
 });

repositoryWatcher

@Deprecated
<T> Watcher<T> repositoryWatcher(String projectName,
 String repositoryName,
 String pathPattern,
 Function<Revision,? extends T> function)

Deprecated.

Use WatcherRequest.start() via CentralDogmaRepository.watcher(PathPattern).

Returns a Watcher which notifies its listeners when the specified repository has a new commit that contains the changes for the files matched by the given pathPattern. e.g:

 Watcher<Map<String, Entry<?>> watcher = client.repositoryWatcher(
         "foo", "bar", "/*.json", revision -> client.getFiles("foo", "bar", revision, "/*.json").join());

 watcher.watch((revision, contents) -> {
     ...
 });

Function by default is executed by a blocking task executor so that you can safely call a blocking operation.

Note that you may get RevisionNotFoundException during the getFiles() call and may have to retry in the above example due to a known issue.

repositoryWatcher

@Deprecated
<T> Watcher<T> repositoryWatcher(String projectName,
 String repositoryName,
 String pathPattern,
 Function<Revision,? extends T> function,
 Executor executor)

Deprecated.

Use WatcherRequest.start() via CentralDogmaRepository.watcher(PathPattern).

Returns a Watcher which notifies its listeners when the specified repository has a new commit that contains the changes for the files matched by the given pathPattern. e.g:

 Watcher<Map<String, Entry<?>> watcher = client.repositoryWatcher(
         "foo", "bar", "/*.json",
         revision -> client.getFiles("foo", "bar", revision, "/*.json").join(), executor);

 watcher.watch((revision, contents) -> {
     ...
 });

Note that you may get RevisionNotFoundException during the getFiles() call and may have to retry in the above example due to a known issue.

Parameters:

executor - the Executor that executes the Function

whenEndpointReady

CompletableFuture<Void> whenEndpointReady()

Returns a CompletableFuture which is completed when the initial endpoints of this client are ready. It is recommended to wait for the initial endpoints in order to send the first request without additional delay.

close

void close()
    throws Exception

Closes underlying resources that may be used when making requests to the server such as health checking or dns queries.

Specified by:

close in interface AutoCloseable

Throws:

Exception