wilma-service-api-net 2.5.1

.NET Framework 4.8 This package targets .NET Framework 4.8. The package is compatible with this framework or higher. 
dotnet add package wilma-service-api-net --version 2.5.1
                    


                    

                
NuGet\Install-Package wilma-service-api-net -Version 2.5.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="wilma-service-api-net" Version="2.5.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="wilma-service-api-net" Version="2.5.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="wilma-service-api-net" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add wilma-service-api-net --version 2.5.1
                    


                    

                
#r "nuget: wilma-service-api-net, 2.5.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#addin nuget:?package=wilma-service-api-net&version=2.5.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=wilma-service-api-net&version=2.5.1
                    


                            Install as a Cake Tool

<a name='contents'></a>

Contents #

<a name='assembly'></a>

wilma-service-api-net # =

<a name='T-epam-wilma_service_api-ILogger'></a>

ILogger # =

Namespace

epam.wilma_service_api

Summary

ILogger interface. Implement this to support WilmaService logging.

<a name='M-epam-wilma_service_api-ILogger-Debug-System-String,System-Object[]-'></a>

Debug(format,prs) method # =

Summary

Debug

Parameters
Name Type Description
format System.String Format string.
prs System.Object[] Parameters

<a name='M-epam-wilma_service_api-ILogger-Error-System-String,System-Object[]-'></a>

Error(format,prs) method # =

Summary

Error

Parameters
Name Type Description
format System.String Format string.
prs System.Object[] Parameters

<a name='M-epam-wilma_service_api-ILogger-Info-System-String,System-Object[]-'></a>

Info(format,prs) method # =

Summary

Info

Parameters
Name Type Description
format System.String Format string.
prs System.Object[] Parameters

<a name='M-epam-wilma_service_api-ILogger-Warning-System-String,System-Object[]-'></a>

Warning(format,prs) method # =

Summary

Warning

Parameters
Name Type Description
format System.String Format string.
prs System.Object[] Parameters

<a name='T-epam-wilma_service_api-ServiceCommClasses-LoadInformation'></a>

LoadInformation # =

Namespace

epam.wilma_service_api.ServiceCommClasses

Summary

Wilma Service Load Information.

<a name='P-epam-wilma_service_api-ServiceCommClasses-LoadInformation-CountOfMessages'></a>

CountOfMessages property # =

Summary

Messages count.

<a name='P-epam-wilma_service_api-ServiceCommClasses-LoadInformation-DeletedFilesCount'></a>

DeletedFilesCount property # =

Summary

Deleted files count.

<a name='P-epam-wilma_service_api-ServiceCommClasses-LoadInformation-LoggerQueueSize'></a>

LoggerQueueSize property # =

Summary

Logger queue size.

<a name='P-epam-wilma_service_api-ServiceCommClasses-LoadInformation-ResponseQueueSize'></a>

ResponseQueueSize property # =

Summary

Response queue size.

<a name='T-epam-wilma_service_api-ServiceCommClasses-LocalhostControlStatus'></a>

LocalhostControlStatus # =

Namespace

epam.wilma_service_api.ServiceCommClasses

Summary

LocalhostControlStatus class.

<a name='P-epam-wilma_service_api-ServiceCommClasses-LocalhostControlStatus-LocalhostMode'></a>

LocalhostMode property # =

Summary

LocalhostMode

<a name='T-epam-wilma_service_api-WilmaService-LocalhostControlStatusEnum'></a>

LocalhostControlStatusEnum # =

Namespace

epam.wilma_service_api.WilmaService

Summary

LocalhostControlStatuses

<a name='F-epam-wilma_service_api-WilmaService-LocalhostControlStatusEnum-Error'></a>

Error constants # =

Summary

Communication error.

<a name='F-epam-wilma_service_api-WilmaService-LocalhostControlStatusEnum-Off'></a>

Off constants # =

Summary

Off.

<a name='F-epam-wilma_service_api-WilmaService-LocalhostControlStatusEnum-On'></a>

On constants # =

Summary

On.

<a name='T-epam-wilma_service_api-ServiceCommClasses-LoggingStatus'></a>

LoggingStatus # =

Namespace

epam.wilma_service_api.ServiceCommClasses

Summary

LoggingStatus class.

<a name='P-epam-wilma_service_api-ServiceCommClasses-LoggingStatus-RequestLogging'></a>

RequestLogging property # =

Summary

Request logging

<a name='P-epam-wilma_service_api-ServiceCommClasses-LoggingStatus-ResponseLogging'></a>

ResponseLogging property # =

Summary

Response logging

<a name='T-epam-wilma_service_api-WilmaService-MessageLoggingStatusEnum'></a>

