Class SharedAccessAuthorizationRule

java.lang.Object

com.azure.messaging.servicebus.administration.models.SharedAccessAuthorizationRule

All Implemented Interfaces:

AuthorizationRule

public final class SharedAccessAuthorizationRule
extends Object
implements AuthorizationRule

A shared access key for accessing Service Bus entities.

See Also:

• CreateQueueOptions.getAuthorizationRules()
• CreateTopicOptions.getAuthorizationRules()

Constructor Summary

Constructors

Constructor	Description
SharedAccessAuthorizationRule(String keyName, String primaryKey, String secondaryKey, List<AccessRights> accessRights)	Creates an instance with the given key name, primary key, secondary key, and access rights.
SharedAccessAuthorizationRule(String keyName, String primaryKey, List<AccessRights> accessRights)	Creates an instance with the given key name, primary key, secondary key, and access rights.
SharedAccessAuthorizationRule(String keyName, List<AccessRights> accessRights)	Creates an instance with the given key name and access rights.

Method Summary

Modifier and Type	Method	Description
List<AccessRights>	getAccessRights()	Gets the access rights for the rule.
String	getClaimType()	Gets the claim type.
String	getClaimValue()	Gets the claim value.
OffsetDateTime	getCreatedAt()	Gets the date time this rule was created.
String	getKeyName()	Gets the name of the authorization rule.
OffsetDateTime	getModifiedAt()	Gets the date time this rule was last modified.
String	getPrimaryKey()	Gets the primary key.
String	getSecondaryKey()	Gets the secondary key.
SharedAccessAuthorizationRule	setPrimaryKey(String primaryKey)	Sets the primary key.
SharedAccessAuthorizationRule	setSecondaryKey(String secondaryKey)	Sets the secondary key.

Methods inherited from class Object

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

Constructor Details

SharedAccessAuthorizationRule

public SharedAccessAuthorizationRule(String keyName,
 List<AccessRights> accessRights)

Creates an instance with the given key name and access rights. The primary key and secondary key is randomly generated.

Parameters:

keyName - The name of the rule.

accessRights - The access rights.

Throws:

NullPointerException - if keyName or accessRights are null.

IllegalArgumentException - if keyName are empty strings.

SharedAccessAuthorizationRule

public SharedAccessAuthorizationRule(String keyName,
 String primaryKey,
 List<AccessRights> accessRights)

Creates an instance with the given key name, primary key, secondary key, and access rights. The secondary key is randomly generated.

Parameters:

keyName - The name of the rule.

primaryKey - The primary key.

accessRights - The access rights.

Throws:

NullPointerException - if keyName, primaryKey, or accessRights are null.

IllegalArgumentException - if keyName, primaryKey are empty strings.

SharedAccessAuthorizationRule

public SharedAccessAuthorizationRule(String keyName,
 String primaryKey,
 String secondaryKey,
 List<AccessRights> accessRights)

Creates an instance with the given key name, primary key, secondary key, and access rights.

Parameters:

keyName - The name of the rule.

primaryKey - The primary key.

secondaryKey - The secondary key.

accessRights - The access rights.

Throws:

NullPointerException - if keyName, primaryKey, secondaryKey, or accessRights are null.

IllegalArgumentException - if keyName, primaryKey, secondaryKey are empty strings.

Method Details

getAccessRights

public List<AccessRights> getAccessRights()

Gets the access rights for the rule.

Specified by:

getAccessRights in interface AuthorizationRule

Returns:

The access rights for the rule.

getClaimType

public String getClaimType()

Gets the claim type.

Specified by:

getClaimType in interface AuthorizationRule

Returns:

The claim type.

getClaimValue

public String getClaimValue()

Gets the claim value.

Specified by:

getClaimValue in interface AuthorizationRule

Returns:

The claim value.

getCreatedAt

public OffsetDateTime getCreatedAt()

Gets the date time this rule was created.

Specified by:

getCreatedAt in interface AuthorizationRule

Returns:

The date time this rule was created.

getKeyName

public String getKeyName()

Gets the name of the authorization rule.

Specified by:

getKeyName in interface AuthorizationRule

Returns:

name of the authorization rule.

getModifiedAt

public OffsetDateTime getModifiedAt()

Gets the date time this rule was last modified.

Specified by:

getModifiedAt in interface AuthorizationRule

Returns:

The date time this rule was last modified.

getPrimaryKey

public String getPrimaryKey()

Gets the primary key.

Specified by:

getPrimaryKey in interface AuthorizationRule

Returns:

The primary key.

setPrimaryKey

public SharedAccessAuthorizationRule setPrimaryKey(String primaryKey)

Sets the primary key.

Parameters:

primaryKey - The primary key to set.

Returns:

The updated SharedAccessAuthorizationRule object.

Throws:

NullPointerException - if primaryKey is null.

IllegalArgumentException - if primaryKey is an empty string.

getSecondaryKey

public String getSecondaryKey()

Gets the secondary key.

Specified by:

getSecondaryKey in interface AuthorizationRule

Returns:

The secondary key.

setSecondaryKey

public SharedAccessAuthorizationRule setSecondaryKey(String secondaryKey)

Sets the secondary key.

Parameters:

secondaryKey - The secondary key to set.

Returns:

The updated SharedAccessAuthorizationRule object.

Throws:

NullPointerException - if secondary is null.

IllegalArgumentException - if secondary is an empty string.