Interface Realm
public interface Realm
This interface provides methods to query information from a realm.
- Author:
- Pedro Igor
-
Method Summary
Modifier and TypeMethodDescriptionReturns all attributes associated with the a user with the givenid
.getUserClientRoles
(String id, String clientId) Returns all client roles granted for a user with the givenid
.getUserGroups
(String id) Returns all groups which the user with the givenid
is a member.Returns all realm roles granted for a user with the givenid
.boolean
isGroupInRole
(String group, String role) Checks whether or not agroup
is granted with the given realmrole
.boolean
isUserInClientRole
(String id, String clientId, String role) Checks whether or not a user with the givenid
is granted with the given clientrole
.default boolean
isUserInGroup
(String id, String group) Checks whether or not a user with the givenid
is a member of the givengroup
.boolean
isUserInGroup
(String id, String group, boolean checkParent) Checks whether or not a user with the givenid
is a member of the givengroup
.boolean
isUserInRealmRole
(String id, String role) Checks whether or not a user with the givenid
is granted with the given realmrole
.
-
Method Details
-
isUserInGroup
Checks whether or not a user with the given
id
is a member of the givengroup
.This method will also consider memberships where the user is a member of any child group of the given
group
. For instance, if user is member of/Group A/Group B
and this method is checking if user is a member of/Group A
the result will betrue
given that the user is a member of a child group of/Group A
.- Parameters:
id
- the user id. It can be the id, username or emailgroup
- the group path. For instance, /Group A/Group B.- Returns:
- true if user is a member of the given group. Otherwise returns false.
-
isUserInGroup
Checks whether or not a user with the givenid
is a member of the givengroup
.- Parameters:
id
- the user id. It can be the id, username or emailgroup
- the group path. For instance, /Group A/Group B.checkParent
- if true, this method returns true even though the user is not directly associated with the given group but a member of any child of the group.- Returns:
- true if user is a member of the given group. Otherwise returns false.
-
isUserInRealmRole
Checks whether or not a user with the givenid
is granted with the given realmrole
.- Parameters:
id
- the user id. It can be the id, username or emailrole
- the role name- Returns:
- true if the user is granted with the role. Otherwise, false.
-
isUserInClientRole
Checks whether or not a user with the givenid
is granted with the given clientrole
.- Parameters:
id
- the user id. It can be the id, username or emailclientId
- the client idrole
- the role name- Returns:
- true if the user is granted with the role. Otherwise, false.
-
isGroupInRole
Checks whether or not agroup
is granted with the given realmrole
.- Parameters:
group
- the group path. For instance, /Group A/Group B.role
- the role name- Returns:
- true if the group is granted with the role. Otherwise, false.
-
getUserRealmRoles
Returns all realm roles granted for a user with the givenid
.- Parameters:
id
- the user id. It can be the id, username or email- Returns:
- the roles granted to the user
-
getUserClientRoles
Returns all client roles granted for a user with the givenid
.- Parameters:
id
- the user id. It can be the id, username or emailclientId
- the client id- Returns:
- the roles granted to the user
-
getUserGroups
Returns all groups which the user with the givenid
is a member.- Parameters:
id
- the user id. It can be the id, username or email- Returns:
- the groups which the user is a member
-
getUserAttributes
Returns all attributes associated with the a user with the givenid
.- Parameters:
id
- the user id. It can be the id, username or email- Returns:
- a map with the attributes associated with the user
-