@ThingworxExtensionApiClass(since={7,4}) public class RemoteThingWithFileTransfer extends RemoteThing
STORE_AND_FORWARD_IS_NOT_ENABLED
_logger, DATASHAPE_INCOMING_LOCAL_PROPERTY_BINDING, DEFAULT_SETTINGS_TABLE, ENTITYLIST_SHAPE, GENERIC_THING_TEMPLATE, TYPE_THING
BASIC_PROPERTIES
NAME_COMPARATOR
Constructor and Description |
---|
RemoteThingWithFileTransfer() |
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) |
AddDynamicRemoteSubscription, callService, checkConnection, executeRemoteService, GetEventSubscriptions, getLastConnectionTime, GetPropertySubscriptions, GetPropertySubscriptions, GetQueuedTasks, GetRemoteMetadata, initializeThing, initializeThing, isConnected, ProcessRemoteEvents, processRemoteService, RemoveDynamicRemoteSubscription, SendMaxQueuedTasks, SendQueuedTasks, startThing, stopThing, UpdateSubscribedPropertyValues
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
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
getID, hasID, isTransient
getDescription, getName, setDescription, setName, toValueCollection
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getName
getID, hasID
getDescription
getID, getName
@ThingworxExtensionApiMethod(since={7,4}) public RemoteThingWithFileTransfer()
@ThingworxExtensionApiMethod(since={7,4}) public java.lang.Boolean IsDerivedFromTemplate(java.lang.String thingTemplateName) throws java.lang.Exception
IsDerivedFromTemplate
in class Thing
thingTemplateName
- Thing template name - THINGTEMPLATENAMEjava.lang.Exception
- If an error occurs@ThingworxExtensionApiMethod(since={7,4}) public void StartFileTransfer(java.lang.String tid, java.lang.String path, java.lang.String mode) throws java.lang.Exception
tid
- Transfer Id - STRINGpath
- File path - STRINGmode
- Indicates if the file will be open in 'read' or 'write' mode - STRINGjava.lang.Exception
- If an error occurs@ThingworxExtensionApiMethod(since={7,4}) public void CompleteFileTransfer(InfoTable job) throws java.lang.Exception
job
- The transfer job being completed - INFOTABLEjava.lang.Exception
- If an error occurs@ThingworxExtensionApiMethod(since={7,4}) public void CancelFileTransfer(InfoTable job) throws java.lang.Exception
job
- The transfer job being completed - INFOTABLEjava.lang.Exception
- If an error occurs@ThingworxExtensionApiMethod(since={7,4}) public InfoTable GetTransferInfo() throws java.lang.Exception
java.lang.Exception
- If an error occurs@ThingworxExtensionApiMethod(since={7,4}) public InfoTable GetFileInfo(java.lang.String path) throws java.lang.Exception
path
- File path - STRINGjava.lang.Exception
- If an error occurs@ThingworxExtensionApiMethod(since={8,4}) public InfoTable GetSupportedFileChecksumAlgorithms() throws java.lang.Exception
java.lang.Exception
- If an error occurs@Deprecated @ThingworxExtensionApiMethod(since={7,4}, deprecatedSince={8,4,0}) public java.lang.String GetFileChecksum(java.lang.String path) throws java.lang.Exception
java.lang.Exception
- If an error occurs@ThingworxExtensionApiMethod(since={8,4}) public java.lang.String GetFileChecksum(java.lang.String path, java.lang.String checksumAlgorithm) throws java.lang.Exception
path
- The path to the file to conduct a checksum onchecksumAlgorithm
- The name of the checksum algorithm to usejava.lang.Exception
- Thrown if the cryptographic algorithm provided is invalid or is not recognized by the server@ThingworxExtensionApiMethod(since={7,4}) public InfoTable BrowseFileSystem(java.lang.String path) throws java.lang.Exception
path
- Directory path - STRINGjava.lang.Exception
- If an error occurs@ThingworxExtensionApiMethod(since={7,4}) public InfoTable BrowseDirectory(java.lang.String path) throws java.lang.Exception
path
- Directory path - STRINGjava.lang.Exception
- If an error occurs@ThingworxExtensionApiMethod(since={7,4}) public InfoTable GetFileListing(java.lang.String path, java.lang.String nameMask) throws java.lang.Exception
path
- Directory path - STRINGnameMask
- Name mask - STRINGjava.lang.Exception
- If an error occurs@ThingworxExtensionApiMethod(since={7,4}) public InfoTable ListFiles(java.lang.String path, java.lang.String nameMask) throws java.lang.Exception
path
- Directory path - STRINGnameMask
- Name mask - STRINGjava.lang.Exception
- If an error occurs@ThingworxExtensionApiMethod(since={7,4}) public InfoTable ListDirectories(java.lang.String path) throws java.lang.Exception
path
- Directory path - STRINGjava.lang.Exception
- If an error occurs@ThingworxExtensionApiMethod(since={7,4}) public void CreateBinaryFile(java.lang.String path, byte[] data, java.lang.Boolean overwrite) throws java.lang.Exception
path
- File path - STRINGdata
- The data to write to the file - BLOBoverwrite
- Overwrite the file if it already exists - BOOLEANjava.lang.Exception
- If an error occurs@ThingworxExtensionApiMethod(since={7,4}) public InfoTable ReadFromBinaryFile(java.lang.String path, java.lang.Double offset, java.lang.Integer count) throws java.lang.Exception
path
- File path - STRINGoffset
- File offset in bytes - NUMBERcount
- Number of bytes to read - INTEGERjava.lang.Exception
- If an error occurs@ThingworxExtensionApiMethod(since={7,4}) public void WriteToBinaryFile(java.lang.String path, java.lang.Double offset, byte[] data) throws java.lang.Exception
path
- File path - STRINGoffset
- File offset in bytes - NUMBERdata
- Initial data - BLOBjava.lang.Exception
- If an error occurs@ThingworxExtensionApiMethod(since={7,4}) public void AppendToBinaryFile(java.lang.String path, byte[] data) throws java.lang.Exception
path
- File path - STRINGdata
- Initial data - BLOBjava.lang.Exception
- If an error occurs@ThingworxExtensionApiMethod(since={7,4}) public void MoveFile(java.lang.String sourcePath, java.lang.String targetPath, java.lang.Boolean overwrite) throws java.lang.Exception
sourcePath
- Path of file to move - STRINGtargetPath
- Target path - STRINGoverwrite
- Overwrite existing file - BOOLEANjava.lang.Exception
- If an error occurs@ThingworxExtensionApiMethod(since={7,4}) public void DeleteFile(java.lang.String path) throws java.lang.Exception
path
- File path - STRINGjava.lang.Exception
- If an error occurs@ThingworxExtensionApiMethod(since={7,4}) public InfoTable GetDirectoryStructure() throws java.lang.Exception
java.lang.Exception
- If an error occurs@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
sid
- File transfer Job ID - STRINGtoUri
- File destination uri - STRINGfromUri
- File source uri - STRINGmd5
- Checksum signature used for validation - STRINGjava.lang.Exception
- If an error occurs