Package com.microsoft.azure.servicebus

Interface IMessageSessionEntity

public interface IMessageSessionEntity

Represents a session full client entity.

Method Summary

Modifier and Type	Method	Description
Collection<IMessageSession>	getMessageSessions()	Gets the message sessions, enabling you to browse sessions on queues.
Collection<IMessageSession>	getMessageSessions(Instant lastUpdatedTime)	Retrieves all message sessions whose session state was updated since lastUpdatedTime.
CompletableFuture<Collection<IMessageSession>>	getMessageSessionsAsync()	Asynchronously gets the message sessions, enabling you to browse sessions on queues.
CompletableFuture<Collection<IMessageSession>>	getMessageSessionsAsync(Instant lastUpdatedTime)	Asynchronously retrieves all message sessions whose session state was updated since lastUpdatedTime.

Method Detail

getMessageSessions

Collection<IMessageSession> getMessageSessions()
                                        throws InterruptedException,
                                               ServiceBusException

Gets the message sessions, enabling you to browse sessions on queues. Only sessions with active messages in the queue are returned. The sessions on the deadletter queue or sessions having a SessionState as 'active' and no messages are not returned with this call.

Returns:

A collection of sessions.

Throws:

InterruptedException - if the current thread was interrupted while waiting.

ServiceBusException - if get sessions failed.

getMessageSessions

Collection<IMessageSession> getMessageSessions(Instant lastUpdatedTime)
                                        throws InterruptedException,
                                               ServiceBusException

Retrieves all message sessions whose session state was updated since lastUpdatedTime. Only sessions with active messages in the queue are returned. The sessions on the deadletter queue or sessions having a SessionState as 'active' and no messages are not returned with this call.

Parameters:

lastUpdatedTime - The time the session was last updated.

Returns:

A collection of sessions.

Throws:

InterruptedException - if the current thread was interrupted while waiting.

ServiceBusException - if get sessions failed.

getMessageSessionsAsync

CompletableFuture<Collection<IMessageSession>> getMessageSessionsAsync()

Asynchronously gets the message sessions, enabling you to browse sessions on queues. Only sessions with active messages in the queue are returned. The sessions on the deadletter queue or sessions having a SessionState as 'active' and no messages are not returned with this call.

Returns:

a CompletableFuture representing the pending operation to get sessions.

See Also:

getMessageSessions()

getMessageSessionsAsync

CompletableFuture<Collection<IMessageSession>> getMessageSessionsAsync(Instant lastUpdatedTime)

Asynchronously retrieves all message sessions whose session state was updated since lastUpdatedTime. Only sessions with active messages in the queue are returned. The sessions on the deadletter queue or sessions having a SessionState as 'active' and no messages are not returned with this call.

Parameters:

lastUpdatedTime - The time the session was last updated.

Returns:

a CompletableFuture representing the pending operation to get sessions.

See Also:

getMessageSessions(Instant)