com.sitewhere.spi.microservice.state.ILifecycleComponentState 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.state;

import java.util.List;
import java.util.UUID;

import com.sitewhere.spi.microservice.lifecycle.LifecycleStatus;

/**
 * Captures state information for a lifecycle component.
 */
public interface ILifecycleComponentState {

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

    /**
     * Get component name.
     * 
     * @return
     */
    String getComponentName();

    /**
     * Get component status.
     * 
     * @return
     */
    LifecycleStatus getStatus();

    /**
     * Get error stack.
     * 
     * @return
     */
    List getErrorStack();

    /**
     * Get state for child components.
     * 
     * @return
     */
    List getChildComponentStates();
}