org.mule.modules.microsoftservicebus.connection

Class SharedAccessSignatureConnectionStrategy

java.lang.Object

org.mule.modules.microsoftservicebus.connection.BaseConnectionStrategy

org.mule.modules.microsoftservicebus.connection.AzureConnectionStrategy

org.mule.modules.microsoftservicebus.connection.SharedAccessSignatureConnectionStrategy

All Implemented Interfaces:

ConnectionStrategy

@ConnectionManagement(configElementName="azureSASConfig",
                      friendlyName="Shared Access Signature")
public class SharedAccessSignatureConnectionStrategy
extends AzureConnectionStrategy

Field Summary

Fields inherited from class org.mule.modules.microsoftservicebus.connection.BaseConnectionStrategy

amqpClient, blobContainer, muleContext, namespace, restClient

Constructor Summary

Constructors

Constructor and Description
SharedAccessSignatureConnectionStrategy()

Method Summary

Modifier and Type	Method and Description
void	connect(String namespace, String sharedAccessSignature, String blobAccountName, String blobAccountKey, String blobContainerName) Connect
String	connectionId() namespace_sasObject
String	getSASToken(String url)
SharedAccessSignatureProvider	getTokenProvider()
List<String>	getTokens()
void	setTokenProvider(SharedAccessSignatureProvider provider)
void	setTokens(List<String> tokens)
protected boolean	testConnectivity()

Methods inherited from class org.mule.modules.microsoftservicebus.connection.AzureConnectionStrategy

createAMQPClient, createRestClient, getBaseUrl

Methods inherited from class org.mule.modules.microsoftservicebus.connection.BaseConnectionStrategy

disconnect, getAMQPClient, getCloudBlobContainer, getMaxConnections, getRestClient, getSkipConnectivityTest, isConnected, setMaxConnections, setMuleContext, setSkipConnectivityTest, testConnectivityAmqpClient

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SharedAccessSignatureConnectionStrategy

public SharedAccessSignatureConnectionStrategy()

Method Detail

connect

@Connect
 @TestConnectivity
public void connect(@ConnectionKey @FriendlyName(value="Service Namespace") @Placement(group="Connection",order=1)
                                                String namespace,
                                                @ConnectionKey @FriendlyName(value="Shared Access Signature") @Placement(group="Connection",order=2) @Optional
                                                String sharedAccessSignature,
                                                @FriendlyName(value="Storage Account Name") @Placement(group="Blob Storage Connection") @Summary(value="(Optional) The account name of the Blob Storage that will be used to store large messages.") @Optional
                                                String blobAccountName,
                                                @FriendlyName(value="Storage Access Key") @Placement(group="Blob Storage Connection") @Password @Summary(value="(Optional) The account key of the Blob Storage that will be used to store large messages.") @Optional
                                                String blobAccountKey,
                                                @FriendlyName(value="Container Name") @Placement(group="Blob Storage Connection") @Summary(value="(Optional) The container name in the Blob Storage that will be used to store large messages. If this parameter is not provided a default container will be created.") @Optional
                                                String blobContainerName)
                                         throws org.mule.api.ConnectionException

Connect

Parameters:

namespace - Azure Service Namespace

sharedAccessSignature - Shared Access Signature (optional - can be left empty if advanced section is configured)

blobAccountName - The account name of the Blob Storage that will be used to store large messages.

blobAccountKey - The account key of the Blob Storage that will be used to store large messages.

blobContainerName - The container name in the Blob Storage that will be used to store large messages. If this parameter is not provided a default container will be created.

Throws:

org.mule.api.ConnectionException - thrown when the namespace is null or empty

connectionId

@ConnectionIdentifier
public String connectionId()

namespace_sasObject

Returns:

connection id value

getSASToken

public String getSASToken(String url)
                   throws ServiceBusException

Specified by:

getSASToken in interface ConnectionStrategy

Specified by:

getSASToken in class BaseConnectionStrategy

Throws:

ServiceBusException

getTokenProvider

public SharedAccessSignatureProvider getTokenProvider()

setTokenProvider

public void setTokenProvider(SharedAccessSignatureProvider provider)

getTokens

public List<String> getTokens()

setTokens

public void setTokens(List<String> tokens)

testConnectivity

protected boolean testConnectivity()

Overrides:

testConnectivity in class BaseConnectionStrategy