Package org.apache.archiva.redback.rest.api.services

Interface UserService

All Known Implementing Classes:

DefaultUserService

@Path("/userService/")
@Deprecated
public interface UserService

Deprecated.

This service is deprecated. Please use UserService

Method Summary

Modifier and Type	Method	Description
Boolean	createAdminUser(User user)	Deprecated. will create admin user only if not exists !! if exists will return false
User	createGuestUser()	Deprecated.
Boolean	createUser(User user)	Deprecated.
Boolean	deleteUser(String username)	Deprecated.
Collection<Operation>	getCurrentUserOperations()	Deprecated.
Collection<Permission>	getCurrentUserPermissions()	Deprecated.
User	getGuestUser()	Deprecated.
User	getUser(String username)	Deprecated.
Collection<Operation>	getUserOperations(String userName)	Deprecated.
Collection<Permission>	getUserPermissions(String userName)	Deprecated.
List<User>	getUsers()	Deprecated.
Boolean	isAdminUserExists()	Deprecated.
Boolean	lockUser(String username)	Deprecated.
Boolean	passwordChangeNotRequired(String username)	Deprecated.
Boolean	passwordChangeRequired(String username)	Deprecated.
Boolean	ping()	Deprecated.
RegistrationKey	registerUser(UserRegistrationRequest userRegistrationRequest)	Deprecated. if redback is not configured for email validation is required, -1 is returned as key
int	removeFromCache(String username)	Deprecated.
Boolean	resetPassword(ResetPasswordRequest resetPasswordRequest)	Deprecated.
Boolean	unlockUser(String username)	Deprecated.
Boolean	updateMe(User user)	Deprecated. update only the current user and this fields: fullname, email, password.
Boolean	updateUser(User user)	Deprecated.
Boolean	validateUserFromKey(String key)	Deprecated. validate the key and the user with forcing a password change for next login.

Method Detail

getUser

@Path("getUser/{userName}")
@GET
@Produces({"application/json","application/xml"})
User getUser(@PathParam("userName")
             String username)
      throws RedbackServiceException

Deprecated.

Throws:

RedbackServiceException

getUsers

@Path("getUsers")
@GET
@Produces({"application/json","application/xml"})
List<User> getUsers()
             throws RedbackServiceException

Deprecated.

Throws:

RedbackServiceException

createUser

@Path("createUser")
@POST
@Produces({"application/json","application/xml","text/plain"})
@Consumes({"application/json","application/xml"})
Boolean createUser(User user)
            throws RedbackServiceException

Deprecated.

Throws:

RedbackServiceException

createAdminUser

@Path("createAdminUser")
@POST
@Produces({"application/json","application/xml","text/plain"})
@Consumes({"application/json","application/xml"})
Boolean createAdminUser(User user)
                 throws RedbackServiceException

Deprecated.

will create admin user only if not exists !! if exists will return false

Throws:

RedbackServiceException

isAdminUserExists

@Path("isAdminUserExists")
@GET
@Produces({"application/json","application/xml","text/plain"})
Boolean isAdminUserExists()
                   throws RedbackServiceException

Deprecated.

Throws:

RedbackServiceException

deleteUser

@Path("deleteUser/{userName}")
@GET
@Produces({"application/json","application/xml","text/plain"})
Boolean deleteUser(@PathParam("userName")
                   String username)
            throws RedbackServiceException

Deprecated.

Throws:

RedbackServiceException

updateUser

@Path("updateUser")
@POST
@Produces({"application/json","application/xml","text/plain"})
Boolean updateUser(User user)
            throws RedbackServiceException

Deprecated.

Throws:

RedbackServiceException

lockUser

@Path("lockUser/{username}")
@GET
@Produces({"application/json","application/xml","text/plain"})
Boolean lockUser(@PathParam("username")
                 String username)
          throws RedbackServiceException

Deprecated.

Throws:

RedbackServiceException

Since:

2.0

unlockUser

@Path("unlockUser/{username}")
@GET
@Produces({"application/json","application/xml","text/plain"})
Boolean unlockUser(@PathParam("username")
                   String username)
            throws RedbackServiceException

Deprecated.

Throws:

RedbackServiceException

Since:

2.0

passwordChangeRequired

