Package org.netxms.client

Class TrafficCredentialField

java.lang.Object

org.netxms.client.TrafficCredentialField

public class TrafficCredentialField
extends Object

Credential field descriptor declared by a traffic connector. Describes one key of the observer's credentials JSON so clients can render a form instead of a raw JSON editor. Password fields are never sent back to clients and are kept on the server when a modification leaves them empty.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TrafficCredentialField.Type	Field type (values match TrafficCredentialFieldType on the server)

Constructor Summary

Constructors

Constructor	Description
TrafficCredentialField(NXCPMessage msg, long baseId)	Create credential field descriptor from NXCP message.

Method Summary

Modifier and Type	Method	Description
String	getDefaultValue()
String	getDescription()
String	getDisplayName()
String	getName()
TrafficCredentialField.Type	getType()
boolean	isRequired()

Methods inherited from class java.lang.Object

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

Constructor Details

TrafficCredentialField

public TrafficCredentialField(NXCPMessage msg,
 long baseId)

Create credential field descriptor from NXCP message. Record stride is 16 fields: baseId = name, +1 = display name, +2 = description, +3 = type code, +4 = required, +5 = default value (remaining fields reserved).

Parameters:

msg - NXCP message

baseId - base field ID of this record

Method Details

getName

public String getName()

Returns:

key in credentials JSON

getDisplayName

public String getDisplayName()

Returns:

display name

getDescription

public String getDescription()

Returns:

description (may be empty)

getType

public TrafficCredentialField.Type getType()

Returns:

field type

isRequired

public boolean isRequired()

Returns:

true if a value is required

getDefaultValue

public String getDefaultValue()

Returns:

textual default value or null if none