C# Class Microsoft.Protocols.TestSuites.MS_WOPI.DiscoveryProcessHelper

This class is used to perform the discovery process between the shared test case part and the pure WOPI test cases part.

Inheritance: HelperBase

Show file Open project: OfficeDev/Interop-TestSuites Class Usage Examples

Public Methods

Method	Description
CleanUpDiscoveryRecord ( string wopiClientName, IMS_WOPISUTControlAdapter sutControllerInstance ) : void	A method is used to clean up the WOPI discovery record for the WOPI server. For removing the record successfully, the WOPI server can be triggered the WOPI discovery process again.
DisposeDiscoveryListener ( ) : void	A method is used to dispose the discovery request listener.
GetDiscoveryResponseXmlString ( string currentTestClientName, string progId ) : string	A method is used to generate response of a WOPI discovery request. It indicates the WOPI client supports 3 types file extensions: ".txt", ".zip", ".one"
PerformDiscoveryProcess ( string hostNameOfDiscoveryListener, IMS_WOPISUTControlAdapter sutControllerInstance ) : void	A method is used to perform the WOPI discovery process for the WOPI server.
StartDiscoveryListen ( string currentTestClient, string progId ) : void	A method is used to start listening the discovery request from the WOPI server. If the listen thread has existed, the DiscoverProcessHelper will not start any new listen thread.

Private Methods

Method	Description
DiscoveryProcessHelper ( ) : System	Prevents a default instance of the DiscoveryProcessHelper class from being created
GetNetZonesForWopiDiscoveryResponse ( string currentTestClientName ) : Microsoft.Protocols.TestSuites.MS_WOPI.ct_netzone[]	A method is used to get necessary internal http and internal https ct_netzone instances. This values is used to response to the WOPI server so that the WOPI server can use this test client as a WOPI client.
GetSingleNetZoneForWopiDiscoveryResponse ( st_wopizone netZoneType, string currentTestClientName, string fakedWOPIClientActionHostName ) : ct_netzone	A method is used to generate a single ct_netzone type instance for current test client according to the netZoneType.

Method Details

CleanUpDiscoveryRecord() public static method

A method is used to clean up the WOPI discovery record for the WOPI server. For removing the record successfully, the WOPI server can be triggered the WOPI discovery process again.

public static CleanUpDiscoveryRecord ( string wopiClientName, IMS_WOPISUTControlAdapter sutControllerInstance ) : void
wopiClientName	string	A parameter represents the WOPI client name which should have been discovered by WOPI server
sutControllerInstance	IMS_WOPISUTControlAdapter	A parameter represents the IMS_WOPISUTControlAdapter instance which is used to make the WOPI server clean up discovery record for the specified WOPI client.
return	void

DisposeDiscoveryListener() public static method

A method is used to dispose the discovery request listener.

public static DisposeDiscoveryListener ( ) : void
return	void

GetDiscoveryResponseXmlString() public static method

A method is used to generate response of a WOPI discovery request. It indicates the WOPI client supports 3 types file extensions: ".txt", ".zip", ".one"

public static GetDiscoveryResponseXmlString ( string currentTestClientName, string progId ) : string
currentTestClientName	string	A parameter represents the current test client name which is used to construct WOPI client's app name in WOPI discovery response.
progId	string	A parameter represents the id of program which is associated with folder level visit in discovery process. This value must be valid for WOPI server.
return	string

PerformDiscoveryProcess() public static method

A method is used to perform the WOPI discovery process for the WOPI server.

public static PerformDiscoveryProcess ( string hostNameOfDiscoveryListener, IMS_WOPISUTControlAdapter sutControllerInstance ) : void
hostNameOfDiscoveryListener	string	A parameter represents the machine name which is hosting the discovery listener feature. It should be the test client name which is running the test suite.
sutControllerInstance	IMS_WOPISUTControlAdapter	A parameter represents the IMS_WOPISUTControlAdapter instance which is used to make the WOPI server perform sending discovery request to the discovery listener.
return	void

StartDiscoveryListen() public static method

A method is used to start listening the discovery request from the WOPI server. If the listen thread has existed, the DiscoverProcessHelper will not start any new listen thread.

public static StartDiscoveryListen ( string currentTestClient, string progId ) : void
currentTestClient	string	A parameter represent the current test client which acts as WOPI client to listen the discovery request.
progId	string	A parameter represents the id of program which is associated with folder level visit in discovery process. This value must be valid for WOPI server. For Microsoft products, this value can be "OneNote.Notebook". It is used to ensure the WOPI server can support folder level visit ability in WOPI mode when receive the value from the discovery response.
return	void