com.sap.scimono.callback.users

Interface UsersCallback

All Known Implementing Classes:

DefaultUsersCallback

public interface UsersCallback

Method Summary

Modifier and Type	Method and Description
User	createUser(User user) Creates a user with the provided attributes.
void	deleteUser(String userId) Deletes the user with the specified userId.
Optional<String>	generateId() Generates a user id for a new user
User	getUser(String userId)
default User	getUser(String userId, RequestedResourceAttributes additionalAttributes)
User	getUserByUsername(String userName)
PagedResult<User>	getUsers(PageInfo pageInfo, String filter) Returns a page of users (limited by SCIMConfigurationCallback.getMaxResourcesPerPage()), taking into account the specified filter and paging parameters.
default PagedResult<User>	getUsers(PageInfo pageInfo, String filter, RequestedResourceAttributes additionalAttributes) Returns a page of users (more info in getUsers(PageInfo, String) ()} adding specifying additional attributes to be returned of excluded from the response
void	patchUser(String userId, PatchBody patchBody, Meta userMeta) Updates a user with the provided attributes.
User	updateUser(User user) + Updates a user with the provided attributes.

Method Detail

getUserByUsername

User getUserByUsername(String userName)

Parameters:

userName, - unique username

Returns:

the user with the specified username or null if no such user exists

getUser

User getUser(String userId)

Parameters:

userId, - unique user id

Returns:

the user with the specified userId or null if no such user exists

getUser

default User getUser(String userId,
                     RequestedResourceAttributes additionalAttributes)

Parameters:

additionalAttributes - additional attributes to be returned of excluded from the response

Returns:

the user with the specified userId or null if no such user exists

getUsers

PagedResult<User> getUsers(PageInfo pageInfo,
                           String filter)

Returns a page of users (limited by SCIMConfigurationCallback.getMaxResourcesPerPage()), taking into account the specified filter and paging parameters.

Parameters:

pageInfo - parsed paging parameters from the API request

filter - unparsed filter string from the $filter query parameter

Returns:

a page of users or empty page if no users match the filter/paging criteria

getUsers

default PagedResult<User> getUsers(PageInfo pageInfo,
                                   String filter,
                                   RequestedResourceAttributes additionalAttributes)

Returns a page of users (more info in getUsers(PageInfo, String) ()} adding specifying additional attributes to be returned of excluded from the response

Parameters:

additionalAttributes - additional attributes to be returned of excluded from the response

Returns:

a page of users or empty page if no users match the filter/paging criteria

createUser

User createUser(User user)

Creates a user with the provided attributes. The user object must have all mandatory attributes available, including metadata (version, etc.). The returned user must have its id set.

Parameters:

user -

updateUser

User updateUser(User user)

+ Updates a user with the provided attributes. The user object must have all mandatory attributes available, including metadata (id, new version, etc.).

Parameters:

user -

patchUser

void patchUser(String userId,
               PatchBody patchBody,
               Meta userMeta)

Updates a user with the provided attributes. The user object must have all mandatory attributes available, including metadata (id, new version, etc.).

Parameters:

userId -

patchBody -

userMeta -

deleteUser

void deleteUser(String userId)

Deletes the user with the specified userId.

Parameters:

userId -

generateId

Optional<String> generateId()

Generates a user id for a new user

Returns:

a unique user idnetifier