Package com.thingworx.security.applicationkeys

Class ApplicationKey

java.lang.Object

com.thingworx.types.NamedObject

com.thingworx.persistence.common.PersistableNamedObject

com.thingworx.entities.RootEntity

com.thingworx.entities.ServiceProviderEntity

com.thingworx.security.applicationkeys.ApplicationKey

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

@ThingworxExtensionApiClass(since={6,6},
                            canInstantiate=true)
public class ApplicationKey
extends ServiceProviderEntity

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

Method Summary

Modifier and Type	Method	Description
User	getAssociatedUser()
EntityReferenceTypeMap	getDependencies()
RelationshipTypes.ThingworxRelationshipTypes	getEntityType()
org.joda.time.DateTime	GetExpirationDate()	Service Category: ApplicationKeys Service Description: Get the expiration date.
String	GetKeyID()	Service Category: ApplicationKeys Service Description: Access the key ID.
String	GetUserName()	Service Category: ApplicationKeys Service Description: Get the associated user name.
boolean	IsExpired()	Service Category: ApplicationKeys Service Description: Returns if the application key is expired.
void	ResetExpirationDateToDefault()	Service Category: ApplicationKeys Service Description: Resets the expiration date to the default set in the UserManagementSubsystem configuration.
void	SetClientName(String name)	Service Category: ApplicationKeys Service Description: Set the client name for this application key.
void	SetExpirationDate(org.joda.time.DateTime expirationDate)	Service Category: ApplicationKeys Service Description: Set the expiration date.
void	SetIPWhitelist(String list)	Service Category: ApplicationKeys Service Description: Set the IP whitelist for this application key.
void	SetUserName(String name)	Service Category: ApplicationKeys Service Description: Set the associated user name for this application key.

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

Constructor Details

ApplicationKey

public ApplicationKey()

Method Details

SetClientName

@ThingworxExtensionApiMethod(since={6,6})
public void SetClientName(String name)
                   throws Exception

Service Category:

ApplicationKeys

Service Description:

Set the client name for this application key.

Parameters:

name - Client name - STRING

Throws:

Exception - If an error occurs

GetKeyID

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

Service Category:

ApplicationKeys

Service Description:

Access the key ID.

Returns:

KeyID Key ID - STRING

Throws:

Exception - If an error occurs

GetUserName

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

Service Category:

ApplicationKeys

Service Description:

Get the associated user name.

Returns:

UserName Key ID - STRING

Throws:

Exception - If an error occurs

SetUserName

@ThingworxExtensionApiMethod(since={6,6})
public void SetUserName(String name)
                 throws Exception

Service Category:

ApplicationKeys

Service Description:

Set the associated user name for this application key.

Parameters:

name - User name - USERNAME

Throws:

Exception - If an error occurs

SetIPWhitelist

@ThingworxExtensionApiMethod(since={6,6})
public void SetIPWhitelist(String list)
                    throws Exception

Service Category:

ApplicationKeys

Service Description:

Set the IP whitelist for this application key.

Parameters:

list - IP whitelist (IP addresses - STRING

Throws:

Exception - If an error occurs

SetExpirationDate

@ThingworxExtensionApiMethod(since={6,6})
public void SetExpirationDate(org.joda.time.DateTime expirationDate)
                       throws Exception

Service Category:

ApplicationKeys

Service Description:

Set the expiration date.

Parameters:

expirationDate - The expiration date of the application key - DATETIME

Throws:

Exception - If an error occurs

ResetExpirationDateToDefault

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

Service Category:

ApplicationKeys

Service Description:

Resets the expiration date to the default set in the UserManagementSubsystem configuration.

Throws:

Exception - If an error occurs

GetExpirationDate

@ThingworxExtensionApiMethod(since={6,6})
public org.joda.time.DateTime GetExpirationDate()

Service Category:

ApplicationKeys

Service Description:

Get the expiration date.

Returns:

ExpirationDate The expiration date of the application key - DATETIME

IsExpired

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

Service Category:

ApplicationKeys

Service Description:

Returns if the application key is expired.

Returns:

expired true if the application key is expired - BOOLEAN

getAssociatedUser

@ThingworxExtensionApiMethod(since={6,6})
public User getAssociatedUser()
                       throws Exception

Throws:

Exception - If an error occurs

getDependencies

@ThingworxExtensionApiMethod(since={6,6})
public EntityReferenceTypeMap getDependencies()

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