BrokeredMessage (Microsoft Windows Azure Client API 0.4.6 API)

java.lang.Object
- com.microsoft.windowsazure.services.serviceBus.models.BrokeredMessage

public class BrokeredMessage
extends Object

Represents a service bus message.

Constructor Summary

Constructors
Constructor and Description
`BrokeredMessage()` Creates an instance of the `Message` class.
`BrokeredMessage(com.microsoft.windowsazure.services.serviceBus.implementation.BrokerProperties properties)` Internal
`BrokeredMessage(byte[] body)` Creates an instance of the `Message` class using the specified byte array.
`BrokeredMessage(InputStream body)` Creates an instance of the `Message` class using the specified `InputStream`.
`BrokeredMessage(String body)` Creates an instance of the `Message` class using the specified string.

Method Summary

Methods
Modifier and Type	Method and Description
`InputStream`	`getBody()` Returns the body of the message.
`com.microsoft.windowsazure.services.serviceBus.implementation.BrokerProperties`	`getBrokerProperties()` Returns the properties of the message.
`String`	`getContentType()` Returns the content type of the message.
`String`	`getCorrelationId()` Returns the correlation ID.
`Date`	`getDate()` Returns the date/time of the message.
`Integer`	`getDeliveryCount()` Returns the delivery count of the message.
`String`	`getLabel()` Returns the label of the message.
`Date`	`getLockedUntilUtc()` Returns the locked-until date/time.
`String`	`getLockLocation()` Returns the lock location.
`String`	`getLockToken()` Returns the lock token for the message.
`String`	`getMessageId()` Returns the message ID.
`String`	`getMessageLocation()` Returns the message location.
`Map<String,Object>`	`getProperties()` Returns the user defined properties of the message.
`Object`	`getProperty(String name)` Returns a user defined property of the message.
`String`	`getReplyTo()` Returns the Reply-To recipient of the message.
`String`	`getReplyToSessionId()` Returns the session ID of the Reply To recipient.
`Date`	`getScheduledEnqueueTimeUtc()` Returns the scheduled enqueue date/time.
`Long`	`getSequenceNumber()` Returns the message sequence number.
`String`	`getSessionId()` Returns the session ID for the message.
`Double`	`getTimeToLive()` Returns the time-to-live for the message.
`String`	`getTo()` Returns the To recipient of the message.
`BrokeredMessage`	`setBody(InputStream body)` Specifies the body of the message.
`BrokeredMessage`	`setContentType(String contentType)` Sets the content type of the message.
`BrokeredMessage`	`setCorrelationId(String correlationId)` Sets the correlation ID.
`BrokeredMessage`	`setDate(Date date)` Sets the date/time of the message.
`BrokeredMessage`	`setLabel(String label)` Sets the label of the message.
`BrokeredMessage`	`setMessageId(String messageId)` Sets the message ID.
`BrokeredMessage`	`setProperty(String name, Object value)` Sets a user defined property of the message.
`BrokeredMessage`	`setReplyTo(String replyTo)` Sets the Reply-To recipient for the message.
`BrokeredMessage`	`setReplyToSessionId(String replyToSessionId)` Sets the session ID of the Reply To recipient.
`BrokeredMessage`	`setScheduledEnqueueTimeUtc(Date scheduledEnqueueTimeUtc)` Sets the scheduled enqueue time.
`BrokeredMessage`	`setSessionId(String sessionId)` Sets the session ID for the message.
`BrokeredMessage`	`setTimeToLive(Double timeToLive)` Sets the time-to-live for the message.
`BrokeredMessage`	`setTo(String to)` Sets the To recipient of the message.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BrokeredMessage
```
public BrokeredMessage()
```
    Creates an instance of the Message class.
  - BrokeredMessage
```
public BrokeredMessage(InputStream body)
```
    Creates an instance of the Message class using the specified InputStream.
    
    Parameters:
    body - An InputStream object that represents the body of the message.
  - BrokeredMessage
```
public BrokeredMessage(byte[] body)
```
    Creates an instance of the Message class using the specified byte array.
    
    Parameters:
    body - A byte array that represents the body of the message.
  - BrokeredMessage
