Package com.itextpdf.licensekey

Class LicenseKeyVolumeConfigurer

java.lang.Object

com.itextpdf.licensekey.LicenseKeyVolumeConfigurer

       public final class LicenseKeyVolumeConfigurer extends Object
      

The static API configurer for volume license reporting

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LOCAL_FILE_DIR_PATH_ENVIRONMENT_VARIABLE_NAME
static final String	LOCAL_FILE_DIR_PATH_PROPERTY_NAME
static final String	LOCAL_REPORTING
static final String	REMOTE_REPORTING
static final String	REPORTING_TYPE_ENVIRONMENT_VARIABLE_NAME
static final String	REPORTING_TYPE_PROPERTY_NAME

Method Summary

Modifier and Type	Method	Description
static void	resetApiConfiguration()	Reset API configuration.
static void	useLocalReporting(String directoryToWritePath)	Select local reporting type for License Key Volume 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

REPORTING_TYPE_ENVIRONMENT_VARIABLE_NAME

             public static final String REPORTING_TYPE_ENVIRONMENT_VARIABLE_NAME
            

See Also:

• Constant Field Values

REPORTING_TYPE_PROPERTY_NAME

             public static final String REPORTING_TYPE_PROPERTY_NAME
            

See Also:

• Constant Field Values

LOCAL_FILE_DIR_PATH_ENVIRONMENT_VARIABLE_NAME

             public static final String LOCAL_FILE_DIR_PATH_ENVIRONMENT_VARIABLE_NAME
            

See Also:

• Constant Field Values

LOCAL_FILE_DIR_PATH_PROPERTY_NAME

             public static final String LOCAL_FILE_DIR_PATH_PROPERTY_NAME
            

See Also:

• Constant Field Values

REMOTE_REPORTING

             public static final String REMOTE_REPORTING
            

See Also:

• Constant Field Values

LOCAL_REPORTING

             public static final String LOCAL_REPORTING
            

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 for License Key Volume with specified root directory for generated reports

Parameters:

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

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.