ProductInfo (IG Aggregated Javadoc 7.2.0 Documentation)

java.lang.Object
- org.forgerock.openig.util.ProductInfo

public final class ProductInfo
extends Object

Utility class to retrieve product information.

Field Summary

Fields
Modifier and Type Field Description

static JsonValue PRODUCT_INFO
The JsonValue containing the product info.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static String`	`getBranch()`	Returns the branch name.
`static String`	`getDocumentationUrl()`	Returns the documentation URI (used in `WelcomeHandler`).
`static String`	`getName()`	Returns the product name.
`static String`	`getRevision()`	Returns the revision.
`static String`	`getShortName()`	Returns the product short name.
`static long`	`getTimeStamp()`	Returns the timestamp.
`static String`	`getVersion()`	Returns the product version.
`static void`	`init(String productInfoPath)`	Initialise the product info.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PRODUCT_INFO
```
public static final JsonValue PRODUCT_INFO
```
    The JsonValue containing the product info.
- Method Detail
  - init
```
public static void init(String productInfoPath)
```
    Initialise the product info.
    
    Parameters:
    
    productInfoPath - The path where to find the JSON file.
  - getBranch
```
public static String getBranch()
```
    Returns the branch name.
    
    Returns:
    
    the branch name.
  - getDocumentationUrl
```
public static String getDocumentationUrl()
```
    Returns the documentation URI (used in WelcomeHandler).
    
    Returns:
    
    the documentation URI.
  - getName
```
public static String getName()
```
    Returns the product name.
    
    Returns:
    
    the product name.
  - getRevision
```
public static String getRevision()
```
    Returns the revision.
    
    Returns:
    
    the revision.
  - getShortName
```
public static String getShortName()
```
    Returns the product short name.
    
    Returns:
    
    the product short name.
  - getTimeStamp
```
public static long getTimeStamp()
```
    Returns the timestamp.
    
    Returns:
    
    the timestamp.
  - getVersion
```
public static String getVersion()
```
    Returns the product version.
    
    Returns:
    
    the product version.