Package com.linecorp.centraldogma.client

Class AbstractCentralDogma

java.lang.Object

com.linecorp.centraldogma.client.AbstractCentralDogma

All Implemented Interfaces:

CentralDogma, AutoCloseable

public abstract class AbstractCentralDogma
extends Object
implements CentralDogma

A skeletal CentralDogma implementation.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractCentralDogma(ScheduledExecutorService blockingTaskExecutor)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
protected final ScheduledExecutorService	executor()	Returns the ScheduledExecutorService which is used for scheduling the tasks related with automatic retries and invoking the callbacks for watched changes.
<T, U> Watcher<U>	fileWatcher(String projectName, String repositoryName, Query<T> query, Function<? super T,? extends U> function)	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:
<T, U> Watcher<U>	fileWatcher(String projectName, String repositoryName, Query<T> query, Function<? super T,? extends U> function, Executor executor)	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:
CentralDogmaRepository	forRepo(String projectName, String repositoryName)	Returns a new CentralDogmaRepository that is used to send a request to the specified projectName and repositoryName.
final CompletableFuture<Change<?>>	getDiff(String projectName, String repositoryName, Revision from, Revision to, String path)	Returns the diff of a file between two Revisions.
final CompletableFuture<Entry<?>>	getFile(String projectName, String repositoryName, Revision revision, String path)	Retrieves the file at the specified revision and path.
final CompletableFuture<List<Commit>>	getHistory(String projectName, String repositoryName, Revision from, Revision to)	Retrieves the history of the repository between two Revisions.
final CompletableFuture<List<Change<?>>>	getPreviewDiffs(String projectName, String repositoryName, Revision baseRevision, Change<?>... changes)	Retrieves the preview diffs, which are hypothetical diffs generated if the specified Changes were successfully pushed to the specified repository.
protected final CompletableFuture<Revision>	maybeNormalizeRevision(String projectName, String repositoryName, Revision revision)	Normalizes the specified Revision only if it is a relative revision.
final CompletableFuture<MergedEntry<?>>	mergeFiles(String projectName, String repositoryName, Revision revision, MergeSource... mergeSources)	Retrieves the merged entry of the specified MergeSources at the specified revision.
final CompletableFuture<MergedEntry<?>>	mergeFiles(String projectName, String repositoryName, Revision revision, Iterable<MergeSource> mergeSources)	Retrieves the merged entry of the specified MergeSources at the specified revision.
final CompletableFuture<PushResult>	push(String projectName, String repositoryName, Revision baseRevision, Author author, String summary, Change<?>... changes)	Pushes the specified Changes to the repository.
final CompletableFuture<PushResult>	push(String projectName, String repositoryName, Revision baseRevision, Author author, String summary, Iterable<? extends Change<?>> changes)	Pushes the specified Changes to the repository.
final CompletableFuture<PushResult>	push(String projectName, String repositoryName, Revision baseRevision, Author author, String summary, String detail, Markup markup, Change<?>... changes)	Pushes the specified Changes to the repository.
final CompletableFuture<PushResult>	push(String projectName, String repositoryName, Revision baseRevision, String summary, Change<?>... changes)	Pushes the specified Changes to the repository.
final CompletableFuture<PushResult>	push(String projectName, String repositoryName, Revision baseRevision, String summary, Iterable<? extends Change<?>> changes)	Pushes the specified Changes to the repository.
final CompletableFuture<PushResult>	push(String projectName, String repositoryName, Revision baseRevision, String summary, String detail, Markup markup, Change<?>... changes)	Pushes the specified Changes to the repository.
<T> Watcher<T>	repositoryWatcher(String projectName, String repositoryName, String pathPattern, Function<Revision,? extends T> function)	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:
<T> Watcher<T>	repositoryWatcher(String projectName, String repositoryName, String pathPattern, Function<Revision,? extends T> function, Executor executor)	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:

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.linecorp.centraldogma.client.CentralDogma

close, createProject, createRepository, fileWatcher, getDiff, getDiff, getDiffs, getFile, getFiles, getFiles, getHistory, getHistory, getHistory, getPreviewDiffs, listFiles, listFiles, listProjects, listRemovedProjects, listRemovedRepositories, listRepositories, mergeFiles, normalizeRevision, purgeProject, purgeRepository, push, push, removeProject, removeRepository, repositoryWatcher, unremoveProject, unremoveRepository, watchFile, watchFile, watchFile, watchRepository, watchRepository, watchRepository, whenEndpointReady

Constructor Details

AbstractCentralDogma

protected AbstractCentralDogma(ScheduledExecutorService blockingTaskExecutor)

Creates a new instance.

Parameters:

