OutboundMessageBuilder (Solace PubSub+ Messaging API for Java 1.7.0 API)

All Superinterfaces:

PropertyBasedConfiguration
```
@ProviderType
public interface OutboundMessageBuilder
extends PropertyBasedConfiguration
```
An interface for the creating and configuring outbound messages. Each instance of this interface is intended to be used as a message factory to produce similarly configured messages.
Warning: the instance of a OutboundMessageBuilder is NOT thread safe. Changing a message builder state using with methods between build method calls expected to be executed on a same thread.
This class is a good choice for sequential template-based message creation.

Since:

1.0

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`OutboundMessage`	`build(byte[] payload)` Creates an outbound message using the configuration provided by `this` instance of a message builder and the byte-array payload.
`OutboundMessage`	`build(byte[] payload, Properties extendedMessageProperties)` Creates an outbound message using the configuration provided by `this` instance of a message builder and byte-array payload.
`OutboundMessage`	`build(String payload)` Creates an outbound message using configuration provided by `this` instance of a message builder and string payload.
`OutboundMessage`	`build(String payload, Properties extendedMessageProperties)` Creates an outbound message using configuration provided by `this` instance of a message builder and string payload.
`<T extends Serializable> OutboundMessage`	`build(T payload, Converter.ObjectToBytes<T> converter)` Creates an outbound message using configuration provided by `this` instance of a message builder and some serializable payload, converter
`<T extends Serializable> OutboundMessage`	`build(T payload, Converter.ObjectToBytes<T> converter, Properties extendedMessageProperties)` Creates an outbound message using configuration provided by `this` instance of a message builder and some serializable payload, converter and extended properties
`OutboundMessageBuilder`	`fromProperties(Properties configuration)` Enables property-based configuration.
`OutboundMessageBuilder`	`withApplicationMessageType(String applicationMessageType)` Configures the application message type.
`OutboundMessageBuilder`	`withExpiration(long utcTime)` Configures UTC time (in milliseconds) as Epoch time to indicate when the message is supposed to expire.
`OutboundMessageBuilder`	`withHTTPContentHeader(String contentType, String contentEncoding)` Configures HTTP content-type and encoding values for interaction with an HTTP client.
`OutboundMessageBuilder`	`withPriority(int priority)` Configures an optional message optionally priority
`OutboundMessageBuilder`	`withProperty(String key, String value)` Configures a user-defined property that's sent with a message.
`OutboundMessageBuilder`	`withSenderId(String senderId)` Configures the developer provided sender ID.
`OutboundMessageBuilder`	`withSequenceNumber(long sequenceNumber)` Configures the developer provided message sequence number.
`OutboundMessageBuilder`	`withTimeToLive(long ttl)` Configures the number of milliseconds before the message is discarded or moved to a Dead Message Queue.

- Method Detail
  - build
```
OutboundMessage build(byte[] payload)
```
    Creates an outbound message using the configuration provided by this instance of a message builder and the byte-array payload.
    
    Parameters:
    
    payload - the payload as a byte-array
    
    Returns:
    
    a new immutable instance of a OutboundMessage to be used for publishing purposes
    
    Since:
    
    1.0
  - build
```
OutboundMessage build(byte[] payload,
                      Properties extendedMessageProperties)
```
    Creates an outbound message using the configuration provided by this instance of a message builder and byte-array payload.
    
    Parameters:
    
    payload - the payload
    
    extendedMessageProperties - the extended properties (Key of type String and Value of type String), to customize a particular message where each key can be customer-provided, or it can be a key from a SolaceProperties.MessageProperties object
    
    Returns:
    
    a new immutable instance of a OutboundMessage to be used for publishing purposes
    
    Since:
    
    1.0
  - build
```
OutboundMessage build(String payload)
```
    Creates an outbound message using configuration provided by this instance of a message builder and string payload.
    
    Parameters:
    
    payload - the string-based payload for the message
    
    Returns:
    
    a new immutable instance of a OutboundMessage to be used for publishing purposes
    
    Since:
    
    1.0
  - build
```
OutboundMessage build(String payload,
                      Properties extendedMessageProperties)
```
    Creates an outbound message using configuration provided by this instance of a message builder and string payload.
    
    Parameters:
    
    payload - the string-based payload for the message
    
    extendedMessageProperties - the extended properties (Key of type String and Value of type String), to customize a particular message where each key can be customer-provided, or it can be a key from a SolaceProperties.MessageProperties object
    
    Returns:
    
    a new immutable instance of a OutboundMessage to be used for publishing purposes
    
    Since:
    
    1.0
  - build
```
<T extends Serializable> OutboundMessage build(T payload,
                                               Converter.ObjectToBytes<T> converter)
```
    Creates an outbound message using configuration provided by this instance of a message builder and some serializable payload, converter
    
    Type Parameters:
    
    T - a serializable business object of type T
    
    Parameters:
    
    payload - the payload of type T
    
    converter - the object to bytes converter for the given serializable business object of type T
    
    Returns:
    
    a new immutable instance of a OutboundMessage to be used for publishing purposes
    
    Since:
    
    1.0
  - build
