com.ten60.netkernel.cache
Interface ICachelet

public interface ICachelet

The cachelet interface

Method Summary

IURRepresentation	get(URRequest aRequest) Attempt to get a representation that will satisfy the given request
ICachelet	getBackingCache() If this cache has a backing cache return it, otherwise null
void	init(Container aContainer, ModuleDefinition aModule) Initialises the cachelet with the container it will be serving
void	put(URResult aResult) Gives the cachelet the opportunity to update or invalidate the cache based on the result that has been issued
void	write(java.io.Writer aWriter) Write the state of the cache out to the outputstream in unparsed xml in a cachelet specific manner.

Method Detail

init

void init(Container aContainer,
          ModuleDefinition aModule)

Initialises the cachelet with the container it will be serving

Parameters:

the - Container the cache will be serving

the - Module the cache is deployed into

get

IURRepresentation get(URRequest aRequest)

Attempt to get a representation that will satisfy the given request

Parameters:

aRequest - the request

Returns:

a representation to satisfy the request or null

put

void put(URResult aResult)

Gives the cachelet the opportunity to update or invalidate the cache based on the result that has been issued

getBackingCache

ICachelet getBackingCache()

If this cache has a backing cache return it, otherwise null

write

void write(java.io.Writer aWriter)
           throws java.io.IOException

Write the state of the cache out to the outputstream in unparsed xml in a cachelet specific manner.

Throws:

java.io.IOException - thrown if we fail to write to the stream