com.solace.messaging.config

Interface SolaceProperties.ClientProperties

Enclosing interface:

SolaceProperties

@ProviderType
public static interface SolaceProperties.ClientProperties

An interface that defines the configurable client properties for MessagingService instances. The properties are for use with MessagingServiceClientBuilder.fromProperties(Properties).

Example usage:

    final Properties clientProperties = new Properties();
    clientProperties.setProperty(ClientProperties.NAME, "Some Client Name");
    clientProperties.setProperty(ClientProperties.APPLICATION_DESCRIPTION, "Client Description");

    final MessagingServiceClientBuilder serviceBuilder = new MessagingServiceClientBuilder(ConfigurationProfile.V1);
    final MessagingService service = serviceBuilder.fromProperties(clientProperties).build();
  

Since:

1.0

See Also:

MessagingServiceClientBuilder.fromProperties(Properties)

Field Summary

Fields

Modifier and Type	Field and Description
static String	APPLICATION_DESCRIPTION A property key to specify a client description to report to an appliance.
static String	NAME A property key to specify the unique client name to use to register to an appliance.

Field Detail

APPLICATION_DESCRIPTION

@PropertiesKeyMapping(mappedClass=com.solacesystems.jcsmp.JCSMPProperties.class,
                      mappedFieldName="APPLICATION_DESCRIPTION",
                      valueType=java.lang.String.class)
static final String APPLICATION_DESCRIPTION

A property key to specify a client description to report to an appliance. The maximum length is 254 ASCII characters. Setting this property is optional.

Since:

1.0

See Also:

Constant Field Values

NAME

@PropertiesKeyMapping(mappedClass=com.solacesystems.jcsmp.JCSMPProperties.class,
                      mappedFieldName="CLIENT_NAME",
                      valueType=java.lang.String.class)
static final String NAME

A property key to specify the unique client name to use to register to an appliance. The default value is and formatted as: $HOSTNAME/$PID/#instanceId (e.g., "localhost/999/#00010123"). Setting this property is optional.

Since:

1.0

See Also:

Constant Field Values