Interface RolePreferencesApi

@FeignClient(name="preferences-service",
             qualifiers="rolePreferencesApi")
public interface RolePreferencesApi

A RolePreferencesApi defines the public REST API to manage RolePreferences.

Author:

Heiko Scherrer

Method Summary

Modifier and Type	Method	Description
List<RolePreferenceVO>	findByRole(String role)	Find and return all existing RolePreferences that belong to a role.
RolePreferenceVO	findByRoleAndKey(String role, String key)	Find and return one RolePreference that belongs to a role and has the given key.

Method Details

findByRole

@GetMapping(value="/v1/preferences",
            params="role")
List<RolePreferenceVO> findByRole(@RequestParam("role")
 String role)

Find and return all existing RolePreferences that belong to a role.

Parameters:

role - The owning role of the preferences

Returns:

A list of RolePreferenceVO

findByRoleAndKey

@GetMapping(value="/v1/preferences",
            params={"role","key"})
RolePreferenceVO findByRoleAndKey(@RequestParam("role")
 String role,
 @RequestParam("key")
 String key)

Find and return one RolePreference that belongs to a role and has the given key.

Parameters:

role - The owning role of the preference

key - The key of the preference

Returns:

One single instance