Copyright and Trademark Information Trademarks Disclaimer; No Warranty

Transcription

1

2 Copyright and Trademark Information Under the copyright laws, this document may not be copied, photocopied, reproduced, translated, or reduced to any electronic medium or machine-readable form, in whole or in part, without the prior written consent of Lotus Development Corporation, except in the manner described in the documentation or the applicable licensing agreement governing the use of the software. Copyright Lotus Development Corporation 55 Cambridge Parkway Cambridge, MA All Rights Reserved. Printed in USA. Trademarks Lotus, Sametime, and Freelance are registered trademarks of Lotus Development Corporation. IBM is a registered trademark of International Business Machines Corporation. Java and all Java-based trademarks and logos are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both. Microsoft, NetMeeting, Windows, Windows NT, and the Windows logo are registered trademarks of Microsoft Corporation in the United States, other countries, or both. MMX is a trademark and Pentium is a registered trademark of Intel Corporation in the United States, other countries, or both. Other product and company names mentioned herein may be the trademarks or registered trademarks of their respective owners. Disclaimer; No Warranty THIS INFORMATION AND ALL OTHER DOCUMENTATION (IN PRINTED OR ELECTRONIC FORM) ARE PROVIDED FOR REFERENCE PURPOSES ONLY. WHILE EFFORTS WERE MADE TO VERIFY THE COMPLETENESS AND ACCURACY OF THIS INFORMATION, THIS INFORMATION AND ALL OTHER DOCUMENTATION ARE PROVIDED AS IS WITHOUT ANY WARRANTY WHATSOEVER AND IS SUBJECT TO CHANGE. TO THE MAXIMUM EXTENT PERMITTED, LOTUS DEVELOPMENT CORPORATION DISCLAIMS ALL WARRANTIES, INCLUDING WITHOUT LIMITATION THE IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE, WITH RESPECT TO THE SAME. LOTUS DEVELOPMENT CORPORATION SHALL NOT BE RESPONSIBLE FOR ANY DAMAGES, INCLUDING WITHOUT LIMITATION, DIRECT, INDIRECT, CONSEQUENTIAL OR INCIDENTAL DAMAGES, ARISING OUT OF THE USE OF, OR OTHERWISE RELATED TO, THIS INFORMATION OR ANY OTHER DOCUMENTATION. NOTWITHSTANDING ANYTHING TO THE CONTRARY, NOTHING CONTAINED IN THIS INFORMATION OR ANY OTHER DOCUMENTATION IS INTENDED TO, NOR SHALL HAVE THE EFFECT OF, CREATING ANY WARRANTIES OR REPRESENTATIONS FROM LOTUS DEVELOPMENT CORPORATION (OR ITS SUPPLIERS OR LICENSORS), OR ALTERING THE TERMS AND CONDITIONS OF THE APPLICABLE LICENSE AGREEMENT GOVERNING THE USE OF THE SOFTWARE REFERRED TO HEREIN.

3 Contents About This Paper... 1 Acknowledgements... 1 Related Documents... 1 Introduction... 2 What Is Lotus Sametime?... 2 What Is the Sametime Java Toolkit?... 2 What Is the Sametime C++ Toolkit?... 2 Architecture... 3 Modular... 4 Thread-Safe... 4 Extendable... 4 Object-Oriented API... 4 Toolkit Components... 5 Community UI Components... 5 Community Services... 9 Meeting Services Conclusion... 14

4

5 About This Paper The Sametime Client Toolkits provide the ability to Sametime-enable software applications in both Java and Windows environments. Both toolkits are based on the same architecture and are therefore very similar. The Java Toolkit exposes the entire client feature set provided by Sametime 2.0, while the C++ Toolkit (which is targeted for Windows) supports only Community Services features. This paper covers both toolkits and will describe the common features and differences where applicable. Acknowledgements The following Sametime team members contributed to this white paper: Meyer Falik, Harry Hornreich, Stephen Londergan, Marjorie Schejter, Yafit Telyas, Nisan Taibi Related Documents Sametime 2.0 Java Toolkit Tutorial Sametime 2.0 Java Toolkit Developers Guide Sametime 2.0 Java Toolkit Javadoc Reference Sametime 2.0 C++ Toolkit Tutorial Sametime 2.0 C++ Toolkit Developers Guide Sametime 2.0 C++ Toolkit HTML Reference White Paper What s New in the Sametime 2.0 Java Toolkit Sametime Application Developers Sheet Additional information can be found at the following Web sites: Lotus Development Corporation Introducing the Sametime Client Toolkits 1

