Groove Web Services Registry Keys

  • Article

Applies to: SharePoint Workspace 2010 | Visual Studio 2008

SharePoint Workspace 2010 uses registry keys to communicate run-time data to a local Groove Web Services SOAP client

Registry Key Locations

HKEY_CURRENT_USER\Software\Microsoft\Office\Groove\WebServices\ 
        LocalRequestKey
        LocalResponseKey
        GrooveHTTPDesiredPort
        GrooveHTTPPort
        GrooveLocalHTTPPort
        GrooveLocalHTTPServerPID

Registry Key Usage

  • LocalRequestKey—SharePoint Workspace uses this key to ensure that Groove Web Services clients are running under the same Windows account as the SharePoint Workspace process. SharePoint Workspace creates a new string, encrypts the key using DPAPI CurrentUser encryption, and then assigns the encrypted value to the key each time SharePoint Workspace starts. The Groove Web Services client application must read the registry key, decrypt it, and then use the decrypted string value in the SOAP header for every Groove Web Services call. When SharePoint Workspace receives a Groove Web Services request, it tests the LocalRequestKey. If it does not have the correct value, it does not process the SOAP request.

  • LocalResponseKey—SharePoint Workspace provides this key to enable Groove Web Services clients to ensure that the SharePoint Workspace process is the process that is handling the SOAP request. SharePoint Workspace creates a new string, encrypts the key using DPAPI CurrentUser encryption, and then assigns the encrypted value to the key each time SharePoint Workspace starts. The Groove Web Services client application may read the registry key, decrypt it, and then use the decrypted string value to test the value returned in Groove Web Services response header.

  • GrooveHTTPDesiredPort—if this key is defined, SharePoint Workspace reads this key on start-up and attempts to use the specified port for HTTP Web service requests. This key has a DWORD value.

  • GrooveHTTPPort and GrooveLocalHTTPPort—SharePoint Workspace sets these keys to specify the port that it is currently listening on for Web service requests. These keys have DWORD values and have identical values.

  • GrooveLocalHTTPServerPID—SharePoint Workspace sets this key to its current Process ID. This key has a DWORD value. Your Web Services application can use the Process ID to check if the SharePoint Workspace process is running. If your application is running as a SOAP client to Groove Web Services, it needs the Process ID so that it can give the SharePoint Workspace process permission to set the foreground window when your Web services application is running. This permission is important if your application calls a GrooveLocal operation that causes SharePoint Workspace to display a window to the user.

See Also

Reference

Headers Used in Groove Web Services

Concepts

Security in Groove Web Services

Reading Groove Web Services Registry Keys