com.microsoft.azure.sdk.iot.device

Class MessageProperty

java.lang.Object

com.microsoft.azure.sdk.iot.device.MessageProperty

public final class MessageProperty
extends java.lang.Object

An IoT Hub message property.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPONENT_ID
static java.lang.String	CONNECTION_DEVICE_ID
static java.lang.String	CONNECTION_MODULE_ID
static java.lang.String	IOTHUB_CONTENT_ENCODING
static java.lang.String	IOTHUB_CONTENT_TYPE
static java.lang.String	IOTHUB_CREATION_TIME_UTC
static java.lang.String	IOTHUB_SECURITY_INTERFACE_ID
static java.lang.String	IOTHUB_SECURITY_INTERFACE_ID_VALUE
static java.lang.String	OUTPUT_NAME_PROPERTY
static java.util.Set<java.lang.String>	RESERVED_PROPERTY_NAMES A set of reserved property names.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MessageProperty()
	MessageProperty(java.lang.String name, java.lang.String value) Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Returns the property name.
java.lang.String	getValue() Returns the property value.
boolean	hasSameName(java.lang.String name) Equivalent to property.getName().equalsIgnoreCase(name).
static boolean	isValidAppProperty(java.lang.String name, java.lang.String value) Returns whether the property is a valid application property.
static boolean	isValidSystemProperty(java.lang.String name, java.lang.String value) Returns whether the property is a valid system property.

Methods inherited from class java.lang.Object

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

Field Detail

RESERVED_PROPERTY_NAMES

public static final java.util.Set<java.lang.String> RESERVED_PROPERTY_NAMES

A set of reserved property names. The reserved property names are interpreted in a meaningful way by the device and the IoT Hub.

OUTPUT_NAME_PROPERTY

public static final java.lang.String OUTPUT_NAME_PROPERTY

See Also:

Constant Field Values

CONNECTION_DEVICE_ID

public static final java.lang.String CONNECTION_DEVICE_ID

See Also:

Constant Field Values

CONNECTION_MODULE_ID

public static final java.lang.String CONNECTION_MODULE_ID

See Also:

Constant Field Values

IOTHUB_CONTENT_ENCODING

public static final java.lang.String IOTHUB_CONTENT_ENCODING

See Also:

Constant Field Values

IOTHUB_CONTENT_TYPE

public static final java.lang.String IOTHUB_CONTENT_TYPE

See Also:

Constant Field Values

IOTHUB_CREATION_TIME_UTC

public static final java.lang.String IOTHUB_CREATION_TIME_UTC

See Also:

Constant Field Values

IOTHUB_SECURITY_INTERFACE_ID

public static final java.lang.String IOTHUB_SECURITY_INTERFACE_ID

See Also:

Constant Field Values

IOTHUB_SECURITY_INTERFACE_ID_VALUE

public static final java.lang.String IOTHUB_SECURITY_INTERFACE_ID_VALUE

See Also:

Constant Field Values

COMPONENT_ID

public static final java.lang.String COMPONENT_ID

See Also:

Constant Field Values

Constructor Detail

MessageProperty

public MessageProperty(java.lang.String name,
                       java.lang.String value)

Constructor.

Parameters:

name - The IoT Hub message property name.

value - The IoT Hub message property value.

Throws:

java.lang.IllegalArgumentException - if the name and value constitute an invalid IoT Hub message property. A message property can only contain US-ASCII. A message property name cannot be one of the reserved property names.

MessageProperty

protected MessageProperty()

Method Detail

getName

public java.lang.String getName()

Returns the property name.

Returns:

the property name.

getValue

public java.lang.String getValue()

Returns the property value.

Returns:

the property value.

hasSameName

public boolean hasSameName(java.lang.String name)

Equivalent to property.getName().equalsIgnoreCase(name).

Parameters:

name - the property name.

Returns:

true if the given name is the property name.

isValidAppProperty

public static boolean isValidAppProperty(java.lang.String name,
                                         java.lang.String value)

Returns whether the property is a valid application property. The property is valid if it is not one of the reserved properties, only uses US-ASCII

Parameters:

name - the property name.

value - the property value.

Returns:

whether the property is a valid application property.

isValidSystemProperty

public static boolean isValidSystemProperty(java.lang.String name,
                                            java.lang.String value)

Returns whether the property is a valid system property. The property is valid if it is one of the reserved properties and only uses US-ASCII

Parameters:

name - the property name.

value - the property value.

Returns:

whether the property is a valid system property.