com.sap.cloud.sdk.service.prov.api.security

Class AuthorizationDecorator

java.lang.Object

com.sap.cloud.sdk.service.prov.api.security.Authorization

com.sap.cloud.sdk.service.prov.api.security.AuthorizationDecorator

Direct Known Subclasses:

BackwardCompatibility

public class AuthorizationDecorator
extends Authorization

AuthorizationDecorator which allows easy extension if new functionalities have to be added to existing IAuthorization.

Constructor Summary

Constructors

Constructor and Description
AuthorizationDecorator(Authorization authorization)

Method Summary

Modifier and Type	Method and Description
String	getUserAttribute(String attributeName) Returns the value for the specified attribute which is part of JWT.
String	getUserId() Returns the ID of this current user.
String	getUserName() Returns the name of this current user.
boolean	hasEntityAccess(String entityName, String operation) Checks if current user is granted access to access the given Odata entity to perform the given operation(READ/WRITE).
boolean	hasUserRole(String roleName) Checks the current user has the given role or not.
boolean	isAuthenticatedUser(String serviceName) Checks if current user is authenticated and given OData service requires authenticated user to access it.
boolean	isRegisteredUser(String serviceName) Checks if current user is registered user and given OData service requires registered user to access it.

Methods inherited from class com.sap.cloud.sdk.service.prov.api.security.Authorization

getWhereCondition, rejectRequest, setWhereCondition

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthorizationDecorator

public AuthorizationDecorator(Authorization authorization)

Method Detail

isAuthenticatedUser

public boolean isAuthenticatedUser(String serviceName)

Description copied from class: Authorization

Checks if current user is authenticated and given OData service requires authenticated user to access it. If there is no restriction defined for the service, It returns true.

Specified by:

isAuthenticatedUser in class Authorization

Parameters:

serviceName - the OData service name.

Returns:

true if no rule found or satisfies rule, else false.

isRegisteredUser

public boolean isRegisteredUser(String serviceName)

Description copied from class: Authorization

Checks if current user is registered user and given OData service requires registered user to access it. If there is no restriction defined for the service, It returns true.

Specified by:

isRegisteredUser in class Authorization

Parameters:

serviceName - the OData service name.

Returns:

true if no rule found or satisfies rule, else false.

hasEntityAccess

public boolean hasEntityAccess(String entityName,
                               String operation)

Description copied from class: Authorization

Checks if current user is granted access to access the given Odata entity to perform the given operation(READ/WRITE). If no rule found, it returns false. (True only when an operation granted explicitly.)

Specified by:

hasEntityAccess in class Authorization

Parameters:

entityName - the OData entity name.

operation - READ or WRITE.

Returns:

true if no rule found or satisfies rule, else false.

getUserName

public String getUserName()

Description copied from class: Authorization

Returns the name of this current user.

Specified by:

getUserName in class Authorization

Returns:

String containing the current principal's user name.

getUserId

public String getUserId()

Description copied from class: Authorization

Returns the ID of this current user.

Specified by:

getUserId in class Authorization

Returns:

String containing the current principal's user id.

hasUserRole

public boolean hasUserRole(String roleName)

Description copied from class: Authorization

Checks the current user has the given role or not.

Specified by:

hasUserRole in class Authorization

Parameters:

roleName - the role name.

Returns:

true if user has the given role otherwise false

getUserAttribute

public String getUserAttribute(String attributeName)

Description copied from class: Authorization

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.

Specified by:

getUserAttribute in class Authorization

Parameters:

attributeName - the attribute name same as in JWT token.

Returns:

String if user has the given value for given attribute otherwise null