AppserverIo\Psr\Servlet\Http\HttpServlet

Complexity

Total Complexity

20

Size/Duplication

Total Lines	199
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

0%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	doConnect()	0	4	1
A	doDelete()	0	4	1
A	doGet()	0	4	1
A	doHead()	0	4	1
A	doOptions()	0	4	1
A	doPost()	0	4	1
A	doPut()	0	4	1
A	doTrace()	0	4	1
A	doPatch()	0	4	1
D	service()	0	41	10
A	destroy()	0	3	1

<?php

/**
 * \AppserverIo\Psr\Servlet\Http\HttpServlet
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author    Tim Wagner <tw@appserver.io>
 * @copyright 2015 TechDivision GmbH <info@appserver.io>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/appserver-io-psr/servlet
 * @link      http://www.appserver.io
 */

namespace AppserverIo\Psr\Servlet\Http;

use AppserverIo\Psr\HttpMessage\Protocol;
use AppserverIo\Psr\Servlet\GenericServlet;
use AppserverIo\Psr\Servlet\ServletException;
use AppserverIo\Psr\Servlet\ServletRequestInterface;
use AppserverIo\Psr\Servlet\ServletResponseInterface;

/**
 * Abstract Http servlet implementation.
 *
 * @author    Tim Wagner <tw@appserver.io>
 * @copyright 2015 TechDivision GmbH <info@appserver.io>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/appserver-io-psr/servlet
 * @link      http://www.appserver.io
 */
abstract class HttpServlet extends GenericServlet
{

    /**
     * Implements Http CONNECT method.
     *
     * @param \AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface  $servletRequest  The request instance
     * @param \AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface $servletResponse The response instance
     *
     * @param \AppserverIo\Psr\Servlet\
     */
    protected $sessionSettings;

    /**
     * Implements Http CONNECT method.
     *
     * @param \AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface  $servletRequest  The request instance
     * @param \AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface $servletResponse The response instance
     *
     * @return void
     * @throws \AppserverIo\Psr\Servlet\ServletException Is thrown if the request method is not implemented
     */
    public function doConnect(HttpServletRequestInterface $servletRequest, HttpServletResponseInterface $servletResponse)

The parameter $servletRequest is not used and could be removed.

The parameter $servletResponse is not used and could be removed.

    {
        throw new ServletException(sprintf('Method %s is not implemented in servlet %s.', __METHOD__, get_class($this)));
    }

    /**
     * Implements Http DELETE method.
     *
     * @param \AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface  $servletRequest  The request instance
     * @param \AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface $servletResponse The response instance
     *
     * @return void
     * @throws \AppserverIo\Psr\Servlet\ServletException Is thrown if the request method is not implemented
     */
    public function doDelete(HttpServletRequestInterface $servletRequest, HttpServletResponseInterface $servletResponse)

The parameter $servletRequest is not used and could be removed.

The parameter $servletResponse is not used and could be removed.

    {
        throw new ServletException(sprintf('Method %s is not implemented in servlet %s.', __METHOD__, get_class($this)));
    }

    /**
     * Implements Http GET method.
     *
     * @param \AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface  $servletRequest  The request instance
     * @param \AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface $servletResponse The response instance
     *
     * @return void
     * @throws \AppserverIo\Psr\Servlet\ServletException Is thrown if the request method is not implemented
     */
    public function doGet(HttpServletRequestInterface $servletRequest, HttpServletResponseInterface $servletResponse)

The parameter $servletRequest is not used and could be removed.

The parameter $servletResponse is not used and could be removed.

    {
        throw new ServletException(sprintf('Method %s is not implemented in servlet %s.', __METHOD__, get_class($this)));
    }

    /**
     * Implements Http HEAD method.
     *
     * @param \AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface  $servletRequest  The request instance
     * @param \AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface $servletResponse The response instance
     *
     * @return void
     * @throws \AppserverIo\Psr\Servlet\ServletException Is thrown if the request method is not implemented
     */
    public function doHead(HttpServletRequestInterface $servletRequest, HttpServletResponseInterface $servletResponse)

The parameter $servletRequest is not used and could be removed.

The parameter $servletResponse is not used and could be removed.

    {
        throw new ServletException(sprintf('Method %s is not implemented in servlet %s.', __METHOD__, get_class($this)));
    }

    /**
     * Implements Http OPTIONS method.
     *
     * @param \AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface  $servletRequest  The request instance
     * @param \AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface $servletResponse The response instance
     *
     * @return void
     * @throws \AppserverIo\Psr\Servlet\ServletException Is thrown if the request method is not implemented
     */
    public function doOptions(HttpServletRequestInterface $servletRequest, HttpServletResponseInterface $servletResponse)

The parameter $servletRequest is not used and could be removed.

The parameter $servletResponse is not used and could be removed.

    {
        throw new ServletException(sprintf('Method %s is not implemented in servlet %s.', __METHOD__, get_class($this)));
    }

