sirius.web.resources

Class Resource

java.lang.Object

sirius.web.resources.Resource

public class Resource
extends Object

Wraps an resolved URL as resource.

Used as result of a Resolver. Next to the resolved URL it also stores the original scope and path which was used to resolve the url.

See Also:

Resolver, UserContext.getCurrentScope()

Method Summary

Modifier and Type	Method and Description
static Resource	constantResource(String scopeId, String path, URL url) Creates a new constant resource for the given scope, path and resulting url.
static Resource	dynamicResource(String scopeId, String path, URL url) Creates a new dynamic resource for the given scope, path and resulting url.
boolean	equals(Object obj)
byte[]	getContent() Returns the contents of the resource as byte array.
String	getContentAsString() Returns the contents of the resource as string.
long	getLastModified() Computes the last modified date.
String	getPath() Returns the path which was used to lookup the resource.
String	getScopeId() Returns the scope id which was set when resolving the resource.
URL	getUrl() Returns the effective URL pointing to the resolved content
int	hashCode()
InputStream	openStream() Returns the contents of the resource as InputStream.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

dynamicResource

public static Resource dynamicResource(String scopeId,
                                       String path,
                                       URL url)

Creates a new dynamic resource for the given scope, path and resulting url.

A dynamic resource might change over time (like a customer specific file on disk). Therefore we frequently check for changes.

Parameters:

scopeId - the scope which was used to resolve the resource

path - the local path pointing to the resource

url - the url pointing to the actual content

Returns:

a new resource based on the given parameters

constantResource

public static Resource constantResource(String scopeId,
                                        String path,
                                        URL url)

Creates a new constant resource for the given scope, path and resulting url.

A constant resource will not change over time. An example might be a file in the classpath. Note that in debug mode (Sirius.isDev()) all resources are considered dynamic.

Parameters:

scopeId - the scope which was used to resolve the resource

path - the local path pointing to the resource

url - the url pointing to the actual content

Returns:

a new resource based on the given parameters

getScopeId

public String getScopeId()

Returns the scope id which was set when resolving the resource.

Returns:

the scope id for which the resource was resolved

getPath

public String getPath()

Returns the path which was used to lookup the resource.

Returns:

the path used to resolve the resource

getUrl

public URL getUrl()

Returns the effective URL pointing to the resolved content

Returns:

the URL pointing to the content

openStream

public InputStream openStream()

Returns the contents of the resource as InputStream.

Returns:

an input stream containing the contents of the resource

getContent

public byte[] getContent()

Returns the contents of the resource as byte array.

Returns:

the contents of the resource

getContentAsString

public String getContentAsString()

Returns the contents of the resource as string.

Returns:

the contents of the resource as string (expecting UTF-8 as encoding).

getLastModified

public long getLastModified()

Computes the last modified date.

This value will be cached if the resource is considered constant. However, in development systems the resource will sill be checked in a regular interval.

Also note that the last modified timestamp is at least the timestamp when the resource was resolved. This is required to manage dynamic resources which suddenly are created or vanish.

Returns:

the last modified value of the underlying resource.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object