```
public BrokeredMessage(String body)
```
    Creates an instance of the Message class using the specified string.
    
    Parameters:
    body - A String object that represents the body of the message.
  - BrokeredMessage
```
public BrokeredMessage(com.microsoft.windowsazure.services.serviceBus.implementation.BrokerProperties properties)
```
    Internal
    
    Parameters:
    properties -
- Method Detail
  - getBrokerProperties
```
public com.microsoft.windowsazure.services.serviceBus.implementation.BrokerProperties getBrokerProperties()
```
    Returns the properties of the message.
    
    Returns:
    A BrokerProperties object that represents the properties of the message.
  - getBody
```
public InputStream getBody()
```
    Returns the body of the message.
    
    Returns:
    An InputStream object that represents the body of the message.
  - setBody
```
public BrokeredMessage setBody(InputStream body)
```
    Specifies the body of the message.
    
    Parameters:
    body - An InputStream object that represents the body of the message.
    
    Returns:
    A Message object that represents the updated message.
  - getContentType
```
public String getContentType()
```
    Returns the content type of the message.
    
    Returns:
    A String object that represents the content type.
  - setContentType
```
public BrokeredMessage setContentType(String contentType)
```
    Sets the content type of the message.
    
    Parameters:
    contentType - A String object that represents the content type.
    
    Returns:
    A Message object that represents the updated message.
  - getDate
```
public Date getDate()
```
    Returns the date/time of the message.
    
    Returns:
    A Date object that represents the date/time of the object.
  - setDate
```
public BrokeredMessage setDate(Date date)
```
    Sets the date/time of the message.
    
    Parameters:
    date - A Date object that represents the date/time of the object.
    
    Returns:
    A Message object that represents the updated message.
  - getProperty
```
public Object getProperty(String name)
```
    Returns a user defined property of the message.
    
    Parameters:
    name - A String object that represents the name of the property.
    
    Returns:
    An Object object that represents the value of the property.
  - setProperty
```
public BrokeredMessage setProperty(String name,
                          Object value)
```
    Sets a user defined property of the message.
    
    Parameters:
    name - A String object that represents the name of the property.
    value - An Object object that represents the value of the property.
    
    Returns:
    A Message object that represents the updated message.
  - getProperties
```
public Map<String,Object> getProperties()
```
    Returns the user defined properties of the message.
    
    Returns:
    A Map object that represents the user defined properties.
  - getDeliveryCount
```
public Integer getDeliveryCount()
```
    Returns the delivery count of the message.
    
    Returns:
    The delivery count.
  - getMessageId
```
public String getMessageId()
```
    Returns the message ID.
    
    Returns:
    A String object that represents the message ID.
  - setMessageId
```
public BrokeredMessage setMessageId(String messageId)
```
    Sets the message ID.
    
    Parameters:
    messageId - A String object that represents the message ID.
    
    Returns:
    A Message object that represents the updated message.
  - getSequenceNumber
```
public Long getSequenceNumber()
```
    Returns the message sequence number.
    
    Returns:
    The message sequence number.
  - getTimeToLive
```
public Double getTimeToLive()
```
    Returns the time-to-live for the message.
    
    Returns:
    The time, in seconds, for the message to live.
  - setTimeToLive
```
public BrokeredMessage setTimeToLive(Double timeToLive)
```
    Sets the time-to-live for the message.
    
    Parameters:
    timeToLive - The time, in seconds, for the message to live.
    
    Returns:
    A Message object that represents the updated message.
  - getLockToken
```
public String getLockToken()
```
    Returns the lock token for the message.
    
    Returns:
    A String object that represents the lock token.
  - getLockedUntilUtc
```
public Date getLockedUntilUtc()
```
    Returns the locked-until date/time.
    
    Returns:
    A Date object that represents the locked-until date/time, in UTC format.
  - getCorrelationId
```
public String getCorrelationId()
```
    Returns the correlation ID.
    
    Returns:
    A String object that represents the correlation ID.
  - setCorrelationId
```
public BrokeredMessage setCorrelationId(String correlationId)
```
    Sets the correlation ID.
    
    Parameters:
    correlationId - A String object that represents the correlation ID.
    
    Returns:
    A Message object that represents the updated message.
  - getSessionId
