cloud.metaapi.sdk.meta_api

Class ProvisioningProfile

java.lang.Object

cloud.metaapi.sdk.meta_api.ProvisioningProfile

public class ProvisioningProfile
extends Object

Implements a provisioning profile entity

Constructor Summary

Constructors

Constructor and Description
ProvisioningProfile(ProvisioningProfileDto data, ProvisioningProfileClient provisioningProfileClient) Constructs a provisioning profile entity

Method Summary

Modifier and Type	Method and Description
String	getBrokerDSTSwitchTimezone() Returns broker DST timezone name from Time Zone Database
String	getBrokerTimezone() Returns broker timezone name from Time Zone Database
String	getId() Returns profile id
String	getName() Returns profile name
String	getStatus() Returns profile status.
int	getVersion() Returns profile version.
CompletableFuture<Void>	reload() Reloads provisioning profile from API
CompletableFuture<Void>	remove() Removes provisioning profile.
CompletableFuture<Void>	update(ProvisioningProfileUpdateDto profile) Updates provisioning profile
CompletableFuture<Void>	uploadFile(String fileName, InputStream fileContents) Uploads a file to provisioning profile.
CompletableFuture<Void>	uploadFile(String fileName, String filePath) Uploads a file to provisioning profile.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProvisioningProfile

public ProvisioningProfile(ProvisioningProfileDto data,
                           ProvisioningProfileClient provisioningProfileClient)

Constructs a provisioning profile entity

Parameters:

data - provisioning profile data

provisioningProfileClient - provisioning profile REST API client

Method Detail

getId

public String getId()

Returns profile id

Returns:

profile id

getName

public String getName()

Returns profile name

Returns:

profile name

getVersion

public int getVersion()

Returns profile version. Possible values are 4 and 5

Returns:

profile version

getStatus

public String getStatus()

Returns profile status. Possible values are new and active

Returns:

profile status

getBrokerTimezone

public String getBrokerTimezone()

Returns broker timezone name from Time Zone Database

Returns:

broker timezone name

getBrokerDSTSwitchTimezone

public String getBrokerDSTSwitchTimezone()

Returns broker DST timezone name from Time Zone Database

Returns:

broker DST timezone name

reload

public CompletableFuture<Void> reload()

Reloads provisioning profile from API

Returns:

completable future resolving when provisioning profile is updated

remove

public CompletableFuture<Void> remove()

Removes provisioning profile. The current object instance should be discarded after returned promise resolves.

Returns:

completable future resolving when provisioning profile is removed

uploadFile

public CompletableFuture<Void> uploadFile(String fileName,
                                          String filePath)

Uploads a file to provisioning profile.

Parameters:

fileName - name of the file to upload. Allowed values are servers.dat for MT5 profile, broker.srv for MT4 profile

filePath - path to a file to upload

Returns:

completable future which resolves when the file was uploaded

uploadFile

public CompletableFuture<Void> uploadFile(String fileName,
                                          InputStream fileContents)

Uploads a file to provisioning profile.

Parameters:

fileName - name of the file to upload. Allowed values are servers.dat for MT5 profile, broker.srv for MT4 profile

fileContents - input stream containing file contents

Returns:

completable future which resolves when the file was uploaded

update

public CompletableFuture<Void> update(ProvisioningProfileUpdateDto profile)

Updates provisioning profile

Parameters:

profile - provisioning profile update

Returns:

completable future resolving when provisioning profile is updated