org.restsql.security

Interface SecurityContext

All Known Implementing Classes:

SecurityContextAdapter

public interface SecurityContext

Provides user principal and role check method. Mapped to the JAX-RS SecurityContext by the org.restsql.service.SecurityContextAdapter.

Author:

Mark Sawers

Method Summary

Methods

Modifier and Type	Method and Description
Principal	getUserPrincipal() Returns a java.security.Principal object containing the name of the current authenticated user.
boolean	isUserInRole(String roleName) Returns a boolean indicating whether the authenticated user is included in the specified logical "role".

Method Detail

isUserInRole

boolean isUserInRole(String roleName)

Returns a boolean indicating whether the authenticated user is included in the specified logical "role".

Parameters:

roleName - a String specifying the name of the role

Returns:

a boolean indicating whether the user making the request belongs to a given role; false if the user has not been authenticated

getUserPrincipal

Principal getUserPrincipal()

Returns a java.security.Principal object containing the name of the current authenticated user. If the user has not been authenticated, the method returns null.

Returns:

a java.security.Principal containing the name of the user making this request; null if the user has not been authenticated