@ThingworxExtensionApiClass(since={6,6}, canInstantiate=true) public abstract class ServiceProviderEntity extends RootEntity implements IServiceProvider
BASIC_PROPERTIES
NAME_COMPARATOR
Constructor and Description |
---|
ServiceProviderEntity() |
Modifier and Type | Method and Description |
---|---|
ServiceDefinitionCollection |
getInstancePublicServiceDefinitions() |
ServiceDefinition |
getInstanceServiceDefinition(java.lang.String serviceName) |
ServiceDefinitionCollection |
getInstanceServiceDefinitions() |
void |
initializeEntity()
|
void |
preInitializeEntity()
Pre initialize the entity. |
InfoTable |
processAPIServiceRequest(java.lang.String serviceName,
ValueCollection params)
|
InfoTable |
processServiceRequest(java.lang.String serviceName,
ValueCollection params)
|
AddConfigurationTableDefinition, addDesignTimePermission, AddDesignTimePermission, addRunTimePermission, AddRunTimePermission, AddTags, addVisibilityPermission, AddVisibilityPermission, CheckDesignTimePermission, CheckDesignTimePermissionForGroup, CheckDesignTimePermissionForUser, CheckPermission, CheckPermissionForGroup, CheckPermissionForUser, cleanupEntity, cleanupEntity, DeleteAllConfigurationTableRows, DeleteConfigurationTable, 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, 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, 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, validateConfiguration
getID, hasID, isTransient
getDescription, getName, setDescription, setName, toValueCollection
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getID, hasID
getDescription, getName
getID, getName
@ThingworxExtensionApiMethod(since={6,6}, canOverride=true, requiresSuper=true) public void preInitializeEntity() throws java.lang.Exception
RootEntity
preInitializeEntity
in class RootEntity
java.lang.Exception
- If an error occurs@ThingworxExtensionApiMethod(since={6,6}, canOverride=true, requiresSuper=true) public void initializeEntity() throws java.lang.Exception
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.
initializeEntity
in class RootEntity
java.lang.Exception
- If an error occurs@ThingworxExtensionApiMethod(since={6,6}, canOverride=true) public InfoTable processServiceRequest(java.lang.String serviceName, ValueCollection params) throws java.lang.Exception
IServiceProvider
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.
processServiceRequest
in interface IServiceProvider
serviceName
- - The name of the service to invokeparams
- - A collection of parameter mappingsjava.lang.Exception
- If an error occurs
@ThingworxExtensionApiMethod(since={6,6}) public InfoTable processAPIServiceRequest(java.lang.String serviceName, ValueCollection params) throws java.lang.Exception
IServiceProvider
Processes a service request invoked via the REST API. This method performs a service invoke authorization check against the current security context.
processAPIServiceRequest
in interface IServiceProvider
serviceName
- - The name of the service to invokeparams
- - A collection of parameter mappingsjava.lang.Exception
- If an error occurs
@ThingworxExtensionApiMethod(since={6,6}) public ServiceDefinition getInstanceServiceDefinition(java.lang.String serviceName)
getInstanceServiceDefinition
in interface IServiceProvider
@ThingworxExtensionApiMethod(since={6,6}) public ServiceDefinitionCollection getInstanceServiceDefinitions()
getInstanceServiceDefinitions
in interface IServiceProvider
@ThingworxExtensionApiMethod(since={6,6}) public ServiceDefinitionCollection getInstancePublicServiceDefinitions()
getInstancePublicServiceDefinitions
in interface IServiceProvider