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

Class ResourceActionSet.Builder

java.lang.Object

com.inductiveautomation.ignition.gateway.config.actions.ResourceActionSet.Builder

Enclosing class:

ResourceActionSet

public static final class ResourceActionSet.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
ResourceActionSet	build()
ResourceActionSet.Builder	copy(ResourceAction.Copy copy)	Sets the default Copy operation to a ResourceAction.Copy.
ResourceActionSet.Builder	create(ResourceAction.Create create)	Sets the default Create operation to a ResourceAction.Create.
ResourceActionSet.Builder	delete(ResourceAction.Delete delete)	Sets the default Delete operation to a ResourceAction.Delete.
ResourceActionSet.Builder	listResources(ResourceAction.ListResources listResources)	Sets the default ListResources operation to a ResourceAction.ListResources.
ResourceActionSet.Builder	modify(ResourceAction.Modify modify)	Sets the default Modify operation to a ResourceAction.Modify.
ResourceActionSet.Builder	move(ResourceAction.Move move)	Sets the default Move operation to a ResourceAction.Move.
ResourceActionSet.Builder	read(ResourceAction.Read read)	Sets the default Read operation to a ResourceAction.Read.
ResourceActionSet.Builder	rename(ResourceAction.Rename rename)	Sets the default Rename operation to a ResourceAction.Rename.
<R> ResourceActionSet.Builder	withValidatingCopy(Function<DefaultResourceActions.CopyResource<R>,Optional<ResourceAction.ValidationFailure>> validator)	Sets the default Copy operation to a DefaultResourceActions.ValidatingCopy, which is backed by the default copy action, but additionally decodes the actual resource and allows for the caller to check the resource for validity.
<R> ResourceActionSet.Builder	withValidatingCreate(Function<DefaultResourceActions.CreateResources<R>,Optional<ResourceAction.ValidationFailure>> validator)	Sets the default Create operation to a DefaultResourceActions.ValidatingCreate, which is backed by the default create action, but additionally decodes the actual resource and allows for the caller to check the resource for validity.
<R> ResourceActionSet.Builder	withValidatingModfy(Function<DefaultResourceActions.ModifyResources<R>,Optional<ResourceAction.ValidationFailure>> validator)	Sets the default Modify operation to a DefaultResourceActions.ValidatingModify, which is backed by the default modify action, but additionally decodes the actual resource and allows for the caller to check the resource for validity.
<R> ResourceActionSet.Builder	withValidatingMove(Function<DefaultResourceActions.MoveResource<R>,Optional<ResourceAction.ValidationFailure>> validator)	Sets the default Move operation to a DefaultResourceActions.ValidatingMove, which is backed by the default move action, but additionally decodes the actual resource and allows for the caller to check the resource for validity.
<R> ResourceActionSet.Builder	withValidatingRename(Function<DefaultResourceActions.RenameResource<R>,Optional<ResourceAction.ValidationFailure>> validator)	Sets the default Rename operation to a DefaultResourceActions.ValidatingRename, which is backed by the default rename action, but additionally decodes the actual resource and allows for the caller to check the resource for validity.

Methods inherited from class java.lang.Object

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

Method Details

read

public ResourceActionSet.Builder read(@Nullable
 ResourceAction.Read read)

Sets the default Read operation to a ResourceAction.Read. If null, reading of resources is disallowed. Typically, your implementation should just proxy to the Default DefaultResourceActions.Read to ensure proper reading of the resource from the ConfigurationManager

Parameters:

read - The Read operation. May be null to disallow reading resources

listResources

public ResourceActionSet.Builder listResources(@Nullable
 ResourceAction.ListResources listResources)

Sets the default ListResources operation to a ResourceAction.ListResources. If null, listing resources is disallowed. Typically, your implementation should just proxy to the Default DefaultResourceActions.ListResources to ensure proper reading of the resource from the ConfigurationManager

Parameters:

