configure

Interface Information

>This API belongs to SentinelLicensing.jar.

>The corresponding library is Sentinel RMS licensing library.

static void configure(Attribute attribute)
throws LicensingException, UnsupportedEncodingException

Description

Use this API to configure the RMS licensing library. The supported licensing library configurations include:

>Enabling trace writer file for troubleshooting. By default, tracing is disabled for the licensing library (refer to attributes no. 1 and 2)

>Customizing the default standalone license filename/path (refer to attributes no. 3)

>Determining whether to configure SCP using configuration file or this API (refer to attributes no. 4)

>Setting Cloud LM configuration (refer to attributes no. 5 and 6)

>Setting lease configuration (refer to attributes no. 7 to 20)

NOTE To configure lease, it is mandatory to set customer, YPS address, and Fingerprint Friendly name fields.

The API must be called before creating the first application context because the library configuration becomes effective at the time of first application context creation. The library configuration cannot be modified later.

Syntax

Argument	Description
attribute [In]	Pointer to the attribute object. The attributes that can be set are described below.

Argument

Description

attribute [In]

Pointer to the attribute object.

The attributes that can be set are described below.

Attributes

Attribute for...

Key and Description

Trace Level Supported in On-premises mode

>Attribute Key - SNTL_ATTR_CONFIG_TRACE_LEVEL

>This attribute is used for setting the client trace level required by the client trace writer file and custom trace writer.

>The allowed values are:

•SNTL_ATTR_CONFIG_TRACE_ERROR - Traces the errors encountered on run-time.

•SNTL_ATTR_CONFIG_TRACE_FUNCTION - Traces the major licensing API functions along with errors encountered at run-time. This option also includes the traces encountered at runtime (SNTL_ATTR_CONFIG_TRACE_ERROR).

•By default, client tracing is disabled (default)

Trace Writer File name Supported in On-premises mode

>Attribute Key - SNTL_ATTR_CONFIG_TRACE_WRITER_FILE

>This attribute is used for setting the client trace writer filename.

>The RMS library writes traces to this file based on the specified client trace level.

>To use the client trace writer file, set the client trace level attribute (mandatory).

NOTE Tracing will not be enabled for API calls placed before application context creation.

License File name Supported in On-premises mode

>Attribute Key - SNTL_ATTR_CONFIG_LSERVRC_FILE

>This attribute is used for customizing the license file name/path. The default license filename is lservrc.

>On Windows platform, support is also provided for Unicode-based filename/path.

>If multiple standalone applications from different vendors are installed on a system then, use this attribute to allow over-ridding the default license filename/path for each vendor application.

SCP configuration file usage Supported in Lease mode

>Attribute Key - SNTL_ATTR_CONFIG_SCP_USE_CONFIG_FILE

>This attribute is used to set the SCP configuration setting.

>The allowed values are:

• Yes (Default) - Configure using the SCP configuration file.

•No - Configure using this API (sntl_licensing_configure) and ignoring the SCP configuration file.

Tenant Host Address Supported in Connected (Cloud LM) mode

Registration Token Supported in Connected (Cloud LM) mode

YPS Address Supported in Lease mode

>Attribute Key - SNTL_ATTR_CONFIG_SCP_YPS_ADDRESS

>This is a mandatory attribute that is used to define the URL of the server machine (cloud instance) where Directory Service is deployed.

>The URL uses https://<YPS_HOSTS>/YPServer format. Where,YPS_HOSTS is the domain name of the Directory Services (DS) machine.

Fingerprint Friendly Name Supported in Lease mode

>Attribute Key - SNTL_ATTR_CONFIG_SCP_FINGERPRINT_FRIENDLYNAME

>This is a mandatory attribute that is used to specify the host name.

Customer List Supported in Lease mode

>Attribute Key - SNTL_ATTR_CONFIG_SCP_CUSTOMER_LIST

>Customer list is defined using add_object API, which is used to add a customer object in the configure object.

>This customer object contains the customer id, which is defined using set API.

Customer Id

>Attribute Key - SNTL_ATTR_CONFIG_SCP_CUSTOMERID

>This is a mandatory attribute that determines the specific customer whose product/line item is to be fetched from the entitlements.

NOTE At present, SCP supports single customer at a time.

Product Key List Supported in Lease mode

>Attribute Key - SNTL_ATTR_CONFIG_SCP_PRODUCT_KEY_LIST

>This attribute is used to add product object in the customer object.

>This product object contains the Product key id and product variant attributes (listed below), which is defined using set API.

Product Key id

>Attribute Key - SNTL_ATTR_CONFIG_SCP_PKID

>This is a mandatory attribute that determines the specific product/line item to be fetched from the entitlements.

NOTE If you don't set this attribute, it would fetch all the products/line items available in an entitlement for the specified customer.

NOTE After configuring this attribute, ensure to add it in the customer list attribute.

Product Variant Supported in Lease mode

>Attribute Key - SNTL_ATTR_CONFIG_SCP_PRODUCT_VARIANT

>This attribute sets the product variant for the license to retrieve. This is an optional property and is used when the fingerprint registration is disabled from EMS. The attribute is applicable only for version-less products.

Product Quantity Supported in Lease mode

>Attribute Key - SNTL_ATTR_CONFIG_SCP_PRODUCT_QUANTITY

>This attribute sets the product quantity for the license to retrieve. This is an optional property and used when the fingerprint registration is disabled from EMS.

Connection Timeout Supported in Lease mode

>Attribute Key - SNTL_ATTR_CONFIG_SCP_CONNECTION_TIMEOUT

This is an optional attribute that is used to set the session timeout interval.

Retry Count Supported in Lease mode

>Attribute Key - SNTL_ATTR_CONFIG_SCP_CONNECTION_RETRY_COUNT

>This is an optional attribute that is used to manage the number of reconnection attempts if there is a connection failure.

Proxy Mode Supported in Lease mode

>Attribute Key - SNTL_ATTR_CONFIG_SCP_PROXY_MODE

>This attribute is used to define the proxy connection mode.

>The allowed values are:

•1: It indicates that the proxy is disabled.

•2: It refers to the manual proxy mode. In this mode, you need to manually set the proxy settings.

NOTE The licensed application will not connect to the cloud if the client machine is in a proxy environment and proxy settings for SCP are not defined.

•3: It refers to the auto proxy mode. In this mode, the proxy settings are automatically detected.

For more information on proxy mode, see Configure Proxy Settings.

Proxy Host Supported in Lease mode

>Attribute Key - SNTL_ATTR_CONFIG_SCP_PROXY_HOST

>This attribute is used to set the proxy host name or IP address.

Proxy User Supported in Lease mode

>Attribute Key - SNTL_ATTR_CONFIG_SCP_PROXY_USER

>This attribute is used to set the user name for proxy authentication.

Proxy Password Supported in Lease mode

>Attribute Key - SNTL_ATTR_CONFIG_SCP_PROXY_PASSWORD

>This attribute is used to set the password for proxy authentication

Proxy Port Number Supported in Lease mode

>Attribute Key - SNTL_ATTR_CONFIG_SCP_PROXY_PORT

>This attribute is used to define the port number of the proxy server.

Proxy PAC

>Attribute Key - SNTL_ATTR_CONFIG_SCP_PROXY_PAC

>This attribute sets the location of the auto-proxy configuration (.pac) file to be used for proxy detection. Use this option in the case of auto-proxy with the .pac file support.

>The allowed values are:

•URL of the .pac file

•Path of the .pac file

Exception Handling

If unsuccessful, throws LicensingException or UnsupportedEncodingException.