co.aurasphere.botmill.fb

Class FbBotMillServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

co.aurasphere.botmill.fb.FbBotMillServlet

All Implemented Interfaces:

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

public class FbBotMillServlet
extends javax.servlet.http.HttpServlet

Main Servlet for FbBotMill framework. This servlet requires an init-param containing the fully qualified name of a class implementing FbBotDefinition in which the initial configuration is done. If not such class is found or can't be loaded, a ServletException is thrown during initialization. The FbBotMillServlet supports GET requests only for the Subscribing phase and POST requests for all the Facebook callbacks. For more information about how the communication is handled, check the documentation for doGet(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse), doPost(HttpServletRequest, HttpServletResponse) and Facebook's documentation with the link below.

Author:

Donato Rimenti

See Also:

Facebook Subscription info, Serialized Form

Constructor Summary

Constructors

Constructor and Description
FbBotMillServlet()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doGet(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) Specifies how to handle a GET request.
protected void	doPost(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) Specifies how to handle a POST request.
void	init() Initializes the FbBotMillServlet.
String	toString()

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, 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, wait, wait, wait

Constructor Detail

FbBotMillServlet

public FbBotMillServlet()

Method Detail

init

public void init()
          throws javax.servlet.ServletException

Initializes the FbBotMillServlet. The initialization will try to load the class implementing FbBotDefinition passed has an init-param in the web.xml. If the class is found and correctly loaded, the method FbBotDefinition.defineBehavior() is called, otherwise a ServletException is thrown.

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException - if the FbBotDefinition class is not found in the servlet init-param in web.xml or if can't be load.

doGet

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

Specifies how to handle a GET request. GET requests are used by Facebook only during the WebHook registration. During this phase, the FbBotMillServlet checks that the FbBotMillNetworkConstants.HUB_MODE_PARAMETER value received equals to FbBotMillNetworkConstants.HUB_MODE_SUBSCRIBE and that the FbBotMillNetworkConstants.HUB_VERIFY_TOKEN_PARAMETER value received equals to the FbBotMillContext.getValidationToken(). If that's true, then the FbBotMillServlet will reply sending back the value of the FbBotMillNetworkConstants.HUB_CHALLENGE_PARAMETER received, in order to confirm the registration, otherwise it will return an error 403.

Overrides:

doGet in class javax.servlet.http.HttpServlet

Parameters:

req - the req

resp - the resp

Throws:

javax.servlet.ServletException - the servlet exception

IOException - Signals that an I/O exception has occurred.

doPost

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

Specifies how to handle a POST request. It parses the request as a MessengerCallback object. If the request is not a MessengerCallback, then the FbBotMillServlet logs an error and does nothing, otherwise it will forward the request to all registered bots in order to let them process the callbacks.

Overrides:

doPost in class javax.servlet.http.HttpServlet

Parameters:

req - the req

resp - the resp

Throws:

javax.servlet.ServletException - the servlet exception

IOException - Signals that an I/O exception has occurred.

toString

public String toString()

Overrides:

toString in class Object