com.sitewhere.spi.server.ISiteWhereTenantEngine Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sitewhere-server-api Show documentation
SiteWhere Server API
There is a newer version: 1.11.0
/*
 * 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.server;

import java.util.List;

import com.sitewhere.spi.SiteWhereException;
import com.sitewhere.spi.asset.IAssetManagement;
import com.sitewhere.spi.asset.IAssetModuleManager;
import com.sitewhere.spi.command.ICommandResponse;
import com.sitewhere.spi.configuration.IGlobalConfigurationResolver;
import com.sitewhere.spi.configuration.ITenantConfigurationResolver;
import com.sitewhere.spi.device.IDeviceManagement;
import com.sitewhere.spi.device.IDeviceManagementCacheProvider;
import com.sitewhere.spi.device.communication.IDeviceCommunication;
import com.sitewhere.spi.device.event.IEventProcessing;
import com.sitewhere.spi.scheduling.IScheduleManagement;
import com.sitewhere.spi.scheduling.IScheduleManager;
import com.sitewhere.spi.search.external.ISearchProviderManager;
import com.sitewhere.spi.server.lifecycle.ITenantLifecycleComponent;

/**
 * A SiteWhere tenant engine wraps up the processing pipeline and data storage for a
 * single SiteWhere tenant.
 * 
 * @author Derek
 */
public interface ISiteWhereTenantEngine extends ITenantLifecycleComponent {

	/**
	 * Get resolver for global configuration elements.
	 * 
	 * @return
	 */
	public IGlobalConfigurationResolver getGlobalConfigurationResolver();

	/**
	 * Get resolver for tenant configuration elements.
	 * 
	 * @return
	 */
	public ITenantConfigurationResolver getTenantConfigurationResolver();

	/**
	 * Get list of components that have registered to participate in the server component
	 * lifecycle.
	 * 
	 * @return
	 */
	public List getRegisteredLifecycleComponents();

	/**
	 * Get the device management implementation.
	 * 
	 * @return
	 */
	public IDeviceManagement getDeviceManagement();

	/**
	 * Get the asset management implementation.
	 * 
	 * @return
	 */
	public IAssetManagement getAssetManagement();

	/**
	 * Get the schedule management implementation.
	 * 
	 * @return
	 * @throws SiteWhereException
	 */
	public IScheduleManagement getScheduleManagement() throws SiteWhereException;

	/**
	 * Get the configured device management cache provider implementation.
	 * 
	 * @return
	 */
	public IDeviceManagementCacheProvider getDeviceManagementCacheProvider();

	/**
	 * Get the device communication subsystem implementation.
	 * 
	 * @return
	 */
	public IDeviceCommunication getDeviceCommunication();

	/**
	 * Get the event processing subsystem implementation.
	 * 
	 * @return
	 */
	public IEventProcessing getEventProcessing();

	/**
	 * Get the asset modules manager instance.
	 * 
	 * @return
	 */
	public IAssetModuleManager getAssetModuleManager();

	/**
	 * Get the search provider manager implementation.
	 * 
	 * @return
	 */
	public ISearchProviderManager getSearchProviderManager();

	/**
	 * Get the schedule manager implementation.
	 * 
	 * @return
	 * @throws SiteWhereException
	 */
	public IScheduleManager getScheduleManager() throws SiteWhereException;

	/**
	 * Get current runtime state of engine.
	 * 
	 * @return
	 */
	public ISiteWhereTenantEngineState getEngineState();

	/**
	 * Initialize the engine.
	 * 
	 * @return
	 * @throws SiteWhereException
	 */
	public boolean initialize() throws SiteWhereException;

	/**
	 * Issue a command to the tenant engine.
	 * 
	 * @param command
	 * @param maxWaitSeconds
	 * @return
	 * @throws SiteWhereException
	 */
	public ICommandResponse issueCommand(String command, int maxWaitSeconds) throws SiteWhereException;
}