```
public String getSessionId()
```
    Returns the session ID for the message.
    
    Returns:
    A String object that represents the session ID.
  - setSessionId
```
public BrokeredMessage setSessionId(String sessionId)
```
    Sets the session ID for the message.
    
    Parameters:
    sessionId - A String object that represents the session ID.
    
    Returns:
    A Message object that represents the updated message.
  - getLabel
```
public String getLabel()
```
    Returns the label of the message.
    
    Returns:
    A String object that represents the label.
  - setLabel
```
public BrokeredMessage setLabel(String label)
```
    Sets the label of the message.
    
    Parameters:
    label - A String object that represents the label.
    
    Returns:
    A Message object that represents the updated message.
  - getReplyTo
```
public String getReplyTo()
```
    Returns the Reply-To recipient of the message.
    
    Returns:
    A String object that represents the Reply-To recipient.
  - setReplyTo
```
public BrokeredMessage setReplyTo(String replyTo)
```
    Sets the Reply-To recipient for the message.
    
    Parameters:
    replyTo - A String object that represents the Reply-To recipient.
    
    Returns:
    A Message object that represents the updated message.
  - getTo
```
public String getTo()
```
    Returns the To recipient of the message.
    
    Returns:
    A String object that represents the To recipient.
  - setTo
```
public BrokeredMessage setTo(String to)
```
    Sets the To recipient of the message.
    
    Parameters:
    to - A String object that represents the To recipient.
    
    Returns:
    A Message object that represents the updated message.
  - getScheduledEnqueueTimeUtc
```
public Date getScheduledEnqueueTimeUtc()
```
    Returns the scheduled enqueue date/time.
    
    Returns:
    A Date object that represents the date/time of the message in UTC format.
  - setScheduledEnqueueTimeUtc
```
public BrokeredMessage setScheduledEnqueueTimeUtc(Date scheduledEnqueueTimeUtc)
```
    Sets the scheduled enqueue time.
    
    Parameters:
    scheduledEnqueueTimeUtc - A Date object that represents the date/time of the message in UTC format.
    
    Returns:
    A Message object that represents the updated message.
  - getReplyToSessionId
```
public String getReplyToSessionId()
```
    Returns the session ID of the Reply To recipient.
    
    Returns:
    A String object that represents the session ID of the Reply To recipient.
  - setReplyToSessionId
```
public BrokeredMessage setReplyToSessionId(String replyToSessionId)
```
    Sets the session ID of the Reply To recipient.
    
    Parameters:
    replyToSessionId - A String object that represents the session ID of the Reply To recipient.
    
    Returns:
    A Message object that represents the updated message.
  - getMessageLocation
```
public String getMessageLocation()
```
    Returns the message location.
    
    Returns:
    A String object that represents the message location.
  - getLockLocation
```
public String getLockLocation()
```
    Returns the lock location.
    
    Returns:
    A String object that represents the lock location.

/** 
* Copyright Microsoft Corporation 
* 
* Licensed under the Apache License, Version 2.0 (the "License"); 
* you may not use this file except in compliance with the License. 
* You may obtain a copy of the License at 
* http://www.apache.org/licenses/LICENSE-2.0 
* 
* Unless required by applicable law or agreed to in writing, software 
* distributed under the License is distributed on an "AS IS" BASIS, 
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
* See the License for the specific language governing permissions and 
* limitations under the License. 
*/

Class BrokeredMessage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BrokeredMessage

BrokeredMessage

BrokeredMessage

BrokeredMessage

BrokeredMessage

Method Detail

getBrokerProperties

getBody

setBody

getContentType

setContentType

getDate

setDate

getProperty

setProperty

getProperties

getDeliveryCount

getMessageId

setMessageId

getSequenceNumber

getTimeToLive

setTimeToLive

getLockToken

getLockedUntilUtc

getCorrelationId

setCorrelationId

getSessionId

setSessionId

getLabel

setLabel

getReplyTo

setReplyTo

getTo

setTo

getScheduledEnqueueTimeUtc

setScheduledEnqueueTimeUtc

getReplyToSessionId

setReplyToSessionId

getMessageLocation

getLockLocation