com.instaclustr.operations.Operation Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of commons Show documentation
Common classes and utilities integrated with various projects
There is a newer version: 2.0.0
package com.instaclustr.operations;

import static java.lang.String.format;

import javax.inject.Inject;
import java.io.Closeable;
import java.time.Instant;
import java.util.EnumSet;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
import java.util.UUID;
import java.util.concurrent.atomic.AtomicBoolean;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import com.fasterxml.jackson.annotation.JsonTypeInfo.As;
import com.fasterxml.jackson.annotation.JsonUnwrapped;
import com.fasterxml.jackson.databind.annotation.JsonTypeIdResolver;
import com.google.common.base.MoreObjects;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

@SuppressWarnings("WeakerAccess")
@JsonTypeInfo(use = JsonTypeInfo.Id.CUSTOM, property = "type", include = As.EXISTING_PROPERTY)
@JsonTypeIdResolver(Operation.TypeIdResolver.class)
public abstract class Operation implements Runnable, Closeable {

    private static final Logger logger = LoggerFactory.getLogger(Operation.class);

    @JsonIgnore
    private final AtomicBoolean shouldCancel = new AtomicBoolean(false);

    @JsonProperty
    public String type;

    public static class TypeIdResolver extends MapBackedTypeIdResolver {

        public TypeIdResolver() {
            this(new HashMap<>());
        }

        @Inject
        public TypeIdResolver(final Map> typeMappings) {
            super(typeMappings);
        }
    }

    public enum State {
        PENDING, RUNNING, COMPLETED, CANCELLED, FAILED;

        public static Set TERMINAL_STATES = EnumSet.of(COMPLETED, FAILED, CANCELLED);

        public boolean isTerminalState() {
            return TERMINAL_STATES.contains(this);
        }
    }

    public UUID id = UUID.randomUUID();
    public Instant creationTime = Instant.now();

    @JsonUnwrapped // embed the request parameters in the serialized output directly
    @JsonProperty(access = JsonProperty.Access.READ_ONLY) // added so unwrap works ok with JsonCreator
    public RequestT request;

    public State state = State.PENDING;
    public Throwable failureCause;
    public float progress = 0;
    public Instant startTime, completionTime;

    public Operation(final RequestT request) {
        this.request = request;
    }

    protected Operation(final String type,
                        final UUID id,
                        final Instant creationTime,
                        final State state,
                        final Throwable failureCause,
                        final float progress,
                        final Instant startTime,
                        final RequestT request) {
        this.id = id;
        this.creationTime = creationTime;
        this.state = state;
        this.failureCause = failureCause;
        this.progress = progress;
        this.startTime = startTime;
        this.request = request;
        this.type = type;
    }

    @Override
    public final void run() {
        state = State.RUNNING;
        startTime = Instant.now();

        try {
            run0();
            progress = 1;
            state = State.COMPLETED;

        } catch (final Throwable t) {
            if (shouldCancel.get()) {
                logger.warn("Operation %s was cancelled.");
                state = State.CANCELLED;
            } else {
                logger.error(format("Operation %s has failed.", id), t);
                state = State.FAILED;
                failureCause = t;
            }
        } finally {
            completionTime = Instant.now();
        }
    }

    protected abstract void run0() throws Exception;

    public void close() {
        shouldCancel.set(true);
    }

    public AtomicBoolean getShouldCancel() {
        return shouldCancel;
    }

    @Override
    public String toString() {
        return MoreObjects.toStringHelper(this)
            .add("id", id)
            .add("creationTime", creationTime)
            .add("request", request)
            .add("state", state)
            .add("failureCause", failureCause)
            .add("progress", progress)
            .add("startTime", startTime)
            .add("shouldCancel", shouldCancel.get())
            .toString();
    }
}