org.wandora.piccolo.actions

Class ImageCacheSimple

java.lang.Object

org.wandora.piccolo.actions.ImageCacheSimple

All Implemented Interfaces:

Action, XMLParamAware

public class ImageCacheSimple
extends java.lang.Object
implements Action, XMLParamAware

Author:

olli, akivela

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImageCacheSimple.DefaultImageMaker
static interface	ImageCacheSimple.ImageMaker
static class	ImageCacheSimple.Profile

Field Summary

Fields

Modifier and Type	Field and Description
private HttpAuthorizer	authorizer
private java.lang.String	cachedir
private java.lang.String	defaultProfile
private Logger	logger
private java.util.HashMap<java.lang.String,ImageCacheSimple.Profile>	profiles
private HttpAuthorizer	secondaryAuthorizer
private java.lang.String	secondarySavedir
private java.lang.String	secondaryUrl

Constructor Summary

Constructors

Constructor and Description
ImageCacheSimple() Creates a new instance of ImageCacheSimple

Method Summary

Modifier and Type	Method and Description
void	doAction(ImageCacheSimple.Profile profile, java.lang.String url, java.lang.String imageID, boolean reload, javax.servlet.ServletResponse response)
void	doAction(User user, javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, Application application)
protected java.lang.String	encodeFileName(java.lang.String url, ImageCacheSimple.Profile profile) Encodes an url and profile into a name of a real file that will contain the cached data.
protected boolean	haveCached(java.lang.String filename) Checks if the specified (encoded) file is cached.
protected java.awt.image.BufferedImage	makeIMG(java.lang.String url, ImageCacheSimple.Profile profile)
protected java.awt.image.BufferedImage	makeIMG(java.lang.String url, ImageCacheSimple.Profile profile, java.lang.String secondaryID) Uses the image maker of the profile to make an image with the given url.
java.awt.image.BufferedImage	readImage(java.lang.String url, HttpAuthorizer authorizer)
java.awt.image.BufferedImage	readImage(java.net.URL url, HttpAuthorizer authorizer)
protected void	sendFile(java.lang.String filename, java.io.OutputStream out) Reads a file and writes it to the output stream.
protected void	writeFile(java.lang.String filename, java.awt.image.BufferedImage img, ImageCacheSimple.Profile profile) Writes an image to disk.
void	xmlParamInitialize(org.w3c.dom.Element element, XMLParamProcessor processor)

Methods inherited from class java.lang.Object

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

Field Detail

logger

private Logger logger

cachedir

private java.lang.String cachedir

profiles

private java.util.HashMap<java.lang.String,ImageCacheSimple.Profile> profiles

defaultProfile

private java.lang.String defaultProfile

authorizer

private HttpAuthorizer authorizer

secondaryAuthorizer

private HttpAuthorizer secondaryAuthorizer

secondaryUrl

private java.lang.String secondaryUrl

secondarySavedir

private java.lang.String secondarySavedir

Constructor Detail

ImageCacheSimple

public ImageCacheSimple()

Creates a new instance of ImageCacheSimple

Method Detail

xmlParamInitialize

public void xmlParamInitialize(org.w3c.dom.Element element,
                               XMLParamProcessor processor)

Specified by:

xmlParamInitialize in interface XMLParamAware

encodeFileName

protected java.lang.String encodeFileName(java.lang.String url,
                                          ImageCacheSimple.Profile profile)

Encodes an url and profile into a name of a real file that will contain the cached data. Same url and profile must always encode to same file name and different urls and profiles must encode to different file names.

haveCached

protected boolean haveCached(java.lang.String filename)

Checks if the specified (encoded) file is cached. Effectively just checks if the given file exists allready.

sendFile

protected void sendFile(java.lang.String filename,
                        java.io.OutputStream out)
                 throws java.io.IOException

Reads a file and writes it to the output stream. Note: In the future this method could cache often used images so they don't need to be read from disk all the time.

Throws:

java.io.IOException

writeFile

protected void writeFile(java.lang.String filename,
                         java.awt.image.BufferedImage img,
                         ImageCacheSimple.Profile profile)
                  throws java.io.IOException

Writes an image to disk.

Throws:

java.io.IOException

readImage

public java.awt.image.BufferedImage readImage(java.lang.String url,
                                              HttpAuthorizer authorizer)
                                       throws java.io.IOException

Throws:

java.io.IOException

readImage

public java.awt.image.BufferedImage readImage(java.net.URL url,
                                              HttpAuthorizer authorizer)
                                       throws java.io.IOException

Throws:

java.io.IOException

makeIMG

protected java.awt.image.BufferedImage makeIMG(java.lang.String url,
                                               ImageCacheSimple.Profile profile)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

makeIMG

protected java.awt.image.BufferedImage makeIMG(java.lang.String url,
                                               ImageCacheSimple.Profile profile,
                                               java.lang.String secondaryID)
                                        throws java.lang.Exception

Uses the image maker of the profile to make an image with the given url. If url does not resolve as image secondary url is generated and tried. If secondary url resolves the image is saved to secondary save directory and the method returns valid image. Otherwise an exception is thrown. Notice: method should not use global variables to save data since there may be multiple threads executing the method simultaneusly!!

Throws:

java.lang.Exception

doAction

public void doAction(ImageCacheSimple.Profile profile,
                     java.lang.String url,
                     java.lang.String imageID,
                     boolean reload,
                     javax.servlet.ServletResponse response)

doAction

public void doAction(User user,
                     javax.servlet.ServletRequest request,
                     javax.servlet.ServletResponse response,
                     Application application)

Specified by:

doAction in interface Action