com.sitewhere.spi.microservice.state.IMicroserviceDetails Maven / Gradle / Ivy

Go to download

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

SiteWhere Core API

The 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;

/**
 * Contains details that allow a microservice to be uniquely identified and
 * described.
 */
public interface IMicroserviceDetails {

    /**
     * Get unique identifier for microservice function.
     * 
     * @return
     */
    public String getIdentifier();

    /**
     * Get hostname for microservice.
     * 
     * @return
     */
    public String getHostname();

    /**
     * Get display name for microservice.
     * 
     * @return
     */
    public String getName();

    /**
     * Get icon for microservice.
     * 
     * @return
     */
    public String getIcon();

    /**
     * Get description for microservice.
     * 
     * @return
     */
    public String getDescription();

    /**
     * Indicates if microservice is global in scope.
     * 
     * @return
     */
    public boolean isGlobal();
}