org.eclipse.jetty.server.handler

Class ContextHandler

  • All Implemented Interfaces:
    Handler, HandlerContainer, Server.Graceful, Attributes, Destroyable, Dumpable, LifeCycle
    Direct Known Subclasses:
    MovedContextHandler


    public class ContextHandlerextends ScopedHandlerimplements Attributes, Server.Graceful
    ContextHandler. This handler wraps a call to handle by setting the context and servlet path, plus setting the context classloader.

    If the context init parameter "org.eclipse.jetty.server.context.ManagedAttributes" is set to a comma separated list of names, then they are treated as context attribute names, which if set as attributes are passed to the servers Container so that they may be managed with JMX.

    The maximum size of a form that can be processed by this context is controlled by the system properties org.eclipse.jetty.server.Request.maxFormKeys and org.eclipse.jetty.server.Request.maxFormContentSize. These can also be configured with setMaxFormContentSize(int) and setMaxFormKeys(int)

    Apache XBean:
    description="Creates a basic HTTP context"
    • Field Detail

      • MANAGED_ATTRIBUTES

        public static final String MANAGED_ATTRIBUTES
        If a context attribute with this name is set, it is interpreted as a comma separated list of attribute name. Any other context attributes that are set with a name from this list will result in a call to setManagedAttribute(String, Object), which typically initiates the creation of a JMX MBean for the attribute value.
        See Also:
        Constant Field Values
    • Constructor Detail

      • ContextHandler

        public ContextHandler()
      • ContextHandler

        public ContextHandler(String contextPath)
    • Method Detail

      • getCurrentContext

        public static ContextHandler.Context getCurrentContext()
        Get the current ServletContext implementation.
        Returns:
        ServletContext implementation
      • getAllowNullPathInfo

        public boolean getAllowNullPathInfo()
        Returns:
        the allowNullPathInfo true if /context is not redirected to /context/
      • setAllowNullPathInfo

        public void setAllowNullPathInfo(boolean allowNullPathInfo)
        Parameters:
        allowNullPathInfo - true if /context is not redirected to /context/
      • setVirtualHosts

        public void setVirtualHosts(String[] vhosts)
        Set the virtual hosts for the context. Only requests that have a matching host header or fully qualified URL will be passed to that context with a virtual host name. A context with no virtual host names or a null virtual host name is available to all requests that are not served by a context with a matching virtual host name.
        Parameters:
        vhosts - Array of virtual hosts that this context responds to. A null host name or null/empty array means any hostname is acceptable. Host names may be String representation of IP addresses. Host names may start with '*.' to wildcard one level of names.
      • addVirtualHosts

        public void addVirtualHosts(String[] virtualHosts)
        Either set virtual hosts or add to an existing set of virtual hosts.
        Parameters:
        virtualHosts - Array of virtual hosts that this context responds to. A null host name or null/empty array means any hostname is acceptable. Host names may be String representation of IP addresses. Host names may start with '*.' to wildcard one level of names.
      • removeVirtualHosts

        public void removeVirtualHosts(String[] virtualHosts)
        Removes an array of virtual host entries, if this removes all entries the _vhosts will be set to null
        Parameters:
        virtualHosts - Array of virtual hosts that this context responds to. A null host name or null/empty array means any hostname is acceptable. Host names may be String representation of IP addresses. Host names may start with '*.' to wildcard one level of names.
      • getVirtualHosts

        public String[] getVirtualHosts()
        Get the virtual hosts for the context. Only requests that have a matching host header or fully qualified URL will be passed to that context with a virtual host name. A context with no virtual host names or a null virtual host name is available to all requests that are not served by a context with a matching virtual host name.
        Returns:
        Array of virtual hosts that this context responds to. A null host name or empty array means any hostname is acceptable. Host names may be String representation of IP addresses. Host names may start with '*.' to wildcard one level of names.
      • getConnectorNames

        public String[] getConnectorNames()
        Returns:
        an array of connector names that this context will accept a request from.
      • setConnectorNames

        public void setConnectorNames(String[] connectors)
        Set the names of accepted connectors. Names are either "host:port" or a specific configured name for a connector.
        Parameters:
        connectors - If non null, an array of connector names that this context will accept a request from.
      • getAttributes

        public Attributes getAttributes()
        Returns:
        Returns the attributes.
      • getClassLoader

        public ClassLoader getClassLoader()
        Returns:
        Returns the classLoader.
      • getClassPath

        public String getClassPath()
        Make best effort to extract a file classpath from the context classloader
        Returns:
        Returns the classLoader.
      • getContextPath

        public String getContextPath()
        Returns:
        Returns the _contextPath.
      • getInitParameter

        public String getInitParameter(String name)
      • getInitParameterNames

        public Enumeration getInitParameterNames()
      • getInitParams

        public Map<String,String> getInitParams()
        Returns:
        Returns the initParams.
      • getDisplayName

        public String getDisplayName()
      • setEventListeners

        public void setEventListeners(EventListener[] eventListeners)
        Set the context event listeners.
        Parameters:
        eventListeners - the event listeners
        See Also:
        ServletContextListener, ServletContextAttributeListener, ServletRequestListener, ServletRequestAttributeListener
      • addEventListener

        public void addEventListener(EventListener listener)
        Add a context event listeners.
        See Also:
        ServletContextListener, ServletContextAttributeListener, ServletRequestListener, ServletRequestAttributeListener
      • restrictEventListener

        public void restrictEventListener(EventListener listener)
        Apply any necessary restrictions on a programmatically added listener. Superclasses should implement.
        Parameters:
        listener -
      • isShutdown

        public boolean isShutdown()
        Returns:
        true if this context is accepting new requests
      • setShutdown

        public void setShutdown(boolean shutdown)
        Set shutdown status. This field allows for graceful shutdown of a context. A started context may be put into non accepting state so that existing requests can complete, but no new requests are accepted.
        Specified by:
        setShutdown in interface Server.Graceful
        Parameters:
        shutdown - true if this context is (not?) accepting new requests
      • isAvailable

        public boolean isAvailable()
        Returns:
        false if this context is unavailable (sends 503)
      • setAvailable

        public void setAvailable(boolean available)
        Set Available status.
      • getLogger

        public Logger getLogger()
      • setLogger

        public void setLogger(Logger logger)
      • startContext

        protected void startContext()                     throws Exception
        Extensible startContext. this method is called from doStart() instead of a call to super.doStart(). This allows derived classes to insert additional handling (Eg configuration) before the call to super.doStart by this method will start contained handlers.
        Throws:
        Exception
        See Also:
        ContextHandler.Context
      • callContextInitialized

        public void callContextInitialized(javax.servlet.ServletContextListener l,                          javax.servlet.ServletContextEvent e)
      • callContextDestroyed

        public void callContextDestroyed(javax.servlet.ServletContextListener l,                        javax.servlet.ServletContextEvent e)
      • checkContext

        public boolean checkContext(String target,                   Request baseRequest,                   javax.servlet.http.HttpServletResponse response)                     throws IOException,                            javax.servlet.ServletException
        Throws:
        IOException
        javax.servlet.ServletException
      • handle

        public void handle(Runnable runnable)
      • setProtectedTargets

        public void setProtectedTargets(String[] targets)
      • getProtectedTargets

        public String[] getProtectedTargets()
      • setAttributes

        public void setAttributes(Attributes attributes)
        Parameters:
        attributes - The attributes to set.
      • checkManagedAttribute

        public void checkManagedAttribute(String name,                         Object value)
      • setManagedAttribute

        public void setManagedAttribute(String name,                       Object value)
      • setClassLoader

        public void setClassLoader(ClassLoader classLoader)
        Parameters:
        classLoader - The classLoader to set.
      • setContextPath

        public void setContextPath(String contextPath)
        Parameters:
        contextPath - The _contextPath to set.
      • setDisplayName

        public void setDisplayName(String servletContextName)
        Parameters:
        servletContextName - The servletContextName to set.
      • getBaseResource

        public Resource getBaseResource()
        Returns:
        Returns the resourceBase.
      • getResourceBase

        public String getResourceBase()
        Returns:
        Returns the base resource as a string.
      • setBaseResource

        public void setBaseResource(Resource base)
        Parameters:
        base - The resourceBase to set.
      • setResourceBase

        public void setResourceBase(String resourceBase)
        Parameters:
        resourceBase - The base resource as a string.
      • isAliases

        public boolean isAliases()
        Returns:
        True if aliases are allowed
      • setAliases

        public void setAliases(boolean aliases)
        Parameters:
        aliases - aliases are allowed
      • getMimeTypes

        public MimeTypes getMimeTypes()
        Returns:
        Returns the mimeTypes.
      • setMimeTypes

        public void setMimeTypes(MimeTypes mimeTypes)
        Parameters:
        mimeTypes - The mimeTypes to set.
      • setWelcomeFiles

        public void setWelcomeFiles(String[] files)
      • getErrorHandler

        public ErrorHandler getErrorHandler()
        Returns:
        Returns the errorHandler.
      • setErrorHandler

        public void setErrorHandler(ErrorHandler errorHandler)
        Parameters:
        errorHandler - The errorHandler to set.
      • getMaxFormContentSize

        public int getMaxFormContentSize()
      • setMaxFormContentSize

        public void setMaxFormContentSize(int maxSize)
        Set the maximum size of a form post, to protect against DOS attacks from large forms.
        Parameters:
        maxSize -
      • getMaxFormKeys

        public int getMaxFormKeys()
      • setMaxFormKeys

        public void setMaxFormKeys(int max)
        Set the maximum number of form Keys to protect against DOS attack from crafted hash keys.
        Parameters:
        max -
      • isCompactPath

        public boolean isCompactPath()
        Returns:
        True if URLs are compacted to replace multiple '/'s with a single '/'
      • setCompactPath

        public void setCompactPath(boolean compactPath)
        Parameters:
        compactPath - True if URLs are compacted to replace multiple '/'s with a single '/'
      • addLocaleEncoding

        public void addLocaleEncoding(String locale,                     String encoding)
      • getLocaleEncoding

        public String getLocaleEncoding(String locale)
      • getLocaleEncoding

        public String getLocaleEncoding(Locale locale)
        Get the character encoding for a locale. The full locale name is first looked up in the map of encodings. If no encoding is found, then the locale language is looked up.
        Parameters:
        locale - a Locale value
        Returns:
        a String representing the character encoding for the locale or null if none found.
      • newResource

        public Resource newResource(String urlOrPath)                     throws IOException
        Convert a URL or path to a Resource. The default implementation is a wrapper for Resource.newResource(String).
        Parameters:
        urlOrPath - The URL or path to convert
        Returns:
        The Resource for the URL/path
        Throws:
        IOException - The Resource could not be created.
      • addAliasCheck

        public void addAliasCheck(ContextHandler.AliasCheck check)
        Add an AliasCheck instance to possibly permit aliased resources
        Parameters:
        check - The alias checker

Copyright © 1995-2013 Mort Bay Consulting. All Rights Reserved.



NOTHING
NOTHING
Add the Maven Dependecy to your project: maven dependecy for com.amazonaws : aws-java-sdk : 1.3.14