In this lesson we would setup the role based authorization and be able to restrict resources based on users role.<\/p>\n
We would cover the following in this tutorial:<\/p>\n
Watch the video tutorial hereWatch the video tutorial here<\/a><\/p>\n We would need to place all the security-related files in the same package. So go ahead to create a package called security. Also four sub-packages as shown below:<\/p>\n <\/p>\n Inside the models package, create a class called Role. This class would be as follows:<\/p>\n I have used Auditable. You can review how to use it here<\/a>. JPA Auditing video here<\/a>.<\/p>\n <\/p>\n You need to modify the User model to include a new filed, roles. This would be a Set of all the roles assigned to the user.<\/p>\n So, open the User.java file and add the following:<\/p>\n <\/p>\n We need create the RoleRepository interface in the repositories package. Then we also create the RoleService in the services package.<\/p>\n Now, in the RoleService, take the following steps:<\/p>\n Step 1<\/strong> – Autowire the UserRepository and RoleRepository<\/p>\n Step 2<\/strong> – Write the findAll(), findById(), save() and delete() methods<\/p>\n <\/p>\n These two methods would be used to assign a role to a user or unassign a role to a user. You’ll write them in the service a well. You can find the two method below:<\/p>\n For assignUserRole()<\/p>\n <\/p>\n For unassignUserRole()<\/p>\n <\/p>\n As you might have thought, these methods are used to return list of a particular user’s roles and list of roles not assigned to a user.<\/p>\n GetUserRoles(user) is quite simple. Just return user.getRoles() as shown below:<\/p>\n <\/p>\n GetUserNotRoles is not that simple. We actually need to use an SQL statement.\u00a0 So we have to extend the RoleRepository to include this:<\/p>\n <\/p>\n You can then write the method in the UserService like shown below:<\/p>\n <\/p>\n This completes Part 1 of Role Base Authorization. In part two, we would setup the controller methods and then create the HTML pages to manage the roles.<\/p>\n1. Setup the Security Packages<\/strong><\/h5>\n
\n
\n
2. Create the Role class<\/strong><\/h5>\n
@Entity<\/span>\r\n@Data<\/span>\r\n@NoArgsConstructor<\/span>\r\n@AllArgsConstructor<\/span>\r\npublic<\/span> class<\/span> Role<\/span> extends<\/span> Auditable<<\/span>String><\/span> {<\/span>\r\n @GeneratedValue<\/span>(<\/span>strategy =<\/span> GenerationType.<\/span>IDENTITY<\/span>)<\/span>\r\n @Id<\/span>\r\n private<\/span> Integer id;<\/span>\r\n\r\n private<\/span> String description;<\/span>\r\n private<\/span> String details;<\/span>\r\n}<\/span>\r\n<\/pre>\n3. Modify the User Model to include Roles<\/strong><\/h5>\n
@ManyToMany<\/span>(<\/span>cascade =<\/span> {<\/span>CascadeType.<\/span>ALL<\/span>},<\/span> fetch =<\/span> FetchType.<\/span>EAGER<\/span>)<\/span>\r\n @JoinTable<\/span>(<\/span>\r\n name =<\/span> \"user_role\"<\/span>,<\/span>\r\n joinColumns =<\/span> {<\/span>@JoinColumn<\/span>(<\/span>name =<\/span> \"user_id\"<\/span>)},<\/span>\r\n inverseJoinColumns =<\/span> {<\/span>@JoinColumn<\/span>(<\/span>name =<\/span> \"role_id\"<\/span>)}<\/span>\r\n )<\/span>\r\nSet<<\/span>Role><\/span> roles =<\/span> new<\/span> HashSet<>();<\/span>\r\n<\/pre>\n4. Create the Role Repository and Service<\/strong><\/h5>\n
5. Write the Assign() and Unassign() Methods<\/strong><\/h5>\n
\/\/Assign Role to User<\/span>\r\npublic<\/span> void<\/span> assignUserRole<\/span>(<\/span>Integer userId,<\/span> Integer roleId){<\/span>\r\n User user =<\/span> userRepository.<\/span>findById<\/span>(<\/span>userId).<\/span>orElse<\/span>(<\/span>null<\/span>);<\/span>\r\n Role role =<\/span> roleRepository.<\/span>findById<\/span>(<\/span>roleId).<\/span>orElse<\/span>(<\/span>null<\/span>);<\/span>\r\n Set<<\/span>Role><\/span> userRoles =<\/span> user.<\/span>getRoles<\/span>();<\/span>\r\n userRoles.<\/span>add<\/span>(<\/span>role);<\/span>\r\n user.<\/span>setRoles<\/span>(<\/span>userRoles);<\/span>\r\n userRepository.<\/span>save<\/span>(<\/span>user);<\/span>\r\n}<\/span>\r\n<\/pre>\n\/\/Unassign Role to User<\/span>\r\npublic<\/span> void<\/span> unassignUserRole<\/span>(<\/span>Integer userId,<\/span> Integer roleId){<\/span>\r\n User user =<\/span> userRepository.<\/span>findById<\/span>(<\/span>userId).<\/span>orElse<\/span>(<\/span>null<\/span>);<\/span>\r\n user.<\/span>getRoles<\/span>().<\/span>removeIf<\/span>(<\/span>x -><\/span> x.<\/span>getId<\/span>()==<\/span>roleId);<\/span>\r\n userRepository.<\/span>save<\/span>(<\/span>user);<\/span>\r\n}<\/span>\r\n<\/pre>\n6. GetUserRoles() and GetUserNotRoles()<\/strong><\/h5>\n
public<\/span> Set<<\/span>Role><\/span> getUserRoles<\/span>(<\/span>User user){<\/span>\r\n return<\/span> user.<\/span>getRoles<\/span>();<\/span>\r\n}<\/span>\r\n<\/pre>\n@Query<\/span>(<\/span>\r\n value =<\/span> \"SELECT * FROM role WHERE id NOT IN (SELECT role_id FROM user_role WHERE user_id = ?1)\"<\/span>,<\/span> \r\n nativeQuery =<\/span> true<\/span>\r\n)<\/span>\r\nList<<\/span>Role><\/span> getUserNotRoles<\/span>(<\/span>Integer userId);<\/span>\r\n<\/pre>\npublic<\/span> List<<\/span>Role><\/span> getUserNotRoles<\/span>(<\/span>User user){<\/span>\r\n return<\/span> roleRepository.<\/span>getUserNotRoles<\/span>(<\/span>user.<\/span>getId<\/span>());<\/span>\r\n}<\/span>\r\n<\/pre>\n