Package com.itextpdf.licensing.base.reporting

Class LicenseKeyReportingConfigurer

java.lang.Object

com.itextpdf.licensing.base.reporting.LicenseKeyReportingConfigurer

       public final class LicenseKeyReportingConfigurer extends Object
      

Class provides a set of static methods to configure licensekey reporting.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LOCAL_REPORTING_TYPE
static final String	REMOTE_REPORTING_TYPE

Method Summary

Modifier and Type	Method	Description
static String	getLocalFileRootDir()	Gets the root directory for local reporting.
static com.itextpdf.licensing.base.licensefile.ReportingType	getReportingType()	Gets the current reporting type as ReportingType instance.
static boolean	isStatisticsEnabledForProduct(String productName)	Checks if statistics are enabled for such productName.
static void	overrideStatisticsSendingForProduct(String productName, boolean sendStatistics)	Enables or disables statistics for provided product.
static void	resetApiConfiguration()	Reset API configuration.
static void	useLocalReporting(String directoryToWritePath)	Select local reporting type with specified root directory for generated reports.
static void	useRemoteReporting()	Select remote reporting type in which events are sent over the web to a remote server.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

REMOTE_REPORTING_TYPE

             public static final String REMOTE_REPORTING_TYPE
            

See Also:

• Constant Field Values

LOCAL_REPORTING_TYPE

             public static final String LOCAL_REPORTING_TYPE
            

See Also:

• Constant Field Values

Method Details

useRemoteReporting

             public static void useRemoteReporting()
            

Select remote reporting type in which events are sent over the web to a remote server.

useLocalReporting

             public static void useLocalReporting
             (String directoryToWritePath)
            

Select local reporting type with specified root directory for generated reports.

Parameters:

directoryToWritePath - the path to local directory for writing reports. If it is null, then System property, or System environment variable will be used.

Throws:

IllegalArgumentException - in case of invalid directory path

resetApiConfiguration

             public static void resetApiConfiguration()
            

Reset API configuration. Can be used to use environment variables or default logic after API use.

getReportingType

             public static com.itextpdf.licensing.base.licensefile.ReportingType getReportingType()
            

Gets the current reporting type as ReportingType instance.

Returns:

the current reporting type

getLocalFileRootDir

             public static String getLocalFileRootDir()
            

Gets the root directory for local reporting.

Returns:

the root directory for local reporting

isStatisticsEnabledForProduct

             public static boolean isStatisticsEnabledForProduct
             (String productName)
            

Checks if statistics are enabled for such productName.

Parameters:

productName - name of the product for which to check if statistics are enabled

Returns:

true if statistics are enabled, false otherwise

overrideStatisticsSendingForProduct

             public static void overrideStatisticsSendingForProduct
             (String productName, boolean sendStatistics)
            

Enables or disables statistics for provided product. By default the value from license file will be taken.

Parameters:

productName - name of the product for which enable or disable statistics

sendStatistics - true to enable statistics, false otherwise