org.syncope.console.rest
Class UsersRestClient

java.lang.Object
  org.syncope.console.rest.UsersRestClient

public class UsersRestClient
extends java.lang.Object

Console client for invoking rest users services.

Field Summary

protected RestClient

restClient

Constructor Summary

UsersRestClient()

Method Summary

boolean	createConfigurationAttributes(ConfigurationTO configurationTO) Create a new configuration.
void	createUser(UserTO userTO) Create a new user and start off the workflow.
void	deleteUser(java.lang.String id)
java.util.List<UserTO>	getAllUsers()
java.util.List<UserTO>	getPaginatedUsersList(int page, int size)
RestClient	getRestClient()
UserTO	getUser(java.lang.String id)
java.util.List<UserTO>	paginatedSearchUsers(NodeCond nodeSearchCondition, int page, int size) Search an user by its schema values.
ConfigurationTO	readConfigurationDisplayAttributes() Load an existent configuration.
java.util.List<UserTO>	searchUsers(NodeCond nodeSearchCondition) Search an user by its schema values.
void	setRestClient(RestClient restClient)
boolean	updateConfigurationAttributes(ConfigurationTO configurationTO) Update an existent configuration.
boolean	updateUser(UserMod userModTO) Update existing user.

Methods inherited from class java.lang.Object

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

Field Detail

restClient

protected RestClient restClient

Constructor Detail

UsersRestClient

public UsersRestClient()

Method Detail

getAllUsers

public java.util.List<UserTO> getAllUsers()

getPaginatedUsersList

public java.util.List<UserTO> getPaginatedUsersList(int page,
                                                    int size)

createUser

public void createUser(UserTO userTO)
                throws SyncopeClientCompositeErrorException

Create a new user and start off the workflow.

Parameters:

userTO - instance

Throws:

SyncopeClientCompositeErrorException

updateUser

public boolean updateUser(UserMod userModTO)
                   throws SyncopeClientCompositeErrorException

Update existing user.

Parameters:

userTO -

Returns:

true is the opertion ends succesfully, false otherwise

Throws:

SyncopeClientCompositeErrorException

deleteUser

public void deleteUser(java.lang.String id)

getUser

public UserTO getUser(java.lang.String id)

createConfigurationAttributes

public boolean createConfigurationAttributes(ConfigurationTO configurationTO)

Create a new configuration.

Parameters:

configurationTO -

Returns:

true if the operation ends succesfully, false otherwise

updateConfigurationAttributes

public boolean updateConfigurationAttributes(ConfigurationTO configurationTO)

Update an existent configuration.

Parameters:

configurationTO -

Returns:

true if the operation ends succesfully, false otherwise

readConfigurationDisplayAttributes

public ConfigurationTO readConfigurationDisplayAttributes()

Load an existent configuration.

Returns:

ConfigurationTO object if the configuration exists, null otherwise

searchUsers

public java.util.List<UserTO> searchUsers(NodeCond nodeSearchCondition)
                                   throws org.springframework.web.client.HttpServerErrorException

Search an user by its schema values.

Parameters:

userTO -

Returns:

UserTOs

Throws:

org.springframework.web.client.HttpServerErrorException

paginatedSearchUsers

public java.util.List<UserTO> paginatedSearchUsers(NodeCond nodeSearchCondition,
                                                   int page,
                                                   int size)
                                            throws org.springframework.web.client.HttpServerErrorException

Search an user by its schema values.

Parameters:

userTO -

Returns:

UserTOs

Throws:

org.springframework.web.client.HttpServerErrorException

getRestClient

public RestClient getRestClient()

setRestClient

public void setRestClient(RestClient restClient)