@Path("passwordChangeRequired/{username}")
@GET
@Produces({"application/json","application/xml","text/plain"})
Boolean passwordChangeRequired(@PathParam("username")
                               String username)
                        throws RedbackServiceException

Deprecated.

Throws:

RedbackServiceException

Since:

2.0

passwordChangeNotRequired

@Path("passwordChangeNotRequired/{username}")
@GET
@Produces({"application/json","application/xml","text/plain"})
Boolean passwordChangeNotRequired(@PathParam("username")
                                  String username)
                           throws RedbackServiceException

Deprecated.

Throws:

RedbackServiceException

Since:

2.0

updateMe

@Path("updateMe")
@POST
@Produces({"application/json","application/xml","text/plain"})
Boolean updateMe(User user)
          throws RedbackServiceException

Deprecated.

update only the current user and this fields: fullname, email, password. the service verify the curent logged user with the one passed in the method

Throws:

RedbackServiceException

Since:

1.4

ping

@Path("ping")
@GET
@Produces({"application/json","application/xml","text/plain"})
Boolean ping()
      throws RedbackServiceException

Deprecated.

Throws:

RedbackServiceException

removeFromCache

@Path("removeFromCache/{userName}")
@GET
@Produces({"application/json","application/xml","text/plain"})
int removeFromCache(@PathParam("userName")
                    String username)
             throws RedbackServiceException

Deprecated.

Throws:

RedbackServiceException

getGuestUser

@Path("getGuestUser")
@GET
@Produces({"application/json","application/xml","text/plain"})
User getGuestUser()
           throws RedbackServiceException

Deprecated.

Throws:

RedbackServiceException

createGuestUser

@Path("createGuestUser")
@GET
@Produces({"application/json","application/xml","text/plain"})
User createGuestUser()
              throws RedbackServiceException

Deprecated.

Throws:

RedbackServiceException

registerUser

@Path("registerUser")
@POST
@Produces({"application/json","application/xml"})
RegistrationKey registerUser(UserRegistrationRequest userRegistrationRequest)
                      throws RedbackServiceException

Deprecated.

if redback is not configured for email validation is required, -1 is returned as key

Throws:

RedbackServiceException

Since:

1.4

validateUserFromKey

@Path("validateKey/{key}")
@GET
@Produces({"application/json","application/xml","text/plain"})
Boolean validateUserFromKey(@PathParam("key")
                            String key)
                     throws RedbackServiceException

Deprecated.

validate the key and the user with forcing a password change for next login. http session is created.

Parameters:

key - authentication key

Throws:

RedbackServiceException

Since:

1.4

resetPassword

@Path("resetPassword")
@POST
@Produces({"application/json","application/xml","text/plain"})
@Consumes({"application/json","application/xml"})
Boolean resetPassword(ResetPasswordRequest resetPasswordRequest)
               throws RedbackServiceException

Deprecated.

Parameters:

resetPasswordRequest - contains username for send a password reset email

Throws:

RedbackServiceException

Since:

1.4

getUserPermissions

@Path("getUserPermissions/{userName}")
@GET
@Produces({"application/json","application/xml","text/plain"})
Collection<Permission> getUserPermissions(@PathParam("userName")
                                          String userName)
                                   throws RedbackServiceException

Deprecated.

Throws:

RedbackServiceException

Since:

1.4

getUserOperations

@Path("getUserOperations/{userName}")
@GET
@Produces({"application/json","application/xml","text/plain"})
Collection<Operation> getUserOperations(@PathParam("userName")
                                        String userName)
                                 throws RedbackServiceException

Deprecated.

Throws:

RedbackServiceException

Since:

1.4

getCurrentUserPermissions

@Path("getCurrentUserPermissions")
@GET
@Produces({"application/json","application/xml","text/plain"})
Collection<Permission> getCurrentUserPermissions()
                                          throws RedbackServiceException

Deprecated.

Returns:

the current logged user permissions, if no logged user guest permissions are returned

Throws:

RedbackServiceException

Since:

1.4

getCurrentUserOperations

@Path("getCurrentUserOperations")
@GET
@Produces({"application/json","application/xml","text/plain"})
Collection<Operation> getCurrentUserOperations()
                                        throws RedbackServiceException

Deprecated.

Returns:

the current logged user operations, if no logged user guest operations are returned

Throws:

RedbackServiceException

Since:

1.4