com.thingworx.entities.interfaces

Interface IServiceProvider

All Superinterfaces:

INamedObject, IPersistable

All Known Implementing Classes:

AlertServices, ApplicationKey, Authenticator, CollectionsServices, ContentLoader, CustomAuthenticator, DashboardFunctions, DataShape, DataTableThing, DataThing, DataThingWithEvents, DeviceFunctions, DirectoryService, EncryptionServices, EntityServices, ExtensibleRootEntity, ExtensionPackage, FileRepositoryThing, Group, InfoTableFunctions, LocalizationTable, MediaEntity, Menu, Network, NotificationHandler, Organization, PlatformSubsystem, Project, RemoteThing, RemoteThingWithFileTransfer, RemoteThingWithTunnels, RemoteThingWithTunnelsAndFileTransfer, ReportingStrategy, Resource, RuntimeLocalizationFunctions, SCIMSubsystem, ScriptServices, Searcher, SecurityClaimsAuthenticator, SecurityMonitorThing, ServiceProviderEntity, SessionInfo, SourceControlFunctions, StreamThing, Subsystem, SubsystemMonitoring, Thing, ThingShape, ThingTemplate, User, UserManagementSubsystem, Vocabulary

@ThingworxExtensionApiClass(since={6,6})
public interface IServiceProvider
extends IPersistable

Method Summary

Modifier and Type	Method and Description
ServiceDefinitionCollection	getInstancePublicServiceDefinitions()
ServiceDefinition	getInstanceServiceDefinition(java.lang.String serviceName)
ServiceDefinitionCollection	getInstanceServiceDefinitions()
InfoTable	processAPIServiceRequest(java.lang.String serviceName, ValueCollection params)
InfoTable	processServiceRequest(java.lang.String serviceName, ValueCollection params)

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

getID, hasID

Methods inherited from interface com.thingworx.types.INamedObject

getDescription, getName

Method Detail

processServiceRequest

@ThingworxExtensionApiMethod(since={6,6},
                             canOverride=true,
                             requiresSuper=true)
InfoTable processServiceRequest(java.lang.String serviceName,
                                                                                                                                                                          ValueCollection params)
                                                                                                                                                                   throws java.lang.Exception

Processes an internal or reflected service request. Entities may call this method if they wish to invoke a service call directly on an entity. This method performs a service invoke authorization check against the current security context.

Parameters:

serviceName - - The name of the service to invoke

params - - A collection of parameter mappings

Returns:

The results of the service invocation

Throws:

java.lang.Exception - If the security check fails, the service does not exist, or an error occurred during the execution of the service

processAPIServiceRequest

@ThingworxExtensionApiMethod(since={7,2,0},
                             canOverride=true,
                             requiresSuper=true)
InfoTable processAPIServiceRequest(java.lang.String serviceName,
                                                                                                                                                                               ValueCollection params)
                                                                                                                                                                        throws java.lang.Exception

Processes a service request invoked via the REST API. This method performs a service invoke authorization check against the current security context.

Parameters:

serviceName - - The name of the service to invoke

params - - A collection of parameter mappings

Returns:

The results of the service invocation

Throws:

java.lang.Exception - If the security check fails, the service does not exist, or an error occurred during the execution of the service

getInstanceServiceDefinition

@ThingworxExtensionApiMethod(since={6,6})
ServiceDefinition getInstanceServiceDefinition(java.lang.String serviceName)

getInstanceServiceDefinitions

@ThingworxExtensionApiMethod(since={6,6})
ServiceDefinitionCollection getInstanceServiceDefinitions()

getInstancePublicServiceDefinitions

@ThingworxExtensionApiMethod(since={6,6})
ServiceDefinitionCollection getInstancePublicServiceDefinitions()