Package com.inductiveautomation.ignition.gateway.config

Class DefaultResourceRouteDelegate<R>

java.lang.Object

com.inductiveautomation.ignition.gateway.config.DefaultResourceRouteDelegate<R>

All Implemented Interfaces:

ResourceRouteDelegate<R>

public class DefaultResourceRouteDelegate<R>
extends Object
implements ResourceRouteDelegate<R>

Standard, builder-supported implementation of ResourceRouteDelegate. Can be built for standard resource types or extension point resource types.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultResourceRouteDelegate.Builder<R>
static class	DefaultResourceRouteDelegate.ExtensionPointBuilder<P extends ExtensionPointProfileConfig>

Nested classes/interfaces inherited from interface com.inductiveautomation.ignition.gateway.config.ResourceRouteDelegate

ResourceRouteDelegate.ApiCapability

Field Summary

Fields

Modifier and Type	Field	Description
protected final JsonResourceCodec<R>	codec
protected final com.inductiveautomation.ignition.common.gson.JsonObject	configSchema
protected final Map<String,Function<R,Object>>	fieldResolvers
protected final String	openApiGroupName
protected final String	openApiTagName
protected final PermissionType	readPermission
protected final Set<ResourceRouteDelegate.ApiCapability>	resourceActionSet
protected final Set<String>	searchFields
protected final PermissionType	writePermission

Constructor Summary

Constructors

Constructor	Description
DefaultResourceRouteDelegate(JsonResourceCodec<R> codec, Set<ResourceRouteDelegate.ApiCapability> resourceActionSet, String openApiGroupName, String openApiTagName, com.inductiveautomation.ignition.common.gson.JsonObject configSchema, Map<String,Function<R,Object>> fieldResolvers, Set<String> searchFields, PermissionType readPermission, PermissionType writePermission)

Method Summary

Modifier and Type	Method	Description
Optional<Object>	findFieldValue(R resource, String field)	Attempts to find the value of a named field for a resource instance.
@NotNull Set<ResourceRouteDelegate.ApiCapability>	getCapabilities()	A declarative set of supported actions for the REST API subsystem.
JsonResourceCodec<R>	getCodec()	Get the JsonResourceCodec used by the automatically created resource type routes to encode and decode resources of this type.
com.inductiveautomation.ignition.common.gson.JsonObject	getConfigSchema()
Optional<String>	getOpenApiGroupName()
Optional<String>	getOpenApiTagName()
PermissionType	getReadPermission()
Set<String>	getSearchFields()
PermissionType	getWritePermission()
static <R> DefaultResourceRouteDelegate.Builder<R>	newBuilder(JsonResourceCodec<R> codec)
static <P extends ExtensionPointProfileConfig> DefaultResourceRouteDelegate.ExtensionPointBuilder<P>	newExtensionPointBuilder(ResourceType resourceType, JsonResourceCodec<ExtensionPointConfig<P,?>> codec, ExtensionPointCollection<? extends ExtensionPoint<?>> extensionPointCollection)

Methods inherited from class java.lang.Object

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

Field Details

codec

protected final JsonResourceCodec<R> codec

resourceActionSet

protected final Set<ResourceRouteDelegate.ApiCapability> resourceActionSet

openApiGroupName

protected final String openApiGroupName

openApiTagName

protected final String openApiTagName

configSchema

protected final com.inductiveautomation.ignition.common.gson.JsonObject configSchema

fieldResolvers

protected final Map<String,Function<R,Object>> fieldResolvers

searchFields

protected final Set<String> searchFields

readPermission

protected final PermissionType readPermission

writePermission

protected final PermissionType writePermission

Constructor Details

DefaultResourceRouteDelegate

public DefaultResourceRouteDelegate(JsonResourceCodec<R> codec,
 Set<ResourceRouteDelegate.ApiCapability> resourceActionSet,
 @Nullable
 String openApiGroupName,
 @Nullable
 String openApiTagName,
 @Nullable
 com.inductiveautomation.ignition.common.gson.JsonObject configSchema,
 Map<String,Function<R,Object>> fieldResolvers,
 Set<String> searchFields,
 PermissionType readPermission,
 PermissionType writePermission)

Method Details

getConfigSchema

public com.inductiveautomation.ignition.common.gson.JsonObject getConfigSchema()

Specified by:

getConfigSchema in interface ResourceRouteDelegate<R>

getCapabilities

@NotNull
public @NotNull Set<ResourceRouteDelegate.ApiCapability> getCapabilities()

Description copied from interface: ResourceRouteDelegate

A declarative set of supported actions for the REST API subsystem. Note that you must both declare a capability and an implementation backing it (ResourceTypeMeta.getResourceActionSet()) for a route to ultimately be exposed.

Specified by:

getCapabilities in interface ResourceRouteDelegate<R>

See Also:

• ResourceRouteDelegate.ApiCapability

getOpenApiGroupName

public Optional<String> getOpenApiGroupName()

Specified by:

getOpenApiGroupName in interface ResourceRouteDelegate<R>

getOpenApiTagName

public Optional<String> getOpenApiTagName()

Specified by:

getOpenApiTagName in interface ResourceRouteDelegate<R>

findFieldValue

public Optional<Object> findFieldValue(R resource,
 String field)

Description copied from interface: ResourceRouteDelegate

Attempts to find the value of a named field for a resource instance. Used by the route system for filtering and sorting. Default implementation looks for top-level keys in the configuration JSON object.

Specified by:

findFieldValue in interface ResourceRouteDelegate<R>

getSearchFields

public Set<String> getSearchFields()

Specified by:

getSearchFields in interface ResourceRouteDelegate<R>

Returns:

the set of fields that can be searched on for this resource type. See RouteGroup.ListRouteMounter.searchFields(Set)

getCodec

public JsonResourceCodec<R> getCodec()

Description copied from interface: ResourceRouteDelegate

Get the JsonResourceCodec used by the automatically created resource type routes to encode and decode resources of this type.

Specified by:

getCodec in interface ResourceRouteDelegate<R>

Returns:

The JsonResourceCodec that can be used to encode and decode resources of this type between their serialized Resource form, and the configuration object form represented by <R>

getReadPermission

public PermissionType getReadPermission()

Specified by:

getReadPermission in interface ResourceRouteDelegate<R>

Returns:

the permission type required to read this resource type. Default is READ.

getWritePermission

public PermissionType getWritePermission()

Specified by:

getWritePermission in interface ResourceRouteDelegate<R>

Returns:

the permission type required to write to this resource type. Default is WRITE.

newBuilder

public static <R>
DefaultResourceRouteDelegate.Builder<R> newBuilder(JsonResourceCodec<R> codec)

Type Parameters:

R - The config object type of the resource

Returns:

A new builder for creating a DefaultResourceRouteDelegate for a standard resource type

newExtensionPointBuilder

public static <P extends ExtensionPointProfileConfig>
DefaultResourceRouteDelegate.ExtensionPointBuilder<P> newExtensionPointBuilder(ResourceType resourceType,
 JsonResourceCodec<ExtensionPointConfig<P,?>> codec,
 ExtensionPointCollection<? extends ExtensionPoint<?>> extensionPointCollection)

Type Parameters:

P - The ExtensionPointProfileConfig type of the extension point category.

Returns:

A new builder for creating a DefaultResourceRouteDelegate for an extension point resource type.