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
Locator based on ServletContext.
- Author:
- tomyeh
-
Constructor Summary
ConstructorsConstructorDescriptionServletContextLocator(jakarta.servlet.ServletContext ctx) Constructor.ServletContextLocator(jakarta.servlet.ServletContext ctx, boolean acceptURL) Constructor.ServletContextLocator(jakarta.servlet.ServletContext ctx, String dir) Constructor.ServletContextLocator(jakarta.servlet.ServletContext ctx, String dir, String prefix) Constructor.ServletContextLocator(jakarta.servlet.ServletContext ctx, String dir, String prefix, boolean acceptURL) Constructor.ServletContextLocator(jakarta.servlet.ServletContext ctx, String dir, String prefix, boolean acceptURL, String externalPrefix) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionbooleangetResource(String name) getResourceAsStream(String name) jakarta.servlet.ServletContextReturns the servlet context.inthashCode()
-
Constructor Details
-
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:
-
ServletContextLocator
Constructor. A short of ServletContextLocator(ctx, dir, null, false, null).- Parameters:
dir- the directory used when relative path is specified (forgetResource(java.lang.String)andgetResourceAsStream(java.lang.String)). It must be null, empty, or starts with /.
-
ServletContextLocator
Constructor. A short cut of ServletContextLocator(ctx, dir, prefix, false, null). -
ServletContextLocator
public ServletContextLocator(jakarta.servlet.ServletContext ctx, String dir, String prefix, boolean acceptURL) Constructor. A short cut of ServletContextLocator(ctx, dir, prefix, acceptURL, null). -
ServletContextLocator
public ServletContextLocator(jakarta.servlet.ServletContext ctx, String dir, String prefix, boolean acceptURL, 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 (forgetResource(java.lang.String)andgetResourceAsStream(java.lang.String)). It must be null, empty, or starts with /.prefix- the directory to prefix each directory specified (forgetResource(java.lang.String)andgetResourceAsStream(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 Details
-
getServletContext
public jakarta.servlet.ServletContext getServletContext()Returns the servlet context. -
getDirectory
- Specified by:
getDirectoryin interfaceorg.zkoss.util.resource.Locator
-
getResource
- Specified by:
getResourcein interfaceorg.zkoss.util.resource.Locator
-
getResourceAsStream
- Specified by:
getResourceAsStreamin interfaceorg.zkoss.util.resource.Locator
-
hashCode
public int hashCode() -
equals
-