graphdb-workbench
Version:
The web application for GraphDB APIs
68 lines (67 loc) • 3.03 kB
TypeScript
import { HttpService } from '../http/http.service';
import { LicenseResponse } from './response/license-response';
/**
* Service class for handling REST API calls related to license operations.
* Extends the HttpService to utilize its HTTP request capabilities.
*/
export declare class LicenseRestService extends HttpService {
private readonly LICENSE_ENDPOINT;
private readonly LICENSE_INFO_ENDPOINT;
/**
* Retrieves the current license information from the GraphDB settings.
*
* This method sends a GET request to the '/rest/graphdb-settings/license' endpoint
* to fetch the license details.
*
* @returns A Promise that resolves to a License object containing the current license information.
*/
getLicense(): Promise<LicenseResponse>;
/**
* Checks if the license is hardcoded in the system.
*
* This method sends a GET request to the '/rest/graphdb-settings/license/hardcoded' endpoint
* to determine if the license is hardcoded.
*
* @returns A Promise that resolves to a string indicating whether the license is hardcoded.
*/
getIsLicenseHardcoded(): Promise<boolean>;
/**
* Registers a new license using the provided license code.
*
* This method sends a POST request to the '/rest/graphdb-settings/license' endpoint
* with the provided license code in the request body.
*
* @param licenseCode - The license code as a base64 encoded string to be registered.
* @returns A Promise that resolves to a LicenseResponse object containing the registered license information.
*/
registerLicense(licenseCode: string): Promise<LicenseResponse>;
/**
* Unregisters the current license from the system.
*
* This method sends a DELETE request to the '/rest/graphdb-settings/license' endpoint
* to remove the existing license.
*
* @returns A Promise that resolves when the license has been successfully unregistered.
*/
unregisterLicense(): Promise<void>;
/**
* Extracts license information from a given license file.
*
* This method uploads the provided license file to the '/rest/info/license/to-base-64' endpoint
* and retrieves the extracted license information in base64 format.
*
* @param file - The license file to be uploaded and processed.
* @returns A Promise that resolves to a string containing the extracted license information in base64 format.
*/
extractFromLicenseFile(file: File): Promise<string>;
/**
* Validates a given license code.
*
* This method sends a POST request to the '/rest/info/license/validate' endpoint
* with the provided license code in the request body for validation.
*
* @param licenseCode - The license code as base64 encoded string to be validated.
* @returns A Promise that resolves to a LicenseResponse object containing the validation result.
*/
validateLicense(licenseCode: string): Promise<LicenseResponse>;
}