Package com.thingworx.queueproviders

Class QueueProvider

java.lang.Object

com.thingworx.types.NamedObject

com.thingworx.persistence.common.PersistableNamedObject

com.thingworx.entities.RootEntity

com.thingworx.entities.ServiceProviderEntity

com.thingworx.queueproviders.QueueProvider

All Implemented Interfaces:

IConfigurableObject, INotScriptFriendly, ISupportsDeprecation, IDiffableObject, IAvatar, IEntityLifeCycleEvent, IPersistable, IServiceProvider, ITaggableObject, IDependencyScannableObject, IEntityDefinition, IPersistableObject<String>, IQueueProvider, IDesignTimeSecurable, IDesignTimeSecurableEntity, IRunTimeSecurable, IRunTimeSecurableEntity, ISecurable, IVisibilitySecurable, IVisibilitySecurableEntity, IAspectContainer, INamedObject, Serializable

@ThingworxExtensionApiClass(since={10,0},
                            canInstantiate=true)
public abstract class QueueProvider
extends ServiceProviderEntity
implements IQueueProvider

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	QueueProvider.IQueueConnection

Nested classes/interfaces inherited from interface com.thingworx.queueproviders.IQueueProvider

IQueueProvider.IQueueEntryPublisher

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONNECTION_INFO
static final String	DECLARED_QUEUES
static final String	PROP_QUEUEPROVIDERPACKAGENAME

Fields inherited from class com.thingworx.entities.RootEntity

BASIC_PROPERTY_DEFINITIONS, EXCLUDED_ENTITY_TYPES_IN_PROJECT

Fields inherited from class com.thingworx.types.NamedObject

NAME_COMPARATOR

Fields inherited from interface com.thingworx.queueproviders.IQueueProvider

QUEUE_NAME

Constructor Summary

Constructors

Constructor	Description
QueueProvider()	Initializes this instace with default values.

Method Summary

Modifier and Type	Method	Description
boolean	Connect(Boolean forceReconnect)	Service Category: Connectivity Service Description: Connect to the external messaging system using the values specified in the Connection Information configuration table.
protected abstract QueueProvider.IQueueConnection	createConnection(boolean validateConfiguration)
void	DeleteQueue(String queueName, Boolean deleteFromExternalMessagingSystem)	Service Category: QueuesManagement Service Description: Delete Queue.
protected abstract void	deleteQueueFromExternalMessagingSystem(String queueName, boolean throwIfNotExists, String errorMessagePrefix)
boolean	Disconnect()	Service Category: Connectivity Service Description: Disconnect from the remote system.
protected final ValueCollection	findDeclaredQueueRowCaseSensitive(String fieldName, String fieldValue)
String	GetConnectedIoTStreamForQueue(String queueName)	Service Category: QueuesManagement Service Description: Get the name of the IoT Stream that is using the queue with given name.
protected final QueueProvider.IQueueConnection	getConnection()
protected abstract String	getConnectionTarget()	Return the connection target, e.g.
final List<String>	getDeclaredQueues()
InfoTable	GetDeclaredQueues()	Service Category: QueuesManagement Service Description: Get a list of all declared queues.
boolean	getEnabled()
final RelationshipTypes.ThingworxRelationshipTypes	getEntityType()	Returns the type of this entity.
boolean	getIsDefaultQueueProvider()
String	getQueueProviderPackageName()
void	initializeQueue(String queueName, ConfigurationTable queueConfig)	Perform necessary actions to prepare queue for future writes/reads.
InfoTable	IsConnected()	Service Category: Connectivity Service Description: Check whether the Queue Provider is currently connected to the external messaging system.
InfoTable	TestConnectivity()	Service Category: Connectivity Service Description: Performs a test to verify the connectivity to the external messaging system using the values specified in the Connection Information configuration table.

Methods inherited from class com.thingworx.entities.ServiceProviderEntity

getInstancePublicServiceDefinitions, getInstanceServiceDefinition, getInstanceServiceDefinitions, initializeEntity, preInitializeEntity, processAPIServiceRequest, processServiceRequest

Methods inherited from class com.thingworx.entities.RootEntity