MessageLoggingStatusEnum # =

Namespace

epam.wilma_service_api.WilmaService

Summary

MessageLoggingStatusEnum

<a name='F-epam-wilma_service_api-WilmaService-MessageLoggingStatusEnum-Error'></a>

Error constants # =

Summary

Communication error.

<a name='F-epam-wilma_service_api-WilmaService-MessageLoggingStatusEnum-Off'></a>

Off constants # =

Summary

Off.

<a name='F-epam-wilma_service_api-WilmaService-MessageLoggingStatusEnum-On'></a>

On constants # =

Summary

On.

<a name='T-epam-wilma_service_api-ServiceCommClasses-MessageMarkingStatus'></a>

MessageMarkingStatus # =

Namespace

epam.wilma_service_api.ServiceCommClasses

Summary

MessageMarkingStatus class.

<a name='P-epam-wilma_service_api-ServiceCommClasses-MessageMarkingStatus-MessageMarking'></a>

MessageMarking property # =

Summary

MessageMarking Mode

<a name='T-epam-wilma_service_api-WilmaService-MessageMarkingStatusEnum'></a>

MessageMarkingStatusEnum # =

Namespace

epam.wilma_service_api.WilmaService

Summary

MessageMarkingStatusEnum

<a name='F-epam-wilma_service_api-WilmaService-MessageMarkingStatusEnum-Error'></a>

Error constants # =

Summary

Communication error.

<a name='F-epam-wilma_service_api-WilmaService-MessageMarkingStatusEnum-Off'></a>

Off constants # =

Summary

Off.

<a name='F-epam-wilma_service_api-WilmaService-MessageMarkingStatusEnum-On'></a>

On constants # =

Summary

On.

<a name='T-epam-wilma_service_api-ServiceCommClasses-OperationMode'></a>

OperationMode # =

Namespace

epam.wilma_service_api.ServiceCommClasses

Summary

OperationMode class.

<a name='P-epam-wilma_service_api-ServiceCommClasses-OperationMode-ProxyMode'></a>

ProxyMode property # =

Summary

Proxy

<a name='P-epam-wilma_service_api-ServiceCommClasses-OperationMode-StubMode'></a>

StubMode property # =

Summary

Stub

<a name='P-epam-wilma_service_api-ServiceCommClasses-OperationMode-WilmaMode'></a>

WilmaMode property # =

Summary

Wilma

<a name='T-epam-wilma_service_api-WilmaService-OperationModeEnum'></a>

OperationModeEnum # =

Namespace

epam.wilma_service_api.WilmaService

Summary

OperationModeEnum

<a name='F-epam-wilma_service_api-WilmaService-OperationModeEnum-ERROR'></a>

ERROR constants # =

Summary

Communication error.

<a name='F-epam-wilma_service_api-WilmaService-OperationModeEnum-PROXY'></a>

PROXY constants # =

Summary

Proxy.

<a name='F-epam-wilma_service_api-WilmaService-OperationModeEnum-STUB'></a>

STUB constants # =

Summary

Stub.

<a name='F-epam-wilma_service_api-WilmaService-OperationModeEnum-WILMA'></a>

WILMA constants # =

Summary

Wilma.

<a name='T-epam-wilma_service_api-WilmaService-StubConfigOrderEnum'></a>

StubConfigOrderEnum # =

Namespace

epam.wilma_service_api.WilmaService

Summary

StubConfigOrderEnum

<a name='F-epam-wilma_service_api-WilmaService-StubConfigOrderEnum-Down'></a>

Down constants # =

Summary

Down.

<a name='F-epam-wilma_service_api-WilmaService-StubConfigOrderEnum-Up'></a>

Up constants # =

Summary

Up.

<a name='T-epam-wilma_service_api-WilmaService-StubConfigStatusEnum'></a>

StubConfigStatusEnum # =

Namespace

epam.wilma_service_api.WilmaService

Summary

StubConfigStatusEnum

<a name='F-epam-wilma_service_api-WilmaService-StubConfigStatusEnum-Disabled'></a>

Disabled constants # =

Summary

Disabled.

<a name='F-epam-wilma_service_api-WilmaService-StubConfigStatusEnum-Enabled'></a>

Enabled constants # =

Summary

Enabled.

<a name='T-epam-wilma_service_api-WilmaService'></a>

WilmaService # =

Namespace

epam.wilma_service_api

Summary

WilmaService class to acccess and manipulate programmatically WilmaApp.

<a name='M-epam-wilma_service_api-WilmaService-#ctor-epam-wilma_service_api-WilmaServiceConfig,epam-wilma_service_api-ILogger,System-Net-Http-HttpClient-'></a>

