com.thingworx.things.connected

Class RemoteThingWithTunnelsAndFileTransfer

java.lang.Object

com.thingworx.types.NamedObject

com.thingworx.persistence.common.PersistableNamedObject

com.thingworx.entities.RootEntity

com.thingworx.things.Thing

com.thingworx.things.connected.RemoteThing

com.thingworx.things.connected.RemoteThingWithTunnels

com.thingworx.things.connected.RemoteThingWithTunnelsAndFileTransfer

All Implemented Interfaces:

IConfigurableObject, INotScriptFriendly, IEndpointBindingObserver, IDiffableObject, IAlertProvider, IAvatar, IEntityLifeCycleEvent, IEventMetadataProvider, IEventProvider, IPersistable, IPropertyProvider, IServiceMetadataProvider, IServiceProvider, IShapeProvider, ITaggableObject, IDependencyScannableObject, IHierarchicalEntity, IEntityDefinition, IPersistableObject<java.lang.String>, IDesignTimeSecurable, IDesignTimeSecurableEntity, IRunTimeSecurable, IRunTimeSecurableEntity, ISecurable, IVisibilitySecurable, IVisibilitySecurableEntity, IEventProcessor, IConnectedDevice, IAspectContainer, INamedObject, java.io.Serializable

@ThingworxExtensionApiClass(since={7,4})
public class RemoteThingWithTunnelsAndFileTransfer
extends RemoteThingWithTunnels

See Also:

Serialized Form

Field Summary

Fields inherited from class com.thingworx.things.connected.RemoteThing

STORE_AND_FORWARD_IS_NOT_ENABLED

Fields inherited from class com.thingworx.things.Thing

_logger, DATASHAPE_INCOMING_LOCAL_PROPERTY_BINDING, DEFAULT_SETTINGS_TABLE, ENTITYLIST_SHAPE, GENERIC_THING_TEMPLATE, TYPE_THING

Fields inherited from class com.thingworx.entities.RootEntity

BASIC_PROPERTIES

Fields inherited from class com.thingworx.types.NamedObject

NAME_COMPARATOR

Constructor Summary

Constructors

Constructor and Description
RemoteThingWithTunnelsAndFileTransfer()

Method Summary

Modifier and Type	Method and Description
void	AppendToBinaryFile(java.lang.String path, byte[] data)
InfoTable	BrowseDirectory(java.lang.String path) Service Category: FileTransfer Service Description: Get a list of files and/or directories on the Edge Thing.
InfoTable	BrowseFileSystem(java.lang.String path) Service Category: FileTransfer Service Description: Get a list of files and/or directories on the Edge Thing.
void	CancelFileTransfer(InfoTable job)
void	CompleteFileTransfer(InfoTable job)
void	CreateBinaryFile(java.lang.String path, byte[] data, java.lang.Boolean overwrite)
void	DeleteFile(java.lang.String path) Service Category: FileSystemServices Service Description: Delete a file.
InfoTable	GetDirectoryStructure() Service Category: FileTransfer Service Description: Get directory structure.
java.lang.String	GetFileChecksum(java.lang.String path) Deprecated.
java.lang.String	GetFileChecksum(java.lang.String path, java.lang.String checksumAlgorithm) Gets the checksum of a file on this RemoteThing, using the cryptographic algorithm whose name was passed into the service as an argument.
InfoTable	GetFileInfo(java.lang.String path) Service Category: FileTransfer Service Description: Get file info.
InfoTable	GetFileListing(java.lang.String path, java.lang.String nameMask) Service Category: FileTransfer Service Description: Get file system listing.
InfoTable	GetSupportedFileChecksumAlgorithms()
InfoTable	GetTransferInfo()
java.lang.Boolean	IsDerivedFromTemplate(java.lang.String thingTemplateName) Service Category: Metadata Service Description: Check to see if a thing is derived from a particular thing template.
InfoTable	ListDirectories(java.lang.String path) Service Category: FileTransfer Service Description: Get listing of directories.
InfoTable	ListFiles(java.lang.String path, java.lang.String nameMask) Service Category: FileTransfer Service Description: Get file system listing.
void	MoveFile(java.lang.String sourcePath, java.lang.String targetPath, java.lang.Boolean overwrite) Service Category: FileSystemServices Service Description: Move a file.
InfoTable	ReadFromBinaryFile(java.lang.String path, java.lang.Double offset, java.lang.Integer count)
void	StartFileTransfer(java.lang.String tid, java.lang.String path, java.lang.String mode)
void	ValidateFileTransfer(java.lang.String sid, java.lang.String toUri, java.lang.String fromUri, java.lang.String md5) Service Category: FileTransfer Service Description: validate the file transfer based on the validation signature.
void	WriteToBinaryFile(java.lang.String path, java.lang.Double offset, byte[] data)

