Module com.semanticcms.openfile.servlet

Package com.semanticcms.openfile.servlet

Class OpenFile

java.lang.Object

com.semanticcms.openfile.servlet.OpenFile

public final class OpenFile
extends Object

Opens files on the server-side.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OpenFile.FileOpener	Additional file openers may be registered to the application context.
static class	OpenFile.Initializer	Registers file openers during application start-up.

Method Summary

Modifier and Type	Method	Description
static void	addFileOpener(ServletContext servletContext, OpenFile.FileOpener fileOpener, String... extensions)	Registers a file opener.
static boolean	isAllowed(ServletContext servletContext, ServletRequest request)	Checks if the given request is allowed to open files on the server.
static boolean	isWindows()	Checks if the current Java runtime is Windows via system property "os.name".
static void	openFile(ServletContext servletContext, HttpServletRequest request, HttpServletResponse response, String book, String path)	Opens a file on the server-side.
static void	removeFileOpener(ServletContext servletContext, String... extensions)	Removes file openers.

Methods inherited from class java.lang.Object

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

Method Details

isAllowed

public static boolean isAllowed(ServletContext servletContext,
 ServletRequest request)

Checks if the given request is allowed to open files on the server. The servlet init param must have it enabled, as well as be from an allowed IP.

isWindows

public static boolean isWindows()

Checks if the current Java runtime is Windows via system property "os.name".

addFileOpener

public static void addFileOpener(ServletContext servletContext,
 OpenFile.FileOpener fileOpener,
 String... extensions)

Registers a file opener.

Parameters:

extensions - The simple extensions, in lowercase, not including the dot, such as "dia"

removeFileOpener

public static void removeFileOpener(ServletContext servletContext,
 String... extensions)

Removes file openers.

Parameters:

extensions - The simple extensions, in lowercase, not including the dot, such as "dia"

openFile

public static void openFile(ServletContext servletContext,
 HttpServletRequest request,
 HttpServletResponse response,
 String book,
 String path)
                     throws ServletException,
IOException,
SkipPageException

Opens a file on the server-side.

Throws:

ServletException

IOException

SkipPageException