AuthorizationService (Gateway Java OData Independent API 1.40.11 API)

java.lang.Object
- com.sap.cloud.sdk.service.prov.api.security.AuthorizationService

```
public final class AuthorizationService
extends Object
```
Provides methods for securing the service and entities exposed as part of the service. Specifically, these methods check user-level access to the service and its entities.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Authorization`	`getAuthorization()` Creates an `Authorization` object whenever an authorization check is required.
`static AuthJWTToken`	`getJWTToken()` This method gets JWTAuthToken
`static String`	`getUserAttribute(String attributeName)` Returns the value for the specified attribute which is part of JWT.
`static String`	`getUserId()` Returns the ID of this current user.
`static Object`	`getUserInfo()` Gets the USERInfo object for the current request
`static String`	`getUserName()` Returns the name of this current user.
`static String`	`getWhereCondition()` Gets the condition specified in the service model for granting entity-level access.
`static boolean`	`hasEntityAccess(String entityName, String operation)` Checks if the current user has rights to perform the specified operation on an entity.
`static boolean`	`hasExpandedEntityAccess(String entityName, String operation)` Checks if the current user has rights to perform the specified operation on an expanded entity.
`static boolean`	`hasUserRole(String roleName)` Checks if the current user has the given role associated.
`static boolean`	`isAuthenticatedUser(String serviceName)` Checks if the current user is authenticated to access the service.
`static boolean`	`isRegisteredUser(String serviceName)` Checks if the current user is registered to access the service.
`static void`	`purgeCurrentAuthorization()` Removes the Authorization data for current request.
`static void`	`setJWTToken(String base64EncodedJWTStr)` Sets the JWT Token using Base64 Encoded string for current request.
`static void`	`setJWTToken(String base64EncodedJWTStr, com.google.gson.JsonObject jwtJson)` Sets the JWT Token using Base64 Encoded string and its converted JsonNode for current request.
`static void`	`setWhereCondition(String whereCondition)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getAuthorization
```
public static Authorization getAuthorization()
```
    Creates an Authorization object whenever an authorization check is required. Once created, this object is available till the request is processed.
    
    Returns:
    
    An Authorization object
  - isAuthenticatedUser
```
public static boolean isAuthenticatedUser(String serviceName)
```
    Checks if the current user is authenticated to access the service. If there is no restriction defined for the service in the model, it always returns true.
    
    Parameters:
    
    serviceName - Name of the service for which the authentication check is performed
    
    Returns:
    
    true if there is no restriction on the service or if the user is authenticated to access the service , false otherwise
  - isRegisteredUser
```
public static boolean isRegisteredUser(String serviceName)
```
    Checks if the current user is registered to access the service. If there is no restriction defined for the service in the model, it always returns true.
    
    Parameters:
    
    serviceName - Name of the service for which the authentication check is performed
    
    Returns:
    
    true if there is no restriction on the service or if the user is authenticated to access the service , false otherwise
  - hasEntityAccess
```
public static boolean hasEntityAccess(String entityName,
                                      String operation)
```
    Checks if the current user has rights to perform the specified operation on an entity. If there is no restriction defined on the entity in the service model, it always returns true.
    
    Parameters:
    
    entityName - Name of the entity being accessed
    
    operation - String representing the operation. Allowed values are READ or WRITE.
    
    Returns:
    
    true if the user is granted rights to perform the specified operation on the entity , false otherwise
  - hasExpandedEntityAccess
```
public static boolean hasExpandedEntityAccess(String entityName,
                                              String operation)
```
    Checks if the current user has rights to perform the specified operation on an expanded entity. If there is no restriction defined on the entity in the service model, it always returns true.
    
    Parameters:
    
    entityName - Name of the entity being accessed
    
    operation - String representing the operation. Allowed values are READ or WRITE.
    
    Returns:
    
    true if the user is granted rights to perform the specified operation on the entity , false otherwise
  - getWhereCondition
```
public static String getWhereCondition()
```
    Gets the condition specified in the service model for granting entity-level access.
    
    Returns:
    
    String containing the resolved where condition
  - setWhereCondition
```
public static void setWhereCondition(String whereCondition)
```
  - getUserName
```
public static String getUserName()
```
    Returns the name of this current user.
    
    Returns:
    
    String containing the current principal's user name.
  - getUserId
```
public static String getUserId()
```
    Returns the ID of this current user.
    
    Returns:
    
    String containing the current principal's user id.
  - hasUserRole
```
public static boolean hasUserRole(String roleName)
```
    Checks if the current user has the given role associated.
    
    Parameters:
    
    roleName - the role name
    
    Returns:
    
    true if the user has the specified role, false otherwise
  - getUserAttribute
```
public static String getUserAttribute(String attributeName)
```
    Returns the value for the specified attribute which is part of JWT. It supports fetching attribute values from first level JWT attributes, user attributes and system attributes.
    
    Parameters:
    
    attributeName - the attribute name same as in JWT token.
    
    Returns:
    
    String if user has the given value for given attribute otherwise null
  - getJWTToken
```
public static AuthJWTToken getJWTToken()
```
    This method gets JWTAuthToken
    
    Returns:
  - setJWTToken
```
public static void setJWTToken(String base64EncodedJWTStr)
```
    Sets the JWT Token using Base64 Encoded string for current request.
    
    Parameters:
    
    base64EncodedJWTStr -
  - setJWTToken
```
public static void setJWTToken(String base64EncodedJWTStr,
                               com.google.gson.JsonObject jwtJson)
```
    Sets the JWT Token using Base64 Encoded string and its converted JsonNode for current request.
    
    Parameters:
    
    base64EncodedJWTStr -
  - getUserInfo
```
public static Object getUserInfo()
```
    Gets the USERInfo object for the current request
    
    Returns:
  - purgeCurrentAuthorization
```
public static void purgeCurrentAuthorization()
```
    Removes the Authorization data for current request.

Class AuthorizationService

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getAuthorization

isAuthenticatedUser

isRegisteredUser

hasEntityAccess

hasExpandedEntityAccess

getWhereCondition

setWhereCondition

getUserName

getUserId

hasUserRole

getUserAttribute

getJWTToken

setJWTToken

setJWTToken

getUserInfo

purgeCurrentAuthorization