Package org.restlet.engine.component

Class HostRoute

  • All Implemented Interfaces:
    org.restlet.Uniform
    public class HostRoute
extends org.restlet.routing.Route
    Route based on a target VirtualHost. Concurrency note: instances of this class or its subclasses can be invoked by several threads at the same time and therefore must be thread-safe. You should be especially careful when storing state in member variables.
    Author:
    Jerome Louvel

    • Field Summary

      • Fields inherited from class org.restlet.routing.Filter

        CONTINUE, SKIP, STOP

    • Constructor Summary

      Constructors 
      Constructor Description
      HostRoute​(org.restlet.routing.Router router, org.restlet.routing.VirtualHost target)
      Constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected int beforeHandle​(org.restlet.Request request, org.restlet.Response response)
      Allows filtering before processing by the next Restlet.
      org.restlet.routing.VirtualHost getVirtualHost()
      Returns the target virtual host.
      float score​(org.restlet.Request request, org.restlet.Response response)
      Returns the score for a given call (between 0 and 1.0).
      void setNext​(org.restlet.routing.VirtualHost next)
      Sets the next virtual host.

      • Methods inherited from class org.restlet.routing.Route

        getRouter, setRouter

      • Methods inherited from class org.restlet.routing.Filter

        afterHandle, doHandle, getNext, handle, hasNext, setNext, setNext, start, stop

      • Methods inherited from class org.restlet.Restlet

        createFinder, finalize, getApplication, getAuthor, getContext, getDescription, getFinderClass, getLogger, getName, getOwner, handle, handle, handle, isStarted, isStopped, setAuthor, setContext, setDescription, setFinderClass, setName, setOwner

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • HostRoute

        public HostRoute​(org.restlet.routing.Router router,
                 org.restlet.routing.VirtualHost target)
        Constructor.
        Parameters:
        router - The parent router.
        target - The target virtual host.

    • Method Detail

      • beforeHandle

        protected int beforeHandle​(org.restlet.Request request,
                           org.restlet.Response response)
        Allows filtering before processing by the next Restlet. Set the base reference.
        Overrides:
        beforeHandle in class org.restlet.routing.Filter
        Parameters:
        request - The request to handle.
        response - The response to update.
        Returns:
        The continuation status.

      • getVirtualHost

        public org.restlet.routing.VirtualHost getVirtualHost()
        Returns the target virtual host.
        Returns:
        The target virtual host.

      • score

        public float score​(org.restlet.Request request,
                   org.restlet.Response response)
        Returns the score for a given call (between 0 and 1.0).
        Specified by:
        score in class org.restlet.routing.Route
        Parameters:
        request - The request to score.
        response - The response to score.
        Returns:
        The score for a given call (between 0 and 1.0).

      • setNext

        public void setNext​(org.restlet.routing.VirtualHost next)
        Sets the next virtual host.
        Parameters:
        next - The next virtual host.