Methods inherited from class com.thingworx.things.connected.RemoteThingWithTunnels

AddTunnel, CompleteTunnel, GetTunnel, GetTunnelNames, GetTunnels, GetTunnelStatus, initializeThing, RemoveTunnel, StartTunnel, TunnelCommandFromEdge, TunnelCommandToEdge

Methods inherited from class com.thingworx.things.connected.RemoteThing

AddDynamicRemoteSubscription, callService, checkConnection, executeRemoteService, GetEventSubscriptions, getLastConnectionTime, GetPropertySubscriptions, GetPropertySubscriptions, GetQueuedTasks, GetRemoteMetadata, initializeThing, isConnected, ProcessRemoteEvents, processRemoteService, RemoveDynamicRemoteSubscription, SendMaxQueuedTasks, SendQueuedTasks, startThing, stopThing, UpdateSubscribedPropertyValues

Methods inherited from class com.thingworx.things.Thing

AcknowledgeAlert, acknowledgeAlertByProperty, acknowledgeAlertByPropertyAndName, acknowledgeAllAlerts, AcknowledgeAllAlerts, AddBooleanValueStreamEntry, AddDateTimeValueStreamEntry, AddDynamicSubscription, AddEventDefinition, AddImageValueStreamEntry, AddInfoTableValueStreamEntry, AddIntegerValueStreamEntry, AddLocationValueStreamEntry, AddLongValueStreamEntry, AddNumberValueStreamEntry, AddOrUpdateAlert, addProperty, AddPropertyDefinition, AddPropertyDefinition, AddPropertyDefinitions, AddPropertyTransformDefinition, AddServiceDefinition, AddStringValueStreamEntry, AddTags, AddThingCodeValueStreamEntry, AddVec2ValueStreamEntry, AddVec3ValueStreamEntry, AddVec4ValueStreamEntry, checkDemandRead, checkPropertyName, checkValueStream, cleanupThing, cleanupThing, DisableAlertsForProperty, DisableAllAlerts, DisableSubscription, DisableThing, dispatchBackgroundEvent, dispatchEvent, dispose, EnableAlertsForProperty, EnableAllAlerts, EnableSubscription, EnableThing, fireEvent, getAlertConfigurations, GetAlertDefinition, GetAlertDefinitions, getAlerts, getAlertsForProperty, GetAlertStatus, GetAlertStatuses, GetAlertStatusesForProperty, GetAlertSummary, GetAlertSummaryForProperty, GetAllAnomalyAlertTrainingStatistics, getAllImplementedThingShapes, getAllImplementedThingTemplates, GetAnomalyAlertTrainingStatisticsForAlert, GetAnomalyAlertTrainingStatisticsForProperty, GetAvatar, GetBooleanAlertParameter, GetBooleanPropertyValue, GetDateTimeAlertParameter, GetDateTimePropertyValue, getDependencies, getEffectiveAlertConfiguration, getEffectiveAlertDefinition, getEffectiveEventDefinition, getEffectiveIdentifier, GetEffectiveLocalPropertyBinding, getEffectiveLocalPropertyBindings, GetEffectiveLocalPropertyBindings, getEffectivePropertyDefinition, GetEffectivePropertyLogging, getEffectiveRemoteEventBindings, getEffectiveRemotePropertyBindings, getEffectiveRemoteServiceBindings, getEffectiveServiceDefinition, getEffectiveValueStreamName, getEntityType, GetHomeMashup, getIdentifier, GetIdentifier, GetImagePropertyValue, GetImplementedShapes, getImplementedThingTemplates, GetIncomingLocalPropertyBinding, GetIncomingLocalPropertyBindings, getInstanceEventDefinition, getInstanceEventDefinitions, getInstancePropertyDefinition, getInstancePropertyDefinitions, getInstancePublicServiceDefinitions, getInstanceServiceDefinition, getInstanceServiceDefinitions, getInstanceShape, getInstanceSubscriptions, GetIntegerAlertParameter, GetIntegerPropertyValue, GetLocalAlertDefinitions, GetLocallyImplementedShapes, GetLocalPropertyBinding, GetLocationAlertParameter, GetLocationPropertyValue, GetLoggedProperties, GetLongAlertParameter, GetLongPropertyValue, GetMashups, GetNamedProperties, GetNamedPropertyValues, GetNamedPropertyValuesVTQ, GetNamedPropertyValuesVTQA, GetNetworks, GetNumberAlertParameter, GetNumberPropertyValue, GetNumericLoggedProperties, getProperties, getProperty, getPropertyAckStatus, getPropertyAlertStatus, GetPropertyLogging, getPropertyQuality, GetPropertyQuality, getPropertyTime, GetPropertyTime, getPropertyType, getPropertyValue, getPropertyValue, getPropertyValues, GetPropertyValues, getPropertyValuesAsInfoTable, GetPropertyValuesAsMultiRowTable, GetPropertyValuesVTQ, GetPropertyValuesVTQA, GetPublished, GetRemoteEventBinding, GetRemotePropertyBinding, GetRemoteServiceBinding, getState, GetStringAlertParameter, GetStringPropertyValue, GetThingCodePropertyValue, GetThingRelationships, GetThingSummaryInformation, getThingTemplate, GetThingTemplate, getThingTemplateName, GetValueStream, getValueStreamName, GetVec2PropertyValue, GetVec3PropertyValue, GetVec4PropertyValue, HasAlert, hasEventDefinition, hasLocalEventDefinition, hasLocalPropertyDefinition, hasLocalServiceDefinition, hasProperty, hasPropertyDefinition, hasServiceDefinition, HavePropertiesChangedSince, implementsShape, ImplementsShape, implementsTemplate, initializeEntity, initializeProperty, isAlwaysAvailableService, isBuiltInEvent, isBuiltInProperty, IsDynamicSubscriptionCreated, isEnabled, IsEnabled, isEventRemote, isExternallySubscribed, IsInNetwork, isLocallySubscribed, isLocalProperty, isPropertyEvent, isPropertyRemote, isPublished, isRunning, isServiceRemote, isSubscribed, preprocessSetPropertyVTQ, processAPIServiceRequest, processServiceRequest, processStartNotification, processStartNotification, PurgeAllPropertyHistory, PurgePropertyHistory, PurgeSelectedPropertyHistory, QueryAlertHistory, QueryAlertSummary, QueryBooleanPropertyHistory, QueryDateTimePropertyHistory, QueryImagePropertyHistory, QueryInfoTablePropertyHistory, QueryIntegerPropertyHistory, QueryLocationPropertyHistory, QueryLongPropertyHistory, QueryNamedPropertyHistory, QueryNumberPropertyHistory, QueryPropertyHistory, QueryStringPropertyHistory, QueryThingCodePropertyHistory, QueryVec2PropertyHistory, QueryVec3PropertyHistory, QueryVec4PropertyHistory, RemoveAlert, RemoveDynamicSubscription, RemoveEventDefinition, RemoveLocalPropertyBinding, RemovePropertyDefinition, RemoveRemoteEventBinding, RemoveRemotePropertyBinding, RemoveRemoteServiceBinding, RemoveServiceDefinition, RestartThing, SetBooleanAlertParameter, SetDateTimeAlertParameter, SetDescription, SetIdentifier, SetIntegerAlertParameter, SetLocalPropertyBinding, SetLocalPropertyBinding, SetLocationAlertParameter, SetNumberAlertParameter, SetPropertyLogging, setPropertyValue, SetPropertyValues, setPropertyVTQ, setPropertyVTQ, SetPublished, SetRemoteEventBinding, SetRemotePropertyBinding, SetRemotePropertyBinding, SetRemoteServiceBinding, SetStringAlertParameter, SetTags, setThingTemplateName, SetUnitsForNumericPropertyDefinition, SetValueStream, startThing, UpdatePropertyValues, validateConfiguration, WritePropertiesToStream

