com.broadleafcommerce.auth.user.web.endpoint

Class PasscodeEndpoint

java.lang.Object

com.broadleafcommerce.auth.user.web.endpoint.PasscodeEndpoint

@FrameworkRestController
 @FrameworkMapping(value="/passcode")
public class PasscodeEndpoint
extends Object

Author:

Cade Rea (cade-rea)

Field Summary

Fields

Modifier and Type	Field and Description
static String	BASE_URI

Constructor Summary

Constructors

Constructor and Description
PasscodeEndpoint(PasscodeService<PasswordToken,User> passcodeService, UserService<User> userService)

Method Summary

Modifier and Type	Method and Description
com.broadleafcommerce.auth.user.web.endpoint.PasscodeEndpoint.PasscodeResponse	consume(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String clientId, String passcode, String purpose, String username)
protected PasscodeService<PasswordToken,User>	getPasscodeService()
protected User	getUser(String clientId, String username)
protected UserService<User>	getUserService()
com.broadleafcommerce.auth.user.web.endpoint.PasscodeEndpoint.PasscodeStatusResponse	invalidate(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String passcodeId)
protected void	passcodeConsumptionErrorHandler()
com.broadleafcommerce.auth.user.web.endpoint.PasscodeEndpoint.PasscodeResponse	retrieve(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String clientId, String purpose, String username)
com.broadleafcommerce.auth.user.web.endpoint.PasscodeEndpoint.PasscodeStatusResponse	status(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String passcodeId)

Methods inherited from class java.lang.Object

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

Field Detail

BASE_URI

public static final String BASE_URI

See Also:

Constant Field Values

Constructor Detail

PasscodeEndpoint

public PasscodeEndpoint(PasscodeService<PasswordToken,User> passcodeService,
                        UserService<User> userService)

Method Detail

retrieve

@Policy(permissionRoots="PASSCODE",
        operationTypes=CREATE)
 @FrameworkGetMapping(value="/retrieve")
public com.broadleafcommerce.auth.user.web.endpoint.PasscodeEndpoint.PasscodeResponse retrieve(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                                                           javax.servlet.http.HttpServletResponse response,
                                                                                                                                                                                                           @RequestParam(value="client_id")
                                                                                                                                                                                                           String clientId,
                                                                                                                                                                                                           @RequestParam(value="purpose")
                                                                                                                                                                                                           String purpose,
                                                                                                                                                                                                           @RequestParam(value="username")
                                                                                                                                                                                                           String username)

consume

@Policy(permissionRoots="PASSCODE",
        operationTypes=UPDATE)
 @FrameworkPostMapping(path="/consume",
                      consumes="application/x-www-form-urlencoded")
public com.broadleafcommerce.auth.user.web.endpoint.PasscodeEndpoint.PasscodeResponse consume(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                                                                                                                             javax.servlet.http.HttpServletResponse response,
                                                                                                                                                                                                                                                                             @RequestParam(value="client_id")
                                                                                                                                                                                                                                                                             String clientId,
                                                                                                                                                                                                                                                                             @RequestParam(value="passcode")
                                                                                                                                                                                                                                                                             String passcode,
                                                                                                                                                                                                                                                                             @RequestParam(value="purpose")
                                                                                                                                                                                                                                                                             String purpose,
                                                                                                                                                                                                                                                                             @RequestParam(value="username")
                                                                                                                                                                                                                                                                             String username)
                                                                                                                                                                                                                                                                      throws PasscodeNotConsumedException

Throws:

PasscodeNotConsumedException

passcodeConsumptionErrorHandler

@ResponseStatus(code=BAD_REQUEST,
                reason="Passcode not consumed.")
 @ExceptionHandler(value=PasscodeNotConsumedException.class)
protected void passcodeConsumptionErrorHandler()

status

@Policy(permissionRoots="PASSCODE",
        operationTypes=READ)
 @FrameworkGetMapping(value="/status")
public com.broadleafcommerce.auth.user.web.endpoint.PasscodeEndpoint.PasscodeStatusResponse status(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                                                           javax.servlet.http.HttpServletResponse response,
                                                                                                                                                                                                           @RequestParam(value="passcode_id")
                                                                                                                                                                                                           String passcodeId)

invalidate

@Policy(permissionRoots="PASSCODE",
        operationTypes=DELETE)
 @FrameworkPostMapping(path="/invalidate",
                      consumes="application/x-www-form-urlencoded")
public com.broadleafcommerce.auth.user.web.endpoint.PasscodeEndpoint.PasscodeStatusResponse invalidate(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                                                                                                                                         javax.servlet.http.HttpServletResponse response,
                                                                                                                                                                                                                                                                                         @RequestParam(value="passcode_id")
                                                                                                                                                                                                                                                                                         String passcodeId)

getUser

protected User getUser(@RequestParam(value="client_id")
                       String clientId,
                       @RequestParam(value="username")
                       String username)

getPasscodeService

protected PasscodeService<PasswordToken,User> getPasscodeService()

getUserService

protected UserService<User> getUserService()