org.openestate.is24.restapi.webapp

Class VerificationServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.openestate.is24.restapi.webapp.VerificationServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class VerificationServlet
extends javax.servlet.http.HttpServlet

A servlet for verification at the REST-Webservice of ImmobilienScout24.de.

Author:

Andreas Rudolph

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
VerificationServlet()

Method Summary

Modifier and Type	Method and Description
protected void	doGet(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) A GET request was received for this servlet.
protected void	doVerificationRequest(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) Create a verification request and show a page with the verification link.
protected void	doVerificationResponse(String state, String token, String verifier, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) Creates access credentials after the verification was passed.
protected String	fetchVerificationSecret(String token) Returns the secret for a previously created verification token.
protected AbstractClient	getClient() Create a client for communication with the IS24-Webservice.
protected Authorization	getWebserviceAuthorization(String token, String secret, String verifier, javax.servlet.http.HttpServletRequest req) Generates credentials for permanent authoriation at the IS24-Webservice.
protected Verification	getWebserviceVerification(javax.servlet.http.HttpServletRequest req) Generates credentials for a verification process at the IS24-Webservice.
void	init() Servlet is initialized by the servlet engine.
protected void	removeVerificationSecret(String token) Remove a previously created verification token from the local store.
protected void	storeVerification(Verification verification) Store newly created verification credentials to the local store.

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Detail

VerificationServlet

public VerificationServlet()

Method Detail

doGet

protected void doGet(javax.servlet.http.HttpServletRequest req,
                     javax.servlet.http.HttpServletResponse resp)
              throws IOException,
                     javax.servlet.ServletException

A GET request was received for this servlet.

The functions decides according to the request parameters, if a verification is requested or if the response of a verification is processed.

Overrides:

doGet in class javax.servlet.http.HttpServlet

Parameters:

req - incoming GET request

resp - outgoing response

Throws:

IOException

javax.servlet.ServletException

doVerificationRequest

protected void doVerificationRequest(javax.servlet.http.HttpServletRequest req,
                                     javax.servlet.http.HttpServletResponse resp)
                              throws IOException,
                                     javax.servlet.ServletException

Create a verification request and show a page with the verification link.

Parameters:

req - incoming GET request

resp - outgoing response

Throws:

IOException

javax.servlet.ServletException

doVerificationResponse

protected void doVerificationResponse(String state,
                                      String token,
                                      String verifier,
                                      javax.servlet.http.HttpServletRequest req,
                                      javax.servlet.http.HttpServletResponse resp)
                               throws IOException,
                                      javax.servlet.ServletException

Creates access credentials after the verification was passed.

The generated access token and secret is shown to the user by default.

Parameters:

state - the state of verification, that was received as request parameter by the webservice

token - the verification token, that was received as request parameter by the webservice

verifier - the verification code, that was received as request parameter by the webservice

req - incoming GET request

resp - outgoing response

Throws:

IOException

javax.servlet.ServletException

fetchVerificationSecret

protected String fetchVerificationSecret(String token)

Returns the secret for a previously created verification token.

By default the created verification credentials are stored in memory. You should replace this method in productive systems - e.g. with a database backend.

Parameters:

token - verification token

Returns:

verification secret

getClient

protected AbstractClient getClient()

Create a client for communication with the IS24-Webservice.

Returns:

client

getWebserviceAuthorization

protected Authorization getWebserviceAuthorization(String token,
                                                   String secret,
                                                   String verifier,
                                                   javax.servlet.http.HttpServletRequest req)
                                            throws oauth.signpost.exception.OAuthException

Generates credentials for permanent authoriation at the IS24-Webservice.

Parameters:

token - verification token

secret - verification secret

verifier - verification code

req - incoming GET request

Returns:

credentials for authorization

Throws:

oauth.signpost.exception.OAuthException

getWebserviceVerification

protected Verification getWebserviceVerification(javax.servlet.http.HttpServletRequest req)
                                          throws oauth.signpost.exception.OAuthException

Generates credentials for a verification process at the IS24-Webservice.

Parameters:

req - incoming GET request

Returns:

credentials for verification

Throws:

oauth.signpost.exception.OAuthException

init

public void init()
          throws javax.servlet.ServletException

Servlet is initialized by the servlet engine.

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

removeVerificationSecret

protected void removeVerificationSecret(String token)

Remove a previously created verification token from the local store.

By default the created verification credentials are stored in memory. You should replace this method in productive systems - e.g. with a database backend.

Parameters:

token - verification token

storeVerification

protected void storeVerification(Verification verification)

Store newly created verification credentials to the local store.

By default the created verification credentials are stored in memory. You should replace this method in productive systems - e.g. with a database backend.

Parameters:

verification - verification credentials