Methods inherited from class com.thingworx.entities.RootEntity

AddConfigurationTableDefinition, addDesignTimePermission, AddDesignTimePermission, addRunTimePermission, AddRunTimePermission, addVisibilityPermission, AddVisibilityPermission, CheckDesignTimePermission, CheckDesignTimePermissionForGroup, CheckDesignTimePermissionForUser, CheckPermission, CheckPermissionForGroup, CheckPermissionForUser, cleanupEntity, cleanupEntity, DeleteAllConfigurationTableRows, DeleteConfigurationTable, DeleteConfigurationTableRows, deleteDesignTimePermission, DeleteDesignTimePermission, deleteRunTimePermission, DeleteRunTimePermission, deleteVisibilityPermission, DeleteVisibilityPermission, getAspects, getAvatarContent, GetAvatarURL, GetConfigurationChangeHistory, getConfigurationSetting, getConfigurationTable, GetConfigurationTable, GetConfigurationTableDefinition, GetConfigurationTableRow, GetConfigurationTables, GetDescription, getDesignTimePermissions, GetDesignTimePermissions, GetDesignTimePermissionsAsJSON, getDocumentationContent, getEntityTypeAsString, GetEventDefinition, GetEventDefinitions, GetIncomingDependencies, GetIncomingDependenciesAsNetwork, GetInstanceMetadataAsJSON, GetInstanceMetadataWithPermissionsAsJSON, GetLastModifiedDate, GetMetadata, GetMetadataAsJSON, GetMetadataWithPermissionsAsJSON, GetOutgoingDependencies, GetOutgoingDependenciesAsNetwork, getOwner, GetPermissionsForCurrentUser, GetPermissionsForGroup, GetPermissionsForUser, GetProjectName, GetPropertyDefinition, GetPropertyDefinitions, getRunTimePermissions, GetRunTimePermissions, GetRunTimePermissionsAsJSON, GetServiceDefinition, GetServiceDefinitions, getStringConfigurationSetting, getStringConfigurationSettingWithDefault, GetSummaryInformation, getTags, GetTags, GetTagsAsInfoTable, getVisibilityPermissions, GetVisibilityPermissions, GetVisibilityPermissionsAsJSON, HasIncomingDependencies, HasOutgoingDependencies, isEditable, isEditableExtensionObject, isEditableSystemObject, isExtensionObject, IsMultiRowTable, isOwner, isSystemObject, isThemeObject, isVisible, isVisible, persistDesignTimePermissions, persistRunTimePermissions, persistVisibilityPermissions, preInitializeEntity, RemoveTags, SaveConfigurationTables, SetAvatar, setConfigurationSetting, SetConfigurationTable, SetConfigurationTableRows, setDesignTimePermissions, SetDesignTimePermissionsAsJSON, setDocumentationContent, setExtensionObject, SetHomeMashup, setLastModifiedDate, SetMultiRowConfigurationTable, setOwner, SetOwner, SetProjectName, setRunTimePermissions, SetRunTimePermissionsAsJSON, setStringConfigurationSetting, setVisibilityPermissions, SetVisibilityPermissionsAsJSON, toJSON, toJSONDefinition

