ClientEntity (Azure SDK for Java Reference Documentation)

java.lang.Object
- com.microsoft.azure.servicebus.primitives.ClientEntity

Direct Known Subclasses:

CoreMessageReceiver, CoreMessageSender, MessageSession, MessagingFactory, MiscRequestResponseOperationHandler, QueueClient, SubscriptionClient, TopicClient
```
public abstract class ClientEntity
extends Object
```
Contract for all client entities with Open-Close/Abort state m/c
main-purpose: closeAll related entities
Internal-class

Since:

1.0

Constructor Summary

Constructors
Modifier Constructor Description

protected ClientEntity(String clientId)

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`close()`
`CompletableFuture<Void>`	`closeAsync()`
`protected void`	`finalize()`
`String`	`getClientId()`
`protected boolean`	`getIsClosed()`
`protected boolean`	`getIsClosingOrClosed()`
`protected abstract CompletableFuture<Void>`	`onClose()`
`protected void`	`setClosed()`
`protected void`	`setClosing()`
`protected void`	`throwIfClosed(Throwable cause)`

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

Constructor Detail

ClientEntity

protected ClientEntity(String clientId)

Method Detail

onClose

protected abstract CompletableFuture<Void> onClose()

getClientId
```
public String getClientId()
```

getIsClosed
```
protected boolean getIsClosed()
```

getIsClosingOrClosed

protected boolean getIsClosingOrClosed()

setClosed
```
protected final void setClosed()
```

setClosing
```
protected final void setClosing()
```

closeAsync

public final CompletableFuture<Void> closeAsync()

close

public final void close()
                 throws ServiceBusException

Throws:: ServiceBusException

throwIfClosed

protected final void throwIfClosed(Throwable cause)

finalize

protected void finalize()
                 throws Throwable

Overrides:: finalize in class Object
Throws:: Throwable