blockingTaskExecutor - the ScheduledExecutorService which will be used for scheduling the tasks related with automatic retries and invoking the callbacks for watched changes.

Method Details

executor

protected final ScheduledExecutorService executor()

Returns the ScheduledExecutorService which is used for scheduling the tasks related with automatic retries and invoking the callbacks for watched changes.

forRepo

public CentralDogmaRepository forRepo(String projectName,
 String repositoryName)

Description copied from interface: CentralDogma

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

Specified by:

forRepo in interface CentralDogma

getFile

public final CompletableFuture<Entry<?>> getFile(String projectName,
 String repositoryName,
 Revision revision,
 String path)

Description copied from interface: CentralDogma

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

Specified by:

getFile in interface CentralDogma

Returns:

the Entry at the given path

mergeFiles

public final CompletableFuture<MergedEntry<?>> mergeFiles(String projectName,
 String repositoryName,
 Revision revision,
 MergeSource... mergeSources)

Description copied from interface: CentralDogma

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.

Specified by:

mergeFiles in interface CentralDogma

Returns:

the MergedEntry which contains the result of the merge

mergeFiles

public final CompletableFuture<MergedEntry<?>> mergeFiles(String projectName,
 String repositoryName,
 Revision revision,
 Iterable<MergeSource> mergeSources)

Description copied from interface: CentralDogma

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.

Specified by:

mergeFiles in interface CentralDogma

Returns:

the MergedEntry which contains the result of the merge

getHistory

public final CompletableFuture<List<Commit>> getHistory(String projectName,
 String repositoryName,
 Revision from,
 Revision to)

Description copied from interface: CentralDogma

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 CentralDogma.getDiff(String, String, Revision, Revision, Query) or CentralDogma.getDiff(String, String, Revision, Revision, PathPattern) to retrieve the diffs.

Specified by:

getHistory in interface CentralDogma

Returns:

a List that contains the Commits of the specified repository

getDiff

public final CompletableFuture<Change<?>> getDiff(String projectName,
 String repositoryName,
 Revision from,
 Revision to,
 String path)

Description copied from interface: CentralDogma

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 CentralDogma.getDiff(String, String, Revision, Revision, Query) with Query.ofText(String) or Query.ofJson(String) if you already know the file type.

Specified by:

getDiff in interface CentralDogma

Returns:

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

getPreviewDiffs

public final CompletableFuture<List<Change<?>>> getPreviewDiffs(String projectName,
 String repositoryName,
 Revision baseRevision,
 Change<?>... changes)

Description copied from interface: CentralDogma

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.

Specified by:

getPreviewDiffs in interface CentralDogma

Returns:

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

push

public final CompletableFuture<PushResult> push(String projectName,
 String repositoryName,
 Revision baseRevision,
 String summary,
 Change<?>... changes)

Description copied from interface: CentralDogma

Pushes the specified Changes to the repository.

Specified by:

push in interface CentralDogma

Returns:

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

push

public final CompletableFuture<PushResult> push(String projectName,
 String repositoryName,
 Revision baseRevision,
 String summary,
 Iterable<? extends Change<?>> changes)

Description copied from interface: CentralDogma

Pushes the specified Changes to the repository.

Specified by:

push in interface CentralDogma

Returns:

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

push

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

Description copied from interface: CentralDogma

Pushes the specified Changes to the repository.

Specified by:

push in interface CentralDogma

Returns:

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

push

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

Description copied from interface: CentralDogma

Pushes the specified Changes to the repository.

Specified by:

push in interface CentralDogma

Returns:

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

push

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

Description copied from interface: CentralDogma

Pushes the specified Changes to the repository.

Specified by:

push in interface CentralDogma

Returns:

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

push

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

Description copied from interface: CentralDogma

Pushes the specified Changes to the repository.

Specified by:

push in interface CentralDogma

Returns:

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

fileWatcher

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

Description copied from interface: CentralDogma

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.

Specified by:

fileWatcher in interface CentralDogma

fileWatcher

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

Description copied from interface: CentralDogma

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;
     ...
 });

Specified by:

fileWatcher in interface CentralDogma

repositoryWatcher

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

Description copied from interface: CentralDogma

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.

Specified by:

repositoryWatcher in interface CentralDogma

repositoryWatcher

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

Description copied from interface: CentralDogma

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.

Specified by:

repositoryWatcher in interface CentralDogma

Parameters:

executor - the Executor that executes the Function

maybeNormalizeRevision

protected final CompletableFuture<Revision> maybeNormalizeRevision(String projectName,
 String repositoryName,
 Revision revision)

Normalizes the specified Revision only if it is a relative revision.

Returns:

the absolute Revision