edu.illinois.ncsa.datawolf.service

Class LoginResource

java.lang.Object

edu.illinois.ncsa.datawolf.service.LoginResource

@Path(value="/login")
public class LoginResource
extends Object

Constructor Summary

Constructors

Constructor and Description
LoginResource()

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createAccount(String email, String personId, String password) Create a user account by either specifying the email or the personId and a password
void	deleteToken(org.jboss.resteasy.spi.HttpRequest request)
javax.ws.rs.core.Response	disable(org.jboss.resteasy.spi.HttpRequest request, String email) Delete the account given the specific id.
javax.ws.rs.core.Response	getKey(String auth) Gets the key/token associated with a user account
javax.ws.rs.core.Response	login(String email, String auth) Login a user by email and authorization string
javax.ws.rs.core.Response	updateAccount(org.jboss.resteasy.spi.HttpRequest request, String personId) Enable/Disable user accounts
javax.ws.rs.core.Response	updateAccountPassword(String auth, String password)

Methods inherited from class java.lang.Object

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

Constructor Detail

LoginResource

public LoginResource()

Method Detail

login

@GET
@Produces(value="application/json")
public javax.ws.rs.core.Response login(@QueryParam(value="email")
                                           String email,
                                           @HeaderParam(value="Authorization")
                                           String auth)
                                throws Exception

Login a user by email and authorization string

Parameters:

email - email of the user attempting to authenticate

auth - authentication string/token

Returns:

the user if authentication is successful

Throws:

Exception

getKey

@GET
@Path(value="key")
@Produces(value="application/json")
public javax.ws.rs.core.Response getKey(@HeaderParam(value="Authorization")
                                                 String auth)
                                 throws Exception

Gets the key/token associated with a user account

Parameters:

auth - - Authorization header with username/password

Returns:

token`

Throws:

Exception

createAccount

@POST
@Produces(value="text/plain")
public javax.ws.rs.core.Response createAccount(@QueryParam(value="email")@DefaultValue(value="")
                                                    String email,
                                                    @QueryParam(value="personId")@DefaultValue(value="")
                                                    String personId,
                                                    @QueryParam(value="password")
                                                    String password)
                                        throws Exception

Create a user account by either specifying the email or the personId and a password

Parameters:

email - email of the account to create

personId - - the ID of the person to create the account for

password - password for the user account

Throws:

Exception - If email or personId and password are not specified or if user does not exist

updateAccountPassword

@POST
@Path(value="updatePassword")
@Produces(value="text/plain")
public javax.ws.rs.core.Response updateAccountPassword(@HeaderParam(value="Authorization")
                                                                 String auth,
                                                                 @QueryParam(value="password")
                                                                 String password)
                                                throws Exception

Throws:

Exception

updateAccount

@PUT
@Path(value="{person-id}/active")
@Produces(value="text/plain")
public javax.ws.rs.core.Response updateAccount(@Context
                                                        org.jboss.resteasy.spi.HttpRequest request,
                                                        @PathParam(value="person-id")
                                                        String personId)

Enable/Disable user accounts

Parameters:

request - - Request body with key-value pair for active attribute

personId - - User account to update

Returns:

Response from request, Success (200) or Error (500) with message

deleteToken

@DELETE
@Path(value="token")
@Produces(value="application/json")
public void deleteToken(@Context
                                    org.jboss.resteasy.spi.HttpRequest request)

disable

@DELETE
public javax.ws.rs.core.Response disable(@Context
                                       org.jboss.resteasy.spi.HttpRequest request,
                                       @QueryParam(value="email")@DefaultValue(value="")
                                       String email)
                                  throws Exception

Delete the account given the specific id.

Parameters:

email - the email for whom the account to be deleted

Throws:

Exception