org.apache.commons.jcs.auxiliary.remote.http.server

Class RemoteHttpCacheServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.apache.commons.jcs.auxiliary.remote.http.server.RemoteHttpCacheServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class RemoteHttpCacheServlet
extends javax.servlet.http.HttpServlet

This servlet simply reads and writes objects. The requests are packaged in a general wrapper. The processor works on the wrapper object and returns a response wrapper.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RemoteHttpCacheServlet()

Method Summary

Modifier and Type	Method and Description
protected ICacheEventLogger	configureCacheEventLogger(Properties props) Tries to get the event logger.
protected RemoteHttpCacheServerAttributes	configureRemoteHttpCacheServerAttributes(Properties prop) Configure.
protected <K,V> RemoteHttpCacheService<K,V>	createRemoteHttpCacheService(ICompositeCacheManager cacheManager) Configures the attributes and the event logger and constructs a service.
void	destroy() Release the cache manager.
String	getServletInfo() Get servlet information
void	init(javax.servlet.ServletConfig config) Initializes the cache.
protected RemoteCacheResponse<Object>	processRequest(RemoteCacheRequest<Serializable,Serializable> request) Processes the request.
protected RemoteCacheRequest<Serializable,Serializable>	readRequest(javax.servlet.http.HttpServletRequest request) Read the request from the input stream.
protected RemoteCacheRequest<Serializable,Serializable>	readRequestFromStream(InputStream inputStream) Reads the response from the stream and then closes it.
void	service(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Read the request, call the processor, write the response.
protected void	setRemoteCacheService(ICacheServiceNonLocal<Serializable,Serializable> rcs)
protected void	writeResponse(javax.servlet.http.HttpServletResponse response, RemoteCacheResponse<Object> cacheResponse) Write the response to the output stream.

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteHttpCacheServlet

public RemoteHttpCacheServlet()

Method Detail

init

public void init(javax.servlet.ServletConfig config)
          throws javax.servlet.ServletException

Initializes the cache.

This provides an easy extension point. Simply extend this servlet and override the init method to change the way the properties are loaded.

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class javax.servlet.GenericServlet

Parameters:

config -

Throws:

javax.servlet.ServletException

service

public void service(javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)
             throws javax.servlet.ServletException,
                    IOException

Read the request, call the processor, write the response.

Overrides:

service in class javax.servlet.http.HttpServlet

Parameters:

request -

response -

Throws:

javax.servlet.ServletException

IOException

readRequest

protected RemoteCacheRequest<Serializable,Serializable> readRequest(javax.servlet.http.HttpServletRequest request)

Read the request from the input stream.

Parameters:

request -

Returns:

RemoteHttpCacheRequest

readRequestFromStream

protected RemoteCacheRequest<Serializable,Serializable> readRequestFromStream(InputStream inputStream)
                                                                       throws IOException,
                                                                              ClassNotFoundException

Reads the response from the stream and then closes it.

Parameters:

inputStream -

Returns:

RemoteHttpCacheRequest

Throws:

IOException

ClassNotFoundException

writeResponse

protected void writeResponse(javax.servlet.http.HttpServletResponse response,
                             RemoteCacheResponse<Object> cacheResponse)

Write the response to the output stream.

Parameters:

response -

cacheResponse -

processRequest

protected RemoteCacheResponse<Object> processRequest(RemoteCacheRequest<Serializable,Serializable> request)

Processes the request. It will call the appropriate method on the service

Parameters:

request -

Returns:

RemoteHttpCacheResponse, never null

createRemoteHttpCacheService

protected <K,V> RemoteHttpCacheService<K,V> createRemoteHttpCacheService(ICompositeCacheManager cacheManager)

Configures the attributes and the event logger and constructs a service.

Parameters:

cacheManager -

Returns:

RemoteHttpCacheService

configureCacheEventLogger

protected ICacheEventLogger configureCacheEventLogger(Properties props)

Tries to get the event logger.

Parameters:

props -

Returns:

ICacheEventLogger

configureRemoteHttpCacheServerAttributes

protected RemoteHttpCacheServerAttributes configureRemoteHttpCacheServerAttributes(Properties prop)

Configure.

jcs.remotehttpcache.serverattributes.ATTRIBUTENAME=ATTRIBUTEVALUE

Parameters:

prop -

Returns:

RemoteCacheServerAttributesconfigureRemoteCacheServerAttributes

setRemoteCacheService

protected void setRemoteCacheService(ICacheServiceNonLocal<Serializable,Serializable> rcs)

Parameters:

rcs - the remoteCacheService to set

destroy

public void destroy()

Release the cache manager.

Specified by:

destroy in interface javax.servlet.Servlet

Overrides:

destroy in class javax.servlet.GenericServlet

getServletInfo

public String getServletInfo()

Get servlet information

Specified by:

getServletInfo in interface javax.servlet.Servlet

Overrides:

getServletInfo in class javax.servlet.GenericServlet

Returns:

basic info