de.alpharogroup.user.management.rest.api

Interface UsersResource

All Superinterfaces:

de.alpharogroup.service.rs.RestfulResource<Integer,de.alpharogroup.user.domain.User>

All Known Implementing Classes:

UsersRestResource

@Path(value="/user/")
 @Produces(value="application/json")
 @Consumes(value="application/json")
public interface UsersResource
extends de.alpharogroup.service.rs.RestfulResource<Integer,de.alpharogroup.user.domain.User>

The interface UsersResource provides methods for resolve users.

Method Summary

Modifier and Type	Method and Description
boolean	existsUserWithUsername(String username) Checks if a user exists with the given user name.
List<de.alpharogroup.address.book.domain.Address>	findAddressesFromUser(de.alpharogroup.user.domain.User user) Find all Address from the given User.
de.alpharogroup.address.book.domain.Address	findAddressFromUser(de.alpharogroup.user.domain.User user) Find the main Address from the given User.
List<de.alpharogroup.user.domain.User>	findAll()
List<de.alpharogroup.user.domain.Role>	findRolesFromUser(de.alpharogroup.user.domain.User user) Find roles from the given User.
List<de.alpharogroup.user.domain.User>	findUsers(de.alpharogroup.collections.pairs.Triple<Integer,de.alpharogroup.user.management.enums.GenderType,Integer> searchCriteria) Find users from the given GenderType object and the range from till until.
List<de.alpharogroup.user.domain.User>	findUsers(de.alpharogroup.user.management.domain.model.UserSearchCriteria userSearchCriteria) Find users from the given GenderType object and the range from till until and the given geohash code.
de.alpharogroup.user.domain.User	findUserWithEmail(String email) Find the User object with the given email.
de.alpharogroup.user.domain.User	findUserWithUsername(String username) Find User object from the given user name.
boolean	userIsInRole(de.alpharogroup.collections.pairs.KeyValuePair<de.alpharogroup.user.domain.User,de.alpharogroup.user.domain.Role> user) Checks if the given User object is in the given Role object.

Methods inherited from interface de.alpharogroup.service.rs.RestfulResource

create, delete, read, update

Method Detail

existsUserWithUsername

@GET
 @Path(value="/exists/user/with/username/{username}")
boolean existsUserWithUsername(@PathParam(value="username")
                                                                                          String username)

Checks if a user exists with the given user name.

Parameters:

username - the user name

Returns:

true, if successful

findAddressesFromUser

@POST
 @Path(value="/find/addresses")
List<de.alpharogroup.address.book.domain.Address> findAddressesFromUser(de.alpharogroup.user.domain.User user)

Find all Address from the given User.

Parameters:

user - the user

Returns:

the list of found Address from the given User.

findAddressFromUser

@POST
 @Path(value="/find/address")
de.alpharogroup.address.book.domain.Address findAddressFromUser(de.alpharogroup.user.domain.User user)

Find the main Address from the given User.

Parameters:

user - the user

Returns:

the main Address from the given User.

findAll

@GET
 @Path(value="/findall/")
List<de.alpharogroup.user.domain.User> findAll()

findRolesFromUser

@POST
 @Path(value="/find/roles")
List<de.alpharogroup.user.domain.Role> findRolesFromUser(de.alpharogroup.user.domain.User user)

Find roles from the given User.

Parameters:

user - the user

Returns:

the list of found Role from the given User.

findUsers

@POST
 @Path(value="/find/users")
List<de.alpharogroup.user.domain.User> findUsers(de.alpharogroup.collections.pairs.Triple<Integer,de.alpharogroup.user.management.enums.GenderType,Integer> searchCriteria)

Find users from the given GenderType object and the range from till until.

Parameters:

searchCriteria - the KeyValuePair object that encapsulate the from age the gender and the until age.

Returns:

the found list of User objects that matches the criteria.

findUsers

@POST
 @Path(value="/find/users/by/geo")
List<de.alpharogroup.user.domain.User> findUsers(de.alpharogroup.user.management.domain.model.UserSearchCriteria userSearchCriteria)

Find users from the given GenderType object and the range from till until and the given geohash code.

Parameters:

userSearchCriteria - the UserSearchCriteria object that encapsulate the search criteria for find users

Returns:

the found list of User objects that matches the criteria.

findUserWithEmail

@GET
 @Path(value="/find/by/email/{email}")
de.alpharogroup.user.domain.User findUserWithEmail(@PathParam(value="email")
                                                                                               String email)

Find the User object with the given email.

Parameters:

email - the email

Returns:

the found User object

findUserWithUsername

@GET
 @Path(value="/find/by/username/{username}")
de.alpharogroup.user.domain.User findUserWithUsername(String username)

Find User object from the given user name.

Parameters:

username - the user name

Returns:

the found User object

userIsInRole

@POST
 @Path(value="/user/is/in/role")
boolean userIsInRole(de.alpharogroup.collections.pairs.KeyValuePair<de.alpharogroup.user.domain.User,de.alpharogroup.user.domain.Role> user)

Checks if the given User object is in the given Role object.

Parameters:

user - the KeyValuePair object that encapsulate the user and the role

Returns:

true, if successful