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:

  • Constructor Details

    • ApplicationKey

      public ApplicationKey()
      Initializes this instace with default values.

  • 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
      Gets the associated user
      Returns:
      a non-null User identifying the associated user
      Throws:
      Exception - if no user is currently associated, or if an error occurs

    • getDependencies

      @ThingworxExtensionApiMethod(since={6,6}) public EntityReferenceTypeMap getDependencies()
      Gets the users that have a dependency on this Application Key.
      Returns:
      a non-null collection of users having a dependency on this Application Key

    • 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