MigratoryDataSubscribeRequest
Represent a subscribe authorization request.
Public Functions
Name | |
---|---|
ClientCredentials | getClientCredentials() Provides the credentials of the client. |
List< String > | getSubjects() Provides the list of subjects to be authorized for subscription. |
void | setAllowed(String subject, boolean allowed) Allows or denies the subscribe authorization request. |
void | sendResponse() Send the response for the authorization request back to the server to allow or deny the subscribed subjects. |
Public Functions Documentation
function getClientCredentials
ClientCredentials getClientCredentials()
Provides the credentials of the client.
Return: the credentials of the client
function getSubjects
List< String > getSubjects()
Provides the list of subjects to be authorized for subscription.
Return: the subjects to be subscribed
function setAllowed
void setAllowed(
String subject,
boolean allowed
)
Allows or denies the subscribe authorization request.
Parameters:
- subject each subject of the list provided by MigratoryDataSubscribeRequest.getSubjects() to be authorized for subscription
- allowed
true
if the client with the credentials provided by MigratoryDataSubscribeRequest.getClientCredentials() is allowed to subscribe to the subject of the first argument, andfalse
otherwise
This method should be used to authorize the subscription for each subject of the list provided by MigratoryDataSubscribeRequest.getSubjects().
function sendResponse
void sendResponse()
Send the response for the authorization request back to the server to allow or deny the subscribed subjects.
This method must be called after the subjects have been authorized using the method MigratoryDataSubscribeRequest.setAllowed()..