AstProperty
public AstProperty(AstPropertyOwner owner,
Object id,
String key,
Date expiresOn,
int flags,
short type,
byte[] binaryValue,
String reportingDetails)
- Parameters:
owner
- An AstPropertyOwner
defines which SSMS object holds this property.
id
- is an Object
, because
- in case of
AstPropertyOwner.OWNER_DEVICE
it is an Integer
that is equal to the ID of an ASM device
- in case of
AstPropertyOwner.OWNER_USER
and AstPropertyOwner.OWNER_GROUP
it is a String
that is equal to the name of the user or group
key
- is the parameter, which property should be returned/set.
expiresOn
- is the expiration date of a property.
flags
- defines feature flags of the property. Value must be a decimal integer.
- bit mask --- description
- 0000 0000 0001 --- reserved
- 0000 0000 0010 --- if set value is saved encrypted in database; if not set, value is saved in clear text
- 0000 0000 0100 --- if set the property's value will not be displayed in the SSMS admin GUI; if not set, the value will be displayed in the SSMS admin GUI
- 0000 0000 1000 --- (ASM device properties only) if set, the value of this property must be unique to all devices belonging to same user.
- 0000 0001 0000 --- reserved
- 0000 0010 0000 --- if set, SOAP methods can only read this property.
- 0000 1100 0000 --- these 2 bits regulate access control
0x11 only SSMS and SDK may access this property
0x10 only SOAP, SSMS and SDK may access this property
0x01 only SSMS, SDK and App may access this property
0x00 (all) SOAP, SSMS, SDK and App may access this property
- 0011 0000 0000 --- these 2 bits regulate how/whether the property is propagated
0x11 SSMS will propagate this property to the SDK (SYNCHRONIZE_FROM_SSMS)
0x10 SDK keeps a local copy AND propagates the property to SSMS (SYNCHRONIZE_FROM_SDK)
0x01 SDK stores this property locally and never sends it to SSMS (SDK_CACHE_ONLY)
0x00 The property will not be stored in the app(NO_CACHING)
- other bits: reserved
Example: flags=902 (0011 1000 0110) means: property shall be stored encrypted, its value not displayed in SSMS GUI, propagated to SDK and be accessible by SOAP/SSMS/SDK
type
- defines the type of the data of the binaryValue. Value must be a decimal integer.
- 0: byte array
byte[]
- binary value
- 1: integer
byte[4]
- The format is in big endian.
For example if the value is 0x0138A4 then: byte 0 = 0, byte 1 = 01, byte 2 = 38 and byte 3 = A4.
- 2: boolean
byte[1]
- byte = 0 means false
; byte = 1 means true
;
- 3: String
byte[]
- UTF Unicode encoding String
- 4: Date
byte[]
- The date has the following format: YYYY-MM-DD HH:MM:SS (2001-07-04 12:08:56)
The date and time are always in Time-Zone GTM. The time is optional.
binaryValue
- the value of the property, see type
reportingDetails
- optional text that is written to the reporting