io.apiman.manager.api.security

Interface ISecurityContext

All Known Implementing Classes:

AbstractSecurityContext, DefaultSecurityContext, KeycloakSecurityContext

public interface ISecurityContext

The security context used by the REST API to determine whether the current user has appropriate access to see specific data or perform certain actions.

Author:

eric.wittmann@redhat.com

Method Summary

Modifier and Type	Method and Description
String	getCurrentUser()
String	getEmail()
String	getFullName()
Set<String>	getPermittedOrganizations(io.apiman.manager.api.beans.idm.PermissionType permission) Returns the set of organizations for which the current user is allowed to perform a given action.
String	getRequestHeader(String headerName) Gets a request header from the current in-scope request.
boolean	hasPermission(io.apiman.manager.api.beans.idm.PermissionType permission, String organizationId) Returns true if the current user has permission to perform a particular action for the provided organization.
boolean	isAdmin() Returns true if the current user is an administrator.

Method Detail

getCurrentUser

String getCurrentUser()

Returns:

the currently authentiated user.

getFullName

String getFullName()

Returns:

the currently authenticated user's full name

getEmail

String getEmail()

Returns:

the currently authenticated user's email address

isAdmin

boolean isAdmin()

Returns true if the current user is an administrator.

Returns:

true if admin, else false

hasPermission

boolean hasPermission(io.apiman.manager.api.beans.idm.PermissionType permission,
                      String organizationId)

Returns true if the current user has permission to perform a particular action for the provided organization.

Parameters:

permission - the permission type

organizationId - the org id

Returns:

true if has permission, else false

getPermittedOrganizations

Set<String> getPermittedOrganizations(io.apiman.manager.api.beans.idm.PermissionType permission)

Returns the set of organizations for which the current user is allowed to perform a given action.

Parameters:

permission - the permission type

Returns:

set of permitted organizations

getRequestHeader

String getRequestHeader(String headerName)

Gets a request header from the current in-scope request.

Parameters:

headerName - the header name

Returns:

the request header