Package com.inductiveautomation.ignition.gateway.config

Class DefaultResourceRouteDelegate.Builder<R>

java.lang.Object

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

Enclosing class:

DefaultResourceRouteDelegate<R>

public static class DefaultResourceRouteDelegate.Builder<R>
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder(JsonResourceCodec<R> codec)

Method Summary

Modifier and Type	Method	Description
DefaultResourceRouteDelegate.Builder<R>	addField(String fieldName, Function<R,Object> resolver)
DefaultResourceRouteDelegate.Builder<R>	addSearchField(String fieldName)	Adds a field to the searchable fields set.
ResourceRouteDelegate<R>	build()
DefaultResourceRouteDelegate.Builder<R>	buildCapabilitySet(@NotNull Consumer<Set<ResourceRouteDelegate.ApiCapability>> capabilitySetBuilder)	Builds a ResourceActionSet using the provided builder.
DefaultResourceRouteDelegate.Builder<R>	codec(JsonResourceCodec<R> codec)	Sets the JsonResourceCodec for the route delegate.
DefaultResourceRouteDelegate.Builder<R>	codec(UnaryOperator<JsonResourceCodec<R>> codecWrapper)	Wraps the JsonResourceCodec for the route delegate.
DefaultResourceRouteDelegate.Builder<R>	configSchema(com.inductiveautomation.ignition.common.gson.JsonObject configSchema)	Supply a JSON schema for the configuration of this resource type.
DefaultResourceRouteDelegate.Builder<R>	configSchema(Class<?> configClass)	Provide the JSON schema for the configuration by reflectively examining the record class.
DefaultResourceRouteDelegate.Builder<R>	configSchema(Consumer<SchemaUtil.Builder> builderConsumer)	Build a JSON schema for the configuration of this resource type.
DefaultResourceRouteDelegate.Builder<R>	openApiGroupName(String openApiGroupName)
DefaultResourceRouteDelegate.Builder<R>	openApiTagName(String openApiTagName)
DefaultResourceRouteDelegate.Builder<R>	readPermission(PermissionType readPermission)	Sets the permission type required to read this resource type.
DefaultResourceRouteDelegate.Builder<R>	setSearchFields(Set<String> searchFields)	Calling this method will set (and overwrite) the searchable fields set.
DefaultResourceRouteDelegate.Builder<R>	supportsExtraDataFiles(boolean supportsExtraDataFiles)	Indicates whether this resource expects any "extra" data files beyond "config.json".
DefaultResourceRouteDelegate.Builder<R>	withCapabilitySet(@NotNull Set<ResourceRouteDelegate.ApiCapability> capabilities)	Provide a constructed ResourceActionSet defining the capabilities this resource exposes to the REST API.
DefaultResourceRouteDelegate.Builder<R>	writePermission(PermissionType writePermission)	Sets the permission type required to write to this resource type.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(JsonResourceCodec<R> codec)

Method Details

codec

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

Sets the JsonResourceCodec for the route delegate. This is optional, and only should be used if you have a custom codec that you want to use for encoding and decoding resources via REST API. Must not be null.

codec

public DefaultResourceRouteDelegate.Builder<R> codec(UnaryOperator<JsonResourceCodec<R>> codecWrapper)

Wraps the JsonResourceCodec for the route delegate. This is optional, and only should be used if you have a custom codec that you want to use for encoding and decoding resources via REST API. Must not be null.

Parameters:

codecWrapper - the codec wrapper Function whose input is the currently installed codec and the output should be the wrapped codec

Returns:

this DefaultResourceRouteDelegate.Builder instance

configSchema

public DefaultResourceRouteDelegate.Builder<R> configSchema(com.inductiveautomation.ignition.common.gson.JsonObject configSchema)

Supply a JSON schema for the configuration of this resource type. Use this overload if you have built the schema already.

configSchema

public DefaultResourceRouteDelegate.Builder<R> configSchema(Consumer<SchemaUtil.Builder> builderConsumer)

Build a JSON schema for the configuration of this resource type. Use this overload if you want to build the schema programmatically.

configSchema

public DefaultResourceRouteDelegate.Builder<R> configSchema(Class<?> configClass)

Provide the JSON schema for the configuration by reflectively examining the record class. This is useful when the configuration is a record type.

supportsExtraDataFiles

public DefaultResourceRouteDelegate.Builder<R> supportsExtraDataFiles(boolean supportsExtraDataFiles)

Indicates whether this resource expects any "extra" data files beyond "config.json". Default is false.

See Also:

• ResourceRouteDelegate.ApiCapability.DATA_FILE_CAPABILITIES

withCapabilitySet

public DefaultResourceRouteDelegate.Builder<R> withCapabilitySet(@NotNull
 @NotNull Set<ResourceRouteDelegate.ApiCapability> capabilities)

Provide a constructed ResourceActionSet defining the capabilities this resource exposes to the REST API.

Throws:

IllegalStateException - if buildCapabilitySet(Consumer) was already called.

See Also:

• ResourceRouteDelegate.ApiCapability

buildCapabilitySet

public DefaultResourceRouteDelegate.Builder<R> buildCapabilitySet(@NotNull
 @NotNull Consumer<Set<ResourceRouteDelegate.ApiCapability>> capabilitySetBuilder)

Builds a ResourceActionSet using the provided builder. This allows you to build a custom set of capabilities this resource exposes to the REST API. This set will be in an initial state depending on the value of supportsExtraDataFiles(boolean) - either indicating default capabilities or all capabilities.

See Also:

• ResourceRouteDelegate.ApiCapability.DEFAULT
• ResourceRouteDelegate.ApiCapability.ALL

openApiGroupName

public DefaultResourceRouteDelegate.Builder<R> openApiGroupName(String openApiGroupName)

openApiTagName

public DefaultResourceRouteDelegate.Builder<R> openApiTagName(String openApiTagName)

addField

public DefaultResourceRouteDelegate.Builder<R> addField(String fieldName,
 Function<R,Object> resolver)

addSearchField

public DefaultResourceRouteDelegate.Builder<R> addSearchField(String fieldName)

Adds a field to the searchable fields set. Note that "name", "description", "enabled", and "mode" are automatically added. Also, any field added through addField(String, Function) will be automatically added as a searchable field. To opt-out of this automatic behavior, call setSearchFields(Set) instead.

setSearchFields

public DefaultResourceRouteDelegate.Builder<R> setSearchFields(Set<String> searchFields)

Calling this method will set (and overwrite) the searchable fields set. By calling this method, you can gain complete control over the set of searchable fields - "name", "description", "enabled", "mode", and any fields added through addField will not be automatically added.

readPermission

public DefaultResourceRouteDelegate.Builder<R> readPermission(PermissionType readPermission)

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

writePermission

public DefaultResourceRouteDelegate.Builder<R> writePermission(PermissionType writePermission)

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

build

public ResourceRouteDelegate<R> build()