com.perforce.workshop.tjuricek.p4oauth.controllers

Interface ControllerMethod

All Known Implementing Classes:

AccessTokenPost, AuthorizationFinishPost, AuthorizationStartGet, LoginGet

public interface ControllerMethod

Controllers in this application are basic functional objects with the following interface that basically have a simple lifetime.

In general, check out one of the handlers. The logic to use a controller is fairly simple:

if (controller.matches(request)) { controller.handle(request, response); }

Method Summary

Modifier and Type	Method and Description
default java.lang.String	getOrSendError(HttpServletRequestHelper request, java.lang.String key, javax.servlet.http.HttpServletResponse response)
void	handle(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Executes the controller call, writing out (and closing) the response.
boolean	matches(javax.servlet.http.HttpServletRequest request) If this returns true, assume that this method should probably be called back.

Method Detail

matches

boolean matches(javax.servlet.http.HttpServletRequest request)

If this returns true, assume that this method should probably be called back.

Parameters:

request - The HttpServletRequest to check

handle

void handle(javax.servlet.http.HttpServletRequest request,
            javax.servlet.http.HttpServletResponse response)
     throws java.io.IOException,
            javax.servlet.ServletException

Executes the controller call, writing out (and closing) the response.

Parameters:

request - The HttpServletRequest that should indicate most of our input data

response - The response object to write out to

Throws:

java.io.IOException

javax.servlet.ServletException

getOrSendError

default java.lang.String getOrSendError(HttpServletRequestHelper request,
                                        java.lang.String key,
                                        javax.servlet.http.HttpServletResponse response)
                                 throws java.io.IOException

Throws:

java.io.IOException