Package com.inductiveautomation.perspective.common

Class PerspectiveModule

java.lang.Object

com.inductiveautomation.perspective.common.PerspectiveModule

public class PerspectiveModule
extends Object

Contains common configuration and const definitions for things like module ID, and also provides a registry for components.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PerspectiveModule.LocationConstants
static class	PerspectiveModule.WellKnownIds

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DESIGNER_SESSION_ID_HEADER	Header the Gateway reads to associate a request with the shared Designer session.
static final String	LOG_PREFIX
static final JsonSchema	META_SCHEMA
static final String	MODULE_ID
static final JsonSchema	SESSION_PROPS_SCHEMA
static final JsonSchema	VIEW_SCHEMA

Constructor Summary

Constructors

Constructor	Description
PerspectiveModule()

Method Summary

Modifier and Type	Method	Description
static @NonNull com.inductiveautomation.ignition.common.gson.Gson	createPerspectiveCompatibleGson()	Creates a Gson instance with the correct type adapters registered to serialize and deserialize views
static @NonNull com.inductiveautomation.ignition.common.gson.Gson	createPerspectiveCompatibleGson(Consumer<com.inductiveautomation.ignition.common.gson.GsonBuilder> customize)	Creates a Gson instance with the correct type adapters registered to serialize and deserialize views
static com.inductiveautomation.ignition.common.gson.JsonObject	defaultMetaProps()
static com.inductiveautomation.ignition.common.gson.JsonObject	defaultSessionProps()
static com.inductiveautomation.ignition.common.gson.JsonObject	defaultViewProps()
static LoggerEx	getLogger(String name)

Methods inherited from class java.lang.Object

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

Field Details

MODULE_ID

public static final String MODULE_ID

See Also:

• Constant Field Values

LOG_PREFIX

public static final String LOG_PREFIX

See Also:

• Constant Field Values

DESIGNER_SESSION_ID_HEADER

public static final String DESIGNER_SESSION_ID_HEADER

Header the Gateway reads to associate a request with the shared Designer session.

A request carrying this header is given SessionScope.Designer, so the Gateway must verify that the value resolves to a session which is genuinely a Designer session and is still valid before honoring it. Any live session id -- including one minted by a Vision client login -- otherwise reaches Designer scope.

See Also:

• Constant Field Values

SESSION_PROPS_SCHEMA

public static final JsonSchema SESSION_PROPS_SCHEMA

VIEW_SCHEMA

public static final JsonSchema VIEW_SCHEMA

META_SCHEMA

public static final JsonSchema META_SCHEMA

Constructor Details

PerspectiveModule

public PerspectiveModule()

Method Details

getLogger

public static LoggerEx getLogger(String name)

createPerspectiveCompatibleGson

public static @NonNull com.inductiveautomation.ignition.common.gson.Gson createPerspectiveCompatibleGson()

Creates a Gson instance with the correct type adapters registered to serialize and deserialize views

createPerspectiveCompatibleGson

public static @NonNull com.inductiveautomation.ignition.common.gson.Gson createPerspectiveCompatibleGson(Consumer<com.inductiveautomation.ignition.common.gson.GsonBuilder> customize)

Creates a Gson instance with the correct type adapters registered to serialize and deserialize views

defaultMetaProps

public static com.inductiveautomation.ignition.common.gson.JsonObject defaultMetaProps()

Returns:

the default object parsed from the common meta-schema resource.

defaultViewProps

public static com.inductiveautomation.ignition.common.gson.JsonObject defaultViewProps()

Returns:

the default object parsed from the common view-props-schema resource.

defaultSessionProps

public static com.inductiveautomation.ignition.common.gson.JsonObject defaultSessionProps()

Returns:

the default object parsed from the common session-props schema resource.