    /**
     * Implements Http POST method.
     *
     * @param \AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface  $servletRequest  The request instance
     * @param \AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface $servletResponse The response instance
     *
     * @return void
     * @throws \AppserverIo\Psr\Servlet\ServletException Is thrown if the request method is not implemented
     */
    public function doPost(HttpServletRequestInterface $servletRequest, HttpServletResponseInterface $servletResponse)

The parameter $servletRequest is not used and could be removed.

The parameter $servletResponse is not used and could be removed.

    {
        throw new ServletException(sprintf('Method %s is not implemented in servlet %s.', __METHOD__, get_class($this)));
    }

    /**
     * Implements Http PUT method.
     *
     * @param \AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface  $servletRequest  The request instance
     * @param \AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface $servletResponse The response instance
     *
     * @return void
     * @throws \AppserverIo\Psr\Servlet\ServletException Is thrown if the request method is not implemented
     */
    public function doPut(HttpServletRequestInterface $servletRequest, HttpServletResponseInterface $servletResponse)

The parameter $servletRequest is not used and could be removed.

The parameter $servletResponse is not used and could be removed.

    {
        throw new ServletException(sprintf('Method %s is not implemented in servlet %s.', __METHOD__, get_class($this)));
    }

    /**
     * Implements Http TRACE method.
     *
     * @param \AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface  $servletRequest  The request instance
     * @param \AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface $servletResponse The response instance
     *
     * @return void
     * @throws \AppserverIo\Psr\Servlet\ServletException Is thrown if the request method is not implemented
     */
    public function doTrace(HttpServletRequestInterface $servletRequest, HttpServletResponseInterface $servletResponse)

The parameter $servletRequest is not used and could be removed.

The parameter $servletResponse is not used and could be removed.

    {
        throw new ServletException(sprintf('Method %s is not implemented in servlet %s.', __METHOD__, get_class($this)));
    }

    /**
     * Implements Http PATCH method.
     *
     * @param \AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface  $servletRequest  The request instance
     * @param \AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface $servletResponse The response instance
     *
     * @return void
     * @throws \AppserverIo\Psr\Servlet\ServletException Is thrown if the request method is not implemented
     */
    public function doPatch(HttpServletRequestInterface $servletRequest, HttpServletResponseInterface $servletResponse)

The parameter $servletRequest is not used and could be removed.

The parameter $servletResponse is not used and could be removed.

    {
        throw new ServletException(sprintf('Method %s is not implemented in servlet %s.', __METHOD__, get_class($this)));
    }

