Class SecurityClaims
- java.lang.Object
-
- com.thingworx.communications.common.SecurityClaims
-
@ThingworxExtensionApiClass(since={6,6}, canInstantiate=true) public final class SecurityClaims extends java.lang.Object
SecurityClaims is a class for managing the security settings for connections to the server.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
TO_STRING_MESSAGE
-
Constructor Summary
Constructors Constructor Description SecurityClaims()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addClaim(java.lang.String name, java.lang.String value)
Adds a SecurityClaims object to this SecurityClaims object.int
count()
Returns the number of SecurityClaims associated with this SecurityClaims object.java.util.Map<java.lang.String,java.lang.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.java.lang.String
toString()
Returns a string representation of this SecurityClaims object.
-
-
-
Field Detail
-
TO_STRING_MESSAGE
public static final java.lang.String TO_STRING_MESSAGE
- See Also:
- Constant Field Values
-
-
Method Detail
-
getClaims
@ThingworxExtensionApiMethod(since={7,1}) public java.util.Map<java.lang.String,java.lang.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(java.lang.String name, java.lang.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 java.lang.String toString()
Returns a string representation of this SecurityClaims object.- Overrides:
toString
in classjava.lang.Object
-
-