This documentation is archived and is not being maintained.

Testing Authentication Implementations

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

This section discusses using the SDK to test your authentication solution.

The Unified Communications AJAX API SDK is provided as a reference for ISVs. It contains detailed information about the concepts discussed in this guide, and contains code samples to illustrate the concepts.

The SDK includes Web-based samples and samples based on the Microsoft Win32® application programming interface. To install the SDK, double-click the SetupSE.exe or SetupEE.exe file on the Office Communications Server 2007 installation media, click Deploy Other Server Roles, click Deploy Communicator Web Access, click the Download the Communicator Web Access SDK link, and then follow the instructions. The SDK default installation folder is %Program Files%/Microsoft Office Communications Server 2007/ Unified Communications AJAX SDK/. Three subfolders are installed, /Docs, /Samples, and /Schemas.

Communicator Web Access provides the Unified Communications AJAX API, the Unified Communications JavaScript Libraries Logon, Presence and Instant Messaging Controls, and the SDK. These items provide the ISV with a starting point for developing applications that access the Unified Communications AJAX API. The API and Controls enable customers and ISVs to develop applications with enhanced presence conferencing. The SSO/CA capability of the combination of Communicator Web Access and ISA Server 2006 enables customers and ISVs to develop applications with an SSO/CA experience for their customers.

Any integrated development environment can be used to develop these applications. However, the SDK code samples require the Microsoft Visual Studio® 2005 integrated development environment.

The Unified Communications AJAX SDK includes a Unified Communications AJAX API sample.

Figure 1:   The UCAjaxManagedSample SDK Sample

Bb969658.a1863b5a-e6a1-4d5b-8887-063f3eed0e3c(en-us,office.12).jpg

AJAX stands for Asynchronous JavaScript and XML. It is a programming model for building interactive Web applications. Communication between a client and server uses standard HTTP and HTTPS request and response transactions. Supported transport formats are XML or plain text. Unlike the traditional HTTP programming practice, an AJAX transaction does not require that an entire Web page be transported over the wire for every change on a Web page. The server provides modularized functionality through different access channels that are exposed as different URLs on the same Web site. The Unified Communications AJAX API supports applications that use the AJAX programming model.

The Communicator Web Access (2007 release) Service is accessible via the Unified Communications AJAX API that publicly exposes a subset of methods and events. ISVs can develop applications by following the AJAX programming patterns. Various programming languages, platforms, and operating systems are supported. The Unified Communications AJAX API uses XML as the data format and supports modularized access of the following functionality:

  • A Unified Communications AJAX API Client signs in to Communicator Web Access by using Forms-based authentication.

  • A Unified Communications AJAX API Client signs in to Communicator Web Access using Integrated Windows authentication.

  • A Unified Communications AJAX API Client signs in to Communicator Web Access by using custom authentication (such as single sign-on and two factor authentication).

  • The Unified Communications AJAX API Client posts methods to Communicator Web Access.

  • The Unified Communications AJAX API Client receives events from Communicator Web Access.

Applications developed by using the AJAX programming model can enable users to do the following:

  • Sign in and out of Communicator Web Access using a supported client.

  • Manage and share presence information.

  • Manage contacts and groups.

  • Send and receive instant messages.

  • Search for users within an enterprise.

  • Redirect voice call.

These clients can be a browser-based Web application (for example, an ASP.NET v2.0 application) or a standalone network application (for example, a .NET-connected executable, a Win32-based standalone application, or a UNIX-based C/C++ application). Because the Unified Communications AJAX API is based on the flexible AJAX programming model, the client applications are not limited to running on Microsoft Windows operating systems and can readily be deployed to desktop, laptop, or other devices.

Creating an application that accesses the Unified Communications AJAX API involves implementing the following:

  • The ISV application must sign in to a Communicator Web Access Server using either Forms-based authentication, Integrated Windows authentication, or custom authentication.

  • The client must then contact the Communicator Web Access Server to initiate the session.

  • The client must post one or more AJAX methods to the Communicator Web Access Server to do the following:

    • Manage contacts or groups.

    • Set or query presence.

    • Configure access control.

    • Find users.

    • Start an instant messaging session, send and receive text messages, or close the IM session.

  • The client must be able to receive AJAX events from the server to do the following:

    • Execute a method and return the result.

    • Respond to a change in the server load and return a new query timeout value.

    • Sign a contact in or out and return the affected contact information.

    • Invite a user to join an IM conversation, accept the IM invitation, or send and receive instant messages during a conversation.

  • The client must sign out of the service and terminate the session.

As a result of a change to the Office Communications Server 2007 schema, Communicator Web Access (2007 release) no longer must retrieve a user’s SIP URI during sign-in. This means that the user name and password are the only pieces of information that need to be provided during sign-on.

Because Communicator Web Access (2007 release) does not require users to enter their SIP address when signing in, Communicator Web Access can use the same set of credentials that are used to sign into other applications. This ability to reuse credentials allows Communicator Web Access to be used in conjunction with automatic sign-in solutions.

The user must be enabled for Microsoft Office Communications Server 2007 and for remote access in the Active Directory® Users and Computers snap-in for internal and remote access, respectively.

Show: