Package org.apache.openjpa.lib.conf

Interface ProductDerivation

    • Method Detail

      • getType

        int getType()
        Return the type of derivation.

      • getConfigurationPrefix

        java.lang.String getConfigurationPrefix()
        Return the configuration prefix for properties of this product.

      • validate

        void validate()
       throws java.lang.Exception
        Ensure that this derivation is valid. This action might consist of loading classes for the product this derivation represents to be sure they exist. Throw any throwable to indicate an invalid derivation. Invalid derivations will not be used.
        Throws:
        java.lang.Exception

      • loadGlobals

        ConfigurationProvider loadGlobals​(java.lang.ClassLoader loader)
                           throws java.lang.Exception
        Load globals into the returned ConfigurationProvider, or return null if no globals are found.
        Throws:
        java.lang.Exception

      • loadDefaults

        ConfigurationProvider loadDefaults​(java.lang.ClassLoader loader)
                            throws java.lang.Exception
        Load defaults into the returned ConfigurationProvider, or return null if no defaults are found.
        Throws:
        java.lang.Exception

      • load

        ConfigurationProvider load​(java.lang.String resource,
                           java.lang.String anchor,
                           java.lang.ClassLoader loader)
                    throws java.lang.Exception
        Load the given given resource into the returned ConfigurationProvider, or return null if it is not a resource this receiver understands. The given class loader may be null.
        Parameters:
        anchor - optional named anchor within a multiple-configuration resource
        Throws:
        java.lang.Exception

      • load

        ConfigurationProvider load​(java.io.File file,
                           java.lang.String anchor)
                    throws java.lang.Exception
        Load given file, or return null if it is not a file this receiver understands.
        Parameters:
        anchor - optional named anchor within a multiple-configuration file
        Throws:
        java.lang.Exception

      • getDefaultResourceLocation

        java.lang.String getDefaultResourceLocation()
        Return a string identifying the default resource location for this product derivation, if one exists. If there is no default location, returns null.
        Since:
        1.1.0

      • getAnchorsInFile

        java.util.List<java.lang.String> getAnchorsInFile​(java.io.File file)
                                           throws java.io.IOException,
                                                  java.lang.Exception
        Return a List of all the anchors defined in file. The returned names are not fully-qualified, so must be used in conjunction with file in calls to load(java.io.File, String). Returns null or an empty list if no anchors could be found.
        Throws:
        java.io.IOException
        java.lang.Exception
        Since:
        1.1.0

      • getAnchorsInResource

        java.util.List<java.lang.String> getAnchorsInResource​(java.lang.String resource)
                                               throws java.lang.Exception
        Return a List of all the anchors defined in resource. The returned names are not fully-qualified, so must be used in conjunction with resource in calls to load(java.io.File, String). Returns null or an empty list if no anchors could be found.
        Throws:
        java.lang.Exception
        Since:
        1.1.0

      • beforeConfigurationConstruct

        boolean beforeConfigurationConstruct​(ConfigurationProvider cp)
        Provides the instance with a callback to mutate the initial properties of the ConfigurationProvider. This is primarily to alter or add properties that determine what type of configuration is constructed, and therefore is typically used at runtime only.
        Returns:
        true if given ConfigurationProvider has been mutated.

      • beforeConfigurationLoad

        boolean beforeConfigurationLoad​(Configuration conf)
        Provides the instance with the opportunity to mutate conf before the user configuration is applied.
        Returns:
        true if given Configuration has been mutated.

      • afterSpecificationSet

        boolean afterSpecificationSet​(Configuration conf)
        Called after the specification has been set.
        Returns:
        true if given Configuration has been mutated.

      • beforeConfigurationClose

        void beforeConfigurationClose​(Configuration conf)
        Called before the given Configuration is closed.
        Since:
        0.9.7

      • getSupportedQueryHints

        java.util.Set<java.lang.String> getSupportedQueryHints()
        Return set of Query hint keys recognized by this receiver.
        Since:
        2.0.0