org.glyptodon.guacamole.net.basic.resource

Class WebApplicationResource

java.lang.Object

org.glyptodon.guacamole.net.basic.resource.AbstractResource

org.glyptodon.guacamole.net.basic.resource.WebApplicationResource

All Implemented Interfaces:

Resource

public class WebApplicationResource
extends AbstractResource

A resource which is located within the classpath associated with another class.

Author:

Michael Jumper

Constructor Summary

Constructors

Constructor and Description
WebApplicationResource(javax.servlet.ServletContext context, String path) Creates a new WebApplicationResource which serves the resource at the given path relative to the given ServletContext.
WebApplicationResource(javax.servlet.ServletContext context, String mimetype, String path) Creates a new WebApplicationResource which serves the resource at the given path relative to the given ServletContext.

Method Summary

Modifier and Type	Method and Description
InputStream	asStream() Returns an InputStream which reads the contents of this resource, starting with the first byte.

Methods inherited from class org.glyptodon.guacamole.net.basic.resource.AbstractResource

getLastModified, getMimeType

Methods inherited from class java.lang.Object

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

Constructor Detail

WebApplicationResource

public WebApplicationResource(javax.servlet.ServletContext context,
                              String mimetype,
                              String path)

Creates a new WebApplicationResource which serves the resource at the given path relative to the given ServletContext. Rather than deriving the mimetype of the resource from the filename within the path, the mimetype given is used.

Parameters:

context - The ServletContext to use when reading the resource.

mimetype - The mimetype of the resource.

path - The path of the resource relative to the given ServletContext.

WebApplicationResource

public WebApplicationResource(javax.servlet.ServletContext context,
                              String path)

Creates a new WebApplicationResource which serves the resource at the given path relative to the given ServletContext. The mimetype of the resource is automatically determined based on the filename within the path.

Parameters:

context - The ServletContext to use when reading the resource and deriving the mimetype.

path - The path of the resource relative to the given ServletContext.

Method Detail

asStream

public InputStream asStream()

Description copied from interface: Resource

Returns an InputStream which reads the contents of this resource, starting with the first byte. Reading from the returned InputStream will not affect reads from other InputStreams returned by other calls to asStream(). The returned InputStream must be manually closed when no longer needed. If the resource is unexpectedly unavailable, this will return null.

Returns:

An InputStream which reads the contents of this resource, starting with the first byte, or null if the resource is unavailable.