Package com.thingworx.entities

Class ServiceProviderEntity

java.lang.Object

com.thingworx.types.NamedObject

com.thingworx.persistence.common.PersistableNamedObject

com.thingworx.entities.RootEntity

com.thingworx.entities.ServiceProviderEntity

All Implemented Interfaces:

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

Direct Known Subclasses:

ApplicationKey, Authenticator, DataShape, ExtensibleRootEntity, Group, LocalizationTable, MediaEntity, Menu, Network, Organization, Project, QueueProvider, ThingShape, ThingTemplate, User, Vocabulary

@ThingworxExtensionApiClass(since={6,6},
                            canInstantiate=true)
public abstract class ServiceProviderEntity
extends RootEntity
implements IServiceProvider

See Also:

• Serialized Form

Field Summary

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ServiceDefinitionCollection	getInstancePublicServiceDefinitions()
ServiceDefinition	getInstanceServiceDefinition(String serviceName)
ServiceDefinitionCollection	getInstanceServiceDefinitions()
void	initializeEntity(ContextType contextType)	Initializes the internal state of the entity.
void	preInitializeEntity()	Pre initialize the entity.
InfoTable	processAPIServiceRequest(String serviceName, ValueCollection params)	Processes a service request invoked via the REST API.
InfoTable	processServiceRequest(String serviceName, ValueCollection params)	Processes an internal or reflected service request.

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, getEntityType, 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

Constructor Details

ServiceProviderEntity

public ServiceProviderEntity()

Initializes this instace with default values.

Method Details

preInitializeEntity

@ThingworxExtensionApiMethod(since={6,6},
                             canOverride=true,
                             requiresSuper=true)
public void preInitializeEntity()
                         throws Exception

Description copied from class: RootEntity

Pre initialize the entity.

Overrides:

preInitializeEntity in class RootEntity

Throws:

Exception - if an error occurs during the pre-initialization process

initializeEntity

@ThingworxExtensionApiMethod(since={9,0},
                             canOverride=true,
                             requiresSuper=true)
public void initializeEntity(ContextType contextType)
                      throws Exception

Description copied from class: RootEntity

Initializes the internal state of the entity. This method may be called more than once on the same entity during initialization.

All metadata, including aspects and configuration tables, are available at this point in the lifecycle.

Overrides:

initializeEntity in class RootEntity

Parameters:

contextType - the patch operation

Throws:

Exception - if an error occurs during the initialization process

processServiceRequest

@ThingworxExtensionApiMethod(since={6,6},
                             canOverride=true)
public InfoTable processServiceRequest(String serviceName,
 ValueCollection params)
                                throws 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.

Specified by:

processServiceRequest in interface IServiceProvider

Parameters:

serviceName - - The name of the service to invoke

params - - A collection of parameter mappings

Returns:

The results of the service invocation

Throws:

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

processAPIServiceRequest

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable processAPIServiceRequest(String serviceName,
 ValueCollection params)
                                   throws Exception

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

Specified by:

processAPIServiceRequest in interface IServiceProvider

Parameters:

serviceName - - The name of the service to invoke

params - - A collection of parameter mappings

Returns:

The results of the service invocation

Throws:

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})
public ServiceDefinition getInstanceServiceDefinition(String serviceName)

Specified by:

getInstanceServiceDefinition in interface IServiceProvider

getInstanceServiceDefinitions

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

Specified by:

getInstanceServiceDefinitions in interface IServiceProvider

getInstancePublicServiceDefinitions

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

Specified by:

getInstancePublicServiceDefinitions in interface IServiceProvider