6 Introduction What Is Lotus Sametime? Lotus Sametime is a family of collaboration products providing real-time awareness, communication, screen-sharing capabilities, and IP audio/video services. Sametime brings the flexibility and efficiency of real-time communication to the business world by connecting people to people: colleagues, customers, suppliers and partners. Lotus Sametime also includes comprehensive Java and C++ based application development toolkits, which developers use to embed real-time capabilities (such as chat and real-time help features) into e-business applications. What Is the Sametime Java Toolkit? The Lotus Sametime Java Toolkit is a collection of building blocks or components that developers use to build applications which leverage the functionality and services provided by Lotus Sametime. These toolkit components can be used in any standard development environment that supports JDK 1.1 or above. The Sametime Java Toolkit is used by developers to embed Sametime-based services and functionality in Web applications. For example, a developer could use the Java Toolkit to build a facility for live customer-service-style help in an online marketplace, or perhaps build awareness into a knowledge management application, or to bring application sharing into an e-business application. What Is the Sametime C++ Toolkit? The Sametime C++ Toolkit is also a collection of components that allow developers to enhance Windows applications with Community Services, such as awareness and instant messaging. Using the Microsoft Visual C++ Developer Studio, developers can quickly and easily Sametime-enable any Win32 or MFC based Windows application. 2 Introducing the Sametime Client Toolkits Lotus Development Corporation

7 Architecture Sametime Client Toolkits provide access to core Sametime services such as awareness, instant messaging, whiteboard and application sharing as well as to Sametime s audio/video capabilities. Higher-level Sametime-enabled Abstract Window Toolkit (AWT) Java components can be embedded inside any AWT container. Sametime Client Toolkits have a layered architecture with three different layers: Transport Layer through which all communication with the Sametime server passes and which provides the basic communication with the Sametime server. Service Layer providing access to the Sametime Community and Meeting Services. UI Layer providing UI components and Sametime-enabled AWT components. Legend Available for Java only Available for Jave and C++ Figure 1: Sametime 2.0 Client Architecture. Please note that the Java Toolkit provides all of the above layers, while the C++ Toolkit provides only the Transport and Community Service layers. The Sametime Client Toolkits are modular, thread-safe and extendable, providing an easy-to-use object-oriented API. Lotus Development Corporation Introducing the Sametime Client Toolkits 3

8 Modular Since the Sametime Client Toolkits are component-based, the developer has complete control over exactly which components are loaded and used, based on the requirements of a given application. Only the packages (for Java) or libraries (for C++) containing the required components from the toolkit need to be included in the final application or applet. This modular structure results in smaller deliverables for C++, and shorter download time for Java. Thread-Safe The Sametime Client Toolkits are thread-safe so that the developer can make multiple thread calls on the Toolkit API without needing to synchronize them. Extendable Developers can add components that provide new services and revisions to the user interface, making the toolkits extendable by both core Sametime developers and also by third-party developers. This allows developers to add new UI functionality and additional services to support extended Sametime capabilities on the server side. Object-Oriented API Sametime Client Toolkits provide a natural object-oriented API for the developer. Each service is an interface implemented by a component class (for Java) or simply a class (for C++). Many services create and require use of one or more additional helper objects in order to execute the service functionality. 4 Introducing the Sametime Client Toolkits Lotus Development Corporation

9 Toolkit Components The toolkits contain three types of components: 1. Community UI for displaying the events from the Community Services 2. Community Services on a semantic level 3. Meeting Services, which allow real-time collaboration Community UI Components These components (which are available only in the Java Toolkit) provide a standard UI for Community Services functionality. The components are responsible for listening to events from the Community Services components and displaying the appropriate UI. The available Community UI components are: Chat UI Community UI Chat UI The Chat UI component is used to create Sametime meetings and participate in them without having to code the low-level protocols that are involved. It includes the Invite dialog used for inviting users to meetings, the Join dialog for incoming invitations, and the Chat window. The Chat UI component can also send a notification requesting to launch the Meeting Room Client (MRC) for richer Sametime meetings that require features such as audio/video, application sharing, and whiteboarding. Chat UI must be loaded into the Sametime session object just like any other toolkit component. The Chat UI component listens to events from the Instant Messaging and Post services (see Community Services on page 9) and notifies the user of incoming instant messages and meeting invitations. It can also be used to easily initiate instant messages and meetings. Lotus Development Corporation Introducing the Sametime Client Toolkits 5

