Package com.tangosol.io.pof

Class PofIndexer

java.lang.Object
com.tangosol.io.pof.PofIndexer
public class PofIndexer extends Object
This class is responsible for creating or reading POF index files.
Since:
Coherence 24.09
Author:
Gunnar Hillert 2024.03.04

  • Field Details

  • Constructor Details

    • PofIndexer

      public PofIndexer()
      Default constructor.

    • PofIndexer

      public PofIndexer(com.tangosol.io.pof.generator.PortableTypeGenerator.Logger logger)
      Constructor with the ability to pass a PortableTypeGenerator.Logger.
      Parameters:
      logger - the PortableTypeGenerator.Logger to use

    • PofIndexer

      public PofIndexer(ClassLoader classLoader)
      Constructor that allows to specify a custom ClassLoader.
      Parameters:
      classLoader - the ClassLoader to set

    • PofIndexer

      public PofIndexer(ClassLoader classLoader, com.tangosol.io.pof.generator.PortableTypeGenerator.Logger logger)
      Constructor that allows to specify a custom ClassLoader as well as a PortableTypeGenerator.Logger.
      Parameters:
      classLoader - the ClassLoader to set
      logger - the PortableTypeGenerator.Logger to use

  • Method Details

    • createIndexInDirectory

      public void createIndexInDirectory(File pofIndexFileDirectory)
      Creates a POF index file at the specified base directory. By default, the index will be created in the subdirectory META-INF/pof.idx.
      Parameters:
      pofIndexFileDirectory - must be a directory

    • createIndex

      public void createIndex(File pofIndexFile)
      Creates an index file containing the discovered PortableType annotated classes.
      Parameters:
      pofIndexFile - the file that will contain the index of PortableType annotated classes

    • discoverPortableTypes

      protected Map<String,Integer> discoverPortableTypes()
      Scans for PortableType annotated classes. The returned Map contains the class name as the key and the POF id as its value. Keep in mind that the POF id can currently only be returned for classes obtained via the classpath but not from actual class files or JAR files.
      Returns:
      a Map containing the class name and the POF id if possible

    • getPortableTypeIdForClassName

      public int getPortableTypeIdForClassName(String classname)
      Returns the id value of an PortableType annotated class.
      Parameters:
      classname - the class name with the PortableType annotation
      Returns:
      returns the portable id

    • loadIndexes

      public Map<URL,Properties> loadIndexes()
      Attempt to load all POF index files which will we will use to load classes that have the PortableType annotation.
      Returns:
      a Map of Properties keyed by URL or an empty Map if none found.

    • setIndexFileName

      public void setIndexFileName(String sIndexFileName)
      Specifies the POF index file and its path to use. If not set, it will default to DEFAULT_INDEX_FILE_NAME.
      Parameters:
      sIndexFileName - the POF index file.

    • setPackagesToScan

      public void setPackagesToScan(Set<String> packagesToScan)
      Specifies the JAVA packages to scan for PortableType annotations. This option is only valid for scanning the classpath and thus if ignoreClasspath(boolean) is not set to true.
      Parameters:
      packagesToScan - the java package names to scan

    • setIncludeFilterPatterns

      public void setIncludeFilterPatterns(Set<String> m_includeFilterPatterns)
      Allows to set regular expressions for classes to be included. E.g. if you want to have only classes included in the POF that end in Address, specify a regular expression string of {code .*Address$}.
      Parameters:
      m_includeFilterPatterns - add a Set of regular expression strings

    • createJarURI

      public URI createJarURI(File jarFile)
      Construct a Jar file URI.
      Parameters:
      jarFile - the File representing a Jar file
      Returns:
      a URI in the Jar URI syntax

    • createJarURL

      public URL createJarURL(File jarFile)
      Helper method to create a JAR file URL. Will call createJarURI(File) underneath. Will not throw any checked exceptions.
      Parameters:
      jarFile - the JAR file for which to return the corresponding URL
      Returns:
      the URL that points to the provided JAR file

    • ignoreClasspath

      public PofIndexer ignoreClasspath(boolean fIgnoreClasspath)
      Ignore the classpath when scanning for classes by setting this property to true. by default this property is false. This can be useful when indexing of actual class or Jar files.
      Parameters:
      fIgnoreClasspath - if true, do not index classes on the classpath
      Returns:
      this PofIndexer

    • withClassesFromDirectory

      public PofIndexer withClassesFromDirectory(Collection<File> directories)
      Add the directory on the file system to read the class files from.
      Parameters:
      directories - the directories on the file system to read the class files from
      Returns:
      this PofIndexer

    • withClassesFromJarFile

      public PofIndexer withClassesFromJarFile(List<File> jarFiles)
      Add one or more JAR files on the file system to read the class files from.
      Parameters:
      jarFiles - the List of JAR files on the file system to read the class files from
      Returns:
      this PofIndexer

    • withClasses

      public PofIndexer withClasses(List<Class> clazzes)
      Add a List of Classes.
      Parameters:
      clazzes - the classes to import
      Returns:
      this PofIndexer

    • withIndexFileName

      public PofIndexer withIndexFileName(String indexFileName)
      Specify the index file name and path. If not specified it will default to DEFAULT_INDEX_FILE_NAME.
      Parameters:
      indexFileName - the path and index file name
      Returns:
      this PofIndexer