Package com.thingworx.system.subsystems

Class Subsystem

java.lang.Object

com.thingworx.types.NamedObject

com.thingworx.persistence.common.PersistableNamedObject

com.thingworx.entities.RootEntity

com.thingworx.entities.ServiceProviderEntity

com.thingworx.entities.ExtensibleRootEntity

com.thingworx.system.subsystems.Subsystem

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:

PlatformSubsystem, SCIMSubsystem, UserManagementSubsystem

@ThingworxExtensionApiClass(since={6,6},
                            canExtendOrImplement=true)
public class Subsystem
extends ExtensibleRootEntity

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_AUTOSTART
static final boolean	DEFAULT_ENABLED

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

Method Summary

Modifier and Type	Method	Description
String	getDependsOn()
RelationshipTypes.ThingworxRelationshipTypes	getEntityType()
String	getFriendlyName()
InfoTable	GetPerformanceMetrics()	Service Category: Metrics Service Description: Get information on how the subsystem is performing.
protected InfoTable	getSubsystemPerformanceMetrics()
SubsystemState	getSubsystemState()
String	GetSubsystemState()	Service Category: Monitoring Service Description: Get the subscriber state.
protected void	initializeSubsystem()
boolean	isAutoStart()
boolean	isEnabled()
boolean	isRunning()
Boolean	IsRunning()	Service Category: Lifecycle Service Description: Check the run status of this subsystem.
void	ResetPerformanceMetrics()	Service Category: Metrics Service Description: Get information on how the subsystem is performing.
protected void	resetSubsystemPerformanceMetrics()
void	Restart()	Service Category: Lifecycle Service Description: Stops and restarts the sub-system.
void	setAutoStart(boolean autoStart)
void	setDependsOn(String value)
void	setFriendlyName(String value)
void	setRunning(boolean value)
void	Start()	Service Category: Lifecycle Service Description: Starts the sub-system.
protected void	startSubsystem(ContextType contextType)	A method to hook into the startup process in the lifecycle of a subsystem.
void	Stop()	Service Category: Lifecycle Service Description: Stops the sub-system.
protected void	stopSubsystem(ContextType contextType)	A method to hook into the shutdown process in the lifecycle of a subsystem.

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

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

See Also:

• Constant Field Values

DEFAULT_AUTOSTART

public static final boolean DEFAULT_AUTOSTART

See Also:

• Constant Field Values

Constructor Details

Subsystem

@ThingworxExtensionApiMethod(since={6,6})
public Subsystem()

Method Details

isEnabled

@ThingworxExtensionApiMethod(since={6,6})
public boolean isEnabled()

getFriendlyName

@ThingworxExtensionApiMethod(since={6,6})
public String getFriendlyName()

setFriendlyName

@ThingworxExtensionApiMethod(since={6,6})
public void setFriendlyName(String value)

getSubsystemState

@ThingworxExtensionApiMethod(since={6,6})
public SubsystemState getSubsystemState()

initializeSubsystem

@ThingworxExtensionApiMethod(since={6,6},
                             canOverride=true)
protected void initializeSubsystem()
                            throws Exception

Throws:

Exception - If an error occurs

startSubsystem

@ThingworxExtensionApiMethod(since={9,0},
                             canOverride=true)
protected void startSubsystem(ContextType contextType)
                       throws Exception

A method to hook into the startup process in the lifecycle of a subsystem. As of 9.0, this method replaced startSubsystem(), which is no long valid because all lifecycle events must be aware of the ContextType in which the method is called in order to appropriately make changes.

Parameters:

contextType - - the type of change happening when this method is called

Throws:

Exception

stopSubsystem

@ThingworxExtensionApiMethod(since={9,0},
                             canOverride=true)
protected void stopSubsystem(ContextType contextType)
                      throws Exception

A method to hook into the shutdown process in the lifecycle of a subsystem. As of 9.0, this method replaced startSubsystem(), which is no long valid because all lifecycle events must be aware of the ContextType in which the method is called in order to appropriately make changes.

Parameters:

contextType - - the type of change happening when this method is called

Throws:

Exception

Start

@ThingworxExtensionApiMethod(since={6,6})
public void Start()
           throws Exception

Service Category:

Lifecycle

Service Description:

Starts the sub-system.

Throws:

Exception - If an error occurs

Stop

@ThingworxExtensionApiMethod(since={6,6})
public void Stop()
          throws Exception

Service Category:

Lifecycle

Service Description:

Stops the sub-system.

Throws:

Exception - If an error occurs

IsRunning

@ThingworxExtensionApiMethod(since={6,6})
public Boolean IsRunning()
                  throws Exception

Service Category:

Lifecycle

Service Description:

Check the run status of this subsystem.

Returns:

result Run status - BOOLEAN

Throws:

Exception - If an error occurs

Restart

@ThingworxExtensionApiMethod(since={6,6})
public void Restart()
             throws Exception

Service Category:

Lifecycle

Service Description:

Stops and restarts the sub-system.

Throws:

Exception - If an error occurs

GetSubsystemState

@ThingworxExtensionApiMethod(since={6,6})
public String GetSubsystemState()
                         throws Exception

Service Category:

Monitoring

Service Description:

Get the subscriber state.

Returns:

result Current subscriber state - STRING

Throws:

Exception - If an error occurs

GetPerformanceMetrics

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetPerformanceMetrics()
                                throws Exception

Service Category:

Metrics

Service Description:

Get information on how the subsystem is performing.

Returns:

result Performance metrics - INFOTABLE - Aspects {dataShape:ThingworxMetric}

Throws:

Exception - If an error occurs

ResetPerformanceMetrics

@ThingworxExtensionApiMethod(since={6,6})
public void ResetPerformanceMetrics()
                             throws Exception

Service Category:

Metrics

Service Description:

Get information on how the subsystem is performing.

Throws:

Exception - If an error occurs

getSubsystemPerformanceMetrics

@ThingworxExtensionApiMethod(since={6,6},
                             canOverride=true)
protected InfoTable getSubsystemPerformanceMetrics()
                                            throws Exception

Throws:

Exception - If an error occurs

resetSubsystemPerformanceMetrics

@ThingworxExtensionApiMethod(since={6,6},
                             canOverride=true)
protected void resetSubsystemPerformanceMetrics()

isRunning

@ThingworxExtensionApiMethod(since={6,6})
public boolean isRunning()

setRunning

@ThingworxExtensionApiMethod(since={6,6})
public void setRunning(boolean value)

getDependsOn

@ThingworxExtensionApiMethod(since={6,6})
public String getDependsOn()

setDependsOn

@ThingworxExtensionApiMethod(since={6,6})
public void setDependsOn(String value)

isAutoStart

@ThingworxExtensionApiMethod(since={6,6})
public boolean isAutoStart()

setAutoStart

@ThingworxExtensionApiMethod(since={6,6})
public void setAutoStart(boolean autoStart)

getEntityType

@ThingworxExtensionApiMethod(since={6,6})
public RelationshipTypes.ThingworxRelationshipTypes getEntityType()

Description copied from class: RootEntity

Returns the type of this entity.

Specified by:

getEntityType in class RootEntity

Returns:

the entity type