AddConfigurationTableDefinition, AddConfigurationTableDefinition, addDesignTimePermission, AddDesignTimePermission, addRunTimePermission, AddRunTimePermission, AddTags, addVisibilityPermission, AddVisibilityPermission, CheckDesignTimePermission, CheckDesignTimePermissionForGroup, CheckDesignTimePermissionForUser, CheckPermission, CheckPermissionForGroup, CheckPermissionForUser, cleanupEntity, DeleteAllConfigurationTableRows, DeleteConfigurationTable, DeleteConfigurationTableRows, DeleteConfigurationTableRows, deleteDesignTimePermission, DeleteDesignTimePermission, deleteRunTimePermission, DeleteRunTimePermission, deleteVisibilityPermission, DeleteVisibilityPermission, dispose, getAspects, GetAvatar, getAvatarContent, GetAvatarURL, GetConfigurationChangeHistory, getConfigurationSetting, getConfigurationTable, GetConfigurationTable, GetConfigurationTableDefinition, GetConfigurationTableRow, GetConfigurationTables, GetDescription, getDesignTimePermissions, GetDesignTimePermissions, GetDesignTimePermissionsAsJSON, getDocumentationContent, getEntityTypeAsString, GetEventDefinition, GetEventDefinitions, GetHomeMashup, GetIncomingDependencies, GetIncomingDependenciesAsNetwork, GetInstanceMetadataAsJSON, GetInstanceMetadataWithPermissionsAsJSON, GetLastModifiedDate, GetMetadata, GetMetadataAsJSON, GetMetadataWithPermissionsAsJSON, GetOutgoingDependencies, GetOutgoingDependenciesAsNetwork, getOwner, 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, ListDeprecatedUsage, persistDesignTimePermissions, persistRunTimePermissions, persistVisibilityPermissions, RemoveTags, SaveConfigurationTables, SetAvatar, setConfigurationSetting, SetConfigurationTable, SetConfigurationTableRows, SetDescription, setDesignTimePermissions, SetDesignTimePermissionsAsJSON, setDocumentationContent, setExtensionObject, SetHomeMashup, setLastModifiedDate, SetMultiRowConfigurationTable, setOwner, SetOwner, SetProjectName, setRunTimePermissions, SetRunTimePermissionsAsJSON, setStringConfigurationSetting, SetTags, setVisibilityPermissions, SetVisibilityPermissionsAsJSON, toJSON, toJSONDefinition, UpdateProjectDependencies, validateConfiguration

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.types.INamedObject

getDescription, getName

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

getID, hasID

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

getID, getName

Methods inherited from interface com.thingworx.deprecation.ISupportsDeprecation

getDeprecated, isDeprecated, isDeprecatedBefore, since

Field Details

PROP_QUEUEPROVIDERPACKAGENAME

public static final String PROP_QUEUEPROVIDERPACKAGENAME

See Also:

• Constant Field Values

CONNECTION_INFO

public static final String CONNECTION_INFO

See Also:

• Constant Field Values

DECLARED_QUEUES

public static final String DECLARED_QUEUES

See Also:

• Constant Field Values

Constructor Details

QueueProvider

public QueueProvider()

Initializes this instace with default values.

Method Details

getEnabled

@ThingworxExtensionApiMethod(since={10,0})
public boolean getEnabled()

getQueueProviderPackageName

@ThingworxExtensionApiMethod(since={10,0})
public String getQueueProviderPackageName()

getIsDefaultQueueProvider

@ThingworxExtensionApiMethod(since={10,0})
public boolean getIsDefaultQueueProvider()

getEntityType

@ThingworxExtensionApiMethod(since={10,0})
public final RelationshipTypes.ThingworxRelationshipTypes getEntityType()

Description copied from class: RootEntity

Returns the type of this entity.

Specified by:

getEntityType in class RootEntity

Returns:

the entity type

TestConnectivity

@ThingworxExtensionApiMethod(since={10,0})
public InfoTable TestConnectivity()
                           throws Exception

Service Category:

Connectivity

Service Description:

Performs a test to verify the connectivity to the external messaging system using the values specified in the Connection Information configuration table.

Returns:

result An infotable informing whether the configured external messaging system is reachable - INFOTABLE

Throws:

Exception - if an error occurs

IsConnected