#ctor(config,logger,httpClient) constructor # =

Summary

WilmaService constructor.

Parameters
Name Type Description
config epam.wilma_service_api.WilmaServiceConfig WilmaServiceConfig stores host and port.
logger epam.wilma_service_api.ILogger Object implements ILogger interface, this methods are called for logging.
httpClient System.Net.Http.HttpClient HttpClient.
Exceptions
Name Description
System.ArgumentNullException Thrown when config or logger is null.

<a name='M-epam-wilma_service_api-WilmaService-#ctor-epam-wilma_service_api-WilmaServiceConfig,epam-wilma_service_api-ILogger-'></a>

#ctor(config,logger) constructor # =

Summary

WilmaService constructor.

Parameters
Name Type Description
config epam.wilma_service_api.WilmaServiceConfig WilmaServiceConfig stores host and port.
logger epam.wilma_service_api.ILogger Object implements ILogger interface, this methods are called for logging.
Exceptions
Name Description
System.ArgumentNullException Thrown when config or logger is null.

<a name='M-epam-wilma_service_api-WilmaService-ChangeStubConfigOrderAsync-System-String,epam-wilma_service_api-WilmaService-StubConfigOrderEnum-'></a>

ChangeStubConfigOrderAsync(groupName,order) method # =

Summary

Sets new order for the given group, move up or down in the list.

Returns

True if success, otherwise returns false.

Parameters
Name Type Description
groupName System.String Name of Group to move.
order epam.wilma_service_api.WilmaService.StubConfigOrderEnum Move direction: Up/Down

<a name='M-epam-wilma_service_api-WilmaService-ChangeStubConfigStatusAsync-System-String,epam-wilma_service_api-WilmaService-StubConfigStatusEnum-'></a>

ChangeStubConfigStatusAsync(groupName,status) method # =

Summary

Enable/disable the given group.

Returns

True if succesful, otherwise returns false.

Parameters
Name Type Description
groupName System.String Name of the Group.
status epam.wilma_service_api.WilmaService.StubConfigStatusEnum Status to set: Enabled/Disabled

<a name='M-epam-wilma_service_api-WilmaService-DropStubConfigAsync-System-String-'></a>

DropStubConfigAsync(groupName) method # =

Summary

Drops the given stub configuration.

Returns

True if succes, otherwise returns false.

Parameters
Name Type Description
groupName System.String Name of Group to drop.

<a name='M-epam-wilma_service_api-WilmaService-GetActualLoadInformationAsync'></a>

GetActualLoadInformationAsync() method # =

Summary

Gets the actual load information of the application.

Returns

Actual load information, or null in case of communication problem.

Parameters

This method has no parameters.

<a name='M-epam-wilma_service_api-WilmaService-GetLocalhostBlockingStatusAsync'></a>

GetLocalhostBlockingStatusAsync() method # =

Summary

Gets the localhost blocking status.

Returns

Localhost blocking status if successful, otherwise LocalhostControlStatuses.Error.

Parameters

This method has no parameters.

<a name='M-epam-wilma_service_api-WilmaService-GetMessageLoggingStatusAsync'></a>

GetMessageLoggingStatusAsync() method # =

Summary

Gets the message logging status.

Returns

Message logging status, or MessageLoggingControlStatusEnum.Error in case of communication problem.

Parameters

This method has no parameters.

<a name='M-epam-wilma_service_api-WilmaService-GetMessageMarkingStatusAsync'></a>

GetMessageMarkingStatusAsync() method # =

Summary

Gets the message marking status.

Returns

Message marking status, or MessageMarkingStatusEnum.Error in case of communication problem.

Parameters

This method has no parameters.

<a name='M-epam-wilma_service_api-WilmaService-GetOperationModeAsync'></a>

GetOperationModeAsync() method # =

Summary

Gets the operation mode status.

Returns

Operation mode status, or OperationModesEnum.ERROR in case of communication problem.

Parameters

This method has no parameters.

<a name='M-epam-wilma_service_api-WilmaService-GetStubConfigInformationAsync'></a>

GetStubConfigInformationAsync() method # =

Summary

Gets the stub configuration information.

Returns

Stub configuration as JsonObject.

Parameters

This method has no parameters.

<a name='M-epam-wilma_service_api-WilmaService-GetVersionInformationAsync'></a>

GetVersionInformationAsync() method # =

Summary

Gets the version of Wilma.

Returns

The version information, or null in case of communication problem.

Parameters

This method has no parameters.

<a name='M-epam-wilma_service_api-WilmaService-PersistActualStubConfigAsync'></a>

PersistActualStubConfigAsync() method # =

Summary

Persists the actual stub configuration.