Methods inherited from class com.thingworx.persistence.common.PersistableNamedObject

getID, hasID, isTransient

Methods inherited from class com.thingworx.types.NamedObject

getDescription, getName, setDescription, setName, toValueCollection

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.thingworx.entities.interfaces.IShapeProvider

getName

Methods inherited from interface com.thingworx.entities.interfaces.IPersistable

getID, hasID

Methods inherited from interface com.thingworx.types.INamedObject

getDescription

Methods inherited from interface com.thingworx.security.permissions.ISecurable

getID, getName

Constructor Detail

RemoteThingWithTunnelsAndFileTransfer

@ThingworxExtensionApiMethod(since={7,4})
public RemoteThingWithTunnelsAndFileTransfer()

Method Detail

IsDerivedFromTemplate

@ThingworxExtensionApiMethod(since={7,4})
public java.lang.Boolean IsDerivedFromTemplate(java.lang.String thingTemplateName)
                                                                                  throws java.lang.Exception

Service Category:

Metadata

Service Description:

Check to see if a thing is derived from a particular thing template.

Overrides:

IsDerivedFromTemplate in class RemoteThingWithTunnels

Parameters:

thingTemplateName - Thing template name - THINGTEMPLATENAME

Returns:

result Is Derived From Template - BOOLEAN

Throws:

java.lang.Exception - If an error occurs

StartFileTransfer

@ThingworxExtensionApiMethod(since={7,4})
public void StartFileTransfer(java.lang.String tid,
                                                                        java.lang.String path,
                                                                        java.lang.String mode)
                                                                 throws java.lang.Exception

Parameters:

tid - Transfer Id - STRING

path - File path - STRING

mode - Indicates if the file will be open in 'read' or 'write' mode - STRING

