io.activej.ot.uplink.OTUplink Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of activej-ot Show documentation

Implementation of operational transformation technology. Allows building collaborative software systems.

There is a newer version: 6.0-rc2

/*
 * Copyright (C) 2020 ActiveJ LLC.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.activej.ot.uplink;

import com.dslplatform.json.CompiledJson;
import com.dslplatform.json.JsonAttribute;
import io.activej.promise.Promise;

import java.util.List;

public interface OTUplink {

	@CompiledJson
	final class FetchData {
		private final K commitId;
		private final long level;
		private final List diffs;

		public FetchData(K commitId, long level, List diffs) {
			this.commitId = commitId;
			this.level = level;
			this.diffs = diffs;
		}

		@JsonAttribute(name = "id")
		public K getCommitId() {
			return commitId;
		}

		public long getLevel() {
			return level;
		}

		public List getDiffs() {
			return diffs;
		}
	}

	Promise> checkout();

	Promise> fetch(K currentCommitId);

	default Promise> poll(K currentCommitId) {
		return fetch(currentCommitId);
	}

	Promise createProtoCommit(K parent, List diffs, long parentLevel);

	Promise> push(PC protoCommit);

}