Package com.inductiveautomation.perspective.gateway.assets.icons

Class IconManagerImpl

java.lang.Object

com.inductiveautomation.ignition.common.lifecycle.AbstractLifecycle

com.inductiveautomation.ignition.gateway.config.NamedResourceHandler<IconLibraryConfig>

com.inductiveautomation.perspective.gateway.assets.icons.IconManagerImpl

All Implemented Interfaces:

Lifecycle, IconManager

public class IconManagerImpl
extends NamedResourceHandler<IconLibraryConfig>
implements IconManager

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	IconManagerImpl.IconLibrary

Nested classes/interfaces inherited from class com.inductiveautomation.ignition.gateway.config.NamedResourceHandler

NamedResourceHandler.Builder<R>

Field Summary

Fields

Modifier and Type	Field	Description
static final ResourceType	RESOURCE_TYPE
static final ResourceTypeMeta<IconLibraryConfig>	RESOURCE_TYPE_META

Fields inherited from class com.inductiveautomation.ignition.gateway.config.NamedResourceHandler

configManager, logger, meta

Constructor Summary

Constructors

Constructor	Description
IconManagerImpl(PerspectiveContext perspectiveContext)

Method Summary

Modifier and Type	Method	Description
Optional<com.inductiveautomation.ignition.common.gson.JsonObject>	digests()
Optional<String>	getLibDigest(String libraryKey)
Map<String,List<String>>	getLibraries()	Fetch a map of all icon library names and their respective icon names
Optional<String>	getLibrary(String libraryName)	Fetch the raw icon library as an SVG String
void	migrate()
protected void	onInitialResources(List<DecodedResource<IconLibraryConfig>> decodedResources)	Called once at startup with the resource that are already present in the configuration collection.
protected void	onResourceAdded(DecodedResource<IconLibraryConfig> res)	Called once per each resource that is added.
protected void	onResourceRemoved(DecodedResource<IconLibraryConfig> removedResource)	Called for resources that are removed (or updated and then fail to parse).
protected void	onResourcesUpdated(List<DecodedResource<IconLibraryConfig>> decodedResources)	Called each time the overall set of resources changes in any way.
protected void	onResourceUpdated(ModifiedResource<IconLibraryConfig> res)	Called once per each resource that is updated.
void	setup()

Methods inherited from class com.inductiveautomation.ignition.gateway.config.NamedResourceHandler

create, create, create, decode, delete, delete, filter, findResource, getResources, isCaseSensitive, isRenameAware, modify, modify, modify, newBuilder, newUuid, onShutdown, onStartup, renameAndModify, renameAndModify, renameAndModify, renameAndModify

Methods inherited from class com.inductiveautomation.ignition.common.lifecycle.AbstractLifecycle

isRunning, shutdown, startup

Methods inherited from class java.lang.Object

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

Field Details

RESOURCE_TYPE

public static final ResourceType RESOURCE_TYPE

RESOURCE_TYPE_META

public static final ResourceTypeMeta<IconLibraryConfig> RESOURCE_TYPE_META

Constructor Details

IconManagerImpl

public IconManagerImpl(@Nonnull
 PerspectiveContext perspectiveContext)

Method Details

migrate

public void migrate()
             throws MigrationException

Throws:

MigrationException

setup

public void setup()

onInitialResources

protected void onInitialResources(List<DecodedResource<IconLibraryConfig>> decodedResources)

Description copied from class: NamedResourceHandler

Called once at startup with the resource that are already present in the configuration collection.

Overrides:

onInitialResources in class NamedResourceHandler<IconLibraryConfig>

onResourceAdded

protected void onResourceAdded(DecodedResource<IconLibraryConfig> res)

Description copied from class: NamedResourceHandler

Called once per each resource that is added.

Overrides:

onResourceAdded in class NamedResourceHandler<IconLibraryConfig>

onResourceUpdated

protected void onResourceUpdated(ModifiedResource<IconLibraryConfig> res)

Description copied from class: NamedResourceHandler

Called once per each resource that is updated.

Note that whether "rename" events are considered "updates" or "removes" and "adds" is determined by NamedResourceHandler.isRenameAware().

Overrides:

onResourceUpdated in class NamedResourceHandler<IconLibraryConfig>

onResourceRemoved

protected void onResourceRemoved(DecodedResource<IconLibraryConfig> removedResource)

Description copied from class: NamedResourceHandler

Called for resources that are removed (or updated and then fail to parse).

Overrides:

onResourceRemoved in class NamedResourceHandler<IconLibraryConfig>

onResourcesUpdated

protected void onResourcesUpdated(List<DecodedResource<IconLibraryConfig>> decodedResources)

Description copied from class: NamedResourceHandler

Called each time the overall set of resources changes in any way. Called after added, updated, and removed are called.

Overrides:

onResourcesUpdated in class NamedResourceHandler<IconLibraryConfig>

getLibraries

@Nonnull
public Map<String,List<String>> getLibraries()

Description copied from interface: IconManager

Fetch a map of all icon library names and their respective icon names

Specified by:

getLibraries in interface IconManager

Returns:

The map of all icon library names and their respective icon names

digests

public Optional<com.inductiveautomation.ignition.common.gson.JsonObject> digests()

getLibrary

@Nonnull
public Optional<String> getLibrary(@Nullable
 String libraryName)

Description copied from interface: IconManager

Fetch the raw icon library as an SVG String

Specified by:

getLibrary in interface IconManager

Parameters:

libraryName - The name of the icon library to fetch

Returns:

An optional String whose contents are an SVG containing the library's icons, or an empty Optional if an icon library with the given name does not exist

getLibDigest

public Optional<String> getLibDigest(String libraryKey)