Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 09D84200AF7 for ; Tue, 14 Jun 2016 22:36:16 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id 08741160A56; Tue, 14 Jun 2016 20:36:16 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 2B3EC160A06 for ; Tue, 14 Jun 2016 22:36:14 +0200 (CEST) Received: (qmail 36720 invoked by uid 500); 14 Jun 2016 20:36:13 -0000 Mailing-List: contact notifications-help@freemarker.incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@freemarker.incubator.apache.org Delivered-To: mailing list notifications@freemarker.incubator.apache.org Received: (qmail 36711 invoked by uid 99); 14 Jun 2016 20:36:13 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd4-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 14 Jun 2016 20:36:13 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd4-us-west.apache.org (ASF Mail Server at spamd4-us-west.apache.org) with ESMTP id DC396C0E26 for ; Tue, 14 Jun 2016 20:36:12 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd4-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -4.646 X-Spam-Level: X-Spam-Status: No, score=-4.646 tagged_above=-999 required=6.31 tests=[KAM_ASCII_DIVIDERS=0.8, KAM_LAZY_DOMAIN_SECURITY=1, RCVD_IN_DNSWL_HI=-5, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, RP_MATCHES_RCVD=-1.426] autolearn=disabled Received: from mx1-lw-us.apache.org ([10.40.0.8]) by localhost (spamd4-us-west.apache.org [10.40.0.11]) (amavisd-new, port 10024) with ESMTP id zmRf0JrRO6iU for ; Tue, 14 Jun 2016 20:36:02 +0000 (UTC) Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx1-lw-us.apache.org (ASF Mail Server at mx1-lw-us.apache.org) with SMTP id 0F4EA5FD10 for ; Tue, 14 Jun 2016 20:36:01 +0000 (UTC) Received: (qmail 36128 invoked by uid 99); 14 Jun 2016 20:36:01 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 14 Jun 2016 20:36:01 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 4FB33E2C1A; Tue, 14 Jun 2016 20:36:01 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: ddekany@apache.org To: notifications@freemarker.incubator.apache.org Date: Tue, 14 Jun 2016 20:36:42 -0000 Message-Id: In-Reply-To: <9a8f022e226e4b28a008aaffda6bbbbe@git.apache.org> References: <9a8f022e226e4b28a008aaffda6bbbbe@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [44/51] [partial] incubator-freemarker-site git commit: Adding 2.3.25-incubating-voted archived-at: Tue, 14 Jun 2016 20:36:16 -0000 http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/843d83cc/builds/2.3.25-incubating-voted/documentation/_html/api/freemarker/cache/FileNameGlobMatcher.html ---------------------------------------------------------------------- diff --git a/builds/2.3.25-incubating-voted/documentation/_html/api/freemarker/cache/FileNameGlobMatcher.html b/builds/2.3.25-incubating-voted/documentation/_html/api/freemarker/cache/FileNameGlobMatcher.html new file mode 100644 index 0000000..853b14e --- /dev/null +++ b/builds/2.3.25-incubating-voted/documentation/_html/api/freemarker/cache/FileNameGlobMatcher.html @@ -0,0 +1,342 @@ + + + + + + +FileNameGlobMatcher (FreeMarker 2.3.25-incubating API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
freemarker.cache
+

Class FileNameGlobMatcher

+
+
+ +
+
    +
  • +
    +
    +
    public class FileNameGlobMatcher
+extends TemplateSourceMatcher
    +
    As opposed to PathGlobMatcher, it only compares the "file name" part (the part after the last /) of + the source name with the given glob. For example, the file name glob *.ftlh matches both foo.ftlh and + foo/bar.ftlh. With other words, that file name glob is equivalent with the **/*.ftlh) + path glob ( PathGlobMatcher).
    +
    +
    Since:
    +
    2.3.24
    +
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        isCaseInsensitive

        +
        public boolean isCaseInsensitive()
        +
        • +
      + + + +
        +
      • +

        setCaseInsensitive

        +
        public void setCaseInsensitive(boolean caseInsensitive)
        +
        Sets if the matching will be case insensitive (UNICODE compliant); default is false.
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/843d83cc/builds/2.3.25-incubating-voted/documentation/_html/api/freemarker/cache/FileTemplateLoader.html ---------------------------------------------------------------------- diff --git a/builds/2.3.25-incubating-voted/documentation/_html/api/freemarker/cache/FileTemplateLoader.html b/builds/2.3.25-incubating-voted/documentation/_html/api/freemarker/cache/FileTemplateLoader.html new file mode 100644 index 0000000..3d0996e --- /dev/null +++ b/builds/2.3.25-incubating-voted/documentation/_html/api/freemarker/cache/FileTemplateLoader.html @@ -0,0 +1,673 @@ + + + + + + +FileTemplateLoader (FreeMarker 2.3.25-incubating API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
freemarker.cache
+

Class FileTemplateLoader

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    TemplateLoader
    +
    +
    +
    +
    public class FileTemplateLoader
+extends Object
+implements TemplateLoader
    +
    A TemplateLoader that uses files inside a specified directory as the source of templates. By default it does + security checks on the canonical path that will prevent it serving templates outside that specified + directory. If you want symbolic links that point outside the template directory to work, you need to disable this + feature by using FileTemplateLoader(File, boolean) with true second argument, but before that, check + the security implications there!
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        SYSTEM_PROPERTY_NAME_EMULATE_CASE_SENSITIVE_FILE_SYSTEM

        +
        public static String SYSTEM_PROPERTY_NAME_EMULATE_CASE_SENSITIVE_FILE_SYSTEM
        +
        By setting this Java system property to true, you can change the default of + #getEmulateCaseSensitiveFileSystem().
        +
        • +
      + + + +
        +
      • +

        baseDir

        +
        public final File baseDir
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FileTemplateLoader

        +
        @Deprecated
+public FileTemplateLoader()
+                                throws IOException
        +
        Deprecated. Relying on what the current directory is is a bad practice; use + FileTemplateLoader(File) instead.
        +
        Creates a new file template cache that will use the current directory (the value of the system property + user.dir as the base directory for loading templates. It will not allow access to template files + that are accessible through symlinks that point outside the base directory.
        +
        +
        Throws:
        +
        IOException
        +
        +
        • +
      + + + +
        +
      • +

        FileTemplateLoader

        +
        public FileTemplateLoader(File baseDir)
+                   throws IOException
        +
        Creates a new file template loader that will use the specified directory + as the base directory for loading templates. It will not allow access to + template files that are accessible through symlinks that point outside + the base directory.
        +
        +
        Parameters:
        +
        baseDir - the base directory for loading templates
        +
        Throws:
        +
        IOException
        +
        +
        • +
      + + + +
        +
      • +

        FileTemplateLoader

        +
        public FileTemplateLoader(File baseDir,
+                          boolean disableCanonicalPathCheck)
+                   throws IOException
        +
        Creates a new file template loader that will use the specified directory as the base directory for loading + templates. See the parameters for allowing symlinks that point outside the base directory.
        +
        +
        Parameters:
        +
        baseDir - the base directory for loading templates
        +
        disableCanonicalPathCheck - If true, it will not check if the file to be loaded is inside the baseDir or not, + according the canonical paths of the baseDir and the file to load. Note that + Configuration.getTemplate(String) and (its overloads) already prevents backing out from the + template directory with paths like /../../../etc/password, however, that can be circumvented + with symbolic links or other file system features. If you really want to use symbolic links that point + outside the baseDir, set this parameter to true, but then be very careful with + template paths that are supplied by the visitor or an external system.
        +
        Throws:
        +
        IOException
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        findTemplateSource

        +
        public Object findTemplateSource(String name)
+                          throws IOException
        +
        Description copied from interface: TemplateLoader
        +
        Finds the template in the backing storage and returns an object that identifies the storage location where the + template can be loaded from. See the return value for more information.
        +
        +
        Specified by:
        +
        findTemplateSource in interface TemplateLoader
        +
        Parameters:
        +
        name - The name of the template, already localized and normalized by the + cache. It is completely up to the loader implementation to + interpret the name, however it should expect to receive hierarchical paths where path components are + separated by a slash (not backslash). Backslashes (or any other OS specific separator character) are + not considered as separators by FreeMarker, and thus they will not be replaced with slash before + passing to this method, so it's up to the template loader to handle them (say, be throwing and + exception that tells the user that the path (s)he has entered is invalid, as (s)he must use slash -- + typical mistake of Windows users). The passed names are always considered relative to some + loader-defined root location (often referred as the "template root directory"), and will never start + with a slash, nor will they contain a path component consisting of either a single or a double dot -- + these are all resolved by the template cache before passing the name to the loader. As a side effect, + paths that trivially reach outside template root directory, such as ../my.ftl, will be + rejected by the template cache, so they never reach the template loader. Note again, that if the path + uses backslash as path separator instead of slash as (the template loader should not accept that), the + normalization will not properly happen, as FreeMarker (the cache) recognizes only the slashes as + separators.
        +
        Returns:
        +
        An object representing the template source, which can be supplied in subsequent calls to + TemplateLoader.getLastModified(Object) and TemplateLoader.getReader(Object, String), when those are called on the + same TemplateLoader. null must be returned if the source for the template doesn't exist; + don't throw exception then! The exact type of this object is up to the TemplateLoader + implementation. As this object is possibly used as hash key in caches, and is surly compared with another + template source for equality, it must have a proper Object.equals(Object) and + Object.hashCode()) implementation. Especially, template sources that refer to the same + physical source must be equivalent, otherwise template caching can become inefficient. This is only + expected from Object.equals(Object) when the compared template sources came from the same + TemplateLoader instance. Also, it must not influence the equality if the source is open or + closed (TemplateLoader.closeTemplateSource(Object)).
        +
        Throws:
        +
        IOException - When an error occurs that makes it impossible to find out if the template exists, or to access the + existing template. Don't throw exception if the template doesn't exist, instead return with + null then!
        +
        +
        • +
      + + + +
        +
      • +

        getLastModified

        +
        public long getLastModified(Object templateSource)
        +
        Description copied from interface: TemplateLoader
        +
        Returns the time of last modification of the specified template source. This method is called after + findTemplateSource().
        +
        +
        Specified by:
        +
        getLastModified in interface TemplateLoader
        +
        Parameters:
        +
        templateSource - an object representing a template source, obtained through a prior call to + TemplateLoader.findTemplateSource(String). This must be an object on which + TemplateLoader.closeTemplateSource(Object) wasn't applied yet.
        +
        Returns:
        +
        the time of last modification of the specified template source, or -1 if the time is not known.
        +
        +
        • +
      + + + +
        +
      • +

        getReader

        +
        public Reader getReader(Object templateSource,
+                        String encoding)
+                 throws IOException
        +
        Description copied from interface: TemplateLoader
        +
        Returns the character stream of a template represented by the specified template source. This method is possibly + called for multiple times for the same template source object, and it must always return a Reader that + reads the template from its beginning. Before this method is called for the second time (or later), its caller + must close the previously returned Reader, and it must not use it anymore. That is, this method is not + required to support multiple concurrent readers for the same source templateSource object. + +

        + Typically, this method is called if the template is missing from the cache, or if after calling + TemplateLoader.findTemplateSource(String) and TemplateLoader.getLastModified(Object) it was determined that the cached copy + of the template is stale. Then, if it turns out that the encoding parameter used doesn't match the actual + template content (based on the #ftl encoding=... header), this method will be called for a second time + with the correct encoding parameter value.

        +
        +
        Specified by:
        +
        getReader in interface TemplateLoader
        +
        Parameters:
        +
        templateSource - an object representing a template source, obtained through a prior call to + TemplateLoader.findTemplateSource(String). This must be an object on which + TemplateLoader.closeTemplateSource(Object) wasn't applied yet.
        +
        encoding - the character encoding used to translate source bytes to characters. Some loaders may not have access + to the byte representation of the template stream, and instead directly obtain a character stream. + These loaders should ignore the encoding parameter.
        +
        Returns:
        +
        A Reader representing the template character stream. It's the responsibility of the caller (which + is TemplateCache usually) to close() it. The Reader is not required to work after + the templateSource was closed (TemplateLoader.closeTemplateSource(Object)).
        +
        Throws:
        +
        IOException - if an I/O error occurs while accessing the stream.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        getBaseDirectory

        +
        public File getBaseDirectory()
        +
        Returns the base directory in which the templates are searched. This comes from the constructor argument, but + it's possibly a canonicalized version of that.
        +
        +
        Since:
        +
        2.3.21
        +
        +
        • +
      + + + +
        +
      • +

        setEmulateCaseSensitiveFileSystem

        +
        public void setEmulateCaseSensitiveFileSystem(boolean nameCaseChecked)
        +
        Intended for development only, checks if the template name matches the case (upper VS lower case letters) of the + actual file name, and if it doesn't, it emulates a file-not-found even if the file system is case insensitive. + This is useful when developing application on Windows, which will be later installed on Linux, OS X, etc. This + check can be resource intensive, as to check the file name the directories involved, up to the + getBaseDirectory() directory, must be listed. Positive results (matching case) will be cached without + expiration time. + +

        The default in FileTemplateLoader is false, but subclasses may change they by overriding + getEmulateCaseSensitiveFileSystemDefault().

        +
        +
        Since:
        +
        2.3.23
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        toString

        +
        public String toString()
        +
        Show class name and some details that are useful in template-not-found errors.
        +
        +
        Overrides:
        +
        toString in class Object
        +
        Since:
        +
        2.3.21
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +