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

Class DefaultResourceActions.Copy

java.lang.Object

com.inductiveautomation.ignition.gateway.config.actions.DefaultResourceActions.Copy

All Implemented Interfaces:

ResourceAction, ResourceAction.Copy

Enclosing class:

DefaultResourceActions

public static final class DefaultResourceActions.Copy
extends Object
implements ResourceAction.Copy

Nested Class Summary

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

Constructor Summary

Constructors

Constructor	Description
Copy()

Method Summary

Modifier and Type	Method	Description
@NotNull StructuralModificationResponse	copy(ConfigurationManager manager, ResourceType resourceType, @Nullable String fromName, @Nullable String toName, @Nullable String fromCollection, @Nullable String toCollection, ImmutableBytes signature, ResourceAction.ContextObject contextObject)	Copies a resource from one location to another.

Methods inherited from class java.lang.Object

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

Constructor Details

Copy

public Copy()

Method Details

copy

@NotNull
public @NotNull StructuralModificationResponse copy(ConfigurationManager manager,
 ResourceType resourceType,
 @Nullable
 @Nullable String fromName,
 @Nullable
 @Nullable String toName,
 @Nullable
 @Nullable String fromCollection,
 @Nullable
 @Nullable String toCollection,
 ImmutableBytes signature,
 ResourceAction.ContextObject contextObject)

Description copied from interface: ResourceAction.Copy

Copies a resource from one location to another.

Specified by:

copy in interface ResourceAction.Copy

Parameters:

manager - The configuration manager to use for copying the resource.

resourceType - The type of the resource to copy.

fromName - The name of the resource to copy from.

toName - The name of the resource to copy to.

fromCollection - The collection in which the source resource resides, if applicable.

toCollection - The collection in which the destination resource will reside, if applicable.

signature - The signature of the resource being copied.

contextObject - The context object to associated with the change.

Returns:

A response indicating the result of the copy operation.