402 строки
36 KiB
YAML
402 строки
36 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.servicebus.primitives.MessagingFactory"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.MessagingFactory"
|
|
name: "MessagingFactory"
|
|
nameWithType: "MessagingFactory"
|
|
summary: "Abstracts all AMQP related details and encapsulates an AMQP connection and manages its life cycle."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.servicebus.primitives.ClientEntity?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"com.microsoft.azure.servicebus.primitives.ClientEntity?alt=com.microsoft.azure.servicebus.primitives.ClientEntity&text=ClientEntity\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"com.microsoft.azure.servicebus.primitives.ClientEntity.close()?alt=com.microsoft.azure.servicebus.primitives.ClientEntity.close&text=close\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.servicebus.primitives.ClientEntity.closeAsync()?alt=com.microsoft.azure.servicebus.primitives.ClientEntity.closeAsync&text=closeAsync\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.servicebus.primitives.ClientEntity.finalize()?alt=com.microsoft.azure.servicebus.primitives.ClientEntity.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.servicebus.primitives.ClientEntity.getClientId()?alt=com.microsoft.azure.servicebus.primitives.ClientEntity.getClientId&text=getClientId\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.servicebus.primitives.ClientEntity.getIsClosed()?alt=com.microsoft.azure.servicebus.primitives.ClientEntity.getIsClosed&text=getIsClosed\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.servicebus.primitives.ClientEntity.getIsClosingOrClosed()?alt=com.microsoft.azure.servicebus.primitives.ClientEntity.getIsClosingOrClosed&text=getIsClosingOrClosed\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.servicebus.primitives.ClientEntity.onClose()?alt=com.microsoft.azure.servicebus.primitives.ClientEntity.onClose&text=onClose\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.servicebus.primitives.ClientEntity.setClosed()?alt=com.microsoft.azure.servicebus.primitives.ClientEntity.setClosed&text=setClosed\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.servicebus.primitives.ClientEntity.setClosing()?alt=com.microsoft.azure.servicebus.primitives.ClientEntity.setClosing&text=setClosing\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.servicebus.primitives.ClientEntity.throwIfClosed(java.lang.Throwable)?alt=com.microsoft.azure.servicebus.primitives.ClientEntity.throwIfClosed&text=throwIfClosed\" data-throw-if-not-resolved=\"False\" />"
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public class **MessagingFactory**</br> extends <xref href=\"com.microsoft.azure.servicebus.primitives.ClientEntity?alt=com.microsoft.azure.servicebus.primitives.ClientEntity&text=ClientEntity\" data-throw-if-not-resolved=\"False\" /></br> implements <xref href=\"com.microsoft.azure.servicebus.amqp.IAmqpConnection?alt=com.microsoft.azure.servicebus.amqp.IAmqpConnection&text=IAmqpConnection\" data-throw-if-not-resolved=\"False\" />"
|
|
fields:
|
|
- uid: "com.microsoft.azure.servicebus.primitives.MessagingFactory.INTERNAL_THREAD_POOL"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.MessagingFactory.INTERNAL_THREAD_POOL"
|
|
name: "INTERNAL_THREAD_POOL"
|
|
nameWithType: "MessagingFactory.INTERNAL_THREAD_POOL"
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ExecutorService.html\">ExecutorService</a>"
|
|
syntax: "public static final ExecutorService INTERNAL_THREAD_POOL"
|
|
methods:
|
|
- uid: "com.microsoft.azure.servicebus.primitives.MessagingFactory.createFromConnectionString(java.lang.String)"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.MessagingFactory.createFromConnectionString(String connectionString)"
|
|
name: "createFromConnectionString(String connectionString)"
|
|
nameWithType: "MessagingFactory.createFromConnectionString(String connectionString)"
|
|
summary: "Creates an instance of Messaging<wbr>Factory from the given connection string."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "connection string to the bus namespace or entity"
|
|
name: "connectionString"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public static MessagingFactory createFromConnectionString(String connectionString)"
|
|
exceptions:
|
|
- description: "if blocking thread is interrupted"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html\">InterruptedException</a>"
|
|
- description: "if blocking thread is interrupted"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ExecutionException.html\">ExecutionException</a>"
|
|
desc: "Creates an instance of MessagingFactory from the given connection string. This method blocks for a connection to the namespace to be established."
|
|
returns:
|
|
description: "an instance of MessagingFactory"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.MessagingFactory?alt=com.microsoft.azure.servicebus.primitives.MessagingFactory&text=MessagingFactory\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.servicebus.primitives.MessagingFactory.createFromConnectionStringAsync(java.lang.String)"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.MessagingFactory.createFromConnectionStringAsync(String connectionString)"
|
|
name: "createFromConnectionStringAsync(String connectionString)"
|
|
nameWithType: "MessagingFactory.createFromConnectionStringAsync(String connectionString)"
|
|
summary: "Creates an instance of Messaging<wbr>Factory from the given connection string."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "connection string to the bus namespace or entity"
|
|
name: "connectionString"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public static CompletableFuture<MessagingFactory> createFromConnectionStringAsync(String connectionString)"
|
|
desc: "Creates an instance of MessagingFactory from the given connection string. This is a non-blocking method."
|
|
returns:
|
|
description: "a <code>CompletableFuture</code> which completes when a connection is established to the namespace or when a connection couldn't be established."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<xref href=\"com.microsoft.azure.servicebus.primitives.MessagingFactory?alt=com.microsoft.azure.servicebus.primitives.MessagingFactory&text=MessagingFactory\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.servicebus.primitives.MessagingFactory.createFromConnectionStringBuilder(com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder)"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.MessagingFactory.createFromConnectionStringBuilder(ConnectionStringBuilder builder)"
|
|
name: "createFromConnectionStringBuilder(ConnectionStringBuilder builder)"
|
|
nameWithType: "MessagingFactory.createFromConnectionStringBuilder(ConnectionStringBuilder builder)"
|
|
summary: "Creates an instance of Messaging<wbr>Factory from the given connection string builder."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "connection string builder to the bus namespace or entity"
|
|
name: "builder"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder?alt=com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder&text=ConnectionStringBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static MessagingFactory createFromConnectionStringBuilder(ConnectionStringBuilder builder)"
|
|
exceptions:
|
|
- description: "if blocking thread is interrupted"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html\">InterruptedException</a>"
|
|
- description: "if blocking thread is interrupted"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ExecutionException.html\">ExecutionException</a>"
|
|
desc: "Creates an instance of MessagingFactory from the given connection string builder. This method blocks for a connection to the namespace to be established."
|
|
returns:
|
|
description: "an instance of MessagingFactory"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.MessagingFactory?alt=com.microsoft.azure.servicebus.primitives.MessagingFactory&text=MessagingFactory\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.servicebus.primitives.MessagingFactory.createFromConnectionStringBuilderAsync(com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder)"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.MessagingFactory.createFromConnectionStringBuilderAsync(ConnectionStringBuilder builder)"
|
|
name: "createFromConnectionStringBuilderAsync(ConnectionStringBuilder builder)"
|
|
nameWithType: "MessagingFactory.createFromConnectionStringBuilderAsync(ConnectionStringBuilder builder)"
|
|
summary: "Creates an instance of Messaging<wbr>Factory from the given connection string builder."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "connection string builder to the bus namespace or entity"
|
|
name: "builder"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder?alt=com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder&text=ConnectionStringBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static CompletableFuture<MessagingFactory> createFromConnectionStringBuilderAsync(ConnectionStringBuilder builder)"
|
|
desc: "Creates an instance of MessagingFactory from the given connection string builder. This is a non-blocking method."
|
|
returns:
|
|
description: "a <code>CompletableFuture</code> which completes when a connection is established to the namespace or when a connection couldn't be established."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<xref href=\"com.microsoft.azure.servicebus.primitives.MessagingFactory?alt=com.microsoft.azure.servicebus.primitives.MessagingFactory&text=MessagingFactory\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.servicebus.primitives.MessagingFactory.createFromNamespaceEndpointURI(java.net.URI,com.microsoft.azure.servicebus.ClientSettings)"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.MessagingFactory.createFromNamespaceEndpointURI(URI namespaceEndpointURI, ClientSettings clientSettings)"
|
|
name: "createFromNamespaceEndpointURI(URI namespaceEndpointURI, ClientSettings clientSettings)"
|
|
nameWithType: "MessagingFactory.createFromNamespaceEndpointURI(URI namespaceEndpointURI, ClientSettings clientSettings)"
|
|
summary: "Creates a messaging factory instance from namesapce endpoint URI and client settings"
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "Endpoint URI of the namespace"
|
|
name: "namespaceEndpointURI"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/net/URI.html\">URI</a>"
|
|
- description: "clientsettings for the factory"
|
|
name: "clientSettings"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.ClientSettings?alt=com.microsoft.azure.servicebus.ClientSettings&text=ClientSettings\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static MessagingFactory createFromNamespaceEndpointURI(URI namespaceEndpointURI, ClientSettings clientSettings)"
|
|
exceptions:
|
|
- description: "if blocking thread is interrupted"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html\">InterruptedException</a>"
|
|
- description: "if blocking thread is interrupted"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ServiceBusException?alt=com.microsoft.azure.servicebus.primitives.ServiceBusException&text=ServiceBusException\" data-throw-if-not-resolved=\"False\" />"
|
|
desc: "Creates a messaging factory instance from namesapce endpoint URI and client settings"
|
|
returns:
|
|
description: "an instance of MessagingFactory"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.MessagingFactory?alt=com.microsoft.azure.servicebus.primitives.MessagingFactory&text=MessagingFactory\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.servicebus.primitives.MessagingFactory.createFromNamespaceEndpointURIAsyc(java.net.URI,com.microsoft.azure.servicebus.ClientSettings)"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.MessagingFactory.createFromNamespaceEndpointURIAsyc(URI namespaceEndpointURI, ClientSettings clientSettings)"
|
|
name: "createFromNamespaceEndpointURIAsyc(URI namespaceEndpointURI, ClientSettings clientSettings)"
|
|
nameWithType: "MessagingFactory.createFromNamespaceEndpointURIAsyc(URI namespaceEndpointURI, ClientSettings clientSettings)"
|
|
summary: "Creates a messaging factory instance from namesapce endpoint URI and client settings"
|
|
deprecatedTag: "Deprecating as spelling is wrong. Replaced by <xref uid=\"com.microsoft.azure.servicebus.primitives.MessagingFactory.createFromNamespaceEndpointURIAsync(java.net.URI,com.microsoft.azure.servicebus.ClientSettings)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#createFromNamespaceEndpointURIAsync(URI, ClientSettings)\"></xref>"
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "Endpoint URI of the namespace"
|
|
name: "namespaceEndpointURI"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/net/URI.html\">URI</a>"
|
|
- description: "clientsettings for the factory"
|
|
name: "clientSettings"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.ClientSettings?alt=com.microsoft.azure.servicebus.ClientSettings&text=ClientSettings\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public static CompletableFuture<MessagingFactory> createFromNamespaceEndpointURIAsyc(URI namespaceEndpointURI, ClientSettings clientSettings)"
|
|
desc: "Creates a messaging factory instance from namesapce endpoint URI and client settings"
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "a completablefuture whose result is messagingfactory instance when its execution completes"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<xref href=\"com.microsoft.azure.servicebus.primitives.MessagingFactory?alt=com.microsoft.azure.servicebus.primitives.MessagingFactory&text=MessagingFactory\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.servicebus.primitives.MessagingFactory.createFromNamespaceEndpointURIAsync(java.net.URI,com.microsoft.azure.servicebus.ClientSettings)"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.MessagingFactory.createFromNamespaceEndpointURIAsync(URI namespaceEndpointURI, ClientSettings clientSettings)"
|
|
name: "createFromNamespaceEndpointURIAsync(URI namespaceEndpointURI, ClientSettings clientSettings)"
|
|
nameWithType: "MessagingFactory.createFromNamespaceEndpointURIAsync(URI namespaceEndpointURI, ClientSettings clientSettings)"
|
|
summary: "Creates a messaging factory instance from namesapce endpoint URI and client settings"
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "Endpoint URI of the namespace"
|
|
name: "namespaceEndpointURI"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/net/URI.html\">URI</a>"
|
|
- description: "clientsettings for the factory"
|
|
name: "clientSettings"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.ClientSettings?alt=com.microsoft.azure.servicebus.ClientSettings&text=ClientSettings\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static CompletableFuture<MessagingFactory> createFromNamespaceEndpointURIAsync(URI namespaceEndpointURI, ClientSettings clientSettings)"
|
|
desc: "Creates a messaging factory instance from namesapce endpoint URI and client settings"
|
|
returns:
|
|
description: "a completablefuture whose result is messagingfactory instance when its execution completes"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<xref href=\"com.microsoft.azure.servicebus.primitives.MessagingFactory?alt=com.microsoft.azure.servicebus.primitives.MessagingFactory&text=MessagingFactory\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.servicebus.primitives.MessagingFactory.createFromNamespaceName(java.lang.String,com.microsoft.azure.servicebus.ClientSettings)"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.MessagingFactory.createFromNamespaceName(String sbNamespaceName, ClientSettings clientSettings)"
|
|
name: "createFromNamespaceName(String sbNamespaceName, ClientSettings clientSettings)"
|
|
nameWithType: "MessagingFactory.createFromNamespaceName(String sbNamespaceName, ClientSettings clientSettings)"
|
|
summary: "Creates a messaging factory instance from namesapce name and client settings"
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "name of the namespace"
|
|
name: "sbNamespaceName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "clientsettings for the factory"
|
|
name: "clientSettings"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.ClientSettings?alt=com.microsoft.azure.servicebus.ClientSettings&text=ClientSettings\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static MessagingFactory createFromNamespaceName(String sbNamespaceName, ClientSettings clientSettings)"
|
|
exceptions:
|
|
- description: "if blocking thread is interrupted"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html\">InterruptedException</a>"
|
|
- description: "if blocking thread is interrupted"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ServiceBusException?alt=com.microsoft.azure.servicebus.primitives.ServiceBusException&text=ServiceBusException\" data-throw-if-not-resolved=\"False\" />"
|
|
desc: "Creates a messaging factory instance from namesapce name and client settings"
|
|
returns:
|
|
description: "an instance of MessagingFactory"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.MessagingFactory?alt=com.microsoft.azure.servicebus.primitives.MessagingFactory&text=MessagingFactory\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.servicebus.primitives.MessagingFactory.createFromNamespaceNameAsyc(java.lang.String,com.microsoft.azure.servicebus.ClientSettings)"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.MessagingFactory.createFromNamespaceNameAsyc(String sbNamespaceName, ClientSettings clientSettings)"
|
|
name: "createFromNamespaceNameAsyc(String sbNamespaceName, ClientSettings clientSettings)"
|
|
nameWithType: "MessagingFactory.createFromNamespaceNameAsyc(String sbNamespaceName, ClientSettings clientSettings)"
|
|
summary: "Creates a messaging factory instance from namesapce name and client settings"
|
|
deprecatedTag: "Deprecating as spelling is wrong. Replaced by <xref uid=\"com.microsoft.azure.servicebus.primitives.MessagingFactory.createFromNamespaceNameAsync(java.lang.String,com.microsoft.azure.servicebus.ClientSettings)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#createFromNamespaceNameAsync(String, ClientSettings)\"></xref>"
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "name of the namespace"
|
|
name: "sbNamespaceName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "clientsettings for the factory"
|
|
name: "clientSettings"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.ClientSettings?alt=com.microsoft.azure.servicebus.ClientSettings&text=ClientSettings\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public static CompletableFuture<MessagingFactory> createFromNamespaceNameAsyc(String sbNamespaceName, ClientSettings clientSettings)"
|
|
desc: "Creates a messaging factory instance from namesapce name and client settings"
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "a completablefuture whose result is messagingfactory instance when its execution completes"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<xref href=\"com.microsoft.azure.servicebus.primitives.MessagingFactory?alt=com.microsoft.azure.servicebus.primitives.MessagingFactory&text=MessagingFactory\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.servicebus.primitives.MessagingFactory.createFromNamespaceNameAsync(java.lang.String,com.microsoft.azure.servicebus.ClientSettings)"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.MessagingFactory.createFromNamespaceNameAsync(String sbNamespaceName, ClientSettings clientSettings)"
|
|
name: "createFromNamespaceNameAsync(String sbNamespaceName, ClientSettings clientSettings)"
|
|
nameWithType: "MessagingFactory.createFromNamespaceNameAsync(String sbNamespaceName, ClientSettings clientSettings)"
|
|
summary: "Creates a messaging factory instance from namesapce name and client settings"
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "name of the namespace"
|
|
name: "sbNamespaceName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "clientsettings for the factory"
|
|
name: "clientSettings"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.ClientSettings?alt=com.microsoft.azure.servicebus.ClientSettings&text=ClientSettings\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static CompletableFuture<MessagingFactory> createFromNamespaceNameAsync(String sbNamespaceName, ClientSettings clientSettings)"
|
|
desc: "Creates a messaging factory instance from namesapce name and client settings"
|
|
returns:
|
|
description: "a completablefuture whose result is messagingfactory instance when its execution completes"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<xref href=\"com.microsoft.azure.servicebus.primitives.MessagingFactory?alt=com.microsoft.azure.servicebus.primitives.MessagingFactory&text=MessagingFactory\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.servicebus.primitives.MessagingFactory.deregisterForConnectionError(org.apache.qpid.proton.engine.Link)"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.MessagingFactory.deregisterForConnectionError(Link link)"
|
|
name: "deregisterForConnectionError(Link link)"
|
|
nameWithType: "MessagingFactory.deregisterForConnectionError(Link link)"
|
|
summary: "Internal method. Clients should not use this method."
|
|
parameters:
|
|
- name: "link"
|
|
type: "<xref href=\"org.apache.qpid.proton.engine.Link?alt=org.apache.qpid.proton.engine.Link&text=Link\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void deregisterForConnectionError(Link link)"
|
|
desc: "Internal method. Clients should not use this method."
|
|
- uid: "com.microsoft.azure.servicebus.primitives.MessagingFactory.endTransaction(com.microsoft.azure.servicebus.TransactionContext,boolean)"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.MessagingFactory.endTransaction(TransactionContext transaction, boolean commit)"
|
|
name: "endTransaction(TransactionContext transaction, boolean commit)"
|
|
nameWithType: "MessagingFactory.endTransaction(TransactionContext transaction, boolean commit)"
|
|
summary: "Ends a transaction that was initiated using <xref uid=\"com.microsoft.azure.servicebus.primitives.MessagingFactory.startTransactionAsync()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MessagingFactory#startTransactionAsync()\"></xref>."
|
|
parameters:
|
|
- description: "The transaction object."
|
|
name: "transaction"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.TransactionContext?alt=com.microsoft.azure.servicebus.TransactionContext&text=TransactionContext\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "A boolean value of <code>true</code> indicates transaction to be committed. A value of\n <code>false</code> indicates a transaction rollback."
|
|
name: "commit"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void endTransaction(TransactionContext transaction, boolean commit)"
|
|
exceptions:
|
|
- description: "if transaction fails to end"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ServiceBusException?alt=com.microsoft.azure.servicebus.primitives.ServiceBusException&text=ServiceBusException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "if transaction fails to end"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html\">InterruptedException</a>"
|
|
desc: "Ends a transaction that was initiated using <xref uid=\"com.microsoft.azure.servicebus.primitives.MessagingFactory.startTransactionAsync()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MessagingFactory#startTransactionAsync()\"></xref>."
|
|
- uid: "com.microsoft.azure.servicebus.primitives.MessagingFactory.endTransactionAsync(com.microsoft.azure.servicebus.TransactionContext,boolean)"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.MessagingFactory.endTransactionAsync(TransactionContext transaction, boolean commit)"
|
|
name: "endTransactionAsync(TransactionContext transaction, boolean commit)"
|
|
nameWithType: "MessagingFactory.endTransactionAsync(TransactionContext transaction, boolean commit)"
|
|
summary: "Ends a transaction that was initiated using <xref uid=\"com.microsoft.azure.servicebus.primitives.MessagingFactory.startTransactionAsync()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MessagingFactory#startTransactionAsync()\"></xref>."
|
|
parameters:
|
|
- description: "The transaction object."
|
|
name: "transaction"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.TransactionContext?alt=com.microsoft.azure.servicebus.TransactionContext&text=TransactionContext\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "A boolean value of <code>true</code> indicates transaction to be committed. A value of\n <code>false</code> indicates a transaction rollback."
|
|
name: "commit"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public CompletableFuture<Void> endTransactionAsync(TransactionContext transaction, boolean commit)"
|
|
desc: "Ends a transaction that was initiated using <xref uid=\"com.microsoft.azure.servicebus.primitives.MessagingFactory.startTransactionAsync()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MessagingFactory#startTransactionAsync()\"></xref>."
|
|
returns:
|
|
description: "A <code>CompletableFuture</code>"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.microsoft.azure.servicebus.primitives.MessagingFactory.getClientSettings()"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.MessagingFactory.getClientSettings()"
|
|
name: "getClientSettings()"
|
|
nameWithType: "MessagingFactory.getClientSettings()"
|
|
summary: "Gets client settings for this messaging factory instance"
|
|
syntax: "public ClientSettings getClientSettings()"
|
|
desc: "Gets client settings for this messaging factory instance"
|
|
returns:
|
|
description: "client settings for this messaging factory instance"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.ClientSettings?alt=com.microsoft.azure.servicebus.ClientSettings&text=ClientSettings\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.servicebus.primitives.MessagingFactory.getHostName()"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.MessagingFactory.getHostName()"
|
|
name: "getHostName()"
|
|
nameWithType: "MessagingFactory.getHostName()"
|
|
syntax: "public String getHostName()"
|
|
returns:
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.servicebus.primitives.MessagingFactory.getOperationTimeout()"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.MessagingFactory.getOperationTimeout()"
|
|
name: "getOperationTimeout()"
|
|
nameWithType: "MessagingFactory.getOperationTimeout()"
|
|
summary: "Gets the operation timeout from the connections string."
|
|
syntax: "public Duration getOperationTimeout()"
|
|
desc: "Gets the operation timeout from the connections string."
|
|
returns:
|
|
description: "operation timeout specified in the connection string"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- uid: "com.microsoft.azure.servicebus.primitives.MessagingFactory.getRetryPolicy()"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.MessagingFactory.getRetryPolicy()"
|
|
name: "getRetryPolicy()"
|
|
nameWithType: "MessagingFactory.getRetryPolicy()"
|
|
summary: "Gets the retry policy from the connection string."
|
|
syntax: "public RetryPolicy getRetryPolicy()"
|
|
desc: "Gets the retry policy from the connection string."
|
|
returns:
|
|
description: "retry policy specified in the connection string"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.RetryPolicy?alt=com.microsoft.azure.servicebus.primitives.RetryPolicy&text=RetryPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.servicebus.primitives.MessagingFactory.onClose()"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.MessagingFactory.onClose()"
|
|
name: "onClose()"
|
|
nameWithType: "MessagingFactory.onClose()"
|
|
modifiers:
|
|
- "protected"
|
|
overridden: "com.microsoft.azure.servicebus.primitives.ClientEntity.onClose()"
|
|
syntax: "protected CompletableFuture<Void> onClose()"
|
|
returns:
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.microsoft.azure.servicebus.primitives.MessagingFactory.onConnectionError(org.apache.qpid.proton.amqp.transport.ErrorCondition)"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.MessagingFactory.onConnectionError(ErrorCondition error)"
|
|
name: "onConnectionError(ErrorCondition error)"
|
|
nameWithType: "MessagingFactory.onConnectionError(ErrorCondition error)"
|
|
summary: "Internal method. Clients should not use this method."
|
|
parameters:
|
|
- name: "error"
|
|
type: "<xref href=\"org.apache.qpid.proton.amqp.transport.ErrorCondition?alt=org.apache.qpid.proton.amqp.transport.ErrorCondition&text=ErrorCondition\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void onConnectionError(ErrorCondition error)"
|
|
desc: "Internal method. Clients should not use this method."
|
|
- uid: "com.microsoft.azure.servicebus.primitives.MessagingFactory.onConnectionOpen()"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.MessagingFactory.onConnectionOpen()"
|
|
name: "onConnectionOpen()"
|
|
nameWithType: "MessagingFactory.onConnectionOpen()"
|
|
summary: "Internal method. Clients should not use this method."
|
|
syntax: "public void onConnectionOpen()"
|
|
desc: "Internal method. Clients should not use this method."
|
|
- uid: "com.microsoft.azure.servicebus.primitives.MessagingFactory.registerForConnectionError(org.apache.qpid.proton.engine.Link)"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.MessagingFactory.registerForConnectionError(Link link)"
|
|
name: "registerForConnectionError(Link link)"
|
|
nameWithType: "MessagingFactory.registerForConnectionError(Link link)"
|
|
summary: "Internal method. Clients should not use this method."
|
|
parameters:
|
|
- name: "link"
|
|
type: "<xref href=\"org.apache.qpid.proton.engine.Link?alt=org.apache.qpid.proton.engine.Link&text=Link\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void registerForConnectionError(Link link)"
|
|
desc: "Internal method. Clients should not use this method."
|
|
- uid: "com.microsoft.azure.servicebus.primitives.MessagingFactory.startTransaction()"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.MessagingFactory.startTransaction()"
|
|
name: "startTransaction()"
|
|
nameWithType: "MessagingFactory.startTransaction()"
|
|
summary: "Starts a new service side transaction."
|
|
syntax: "public TransactionContext startTransaction()"
|
|
exceptions:
|
|
- description: "if transaction fails to start"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.primitives.ServiceBusException?alt=com.microsoft.azure.servicebus.primitives.ServiceBusException&text=ServiceBusException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "if transaction fails to start"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html\">InterruptedException</a>"
|
|
desc: "Starts a new service side transaction. The <xref uid=\"com.microsoft.azure.servicebus.TransactionContext\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TransactionContext\"></xref> should be passed to all operations that needs to be in this transaction."
|
|
returns:
|
|
description: "a new transaction"
|
|
type: "<xref href=\"com.microsoft.azure.servicebus.TransactionContext?alt=com.microsoft.azure.servicebus.TransactionContext&text=TransactionContext\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.servicebus.primitives.MessagingFactory.startTransactionAsync()"
|
|
fullName: "com.microsoft.azure.servicebus.primitives.MessagingFactory.startTransactionAsync()"
|
|
name: "startTransactionAsync()"
|
|
nameWithType: "MessagingFactory.startTransactionAsync()"
|
|
summary: "Starts a new service side transaction."
|
|
syntax: "public CompletableFuture<TransactionContext> startTransactionAsync()"
|
|
desc: "Starts a new service side transaction. The <xref uid=\"com.microsoft.azure.servicebus.TransactionContext\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TransactionContext\"></xref> should be passed to all operations that needs to be in this transaction."
|
|
returns:
|
|
description: "A <code>CompletableFuture</code> which returns a new transaction"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html\">CompletableFuture</a><<xref href=\"com.microsoft.azure.servicebus.TransactionContext?alt=com.microsoft.azure.servicebus.TransactionContext&text=TransactionContext\" data-throw-if-not-resolved=\"False\" />>"
|
|
type: "class"
|
|
desc: "Abstracts all AMQP related details and encapsulates an AMQP connection and manages its life cycle. Each instance of this class represent one AMQP connection to the namespace. If an application creates multiple senders, receivers or clients using the same MessagingFactory instance, all those senders, receivers or clients will share the same connection to the namespace."
|
|
implements:
|
|
- "<xref href=\"com.microsoft.azure.servicebus.amqp.IAmqpConnection?alt=com.microsoft.azure.servicebus.amqp.IAmqpConnection&text=IAmqpConnection\" data-throw-if-not-resolved=\"False\" />"
|
|
metadata: {}
|
|
package: "com.microsoft.azure.servicebus.primitives"
|
|
artifact: com.microsoft.azure:azure-servicebus:3.6.7
|