com.sitewhere.spi.microservice.instance.IInstanceStatusUpdateOperation Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sitewhere-microservice Show documentation

SiteWhere Microservice Components Library

There is a newer version: 3.0.13

Show newest version

/*
 * Copyright (c) SiteWhere, LLC. All rights reserved. http://www.sitewhere.com
 *
 * The software in this package is published under the terms of the CPAL v1.0
 * license, a copy of which has been included with this distribution in the
 * LICENSE.txt file.
 */
package com.sitewhere.spi.microservice.instance;

import com.sitewhere.spi.SiteWhereException;
import com.sitewhere.spi.microservice.IMicroservice;

import io.sitewhere.k8s.crd.instance.SiteWhereInstance;
import io.sitewhere.k8s.crd.instance.SiteWhereInstanceStatus;

/**
 * Operation that mutates the SiteWhere instance resource status.
 */
public interface IInstanceStatusUpdateOperation {

    /**
     * Executes the operation in the context of the given microservice.
     * 
     * @param microservice
     * @return
     * @throws SiteWhereException
     */
    SiteWhereInstance execute(IMicroservice microservice) throws SiteWhereException;

    /**
     * Makes an update to the current instance status.
     * 
     * @param current
     * @throws SiteWhereException
     */
    void update(SiteWhereInstanceStatus current) throws SiteWhereException;
}