Package org.forgerock.opendj.server.core

Class ProductInformation

  • public final class ProductInformation
extends Object
    OpenDJ product information, including version number, build information, and references to documentation.

    • Method Detail

      • getInstance

        public static ProductInformation getInstance()
        Returns the singleton product information instance.
        Returns:
        The singleton product information instance.

      • buildId

        public String buildId()
        Returns the build ID for the generated build of the Directory Server.
        Returns:
        The build ID for the generated build of the Directory Server.

      • buildIsDebug

        public boolean buildIsDebug()
        Returns true if this is a debug build of the Directory Server that may include additional debugging facilities not available in standard release versions.
        Returns:
        true if this is a debug build of the Directory Server that may include additional debugging facilities not available in standard release versions.

      • buildJavaVendor

        public String buildJavaVendor()
        Returns the vendor for the Java version used to generate this build.
        Returns:
        The vendor for the Java version used to generate this build.

      • buildJavaVersion

        public String buildJavaVersion()
        Returns the Java version used to generate this build.
        Returns:
        The Java version used to generate this build.

      • buildJvmVendor

        public String buildJvmVendor()
        Returns the vendor for the JVM used to generate this build.
        Returns:
        The vendor for the JVM used to generate this build.

      • buildJvmVersion

        public String buildJvmVersion()
        Returns the JVM version used to generate this build.
        Returns:
        The JVM version used to generate this build.

      • buildOs

        public String buildOs()
        Returns the operating system on which this build was generated.
        Returns:
        The operating system on which this build was generated.

      • buildUser

        public String buildUser()
        Returns the username of the user that created this build.
        Returns:
        The username of the user that created this build.

      • documentationAdminGuideUrl

        public String documentationAdminGuideUrl()
        Returns the URL of the product WIKI page.
        Returns:
        The URL of the product WIKI page.

      • documentationHomePageUrl

        public String documentationHomePageUrl()
        Returns the URL of the product home page.
        Returns:
        The URL of the product home page.

      • documentationReferenceGuideUrl

        public String documentationReferenceGuideUrl()
        Returns the URL of the product WIKI page.
        Returns:
        The URL of the product WIKI page.

      • documentationWikiUrl

        public String documentationWikiUrl()
        Returns the URL of the product WIKI page.
        Returns:
        The URL of the product WIKI page.

      • patchFixIds

        public String patchFixIds()
        Returns the set of bug IDs for fixes included in this build of the Directory Server.
        Returns:
        The set of bug IDs for fixes included in this build of the Directory Server.

      • productName

        public String productName()
        Returns the full product name for the Directory Server, which may contain white space.
        Returns:
        The full product name for the Directory Server.

      • productPublicationDate

        public String productPublicationDate()
        Returns the product publication date.
        Returns:
        The product publication date.

      • productReleaseDate

        public String productReleaseDate()
        Returns the product release date.
        Returns:
        The product release date.

      • productShortName

        public String productShortName()
        Returns the short product name for the Directory Server, suitable for use in file names.
        Returns:
        The short product name for the Directory Server.

      • scmRevision

        public String scmRevision()
        Returns the revision number of the source repository on which this build is based.
        Returns:
        The revision number of the source repository on which this build is based.

      • scmUrl

        public String scmUrl()
        Returns the URL of the source repository location on which this build is based.
        Returns:
        The URL of the source repository location on which this build is based.

      • version

        public String version()
        Returns the version number for the Directory Server. The return string will have the format major.minor.point[-qualifier].
        Returns:
        The version number for the Directory Server.

      • versionBuildNumber

        public int versionBuildNumber()
        Returns the build number for the Directory Server.
        Returns:
        The build number for the Directory Server.

      • versionCompact

        public String versionCompact()
        Returns the compact version string for this product, suitable for use in path names and similar cases.
        Returns:
        The compact version string for this product, suitable for use in path names and similar cases.

      • versionFull

        public String versionFull()
        Returns the full version string for this product.
        Returns:
        The full version string for this product.

      • versionMajorNumber

        public int versionMajorNumber()
        Returns the major version number for the Directory Server.
        Returns:
        The major version number for the Directory Server.

      • versionMinorNumber

        public int versionMinorNumber()
        Returns the minor version number for the Directory Server.
        Returns:
        The minor version number for the Directory Server.

      • versionPointNumber

        public int versionPointNumber()
        Returns the point version number for the Directory Server.
        Returns:
        The point version number for the Directory Server.

      • versionPrintable

        public String versionPrintable()
        Returns the printable version string for this product.
        Returns:
        The printable version string for this product.

      • versionQualifier

        public String versionQualifier()
        Returns the version qualifier string for the Directory Server.
        Returns:
        The version qualifier string for the Directory Server.

      • versionRevision

        public String versionRevision()
        Returns the revision number of the source repository on which this build is based.
        Returns:
        The revision number of the source repository on which this build is based.