Package org.apache.wicket.request.handler.resource

Class ResourceStreamRequestHandler

  • All Implemented Interfaces:
    org.apache.wicket.request.ILoggableRequestHandler, org.apache.wicket.request.IRequestHandler
    Direct Known Subclasses:
    WebExternalResourceRequestHandler
    public class ResourceStreamRequestHandler
extends java.lang.Object
implements org.apache.wicket.request.IRequestHandler, org.apache.wicket.request.ILoggableRequestHandler
    Request target that responds by sending its resource stream.
    Author:
    Eelco Hillenius

    • Constructor Detail

      • ResourceStreamRequestHandler

        public ResourceStreamRequestHandler​(org.apache.wicket.util.resource.IResourceStream resourceStream)
        Construct.
        Parameters:
        resourceStream - the resource stream for the response

      • ResourceStreamRequestHandler

        public ResourceStreamRequestHandler​(org.apache.wicket.util.resource.IResourceStream resourceStream,
                                    java.lang.String fileName)
        Construct.
        Parameters:
        resourceStream - the resource stream for the response
        fileName -

    • Method Detail

      • detach

        public void detach​(org.apache.wicket.request.IRequestCycle requestCycle)
        Specified by:
        detach in interface org.apache.wicket.request.IRequestHandler

      • getLogData

        public ResourceStreamLogData getLogData()
        Specified by:
        getLogData in interface org.apache.wicket.request.ILoggableRequestHandler

      • getFileName

        public final java.lang.String getFileName()
        Returns:
        Optional filename, used to set the content disposition header. Only meaningful when using with web requests.

      • getResourceStream

        public final org.apache.wicket.util.resource.IResourceStream getResourceStream()
        Gets the resource stream for the response.
        Returns:
        the resource stream for the response

      • respond

        public void respond​(org.apache.wicket.request.IRequestCycle requestCycle)
        Responds by sending the contents of the resource stream.
        Specified by:
        respond in interface org.apache.wicket.request.IRequestHandler
        See Also:
        IRequestHandler.respond(org.apache.wicket.request.IRequestCycle)

      • configure

        protected void configure​(ResourceStreamResource resource)
        Configures the ResourceStreamResource used by this request handler
        Parameters:
        resource - the resource to configure

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • setFileName

        public final ResourceStreamRequestHandler setFileName​(java.lang.String fileName)
        Parameters:
        fileName - Optional filename, used to set the content disposition header. Only meaningful when using with web requests.
        Returns:
        The this.

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
        See Also:
        Object.toString()

      • getContentDisposition

        public final ContentDisposition getContentDisposition()
        Returns:
        ContentDisposition

      • getCacheDuration

        public org.apache.wicket.util.time.Duration getCacheDuration()
        Returns:
        the duration for which the resource will be cached by the browser

      • setCacheDuration

        public ResourceStreamRequestHandler setCacheDuration​(org.apache.wicket.util.time.Duration cacheDuration)
        Parameters:
        cacheDuration - the duration for which the resource will be cached by the browser
        Returns:
        this component