Throws:

java.lang.Exception - If an error occurs

CompleteFileTransfer

@ThingworxExtensionApiMethod(since={7,4})
public void CompleteFileTransfer(InfoTable job)
                                                                    throws java.lang.Exception

Parameters:

job - The transfer job being completed - INFOTABLE

Throws:

java.lang.Exception - If an error occurs

CancelFileTransfer

@ThingworxExtensionApiMethod(since={7,4})
public void CancelFileTransfer(InfoTable job)
                                                                  throws java.lang.Exception

Parameters:

job - The transfer job being completed - INFOTABLE

Throws:

java.lang.Exception - If an error occurs

GetTransferInfo

@ThingworxExtensionApiMethod(since={7,4})
public InfoTable GetTransferInfo()
                                                                    throws java.lang.Exception

Returns:

result File Results - INFOTABLE - Aspects {dataShape:GetTransferInfoResult}

Throws:

java.lang.Exception - If an error occurs

GetFileInfo

@ThingworxExtensionApiMethod(since={7,4})
public InfoTable GetFileInfo(java.lang.String path)
                                                                throws java.lang.Exception

Service Category:

FileTransfer

Service Description:

Get file info.

Parameters:

path - File path - STRING

Returns:

result File Results - INFOTABLE - Aspects {dataShape:FileSystemFile}

Throws:

java.lang.Exception - If an error occurs

GetSupportedFileChecksumAlgorithms

@ThingworxExtensionApiMethod(since={8,4})
public InfoTable GetSupportedFileChecksumAlgorithms()
                                                                                       throws java.lang.Exception

Returns:

result List of cryptographic algorithms this Thing supports for file transfers - INFOTABLE - Aspects {dataShape:ChecksumAlgorithmList}

Throws:

java.lang.Exception - If an error occurs

GetFileChecksum

@Deprecated
 @ThingworxExtensionApiMethod(since={7,4},
                             deprecatedSince={8,4,0})
public java.lang.String GetFileChecksum(java.lang.String path)
                                                                                                                                              throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception - If an error occurs

GetFileChecksum

@ThingworxExtensionApiMethod(since={8,4})
public java.lang.String GetFileChecksum(java.lang.String path,
                                                                                  java.lang.String checksumAlgorithm)
                                                                           throws java.lang.Exception

Gets the checksum of a file on this RemoteThing, using the cryptographic algorithm whose name was passed into the service as an argument. Supported checksum algorithms can be gotten using the GetSupportedChecksumAlgorithms service.

Parameters:

path - The path to the file to conduct a checksum on

checksumAlgorithm - The name of the checksum algorithm to use

Returns:

The checksum of the indicated file

Throws:

java.lang.Exception - Thrown if the cryptographic algorithm provided is invalid or is not recognized by the server

BrowseFileSystem

@ThingworxExtensionApiMethod(since={7,4})
public InfoTable BrowseFileSystem(java.lang.String path)
                                                                     throws java.lang.Exception

Service Category:

FileTransfer

Service Description:

Get a list of files and/or directories on the Edge Thing.

Parameters:

path - Directory path - STRING

Returns:

result Browse Results - INFOTABLE - Aspects {dataShape:FileSystemFile}

Throws:

java.lang.Exception - If an error occurs

BrowseDirectory

@ThingworxExtensionApiMethod(since={7,4})
public InfoTable BrowseDirectory(java.lang.String path)
                                                                    throws java.lang.Exception

Service Category:

FileTransfer

Service Description:

Get a list of files and/or directories on the Edge Thing.

Parameters:

path - Directory path - STRING

Returns:

result Browse Results - INFOTABLE - Aspects {dataShape:FileSystemFile}

Throws:

java.lang.Exception - If an error occurs

GetFileListing

@ThingworxExtensionApiMethod(since={7,4})
public InfoTable GetFileListing(java.lang.String path,
                                                                          java.lang.String nameMask)
                                                                   throws java.lang.Exception

Service Category:

FileTransfer

Service Description:

Get file system listing.

Parameters:

path - Directory path - STRING

nameMask - Name mask - STRING

Returns:

result File Results - INFOTABLE - Aspects {dataShape:FileSystemFile}

Throws:

java.lang.Exception - If an error occurs

ListFiles

@ThingworxExtensionApiMethod(since={7,4})
public InfoTable ListFiles(java.lang.String path,
                                                                     java.lang.String nameMask)
                                                              throws java.lang.Exception

