Package org.eclipse.rap.rwt.service
Interface ResourceManager
-
public interface ResourceManagerThe resource manager is used to register static resources like images, CSS files etc. in order to make them available at a URL.- Since:
- 2.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.StringgetLocation(java.lang.String name)Returns the location within the web-applications context where the resource will be available for download.java.io.InputStreamgetRegisteredContent(java.lang.String name)Returns the content of the registered resource with the given name.booleanisRegistered(java.lang.String name)Determines whether the resource with the given name has been registered.voidregister(java.lang.String name, java.io.InputStream inputStream)Registers a given resource and makes it available for download.booleanunregister(java.lang.String name)Unregisters the resource with the given name.
-
-
-
Method Detail
-
register
void register(java.lang.String name, java.io.InputStream inputStream)Registers a given resource and makes it available for download. The URL for the registered resource can be obtained fromgetLocation(String).- Parameters:
name- a name that represents the resourceinputStream- a stream to read the content from
-
unregister
boolean unregister(java.lang.String name)
Unregisters the resource with the given name.- Parameters:
name- the name that represents the resource. Must not benull.- Returns:
trueif unregistering the resource was successful,falseotherwise.
-
isRegistered
boolean isRegistered(java.lang.String name)
Determines whether the resource with the given name has been registered.- Parameters:
name- filename which identifies the registered resource. The filename must be relative to a classpath root, e.g. a gif 'my.gif' located within the package 'org.eclipse.rap' is identified as 'org/eclipse/rap/my.gif'. Must not benull.- Returns:
- if the resource is already registered
-
getLocation
java.lang.String getLocation(java.lang.String name)
Returns the location within the web-applications context where the resource will be available for download.- Parameters:
name- the name which identifies the registered resource- Returns:
- the location where the resource will be available for download
-
getRegisteredContent
java.io.InputStream getRegisteredContent(java.lang.String name)
Returns the content of the registered resource with the given name.- Parameters:
name- the name of the resource, must not benull- Returns:
- an input stream to the contents of the resource, or
nullif no such resource exists
-
-