listResources - The ListResources operation. May be null to disallow listing resources

create

public ResourceActionSet.Builder create(@Nullable
 ResourceAction.Create create)

Sets the default Create operation to a ResourceAction.Create. If null, creation of resources is disallowed. Typically, your implementation should just proxy to the Default DefaultResourceActions.Create to ensure proper creation and saving of the resource to the ConfigurationManager

Parameters:

create - The Create operation. may be null to disallow creation of resources

withValidatingCreate

public <R> ResourceActionSet.Builder withValidatingCreate(@Nonnull
 Function<DefaultResourceActions.CreateResources<R>,Optional<ResourceAction.ValidationFailure>> validator)

Sets the default Create operation to a DefaultResourceActions.ValidatingCreate, which is backed by the default create action, but additionally decodes the actual resource and allows for the caller to check the resource for validity. This does add some overhead, so it is recommended to use the default create if all you need is the information in ResourceAction.CreateRequest. This method cannot be used at the same time as create(ResourceAction.Create)

Type Parameters:

R - The Configuration class set on the ResourceTypeMeta of the resource being created.

Parameters:

validator - A function that accepts a DefaultResourceActions.CreateResources and returns an Optional of ResourceAction.ValidationFailure if the resource is invalid or empty if it is valid.

modify

public ResourceActionSet.Builder modify(@Nullable
 ResourceAction.Modify modify)

Sets the default Modify operation to a ResourceAction.Modify. If null, modifying resources is disallowed. Typically, your implementation should just proxy to the Default DefaultResourceActions.Modify to ensure proper modification of the resource in the ConfigurationManager

Parameters:

modify - The Modify operation. May be null to disallow modification of resources

withValidatingModfy

public <R> ResourceActionSet.Builder withValidatingModfy(@Nonnull
 Function<DefaultResourceActions.ModifyResources<R>,Optional<ResourceAction.ValidationFailure>> validator)

Sets the default Modify operation to a DefaultResourceActions.ValidatingModify, which is backed by the default modify action, but additionally decodes the actual resource and allows for the caller to check the resource for validity. This does add some overhead, so it is recommended to use the default Modify if all you need is the information in ResourceAction.ModifyRequest. This method cannot be used at the same time as modify(ResourceAction.Modify)

Type Parameters:

R - The Configuration class set on the ResourceTypeMeta of the resource being created.

Parameters:

validator - A function that accepts a DefaultResourceActions.ModifyResources and returns an Optional of ResourceAction.ValidationFailure if the resource is invalid or empty if it is valid.

delete

public ResourceActionSet.Builder delete(@Nullable
 ResourceAction.Delete delete)

Sets the default Delete operation to a ResourceAction.Delete. If null, deleting resources is disallowed. Typically, your implementation should just proxy to the Default DefaultResourceActions.Delete to ensure proper deletion of the resource in the ConfigurationManager

Parameters:

delete - The Delete operation. May be null to disallow deletion of resources

move

public ResourceActionSet.Builder move(@Nullable
 ResourceAction.Move move)

Sets the default Move operation to a ResourceAction.Move. If null, moving resources is disallowed. Typically, your implementation should just proxy to the Default DefaultResourceActions.Move to ensure the resource is moved to the proper location in the ConfigurationManager

Parameters:

move - The Move operation. May be null to disallow moving of resources

withValidatingMove

public <R> ResourceActionSet.Builder withValidatingMove(@Nonnull
 Function<DefaultResourceActions.MoveResource<R>,Optional<ResourceAction.ValidationFailure>> validator)