10 Figure 2: N-way Chat Window created by Chat UI component. Community UI The Community UI component provides the following capabilities: Resolve user names in the community. When more than one user match is found, a dialog allowing the user to select the appropriate name is displayed. Display messages when the user is disconnected from the community. This message includes a short text description giving the specific disconnect reason. Display administrator messages that are sent to the entire community. Community AWT Components The Java Toolkit includes the following Sametime-enabled AWT components: Add Dialog This dialog is used to add users in the Community to the buddy list by entering their names or browsing for them in the Sametime directory. 6 Introducing the Sametime Client Toolkits Lotus Development Corporation

11 Figure 3: Add Dialog Awareness List This embeddable AWT panel displays the current online status for a predefined list of users in the Community. Users launch instant messages and Sametime meetings with participants from the list by selecting one or more users and choosing the required type of meeting from the context menu. (Figure 2 shows an Awareness list embedded inside a chat window.) Lotus Development Corporation Introducing the Sametime Client Toolkits 7

12 Capabilities List This embeddable AWT panel displays the available audio/video tools of a list of users. Capabilities List Figure 4: Capabilities List embedded inside Invite dialog. Directory Dialog and Panel This dialog and embeddable AWT panel provide standard UI for browsing and searching the Sametime directory for users and groups. Group Content Dialog This dialog displays the content of a Sametime directory group. Place Awareness List This embeddable AWT panel displays a list of users in the Community that are currently in a specific place (such as viewing the same database, document, or Web page). The users are shown with their current online status. You can launch instant messages and Sametime meetings with participants from the list by selecting one or more users and choosing the required type of meeting from the context menu. Privacy Dialog and Panel This dialog and panel provide a standard UI for setting and viewing your Sametime privacy settings. 8 Introducing the Sametime Client Toolkits Lotus Development Corporation

13 Resolve Panel This embeddable AWT panel is used to resolve user names to unique Sametime user objects. Tools Dialog This dialog displays the audio/video tools of a list of users. Community Services Community Services are available in both toolkits. The Community Services expose the features of the community part of the Sametime server including fundamental capabilities, such as awareness and online messaging. Awareness The Awareness Service provides the ability to be aware of the online status of different kinds of Sametime objects such as users, groups and servers. Using this service, you can register to receive notifications of changes in the online status and online attributes of users. This service is sometimes referred to as People Awareness. Community The Community Service is the core service you must use in order to log in and log out from the Sametime server. In addition to login, the Community Service provides the ability to change your status and privacy in the community to receive administrator messages, and to request to change your displayed user name if you logged on anonymously. Directory Services The Directory Service enables you to browse the Sametime community directories. It provides a list of all available directories and allows you to query for chunks of entries in each directory. Depending on the directory configuration, directory browsing might not be available on your Sametime server. (For example, directory browsing is not available when using an LDAP directory.) When directory browsing is not available, the developer should limit the application to the use of the Lookup Service (see below) that provides name-resolving capabilities. Instant Messaging The Instant Messaging Service allows the sending of text and binary messages between clients. It is used for standard instant messages, but can also be used for passing any other messages such as game moves and translated messages. Lotus Development Corporation Introducing the Sametime Client Toolkits 9

14 Lookup The Lookup Service provides the ability to resolve user and group names to unique user or group objects and to query group content. Names 1 The Names Service helps manage user nicknames and name delimiters across the entire application. This local service has no equivalent server-side component. For example: A user can define the nickname Joe for a user in his buddy list, and that user will appear as Joe anywhere he is shown. Sametime Connect uses this service to provide Automatic Nicknames for users. This is a way to quickly shorten all the names of the users in the buddy list by having the name cut at some predefined delimiter, which is often the / delimiter in a hierarchical name. For example, Stephen Londergan/Cam/Lotus will instead be shown as Stephen Londergan. Places The Places Service exposes the places architecture and allows you to create virtual places. The flexibility of the places architecture allows you to develop varied applications that take advantage of place-based awareness. The Sametime 2.0 places architecture unifies the Meeting and Community Services in Sametime 2.0. It binds the activities provided by the meeting Services (such as audio, video, application sharing, and whiteboard) with a place provided by the Community Services. Post The Post Service allows you to send a single message to many users at once, and allows these users to respond to the message. Storage The Storage Services stores user-related information such as attributes directly on the Sametime server. The Storage Service allows you to access these attributes from wherever you log into your Sametime server. For example, a user s Connect buddy list is stored on the Sametime server, so that a user can log in from any machine and always get the right buddy list. Sametime applications can use this service to access standard Sametime attributes, such as buddy list and Connect preferences, or add their own application-specific attributes. Token The Token Service provides the ability to generate a token that can be used by a logged-in user to log in to the Sametime server without being challenged to authenticate again. For example, a Sametime application could generate a token and pass it as a parameter to a second application. The launched application would then use this token to 1 Currently available only in the Java Toolkit. 10 Introducing the Sametime Client Toolkits Lotus Development Corporation