Returns

True if success, otherwise returns false.

Parameters

This method has no parameters.

<a name='M-epam-wilma_service_api-WilmaService-SetLocalhostBlockingStatusAsync-epam-wilma_service_api-WilmaService-LocalhostControlStatusEnum-'></a>

SetLocalhostBlockingStatusAsync(control) method # =

Summary

Turns on/off the localhost blocking.

Returns

True if the request is successful, otherwise returns false.

Parameters
Name Type Description
control epam.wilma_service_api.WilmaService.LocalhostControlStatusEnum Control on/off

<a name='M-epam-wilma_service_api-WilmaService-SetMessageLoggingStatusAsync-epam-wilma_service_api-WilmaService-MessageLoggingStatusEnum-'></a>

SetMessageLoggingStatusAsync(control) method # =

Summary

Turns on/off the message logging status.

Returns

True if the request is successful, otherwise returns false.

Parameters
Name Type Description
control epam.wilma_service_api.WilmaService.MessageLoggingStatusEnum Control on/off

<a name='M-epam-wilma_service_api-WilmaService-SetMessageMarkingStatusAsync-epam-wilma_service_api-WilmaService-MessageMarkingStatusEnum-'></a>

SetMessageMarkingStatusAsync(control) method # =

Summary

Turns on/off the message marking status.

Returns

True if the request is successful, otherwise returns false.

Parameters
Name Type Description
control epam.wilma_service_api.WilmaService.MessageMarkingStatusEnum Control on/off

<a name='M-epam-wilma_service_api-WilmaService-SetOperationModeAsync-epam-wilma_service_api-WilmaService-OperationModeEnum-'></a>

SetOperationModeAsync(modes) method # =

Summary

Switch the operation mode.

Returns

True if the request is successful, otherwise returns false.

Parameters
Name Type Description
modes epam.wilma_service_api.WilmaService.OperationModeEnum Mode: wilma/stub/proxy

<a name='M-epam-wilma_service_api-WilmaService-ShutdownApplicationAsync'></a>

ShutdownApplicationAsync() method # =

Summary

Shutdown the Wilma application.

Returns

True if the request is successful, otherwise returns false

Parameters

This method has no parameters.

<a name='M-epam-wilma_service_api-WilmaService-UploadConditionCheckerAsync-System-String,System-IO-Stream-'></a>

UploadConditionCheckerAsync(fileName,stream) method # =

Summary

Uploads condition checker configuration.

Returns

True if success, otherwise returns false.

Parameters
Name Type Description
fileName System.String Name of file.
stream System.IO.Stream FileStream to upload.

<a name='M-epam-wilma_service_api-WilmaService-UploadStubConfigurationAsync-System-String,System-IO-Stream-'></a>

UploadStubConfigurationAsync(fileName,stream) method # =

Summary

Uploads Stub Configuration.

Returns

True if success, otherwise returns false.

Parameters
Name Type Description
fileName System.String Name of file.
stream System.IO.Stream FileStream to upload.

<a name='M-epam-wilma_service_api-WilmaService-UploadTemplateAsync-System-String,System-IO-Stream-'></a>

UploadTemplateAsync(fileName,stream) method # =

Summary

Uploads template.

Returns

True if success, otherwise returns false.

Parameters
Name Type Description
fileName System.String Name of file.
stream System.IO.Stream FileStream to upload.

<a name='M-epam-wilma_service_api-WilmaService-UploadTemplateFormatterAsync-System-String,System-IO-Stream-'></a>

UploadTemplateFormatterAsync(fileName,stream) method # =

Summary

Uploads template formatter.

Returns

True if success, otherwise returns false.

Parameters
Name Type Description
fileName System.String Name of file.
stream System.IO.Stream FileStream to upload.

<a name='T-epam-wilma_service_api-WilmaServiceConfig'></a>

WilmaServiceConfig # =

Namespace

epam.wilma_service_api

Summary

Configuraation class to store WilmaService config.

<a name='M-epam-wilma_service_api-WilmaServiceConfig-#ctor-System-String,System-UInt16-'></a>

#ctor(host,port) constructor # =

Summary

Constructor.

Parameters
Name Type Description
host System.String WilmaApp host.
port System.UInt16 WilmaApp port.

<a name='P-epam-wilma_service_api-WilmaServiceConfig-Host'></a>

Host property # =

Summary

WilmaApp host.

<a name='P-epam-wilma_service_api-WilmaServiceConfig-Port'></a>

Port property # =

Summary

WilmaApp port.

Product Compatible and additional computed target framework versions.
.NET Framework net48 is compatible.  net481 was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

  • .NETFramework 4.8

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Updated dependencies.