com.thingworx.things.connected

Class RemoteThingWithTunnels

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

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

Direct Known Subclasses:

RemoteThingWithTunnelsAndFileTransfer

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

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
RemoteThingWithTunnels()

Method Summary

Modifier and Type	Method and Description
void	AddTunnel(java.lang.String name, java.lang.String host, java.lang.Double port, java.lang.String proto, java.lang.Double numConnects, java.lang.String description, java.lang.String appUri) Service Category: Tunneling Service Description: Register a new tunnel endpoint at the edge.
void	CompleteTunnel(java.lang.String tid, org.joda.time.DateTime start_time, org.joda.time.DateTime stop_time, java.lang.String peer_name, org.json.JSONObject connection)
InfoTable	GetTunnel(java.lang.String name) Service Category: Tunneling Service Description: Get information about a specific tunnel endpoint registered at the edge.
InfoTable	GetTunnelNames() Service Category: Tunneling Service Description: Get a list of Tunnels registered at the edge.
InfoTable	GetTunnels() Service Category: Tunneling Service Description: Get a list of Tunnel Endpoints registered at the edge.
InfoTable	GetTunnelStatus() Service Category: Tunneling Service Description: Get the tunnel status and access URL.
void	initializeThing()
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.
void	RemoveTunnel(java.lang.String name) Service Category: Tunneling Service Description: Remove a tunnel endpoint from the edge.
void	StartTunnel(java.lang.String tid, java.lang.String type, java.lang.Integer chunksize, java.lang.Integer idle_timeout, java.lang.Integer read_timeout, java.lang.Integer startup_timeout, org.json.JSONObject connection)
void	TunnelCommandFromEdge(java.lang.String tid, java.lang.String command)
void	TunnelCommandToEdge(java.lang.String tid, java.lang.String command)

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

RemoteThingWithTunnels

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

Method Detail

initializeThing

@ThingworxExtensionApiMethod(since={7,4},
                             canOverride=true,
                             requiresSuper=true)
public void initializeThing()
                                                                                                                                                               throws java.lang.Exception

Description copied from class: Thing

An initialization hook for subclasses of Thing. Some resources of Thing may not be available at this point in the lifecycle.

Overrides:

initializeThing in class RemoteThing

Throws:

java.lang.Exception - If an error occurs

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 Thing

Parameters:

thingTemplateName - Thing template name - THINGTEMPLATENAME

Returns:

result Is Derived From Template - BOOLEAN

Throws:

java.lang.Exception - If an error occurs

GetTunnelNames

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

Service Category:

Tunneling

Service Description:

Get a list of Tunnels registered at the edge.

Returns:

result Tunnel names - INFOTABLE - Aspects {dataShape:EntityList}

Throws:

java.lang.Exception - If an error occurs

GetTunnelStatus

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

Service Category:

Tunneling

Service Description:

Get the tunnel status and access URL.

Returns:

result Tunnel status - INFOTABLE - Aspects {dataShape:TunnelStatus}

Throws:

java.lang.Exception - If an error occurs

GetTunnels

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

Service Category:

Tunneling

Service Description:

Get a list of Tunnel Endpoints registered at the edge.

Returns:

result List of registered tunnel endpoints - INFOTABLE - Aspects {dataShape:TunnelEndpoint}

Throws:

java.lang.Exception - If an error occurs

AddTunnel

@ThingworxExtensionApiMethod(since={7,4})
public void AddTunnel(java.lang.String name,
                                                                java.lang.String host,
                                                                java.lang.Double port,
                                                                java.lang.String proto,
                                                                java.lang.Double numConnects,
                                                                java.lang.String description,
                                                                java.lang.String appUri)
                                                         throws java.lang.Exception

Service Category:

Tunneling

Service Description:

Register a new tunnel endpoint at the edge.

Parameters:

name - Name of the tunnel to add - STRING

host - Host that the tunnel will connect to - STRING

port - Port that the tunnel will connect to - NUMBER

proto - Protocol used by the tunnel - STRING

numConnects - The number of connections required to initilaize the tunnel - NUMBER

description - Description of the tunnel - STRING

appUri - Location of the client app that will use this tunnel - STRING

Throws:

java.lang.Exception - If an error occurs

RemoveTunnel

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

Service Category:

Tunneling

Service Description:

Remove a tunnel endpoint from the edge.

Parameters:

name - Name of the tunnel to remove - STRING

Throws:

java.lang.Exception - If an error occurs

GetTunnel

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

Service Category:

Tunneling

Service Description:

Get information about a specific tunnel endpoint registered at the edge.

Parameters:

name - Name of the tunnel to query - STRING

Returns:

result A tunnel endpoint - INFOTABLE - Aspects {dataShape:TunnelEndpoint}

Throws:

java.lang.Exception - If an error occurs

StartTunnel

@ThingworxExtensionApiMethod(since={7,4})
public void StartTunnel(java.lang.String tid,
                                                                  java.lang.String type,
                                                                  java.lang.Integer chunksize,
                                                                  java.lang.Integer idle_timeout,
                                                                  java.lang.Integer read_timeout,
                                                                  java.lang.Integer startup_timeout,
                                                                  org.json.JSONObject connection)
                                                           throws java.lang.Exception

Parameters:

tid - Id of the tunnel - STRING

type - Type of tunnel, tcp or udp - STRING

chunksize - Max size of tunnel data to send - INTEGER

idle_timeout - How long tunnel can remain idle before it will be closed - INTEGER

read_timeout - Read timout on tunnel socket - INTEGER

startup_timeout - Read timout on tunnel socket - INTEGER

connection - The connection parameters - JSON

Throws:

java.lang.Exception - If an error occurs

CompleteTunnel

@ThingworxExtensionApiMethod(since={7,4})
public void CompleteTunnel(java.lang.String tid,
                                                                     org.joda.time.DateTime start_time,
                                                                     org.joda.time.DateTime stop_time,
                                                                     java.lang.String peer_name,
                                                                     org.json.JSONObject connection)
                                                              throws java.lang.Exception

Parameters:

tid - Id of the tunnel - STRING

start_time - Start time of the tunnel - DATETIME

stop_time - Stop time of the tunnel - DATETIME

peer_name - Name of the peer connected to this tunnel - STRING

connection - The connection parameters - JSON

Throws:

java.lang.Exception - If an error occurs

TunnelCommandToEdge

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

Parameters:

tid - Id of the tunnel - STRING

command - The command - STRING

Throws:

java.lang.Exception - If an error occurs

TunnelCommandFromEdge

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

Parameters:

tid - Id of the tunnel - STRING

command - The command - STRING

Throws:

java.lang.Exception - If an error occurs