Package com.inductiveautomation.ignition.gateway.config.actions

Class DefaultResourceActions.ValidatingModify<R>

java.lang.Object

com.inductiveautomation.ignition.gateway.config.actions.DefaultResourceActions.ValidatingModify<R>

Type Parameters:

R - This must be the config class object used for this ResourceTypeMeta

All Implemented Interfaces:

ResourceAction, ResourceAction.Modify

Enclosing class:

DefaultResourceActions

public static final class DefaultResourceActions.ValidatingModify<R>
extends Object

Performs the default Modify operation but allows for validation of the resource prior to the resource being committed to the configuration system to be persisted. This means that a DefaultResourceActions.ModifyResources is provided to the supplied validator which contains a DecodedResource instance of the resource which does incur some overhead since this resource has to be decoded. It is expected that these validations are also fairly light-weight as this occurs during user interaction from the Web API or the Rest API.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	com.inductiveautomation.ignition.gateway.config.actions.DefaultResourceActions.ModifyImpl.ModifyContext	Used internally by the Modify implementation for validation.

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

ResourceAction.ContextObject, ResourceAction.Copy, ResourceAction.Create, ResourceAction.CreateRequest, ResourceAction.Delete, ResourceAction.DeleteRequest, ResourceAction.ListResources, ResourceAction.Modify, ResourceAction.ModifyRequest, ResourceAction.Move, ResourceAction.Read, ResourceAction.Rename, ResourceAction.ValidationFailure

Constructor Summary

Constructors

Constructor	Description
ValidatingModify(Function<DefaultResourceActions.ModifyResources<R>,Optional<ResourceAction.ValidationFailure>> validator)

Method Summary

Modifier and Type	Method	Description
@NotNull StatefulModificationResponse	modify(ConfigurationManager manager, List<ResourceAction.ModifyRequest> requests, ResourceAction.ContextObject contextObject)
Optional<ResourceAction.ValidationFailure>	validateResources(Set<com.inductiveautomation.ignition.gateway.config.actions.DefaultResourceActions.ModifyImpl.ModifyContext> resources)

Methods inherited from class java.lang.Object

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

Constructor Details

ValidatingModify

public ValidatingModify(Function<DefaultResourceActions.ModifyResources<R>,Optional<ResourceAction.ValidationFailure>> validator)

Method Details

validateResources

public Optional<ResourceAction.ValidationFailure> validateResources(Set<com.inductiveautomation.ignition.gateway.config.actions.DefaultResourceActions.ModifyImpl.ModifyContext> resources)

modify

@NotNull
public @NotNull StatefulModificationResponse modify(ConfigurationManager manager,
 List<ResourceAction.ModifyRequest> requests,
 ResourceAction.ContextObject contextObject)

Specified by:

modify in interface ResourceAction.Modify