com.microsoft.windowsazure.services.servicebus

Class ServiceBusConfiguration

java.lang.Object

com.microsoft.windowsazure.services.servicebus.ServiceBusConfiguration

public abstract class ServiceBusConfiguration
extends Object

Provides functionality to create a service bus configuration.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONNECTION_STRING Defines the configuration connection string constant.
static String	SAS_KEY Defines the configuration SAS Access key value constant.
static String	SAS_KEY_NAME Defines the configuration SAS Access Key name constant.
static String	URI Defines the configuration URI constant.
static String	WRAP_NAME Defines the configuration wrap name constant.
static String	WRAP_PASSWORD Defines the configuration wrap password constant.
static String	WRAP_URI Defines the configuration wrap URI constant.

Constructor Summary

Constructors

Constructor and Description
ServiceBusConfiguration()

Method Summary

Methods

Modifier and Type	Method and Description
static com.microsoft.windowsazure.Configuration	configureWithConnectionString(String profile, com.microsoft.windowsazure.Configuration configuration, String connectionString) Creates a service bus configuration using the specified connection string.
static com.microsoft.windowsazure.Configuration	configureWithSASAuthentication(com.microsoft.windowsazure.Configuration configuration, String namespace, String sasKeyName, String sasKey, String serviceBusRootUri) Create a service bus configuration using the given SAS authentication information.
static com.microsoft.windowsazure.Configuration	configureWithSASAuthentication(String profile, com.microsoft.windowsazure.Configuration configuration, String namespace, String sasKeyName, String sasKey, String serviceBusRootUri) Create a service bus configuration using the given SAS authentication information.
static com.microsoft.windowsazure.Configuration	configureWithSASAuthentication(String namespace, String sasKeyName, String sasKey, String serviceBusRootUri) Create a service bus configuration using the given SAS authentication information.
static com.microsoft.windowsazure.Configuration	configureWithWrapAuthentication(com.microsoft.windowsazure.Configuration configuration, String namespace, String authenticationName, String authenticationPassword, String serviceBusRootUri, String wrapRootUri) Creates a service bus configuration using the specified configuration, namespace, name, and password.
static com.microsoft.windowsazure.Configuration	configureWithWrapAuthentication(String profile, com.microsoft.windowsazure.Configuration configuration, String namespace, String authenticationName, String authenticationPassword, String serviceBusRootUri, String wrapRootUri) Creates a service bus configuration using the specified profile, configuration, namespace, name, and password.
static com.microsoft.windowsazure.Configuration	configureWithWrapAuthentication(String namespace, String authenticationName, String authenticationPassword, String serviceBusRootUri, String wrapRootUri) Creates a service bus configuration using the specified namespace, name, and password.

Methods inherited from class java.lang.Object

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

Field Detail

CONNECTION_STRING

public static final String CONNECTION_STRING

Defines the configuration connection string constant.

See Also:

Constant Field Values

URI

public static final String URI

Defines the configuration URI constant.

See Also:

Constant Field Values

WRAP_URI

public static final String WRAP_URI

Defines the configuration wrap URI constant.

See Also:

Constant Field Values

WRAP_NAME

public static final String WRAP_NAME

Defines the configuration wrap name constant.

See Also:

Constant Field Values

WRAP_PASSWORD

public static final String WRAP_PASSWORD

Defines the configuration wrap password constant.

See Also:

Constant Field Values

SAS_KEY_NAME

public static final String SAS_KEY_NAME

Defines the configuration SAS Access Key name constant. This is the value of the SharedAccessKeyName field in the connection string.

See Also:

Constant Field Values

SAS_KEY

public static final String SAS_KEY

Defines the configuration SAS Access key value constant. This is the actual token.

See Also:

Constant Field Values

Constructor Detail

ServiceBusConfiguration

public ServiceBusConfiguration()

Method Detail

configureWithWrapAuthentication

public static com.microsoft.windowsazure.Configuration configureWithWrapAuthentication(String namespace,
                                                                       String authenticationName,
                                                                       String authenticationPassword,
                                                                       String serviceBusRootUri,
                                                                       String wrapRootUri)

Creates a service bus configuration using the specified namespace, name, and password.

Parameters:

namespace - A String object that represents the namespace.

authenticationName - A String object that represents the authentication name.

authenticationPassword - A String object that represents the authentication password.

serviceBusRootUri - A String object containing the base URI that is added to your Service Bus namespace to form the URI to connect to the Service Bus service. To access the default public Azure service, pass ".servicebus.windows.net"

wrapRootUri - A String object containing the base URI that is added to your Service Bus namespace to form the URI to get an access token for the Service Bus service. To access the default public Azure service, pass "-sb.accesscontrol.windows.net/WRAPv0.9"

Returns:

A Configuration object that can be used when creating an instance of the ServiceBusService class.

configureWithWrapAuthentication