```
<T extends Serializable> OutboundMessage build(T payload,
                                               Converter.ObjectToBytes<T> converter,
                                               Properties extendedMessageProperties)
```
    Creates an outbound message using configuration provided by this instance of a message builder and some serializable payload, converter and extended properties
    
    Type Parameters:
    
    T - the serializable business object of type T
    
    Parameters:
    
    payload - payload of type T
    
    converter - object to bytes converter for the given serializable business object of type T
    
    extendedMessageProperties - the extended properties (Key of type String and Value of type String), to customize a particular message where each key can be customer-provided, or it can be a key from a SolaceProperties.MessageProperties object
    
    Returns:
    
    a new immutable instance of a OutboundMessage to be used for publishing purposes
    
    Since:
    
    1.0
  - fromProperties
```
OutboundMessageBuilder fromProperties(Properties configuration)
```
    Enables property-based configuration.
    
    Specified by:
    
    fromProperties in interface PropertyBasedConfiguration
    
    Parameters:
    
    configuration - the properties (key of type String and value of type String) for configuration and fine-tuning. Common properties can be found in SolaceProperties and its sub-interfaces. Refer the SolaceProperties.MessageProperties for the list of Message properties configurable through this OutboundMessageBuilder
    
    Returns:
    
    instance of itself
    
    Throws:
    
    IllegalArgumentException - if invalid properties were specified
    
    Since:
    
    1.0
  - withApplicationMessageType
```
OutboundMessageBuilder withApplicationMessageType(String applicationMessageType)
```
    Configures the application message type. This value is used by applications only and is passed through the API untouched.
    
    Parameters:
    
    applicationMessageType - the application type value
    
    Returns:
    
    an instance of OutboundMessageBuilder
    
    Since:
    
    1.0
  - withExpiration
```
OutboundMessageBuilder withExpiration(long utcTime)
```
    Configures UTC time (in milliseconds) as Epoch time to indicate when the message is supposed to expire. Setting for this property have no effect if the TimeToLive is set in the same message. It is carried to clients that receive the message, unmodified and does not affect the lifecycle of the message.
    This property is only valid for persistent messages.
    
    Parameters:
    
    utcTime - the UTC time (in milliseconds) as Epoch time (from midnight of January 1, 1970 UTC) of when the message expires
    
    Returns:
    
    an instance of OutboundMessageBuilder
    
    Since:
    
    1.0
  - withHTTPContentHeader
```
OutboundMessageBuilder withHTTPContentHeader(String contentType,
                                             String contentEncoding)
```
    Configures HTTP content-type and encoding values for interaction with an HTTP client.
    
    Parameters:
    
    contentType - the MIME content type; the valid values that can be used are defined in RFC 7231, section-3.1.2.2
    
    contentEncoding - the content encoding; the valid values that can be used are defined in RFC 2616, section-14.11
    
    Returns:
    
    an instance of OutboundMessageBuilder
    
    Since:
    
    1.0
  - withPriority
```
OutboundMessageBuilder withPriority(int priority)
```
    Configures an optional message optionally priority
    
    Parameters:
    
    priority - a valid priority value range between 0-255 with 0 as the lowest priority and 255 as the highest. A value -1 indicates the priority is not set and a default priority value is used instead
    
    Returns:
    
    an instance of OutboundMessageBuilder
    
    Since:
    
    1.0
  - withProperty
```
OutboundMessageBuilder withProperty(String key,
                                    String value)
```
    Configures a user-defined property that's sent with a message.
    
    Parameters:
    
    key - the user-defined key
    
    value - the user-defined value
    
    Returns:
    
    an instance of itself for method chaining
    
    Since:
    
    1.0
  - withSenderId
```
OutboundMessageBuilder withSenderId(String senderId)
```
    Configures the developer provided sender ID. This value is used by applications only and is passed through the API untouched.
    
    Parameters:
    
    senderId - the message sender ID value specified by API user. When this value is not set, API generates internally a value when configured using SolaceProperties.ServiceProperties.GENERATE_SENDER_ID.
    
    Returns:
    
    an instance of OutboundMessageBuilder
    
    Since:
    
    1.0
  - withSequenceNumber
```
OutboundMessageBuilder withSequenceNumber(long sequenceNumber)
```
    Configures the developer provided message sequence number. This value is used by applications only and is passed through the API untouched. It is expected to be set per message.
    
    Parameters:
    
    sequenceNumber - the message sequence number value specified by API user, expected to be set per message. When this value is not set, API generates internally a value.
    
    Returns:
    
    an instance of OutboundMessageBuilder
    
    Since:
    
    1.0
  - withTimeToLive
```
OutboundMessageBuilder withTimeToLive(long ttl)
```
    Configures the number of milliseconds before the message is discarded or moved to a Dead Message Queue.
    A value of 0 means the message never expires. The default value is 0. Value more than 10 years is not permitted.
    This property is only valid for persistent messages. It has no effect when used in conjunction with other message types unless the message is promoted by the appliance to a Guaranteed message.
    
    Parameters:
    
    ttl - The number of milliseconds the persistent message is allowed to live before delivery to a subscriber.
    
    Returns:
    
    an instance of OutboundMessageBuilder
    
    Since:
    
    1.0

Interface OutboundMessageBuilder

Method Summary

Method Detail

build

build

build

build

build

build

fromProperties

withApplicationMessageType

withExpiration

withHTTPContentHeader

withPriority

withProperty

withSenderId

withSequenceNumber

withTimeToLive