Package com.inductiveautomation.perspective.gateway.cache

Class PerspectiveProjectCacheImpl

java.lang.Object

com.inductiveautomation.perspective.gateway.cache.PerspectiveProjectCacheImpl

All Implemented Interfaces:

PerspectiveProjectCache

public class PerspectiveProjectCacheImpl
extends java.lang.Object
implements PerspectiveProjectCache

Constructor Summary

Constructors

Constructor	Description
PerspectiveProjectCacheImpl(GatewayContext gatewayContext, ComponentRegistry componentRegistry)

Method Summary

Modifier and Type	Method	Description
java.util.Optional<PerspectiveProject>	get(java.lang.String projectName)	Fetch the PerspectiveProject with the given name from the cache.
java.util.List<PerspectiveProjectDisplayData>	getAll()	Fetches all PerspectiveProject on the gateway and returns them as a list of PerspectiveProjectDisplayData
java.util.Optional<ProjectUpdateResponse>	getDiff(java.lang.String projectName, RuntimeProject.EffectiveProjectSnapshot snapshot)
java.util.List<PerspectiveProjectDisplayData>	getDisplayable()	Fetches all Runnable and displayable PerspectiveProjects on the gateway and returns them as a list of PerspectiveProjectDisplayData
com.google.common.eventbus.EventBus	getEventBus()	Fetch the EventBus for this PerspectiveProjectCache.
void	shutdown()
void	startup()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PerspectiveProjectCacheImpl

public PerspectiveProjectCacheImpl(GatewayContext gatewayContext,
                                   ComponentRegistry componentRegistry)

Method Detail

startup

public void startup()

shutdown

public void shutdown()

getEventBus

@Nonnull
public com.google.common.eventbus.EventBus getEventBus()

Description copied from interface: PerspectiveProjectCache

Fetch the EventBus for this PerspectiveProjectCache. Interested parties may Subscribe to receive ProjectUpdatedEvents when projects are updated, and ProjectDeletedEvents when projects are deleted.

Specified by:

getEventBus in interface PerspectiveProjectCache

Returns:

The event bus

get

@Nonnull
public java.util.Optional<PerspectiveProject> get(java.lang.String projectName)

Description copied from interface: PerspectiveProjectCache

Fetch the PerspectiveProject with the given name from the cache. If the cache does not have the entry, it will attempt to load from the ProjectManager or another source of record. If the ProjectManager does not have the entry, Optional.empty is returned since this means the project does not exist.

Specified by:

get in interface PerspectiveProjectCache

Returns:

An Optional containing the PerspectiveProject with the given name or an empty Optional if it does not exist or a problem occurred fetching it

getAll

@Nonnull
public java.util.List<PerspectiveProjectDisplayData> getAll()

Description copied from interface: PerspectiveProjectCache

Fetches all PerspectiveProject on the gateway and returns them as a list of PerspectiveProjectDisplayData

Specified by:

getAll in interface PerspectiveProjectCache

getDisplayable

@Nonnull
public java.util.List<PerspectiveProjectDisplayData> getDisplayable()

Description copied from interface: PerspectiveProjectCache

Fetches all Runnable and displayable PerspectiveProjects on the gateway and returns them as a list of PerspectiveProjectDisplayData

Specified by:

getDisplayable in interface PerspectiveProjectCache

getDiff

public java.util.Optional<ProjectUpdateResponse> getDiff(java.lang.String projectName,
                                                         RuntimeProject.EffectiveProjectSnapshot snapshot)

Specified by:

getDiff in interface PerspectiveProjectCache

Parameters:

projectName - Name of the (leaf) project to diff.

snapshot - The effective snapshot of the copy of the project that you already have.

Returns:

A perspective project diff containing the things that have changed since the given snapshot was generated. Empty optional if the project doesn't exist.