@ThingworxExtensionApiMethod(since={10,0})
public InfoTable IsConnected()
                      throws Exception

Service Category:

Connectivity

Service Description:

Check whether the Queue Provider is currently connected to the external messaging system.

Returns:

result An infotable containing the status of the connection - INFOTABLE

Throws:

Exception - if an error occurs

Connect

@ThingworxExtensionApiMethod(since={10,0})
public boolean Connect(Boolean forceReconnect)
                throws Exception

Service Category:

Connectivity

Service Description:

Connect to the external messaging system using the values specified in the Connection Information configuration table.

Parameters:

forceReconnect - If not set, will return true and not attempt connecting if already connected. If set, will disconnect and attempt connecting again.

Returns:

true if connection attempt succeeded or already connected, otherwise false

Throws:

Exception - if an error occurs

Disconnect

@ThingworxExtensionApiMethod(since={10,0})
public boolean Disconnect()
                   throws Exception

Service Category:

Connectivity

Service Description:

Disconnect from the remote system.

Returns:

true if disconnected successfully or not previously connected, otherwise false.

Throws:

Exception - if an error occurs

GetDeclaredQueues

@ThingworxExtensionApiMethod(since={10,0})
public InfoTable GetDeclaredQueues()
                            throws Exception

Service Category:

QueuesManagement

Service Description:

Get a list of all declared queues.

Returns:

result An infotable containing the names of all declared queues - INFOTABLE

Throws:

Exception - if an error occurs

GetConnectedIoTStreamForQueue

@ThingworxExtensionApiMethod(since={10,0})
public String GetConnectedIoTStreamForQueue(String queueName)
                                     throws Exception

Service Category:

QueuesManagement

Service Description:

Get the name of the IoT Stream that is using the queue with given name.

Parameters:

queueName - Queue name - STRING

Returns:

result The name of the IoT Stream that is using this queue - STRING

Throws:

Exception - if an error occurs

DeleteQueue

@ThingworxExtensionApiMethod(since={10,0})
public void DeleteQueue(String queueName,
 Boolean deleteFromExternalMessagingSystem)
                 throws Exception

Service Category:

QueuesManagement

Service Description:

Delete Queue.

Parameters:

queueName - Queue Name - STRING

deleteFromExternalMessagingSystem - Delete the queue representation from the external messaging system - BOOLEAN

Throws:

Exception - if an error occurs

initializeQueue

@ThingworxExtensionApiMethod(since={10,0})
public void initializeQueue(String queueName,
 ConfigurationTable queueConfig)
                     throws Exception

Description copied from interface: IQueueProvider

Perform necessary actions to prepare queue for future writes/reads. Could be actions such as creating new queue or validation of existing queue access, etc. Will throw an exception on initialization failure.

Specified by:

initializeQueue in interface IQueueProvider

Parameters:

queueName - queue name (if queue not declared, will throw an exception)

queueConfig - queue configuration

Throws:

Exception

getDeclaredQueues

@ThingworxExtensionApiMethod(since={10,0})
public final List<String> getDeclaredQueues()
                                     throws Exception

Throws:

Exception

getConnection

@ThingworxExtensionApiMethod(since={10,0})
protected final QueueProvider.IQueueConnection getConnection()

getConnectionTarget

@ThingworxExtensionApiMethod(since={10,0})
protected abstract String getConnectionTarget()

Return the connection target, e.g. Kafka broker URL, Azure Event Hubs namespace, etc.

createConnection

@ThingworxExtensionApiMethod(since={10,0})
protected abstract QueueProvider.IQueueConnection createConnection(boolean validateConfiguration)
                                                            throws Exception

Throws:

Exception

deleteQueueFromExternalMessagingSystem

@ThingworxExtensionApiMethod(since={10,0})
protected abstract void deleteQueueFromExternalMessagingSystem(String queueName,
 boolean throwIfNotExists,
 String errorMessagePrefix)
                                                        throws Exception

Throws:

Exception

findDeclaredQueueRowCaseSensitive

@ThingworxExtensionApiMethod(since={10,0})
protected final ValueCollection findDeclaredQueueRowCaseSensitive(String fieldName,
 String fieldValue)
                                                           throws Exception

Throws:

Exception