    /**
     * Delegation method for specific Http methods.
     *
     * @param \AppserverIo\Psr\Servlet\ServletRequestInterface  $servletRequest  The request instance
     * @param \AppserverIo\Psr\Servlet\ServletResponseInterface $servletResponse The response instance
     *
     * @return void
     * @throws \AppserverIo\Psr\Servlet\ServletException Is thrown if the request method is not available
     */
    public function service(ServletRequestInterface $servletRequest, ServletResponseInterface $servletResponse)
    {

        // pre-initialize response
        $servletResponse->addHeader(Protocol::HEADER_X_POWERED_BY, get_class($this));

It seems like you code against a concrete implementation and not the interface AppserverIo\Psr\Servlet\ServletResponseInterface as the method addHeader() does only exist in the following implementations of said interface: AppserverIo\Psr\Servlet\Http\HttpServletResponseWrapper.

        // check the request method to invoke the appropriate method
        switch ($servletRequest->getMethod()) {

It seems like you code against a concrete implementation and not the interface AppserverIo\Psr\Servlet\ServletRequestInterface as the method getMethod() does only exist in the following implementations of said interface: AppserverIo\Psr\Servlet\Http\HttpServletRequestWrapper.

            case Protocol::METHOD_CONNECT:
                $this->doConnect($servletRequest, $servletResponse);

$servletRequest of type object<AppserverIo\Psr\Servlet\ServletRequestInterface> is not a sub-type of object<AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface>. It seems like you assume a child interface of the interface AppserverIo\Psr\Servlet\ServletRequestInterface to be always present.

$servletResponse of type object<AppserverIo\Psr\Servlet\ServletResponseInterface> is not a sub-type of object<AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface>. It seems like you assume a child interface of the interface AppserverIo\Psr\Servlet\ServletResponseInterface to be always present.

                break;
            case Protocol::METHOD_DELETE:
                $this->doDelete($servletRequest, $servletResponse);

$servletRequest of type object<AppserverIo\Psr\Servlet\ServletRequestInterface> is not a sub-type of object<AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface>. It seems like you assume a child interface of the interface AppserverIo\Psr\Servlet\ServletRequestInterface to be always present.

$servletResponse of type object<AppserverIo\Psr\Servlet\ServletResponseInterface> is not a sub-type of object<AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface>. It seems like you assume a child interface of the interface AppserverIo\Psr\Servlet\ServletResponseInterface to be always present.

                break;
            case Protocol::METHOD_GET:
                $this->doGet($servletRequest, $servletResponse);

$servletRequest of type object<AppserverIo\Psr\Servlet\ServletRequestInterface> is not a sub-type of object<AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface>. It seems like you assume a child interface of the interface AppserverIo\Psr\Servlet\ServletRequestInterface to be always present.

$servletResponse of type object<AppserverIo\Psr\Servlet\ServletResponseInterface> is not a sub-type of object<AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface>. It seems like you assume a child interface of the interface AppserverIo\Psr\Servlet\ServletResponseInterface to be always present.

                break;
            case Protocol::METHOD_HEAD:
                $this->doHead($servletRequest, $servletResponse);

$servletRequest of type object<AppserverIo\Psr\Servlet\ServletRequestInterface> is not a sub-type of object<AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface>. It seems like you assume a child interface of the interface AppserverIo\Psr\Servlet\ServletRequestInterface to be always present.

$servletResponse of type object<AppserverIo\Psr\Servlet\ServletResponseInterface> is not a sub-type of object<AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface>. It seems like you assume a child interface of the interface AppserverIo\Psr\Servlet\ServletResponseInterface to be always present.

                break;
            case Protocol::METHOD_OPTIONS:
                $this->doOptions($servletRequest, $servletResponse);

$servletRequest of type object<AppserverIo\Psr\Servlet\ServletRequestInterface> is not a sub-type of object<AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface>. It seems like you assume a child interface of the interface AppserverIo\Psr\Servlet\ServletRequestInterface to be always present.

$servletResponse of type object<AppserverIo\Psr\Servlet\ServletResponseInterface> is not a sub-type of object<AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface>. It seems like you assume a child interface of the interface AppserverIo\Psr\Servlet\ServletResponseInterface to be always present.

                break;
            case Protocol::METHOD_POST:
                $this->doPost($servletRequest, $servletResponse);

$servletRequest of type object<AppserverIo\Psr\Servlet\ServletRequestInterface> is not a sub-type of object<AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface>. It seems like you assume a child interface of the interface AppserverIo\Psr\Servlet\ServletRequestInterface to be always present.

$servletResponse of type object<AppserverIo\Psr\Servlet\ServletResponseInterface> is not a sub-type of object<AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface>. It seems like you assume a child interface of the interface AppserverIo\Psr\Servlet\ServletResponseInterface to be always present.

                break;
            case Protocol::METHOD_PUT:
                $this->doPut($servletRequest, $servletResponse);

$servletRequest of type object<AppserverIo\Psr\Servlet\ServletRequestInterface> is not a sub-type of object<AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface>. It seems like you assume a child interface of the interface AppserverIo\Psr\Servlet\ServletRequestInterface to be always present.

$servletResponse of type object<AppserverIo\Psr\Servlet\ServletResponseInterface> is not a sub-type of object<AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface>. It seems like you assume a child interface of the interface AppserverIo\Psr\Servlet\ServletResponseInterface to be always present.

                break;
            case Protocol::METHOD_TRACE:
                $this->doTrace($servletRequest, $servletResponse);

$servletRequest of type object<AppserverIo\Psr\Servlet\ServletRequestInterface> is not a sub-type of object<AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface>. It seems like you assume a child interface of the interface AppserverIo\Psr\Servlet\ServletRequestInterface to be always present.

$servletResponse of type object<AppserverIo\Psr\Servlet\ServletResponseInterface> is not a sub-type of object<AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface>. It seems like you assume a child interface of the interface AppserverIo\Psr\Servlet\ServletResponseInterface to be always present.

                break;
            case Protocol::METHOD_PATCH:
                $this->doPatch($servletRequest, $servletResponse);

$servletRequest of type object<AppserverIo\Psr\Servlet\ServletRequestInterface> is not a sub-type of object<AppserverIo\Psr\Servlet\Http\HttpServletRequestInterface>. It seems like you assume a child interface of the interface AppserverIo\Psr\Servlet\ServletRequestInterface to be always present.

$servletResponse of type object<AppserverIo\Psr\Servlet\ServletResponseInterface> is not a sub-type of object<AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface>. It seems like you assume a child interface of the interface AppserverIo\Psr\Servlet\ServletResponseInterface to be always present.

                break;
            default:
                throw new ServletException(
                    sprintf('%s is not implemented yet.', $servletRequest->getMethod())

It seems like you code against a concrete implementation and not the interface AppserverIo\Psr\Servlet\ServletRequestInterface as the method getMethod() does only exist in the following implementations of said interface: AppserverIo\Psr\Servlet\Http\HttpServletRequestWrapper.

                );
        }
    }

    /**
     * Destroys the object on shutdown.
     *
     * @return void
     */
    public function destroy()
    {
    }
}