com.sap.scimono.callback.users

Class DefaultUsersCallback

java.lang.Object

com.sap.scimono.callback.users.DefaultUsersCallback

All Implemented Interfaces:

UsersCallback

public class DefaultUsersCallback
extends Object
implements UsersCallback

Constructor Summary

Constructors

Constructor and Description
DefaultUsersCallback()

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)
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.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.sap.scimono.callback.users.UsersCallback

getUser, getUsers

Constructor Detail

DefaultUsersCallback

public DefaultUsersCallback()

Method Detail

getUserByUsername

public User getUserByUsername(String username)

Specified by:

getUserByUsername in interface UsersCallback

Returns:

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

getUser

public User getUser(String userId)

Specified by:

getUser in interface UsersCallback

Returns:

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

getUsers

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

Description copied from interface: UsersCallback

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

Specified by:

getUsers in interface UsersCallback

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

createUser

public User createUser(User user)

Description copied from interface: UsersCallback

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.

Specified by:

createUser in interface UsersCallback

updateUser

public User updateUser(User user)

Description copied from interface: UsersCallback

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

Specified by:

updateUser in interface UsersCallback

patchUser

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

Description copied from interface: UsersCallback

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

Specified by:

patchUser in interface UsersCallback

deleteUser

public void deleteUser(String userId)

Description copied from interface: UsersCallback

Deletes the user with the specified userId.

Specified by:

deleteUser in interface UsersCallback

generateId

public Optional<String> generateId()

Description copied from interface: UsersCallback

Generates a user id for a new user

Specified by:

generateId in interface UsersCallback

Returns:

a unique user idnetifier