Package org.zkoss.web.util.resource

Class ServletContextLocator

java.lang.Object

org.zkoss.web.util.resource.ServletContextLocator

All Implemented Interfaces:

org.zkoss.util.resource.Locator

public class ServletContextLocator
extends java.lang.Object
implements org.zkoss.util.resource.Locator

Locator based on ServletContext.

Author:

tomyeh

Constructor Summary

Constructors

Constructor	Description
ServletContextLocator(jakarta.servlet.ServletContext ctx)	Constructor.
ServletContextLocator(jakarta.servlet.ServletContext ctx, boolean acceptURL)	Constructor.
ServletContextLocator(jakarta.servlet.ServletContext ctx, java.lang.String dir)	Constructor.
ServletContextLocator(jakarta.servlet.ServletContext ctx, java.lang.String dir, java.lang.String prefix)	Constructor.
ServletContextLocator(jakarta.servlet.ServletContext ctx, java.lang.String dir, java.lang.String prefix, boolean acceptURL)	Constructor.
ServletContextLocator(jakarta.servlet.ServletContext ctx, java.lang.String dir, java.lang.String prefix, boolean acceptURL, java.lang.String externalPrefix)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
java.lang.String	getDirectory()
java.net.URL	getResource(java.lang.String name)
java.io.InputStream	getResourceAsStream(java.lang.String name)
jakarta.servlet.ServletContext	getServletContext()	Returns the servlet context.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletContextLocator

public ServletContextLocator(jakarta.servlet.ServletContext ctx)

Constructor. A short cut of ServletContextLocator(ctx, null, null, false)

ServletContextLocator

public ServletContextLocator(jakarta.servlet.ServletContext ctx,
                             boolean acceptURL)

Constructor.

Parameters:

acceptURL - whether to URL (such as file:/, http:// and ftp://) are accepted. In other words, Servlets.getResource(jakarta.servlet.ServletContext, java.lang.String) will be used.

Since:

5.0.7

See Also:

Servlets.getResource(jakarta.servlet.ServletContext, java.lang.String)

ServletContextLocator

public ServletContextLocator(jakarta.servlet.ServletContext ctx,
                             java.lang.String dir)

Constructor. A short of ServletContextLocator(ctx, dir, null, false, null).

Parameters:

dir - the directory used when relative path is specified (for getResource(java.lang.String) and getResourceAsStream(java.lang.String)). It must be null, empty, or starts with /.

ServletContextLocator

public ServletContextLocator(jakarta.servlet.ServletContext ctx,
                             java.lang.String dir,
                             java.lang.String prefix)

Constructor. A short cut of ServletContextLocator(ctx, dir, prefix, false, null).

ServletContextLocator

public ServletContextLocator(jakarta.servlet.ServletContext ctx,
                             java.lang.String dir,
                             java.lang.String prefix,
                             boolean acceptURL)

Constructor. A short cut of ServletContextLocator(ctx, dir, prefix, acceptURL, null).

ServletContextLocator

public ServletContextLocator(jakarta.servlet.ServletContext ctx,
                             java.lang.String dir,
                             java.lang.String prefix,
                             boolean acceptURL,
                             java.lang.String externalPrefix)

Constructor. For example, if prefix is "/WEB-INF/cwr", then getResource("/abc") will look for "/WEB-INF/cwr/abc" first, and then "/abc".

Another example, if prefix is "/WEB-INF/cwr" and dir is "/subdir", then getResource("abc") will look for "/WEB-INF/cwr/subdir/abc".

Parameters:

dir - the directory used when relative path is specified (for getResource(java.lang.String) and getResourceAsStream(java.lang.String)). It must be null, empty, or starts with /.

prefix - the directory to prefix each directory specified (for getResource(java.lang.String) and getResourceAsStream(java.lang.String)). It must be null, empty, or starts with /.

acceptURL - whether to URL (such as file:/, http:// and ftp://) are accepted. In other words, Servlets.getResource(jakarta.servlet.ServletContext, java.lang.String) will be used.

Method Detail

getServletContext

public jakarta.servlet.ServletContext getServletContext()

Returns the servlet context.

getDirectory

public java.lang.String getDirectory()

Specified by:

getDirectory in interface org.zkoss.util.resource.Locator

getResource

public java.net.URL getResource(java.lang.String name)

Specified by:

getResource in interface org.zkoss.util.resource.Locator

getResourceAsStream

public java.io.InputStream getResourceAsStream(java.lang.String name)

Specified by:

getResourceAsStream in interface org.zkoss.util.resource.Locator

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object