Package com.thingworx.communications.common

Class SecurityClaims

java.lang.Object
com.thingworx.communications.common.SecurityClaims
@ThingworxExtensionApiClass(since={6,6}, canInstantiate=true) public final class SecurityClaims extends Object
SecurityClaims is a class for managing the security settings for connections to the server.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    TO_STRING_MESSAGE
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    SecurityClaims()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addClaim(String name, String value)


    Adds a SecurityClaims object to this SecurityClaims object.
    int
    count()


    Returns the number of SecurityClaims associated with this SecurityClaims object.
    Map<String,String>
    getClaims()


    Returns the SecurityClaims associated with this SecurityClaims object.
    boolean
    hasClaims()


    Returns a boolean value that indicates whether any SecurityClaims are associated with this SecurityClaims object.
    String
    toString()


    Returns a string representation of this SecurityClaims object.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Field Details

  • Constructor Details

    • SecurityClaims

      public SecurityClaims()

  • Method Details

    • getClaims

      @ThingworxExtensionApiMethod(since={7,1}) public Map<String,String> getClaims()


      Returns the SecurityClaims associated with this SecurityClaims object.
      Returns:
      the SecurityClaims associated with this SecurityClaims object

    • hasClaims

      @ThingworxExtensionApiMethod(since={7,1}) public boolean hasClaims()


      Returns a boolean value that indicates whether any SecurityClaims are associated with this SecurityClaims object.
      Returns:
      a boolean value that indicates whether any SecurityClaims are associated with this SecurityClaims object

    • count

      @ThingworxExtensionApiMethod(since={7,1}) public int count()


      Returns the number of SecurityClaims associated with this SecurityClaims object.
      Returns:
      the number of SecurityClaims associated with this SecurityClaims object

    • addClaim

      @ThingworxExtensionApiMethod(since={7,1}) public void addClaim(String name, String value)


      Adds a SecurityClaims object to this SecurityClaims object.
      Parameters:
      name - the name of the SecurityClaims (e.g., "userid", "password", "appKey")
      value - the value of the SecurityClaims

    • toString

      @ThingworxExtensionApiMethod(since={7,1}) public String toString()


      Returns a string representation of this SecurityClaims object.
      Overrides:
      toString in class Object