public class EntitlementRequest extends Object
An {@link EntitlementRequest} represents a request sent to the server containing the permissions being requested.
Along with an entitlement request additional {@link AuthorizationRequestMetadata} information can be passed in order to define what clients expect from the server when evaluating the requested permissions and when returning with a response.
Constructor and Description |
---|
EntitlementRequest() |
Modifier and Type | Method and Description |
---|---|
void |
addPermission(PermissionRequest request)
Adds the given
PermissionRequest to the list of requested permissions. |
AuthorizationRequestMetadata |
getMetadata()
Return the
Metadata associated with this request. |
List<PermissionRequest> |
getPermissions()
Returns the permissions being requested.
|
String |
getRpt()
Returns a
String representing a previously issued RPT which permissions will be included the response in addition to the new ones being requested. |
void |
setMetadata(AuthorizationRequestMetadata metadata)
The
Metadata associated with this request. |
void |
setPermissions(List<PermissionRequest> permissions)
Set the permissions being requested
|
void |
setRpt(String rpt)
A
String representing a previously issued RPT which permissions will be included the response in addition to the new ones being requested. |
public List<PermissionRequest> getPermissions()
null
)public void setPermissions(List<PermissionRequest> permissions)
permissions
- the permissions being requests (not null
)public void addPermission(PermissionRequest request)
PermissionRequest
to the list of requested permissions.request
- the permission to request (not null
)public String getRpt()
String
representing a previously issued RPT which permissions will be included the response in addition to the new ones being requested.null
)public void setRpt(String rpt)
String
representing a previously issued RPT which permissions will be included the response in addition to the new ones being requested.rpt
- a previously issued RPT. If null
, only the requested permissions are evaluatedpublic AuthorizationRequestMetadata getMetadata()
Metadata
associated with this request.public void setMetadata(AuthorizationRequestMetadata metadata)
Metadata
associated with this request. The metadata defines specific information that should be considered
by the server when evaluating and returning permissions.metadata
- the Metadata
associated with this request (may be null
)Copyright © 2019 JBoss by Red Hat. All rights reserved.