Sets the default Move operation to a DefaultResourceActions.ValidatingMove, which is backed by the default move action, but additionally decodes the actual resource and allows for the caller to check the resource for validity. This does add some overhead, so it is recommended to use the default Move if all you need is the information in ResourceAction.Move.move(com.inductiveautomation.ignition.gateway.config.ConfigurationManager, com.inductiveautomation.ignition.common.resourcecollection.ResourceType, java.lang.String, java.lang.String, java.lang.String, java.lang.String, com.inductiveautomation.ignition.common.ImmutableBytes, com.inductiveautomation.ignition.gateway.config.actions.ResourceAction.ContextObject). This method cannot be used at the same time as move(ResourceAction.Move)

Type Parameters:

R - The Configuration class set on the ResourceTypeMeta of the resource being created.

Parameters:

validator - A function that accepts a DefaultResourceActions.MoveResource and returns an Optional of ResourceAction.ValidationFailure if the resource is invalid or empty if it is valid.

copy

public ResourceActionSet.Builder copy(@Nullable
 ResourceAction.Copy copy)

Sets the default Copy operation to a ResourceAction.Copy. If null, copying resources is disallowed. Typically, your implementation should just proxy to the Default DefaultResourceActions.Copy to ensure the resource is copied properly in ConfigurationManager

Parameters:

copy - The Copy operation. May be null to disallow copying resources

withValidatingCopy

public <R> ResourceActionSet.Builder withValidatingCopy(@Nonnull
 Function<DefaultResourceActions.CopyResource<R>,Optional<ResourceAction.ValidationFailure>> validator)

Sets the default Copy operation to a DefaultResourceActions.ValidatingCopy, which is backed by the default copy action, but additionally decodes the actual resource and allows for the caller to check the resource for validity. This does add some overhead, so it is recommended to use the default Copy if all you need is the information in ResourceAction.Copy.copy(com.inductiveautomation.ignition.gateway.config.ConfigurationManager, com.inductiveautomation.ignition.common.resourcecollection.ResourceType, java.lang.String, java.lang.String, java.lang.String, java.lang.String, com.inductiveautomation.ignition.common.ImmutableBytes, com.inductiveautomation.ignition.gateway.config.actions.ResourceAction.ContextObject). This method cannot be used at the same time as copy(ResourceAction.Copy)

Type Parameters:

R - The Configuration class set on the ResourceTypeMeta of the resource being created.

Parameters:

validator - A function that accepts a DefaultResourceActions.CopyResource and returns an Optional of ResourceAction.ValidationFailure if the resource is invalid or empty if it is valid.

rename

public ResourceActionSet.Builder rename(@Nullable
 ResourceAction.Rename rename)

Sets the default Rename operation to a ResourceAction.Rename. If null, renaming resources is disallowed. Typically, your implementation should just proxy to the Default DefaultResourceActions.Rename to ensure the resource is renamed properly in ConfigurationManager

Parameters:

rename - The Rename operation. May be null to disallow renaming resources

withValidatingRename

public <R> ResourceActionSet.Builder withValidatingRename(@Nonnull
 Function<DefaultResourceActions.RenameResource<R>,Optional<ResourceAction.ValidationFailure>> validator)

Sets the default Rename operation to a DefaultResourceActions.ValidatingRename, which is backed by the default rename action, but additionally decodes the actual resource and allows for the caller to check the resource for validity. This does add some overhead, so it is recommended to use the default Rename if all you need is the information in ResourceAction.Rename.rename(com.inductiveautomation.ignition.gateway.config.ConfigurationManager, com.inductiveautomation.ignition.common.resourcecollection.ResourceType, java.lang.String, java.lang.String, com.inductiveautomation.ignition.gateway.config.ReferenceHandling, java.lang.String, com.inductiveautomation.ignition.gateway.config.actions.ResourceAction.ContextObject). This method cannot be used at the same time as rename(ResourceAction.Rename)

Type Parameters:

R - The Configuration class set on the ResourceTypeMeta of the resource being created.

Parameters:

validator - A function that accepts a DefaultResourceActions.CopyResource and returns an Optional of ResourceAction.ValidationFailure if the resource is invalid or empty if it is valid.

build

public ResourceActionSet build()