public static com.microsoft.windowsazure.Configuration configureWithWrapAuthentication(com.microsoft.windowsazure.Configuration configuration,
                                                                       String namespace,
                                                                       String authenticationName,
                                                                       String authenticationPassword,
                                                                       String serviceBusRootUri,
                                                                       String wrapRootUri)

Creates a service bus configuration using the specified configuration, namespace, name, and password.

Parameters:

configuration - A previously instantiated Configuration object.

namespace - A String object that represents the namespace.

authenticationName - A String object that represents the authentication name.

authenticationPassword - A String object that represents the authentication password.

serviceBusRootUri - A String object containing the base URI that is added to your Service Bus namespace to form the URI to connect to the Service Bus service. To access the default public Azure service, pass ".servicebus.windows.net"

wrapRootUri - A String object containing the base URI that is added to your Service Bus namespace to form the URI to get an access token for the Service Bus service. To access the default public Azure service, pass "-sb.accesscontrol.windows.net/WRAPv0.9"

Returns:

A Configuration object that can be used when creating an instance of the ServiceBusService class.

configureWithWrapAuthentication

public static com.microsoft.windowsazure.Configuration configureWithWrapAuthentication(String profile,
                                                                       com.microsoft.windowsazure.Configuration configuration,
                                                                       String namespace,
                                                                       String authenticationName,
                                                                       String authenticationPassword,
                                                                       String serviceBusRootUri,
                                                                       String wrapRootUri)

Creates a service bus configuration using the specified profile, configuration, namespace, name, and password.

Parameters:

profile - A String object that represents the profile.

configuration - A previously instantiated Configuration object.

namespace - A String object that represents the namespace.

authenticationName - A String object that represents the authentication name.

authenticationPassword - A String object that represents the authentication password.

serviceBusRootUri - A String object containing the base URI that is added to your Service Bus namespace to form the URI to connect to the Service Bus service. To access the default public Azure service, pass ".servicebus.windows.net"

wrapRootUri - A String object containing the base URI that is added to your Service Bus namespace to form the URI to get an access token for the Service Bus service. To access the default public Azure service, pass "-sb.accesscontrol.windows.net/WRAPv0.9"

Returns:

A Configuration object that can be used when creating an instance of the ServiceBusService class.

configureWithSASAuthentication

public static com.microsoft.windowsazure.Configuration configureWithSASAuthentication(String namespace,
                                                                      String sasKeyName,
                                                                      String sasKey,
                                                                      String serviceBusRootUri)

Create a service bus configuration using the given SAS authentication information.

Parameters:

namespace - A String object that represents the namespace.

sasKeyName - A String object that contains the SAS key name.

sasKey - A String object that contains the SAS key.

serviceBusRootUri - A String object containing the base URI that is added to your Service Bus namespace to form the URI to connect to the Service Bus service. To access the default public Azure service, pass ".servicebus.windows.net"

Returns:

A Configuration object that can be used when creating an instance of the ServiceBusService class.

configureWithSASAuthentication

public static com.microsoft.windowsazure.Configuration configureWithSASAuthentication(com.microsoft.windowsazure.Configuration configuration,
                                                                      String namespace,
                                                                      String sasKeyName,
                                                                      String sasKey,
                                                                      String serviceBusRootUri)

Create a service bus configuration using the given SAS authentication information.

Parameters:

configuration - A previously instantiated Configuration object.

namespace - A String object that represents the namespace.

sasKeyName - A String object that contains the SAS key name.

sasKey - A String object that contains the SAS key.

serviceBusRootUri - A String object containing the base URI that is added to your Service Bus namespace to form the URI to connect to the Service Bus service. To access the default public Azure service, pass ".servicebus.windows.net"

Returns:

A Configuration object that can be used when creating an instance of the ServiceBusService class.

configureWithSASAuthentication

public static com.microsoft.windowsazure.Configuration configureWithSASAuthentication(String profile,
                                                                      com.microsoft.windowsazure.Configuration configuration,
                                                                      String namespace,
                                                                      String sasKeyName,
                                                                      String sasKey,
                                                                      String serviceBusRootUri)

Create a service bus configuration using the given SAS authentication information.

Parameters:

profile - A String object that represents the namespace.

configuration - A previously instantiated Configuration object.

namespace - A String object that represents the namespace.

sasKeyName - A String object that contains the SAS key name.

sasKey - A String object that contains the SAS key.

serviceBusRootUri - A String object containing the base URI that is added to your Service Bus namespace to form the URI to connect to the Service Bus service. To access the default public Azure service, pass ".servicebus.windows.net"

Returns:

A Configuration object that can be used when creating an instance of the ServiceBusService class.

configureWithConnectionString

public static com.microsoft.windowsazure.Configuration configureWithConnectionString(String profile,
                                                                     com.microsoft.windowsazure.Configuration configuration,
                                                                     String connectionString)

Creates a service bus configuration using the specified connection string.

Parameters:

profile - A String object that represents the profile.

configuration - A previously instantiated Configuration object.

connectionString - A String object the contains the connection string for the service bus connection information.

Returns:

A Configuration object that can be used when creating an instance of the ServiceBusService class.