Service Category:

FileTransfer

Service Description:

Get file system listing.

Parameters:

path - Directory path - STRING

nameMask - Name mask - STRING

Returns:

result File Results - INFOTABLE - Aspects {dataShape:FileSystemFile}

Throws:

java.lang.Exception - If an error occurs

ListDirectories

@ThingworxExtensionApiMethod(since={7,4})
public InfoTable ListDirectories(java.lang.String path)
                                                                    throws java.lang.Exception

Service Category:

FileTransfer

Service Description:

Get listing of directories.

Parameters:

path - Directory path - STRING

Returns:

result File Results - INFOTABLE - Aspects {dataShape:FileSystemDirectory}

Throws:

java.lang.Exception - If an error occurs

CreateBinaryFile

@ThingworxExtensionApiMethod(since={7,4})
public void CreateBinaryFile(java.lang.String path,
                                                                       byte[] data,
                                                                       java.lang.Boolean overwrite)
                                                                throws java.lang.Exception

Parameters:

path - File path - STRING

data - The data to write to the file - BLOB

overwrite - Overwrite the file if it already exists - BOOLEAN

Throws:

java.lang.Exception - If an error occurs

ReadFromBinaryFile

@ThingworxExtensionApiMethod(since={7,4})
public InfoTable ReadFromBinaryFile(java.lang.String path,
                                                                              java.lang.Double offset,
                                                                              java.lang.Integer count)
                                                                       throws java.lang.Exception

Parameters:

path - File path - STRING

offset - File offset in bytes - NUMBER

count - Number of bytes to read - INTEGER

Returns:

result File Read Results - INFOTABLE - Aspects {dataShape:ReadFromBinaryFileResult}

Throws:

java.lang.Exception - If an error occurs

WriteToBinaryFile

@ThingworxExtensionApiMethod(since={7,4})
public void WriteToBinaryFile(java.lang.String path,
                                                                        java.lang.Double offset,
                                                                        byte[] data)
                                                                 throws java.lang.Exception

Parameters:

path - File path - STRING

offset - File offset in bytes - NUMBER

data - Initial data - BLOB

Throws:

java.lang.Exception - If an error occurs

AppendToBinaryFile

@ThingworxExtensionApiMethod(since={7,4})
public void AppendToBinaryFile(java.lang.String path,
                                                                         byte[] data)
                                                                  throws java.lang.Exception

Parameters:

path - File path - STRING

data - Initial data - BLOB

Throws:

java.lang.Exception - If an error occurs

MoveFile

@ThingworxExtensionApiMethod(since={7,4})
public void MoveFile(java.lang.String sourcePath,
                                                               java.lang.String targetPath,
                                                               java.lang.Boolean overwrite)
                                                        throws java.lang.Exception

Service Category:

FileSystemServices

Service Description:

Move a file.

Parameters:

sourcePath - Path of file to move - STRING

targetPath - Target path - STRING

overwrite - Overwrite existing file - BOOLEAN

Throws:

java.lang.Exception - If an error occurs

DeleteFile

@ThingworxExtensionApiMethod(since={7,4})
public void DeleteFile(java.lang.String path)
                                                          throws java.lang.Exception

Service Category:

FileSystemServices

Service Description:

Delete a file.

Parameters:

path - File path - STRING

Throws:

java.lang.Exception - If an error occurs

GetDirectoryStructure

@ThingworxExtensionApiMethod(since={7,4})
public InfoTable GetDirectoryStructure()
                                                                          throws java.lang.Exception

Service Category:

FileTransfer

Service Description:

Get directory structure.

Returns:

result The directory structure at the edge - INFOTABLE - Aspects {dataShape:FileSystemDirectory}

Throws:

java.lang.Exception - If an error occurs

ValidateFileTransfer

@ThingworxExtensionApiMethod(since={7,4})
public void ValidateFileTransfer(java.lang.String sid,
                                                                           java.lang.String toUri,
                                                                           java.lang.String fromUri,
                                                                           java.lang.String md5)
                                                                    throws java.lang.Exception

Service Category:

FileTransfer

Service Description:

validate the file transfer based on the validation signature.

Parameters:

sid - File transfer Job ID - STRING

toUri - File destination uri - STRING

fromUri - File source uri - STRING

md5 - Checksum signature used for validation - STRING

Throws:

java.lang.Exception - If an error occurs