15 log in to the community. A token has a time limit, depending on administrator configuration. Meeting Services Meeting Services are available only in the Java Toolkit. Meeting Services allow client Java applets and applications to create and join multi-participant meetings. These services are used to share and annotate documents, share and control applications, and communicate using live audio and video. Developers choose the tools to use in a meeting, and can control the visual layout and containments of various UI components. The Meeting Services include application sharing, shared whiteboard, and IP audio and video, and also provide a highly scalable and lightweight Broadcast Receiver. The Broadcast Receiver receives and interprets audio, video and data streams generated by the different Meeting Services, and renders these without actively participating in the meeting. Meeting Factory Services The Meeting Factory Services handle the authenticated connection to the Sametime server used by the various meeting components (application sharing, whiteboard, audio/video). Objects can register themselves and receive events about the connection and meeting join process. Application Sharing Service The Application Sharing Service allows applications to be shared within the context of a place. Additionally, clients within a place are able to view and/or control the shared application. Common uses include on-line editing, remote control, software demonstrations and presentations. Whiteboard The Whiteboard Service allows users within a place to simultaneously view and annotate attached content and to create whiteboard content by using a basic set of tools (lines, boxes, circles, text, etc.) for drawing. (See Figure 5.) Whiteboard content, such as a Power Point or Freelance presentation, can be attached to a meeting created in the Sametime Meeting Center. Developers can either programmatically control the various whiteboard elements (such as switching between documents and pages and selecting drawing tools/colors/stroke widths) or to use a default set of AWT components that encompass complete whiteboard functionality. Lotus Development Corporation Introducing the Sametime Client Toolkits 11

16 Figure 5: Whiteboard and Place Awareness list. Streamed Media One of the major features of Sametime 2.0 is the addition of IP audio and video; when you use the Java Toolkit, you can access these capabilities in your own applications. Once you have a place object with audio or video activities defined, you can manipulate different features of these activities, such as muting a microphone or pausing the video camera. In addition you can create an AWT panel to display local or incoming video. This same technique can be used for scheduled, instant, and broadcast meetings. General Streamed Media Service The Streamed Media Service allows clients to access audio, video, and/or data content in a meeting. This service handles all service-level aspects of controlling the content streams, including support for audio mute and pause/play of video. The specific implementation of the service determines which types of content are available and whether the content can be both transmitted and received, or received only. Streamed Media Interactive Service The Streamed Media Interactive Service provides clients with two-way communication via audio and video within the context of a place. This service encompasses all the functionality needed to participate in a two-way or multiple-way IP audio/video call. 12 Introducing the Sametime Client Toolkits Lotus Development Corporation

17 The service handles all semantic-level aspects of controlling the audio and video streams including support for audio mute, pause/play of video, displaying the video stream, and conducted or request mode audio calls. Streamed Media Broadcast Service The Streamed Media Broadcast service allows clients to receive the audio, video, and data content being sourced by an interactive client meeting. Clients using this service are limited to only viewing the meeting and cannot interact. Unlike other services, the Broadcast Streamed Media Service does not require the use of Sametime places. Common uses of the Streamed Media Broadcast Service include remote viewing and large-scale software demonstrations and presentations. This service is more scalable than the interactive services since multicast is used whenever possible. Lotus Development Corporation Introducing the Sametime Client Toolkits 13

18 Conclusion Real-time collaboration is becoming as trivial as , and as common and as necessary as the telephone system. In fact, collaborating in real time over IP is almost as natural as picking up the telephone and in many cases can reduce the costs. Real-time technologies like Sametime are growing. Companies rely on Web-based, real-time collaboration to do business with their customers, partners, and suppliers, and people expect real-time help in almost any e-commerce related venture. We re proud that Lotus Sametime is not only the leader in out of the box business-ready, real-time collaboration, but that the Sametime toolkits offer opportunities for unlimited customized solutions. A Sametime developer s community has been created to foster the exchange of experiences, knowledge and support among the members. More information, such as white papers, guidelines and news, is available at our Developer s Community Web site: 14 Introducing the Sametime Client Toolkits Lotus Development Corporation

19

20