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

Class DefaultResourceActions.ValidatingCreate<R>

java.lang.Object

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

Type Parameters:

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

All Implemented Interfaces:

ResourceAction, ResourceAction.Create

Enclosing class:

DefaultResourceActions

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

Performs the default Create 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.CreateResources 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.CreateImpl.CreateContext	Used internally by the Create 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
ValidatingCreate(Function<DefaultResourceActions.CreateResources<R>,Optional<ResourceAction.ValidationFailure>> validator)

Method Summary

Modifier and Type	Method	Description
@NotNull StatefulModificationResponse	create(ConfigurationManager manager, List<ResourceAction.CreateRequest> changes, ResourceAction.ContextObject contextObject)	Creates one or more named resources based on the provided list of ResourceAction.CreateRequest.
Optional<ResourceAction.ValidationFailure>	validateResources(Set<com.inductiveautomation.ignition.gateway.config.actions.DefaultResourceActions.CreateImpl.CreateContext> resources)

Methods inherited from class java.lang.Object

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

Constructor Details

ValidatingCreate

public ValidatingCreate(Function<DefaultResourceActions.CreateResources<R>,Optional<ResourceAction.ValidationFailure>> validator)

Method Details

validateResources

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

create

@NotNull
public @NotNull StatefulModificationResponse create(ConfigurationManager manager,
 List<ResourceAction.CreateRequest> changes,
 ResourceAction.ContextObject contextObject)

Description copied from interface: ResourceAction.Create

Creates one or more named resources based on the provided list of ResourceAction.CreateRequest.

Specified by:

create in interface ResourceAction.Create

Parameters:

manager - The configuration manager to use for creating the resources.

changes - The list of requests containing details about the resources to create.

contextObject - The context object to associated with the change.

Returns:

A response indicating the result of the creation operation.