com.sitewhere.spi.microservice.lifecycle.ILifecycleComponent 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
The newest version!
/**
 * Copyright © 2014-2021 The SiteWhere Authors
 *
 * 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 com.sitewhere.spi.microservice.lifecycle;

import java.util.Date;
import java.util.List;
import java.util.Map;
import java.util.UUID;

import org.slf4j.cal10n.LocLogger;

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

/**
 * Lifecycle methods used in SiteWhere components.
 */
public interface ILifecycleComponent {

    /**
     * Get the unique component id.
     * 
     * @return
     */
    UUID getComponentId();

    /**
     * Get human-readable name shown for component.
     * 
     * @return
     */
    String getComponentName();

    /**
     * Get component type.
     * 
     * @return
     */
    LifecycleComponentType getComponentType();

    /**
     * Get microservice that owns the component.
     * 
     * @return
     */
    IMicroservice getMicroservice();

    /**
     * Set microservice that owns the component.
     * 
     * @param microservice
     */
    void setMicroservice(
	    IMicroservice microservice);

    /**
     * Get current lifecycle status.
     * 
     * @return
     */
    LifecycleStatus getLifecycleStatus();

    /**
     * Gets the last lifecycle error that occurred.
     * 
     * @return
     */
    SiteWhereException getLifecycleError();

    /**
     * Overridden in subclasses to initialize parameters.
     * 
     * @throws SiteWhereException
     */
    void initializeParameters() throws SiteWhereException;

    /**
     * Get map of contained {@link ILifecycleComponent} elements by unique id.
     * 
     * @return
     */
    Map getLifecycleComponents();

    /**
     * Provisions the component and any nested components.
     * 
     * @param monitor
     * @throws SiteWhereException
     */
    void lifecycleProvision(ILifecycleProgressMonitor monitor) throws SiteWhereException;

    /**
     * Provision the component.
     * 
     * @param monitor
     * @throws SiteWhereException
     */
    void provision(ILifecycleProgressMonitor monitor) throws SiteWhereException;

    /**
     * Initializes the component while keeping up with lifeycle information.
     * 
     * @param monitor
     */
    void lifecycleInitialize(ILifecycleProgressMonitor monitor);

    /**
     * Indicates to framework whether component can be initialized.
     * 
     * @return
     * @throws SiteWhereException
     */
    boolean canInitialize() throws SiteWhereException;

    /**
     * Initialize the component.
     * 
     * @param monitor
     * @throws SiteWhereException
     */
    void initialize(ILifecycleProgressMonitor monitor) throws SiteWhereException;

    /**
     * Initialize a nested component.
     * 
     * @param component
     * @param monitor
     * @param require
     * @throws SiteWhereException
     */
    void initializeNestedComponent(ILifecycleComponent component, ILifecycleProgressMonitor monitor, boolean require)
	    throws SiteWhereException;

    /**
     * Starts the component while keeping up with lifecycle information.
     */
    void lifecycleStart(ILifecycleProgressMonitor monitor);

    /**
     * Indicates to framework whether component can be started.
     * 
     * @return
     * @throws SiteWhereException
     */
    boolean canStart() throws SiteWhereException;

    /**
     * Start the component.
     * 
     * @throws SiteWhereException
     */
    void start(ILifecycleProgressMonitor monitor) throws SiteWhereException;

    /**
     * Start component as a nested lifecycle component.
     * 
     * @param component
     * @param monitor
     * @param require
     * @throws SiteWhereException
     */
    void startNestedComponent(ILifecycleComponent component, ILifecycleProgressMonitor monitor, boolean require)
	    throws SiteWhereException;

    /**
     * Pauses the component while keeping up with lifecycle information.
     */
    void lifecyclePause(ILifecycleProgressMonitor monitor);

    /**
     * Indicates to framework whether component can be paused.
     * 
     * @return
     * @throws SiteWhereException
     */
    boolean canPause() throws SiteWhereException;

    /**
     * Pause the component.
     * 
     * @throws SiteWhereException
     */
    void pause(ILifecycleProgressMonitor monitor) throws SiteWhereException;

    /**
     * Stops the component while keeping up with lifecycle information.
     * 
     * @param monitor
     */
    void lifecycleStop(ILifecycleProgressMonitor monitor);

    /**
     * Stops the component while keeping up with lifecycle information. This version
     * allows constraints to be passed to the operation.
     * 
     * @param monitor
     * @param constraints
     */
    void lifecycleStop(ILifecycleProgressMonitor monitor, ILifecycleConstraints constraints);

    /**
     * Indicates to framework whether component can be stopped.
     * 
     * @return
     * @throws SiteWhereException
     */
    boolean canStop() throws SiteWhereException;

    /**
     * Stop the component.
     * 
     * @throws SiteWhereException
     */
    void stop(ILifecycleProgressMonitor monitor) throws SiteWhereException;

    /**
     * Stop the component. This version allows constraints to be passed to the
     * operation.
     * 
     * @throws SiteWhereException
     */
    void stop(ILifecycleProgressMonitor monitor, ILifecycleConstraints constraints) throws SiteWhereException;

    /**
     * Stop a nested lifecycle component.
     * 
     * @param component
     * @param monitor
     * @throws SiteWhereException
     */
    void stopNestedComponent(ILifecycleComponent component, ILifecycleProgressMonitor monitor)
	    throws SiteWhereException;

    /**
     * Terminates the component while keeping up with lifecycle information.
     * 
     * @param monitor
     */
    void lifecycleTerminate(ILifecycleProgressMonitor monitor);

    /**
     * Terminate the component.
     * 
     * @throws SiteWhereException
     */
    void terminate(ILifecycleProgressMonitor monitor) throws SiteWhereException;

    /**
     * Called to track component lifecycle changes.
     * 
     * @param before
     * @param after
     */
    void lifecycleStatusChanged(LifecycleStatus before, LifecycleStatus after);

    /**
     * Find components (including this component and nested components) that are of
     * the given type.
     * 
     * @param type
     * @return
     * @throws SiteWhereException
     */
    List findComponentsOfType(LifecycleComponentType type) throws SiteWhereException;

    /**
     * Get date the component was created.
     * 
     * @return
     */
    Date getCreatedDate();

    /**
     * Get component logger.
     * 
     * @return
     */
    LocLogger getLogger();
}