Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 

OpenFire Server Custom Service Shell

Introduction

This custom service shell provides an integration between CloudShell and the OpenFire RealTime Collaboration (RTC) server whose details can be found @ https://www.igniterealtime.org/projects/openfire/

OpenFire uses the only widely adopted open protocol for instant messaging, XMPP (also called Jabber). At its core is the concept of a conference or chat room. The idea behind this integration is to allow a chat room to be created by this service for each sandbox. Messages can be entered directly into the chat room via a client such as Spark (for example, the Instant Messaging client @ https://www.igniterealtime.org/projects/spark/index.jsp) or via a command from this Shell.

For details on functions provided by this shell, please see the "Operational Usage" section below.

CloudShell and OpenFire Compatibility

This service shell was developed and tested against CloudShell 9.2 GA. There is no reason why it would not work with 9.3 GA although it would require an update to the requirements.txt file as documented @ https://devguide.quali.com/orchestration/9.3.0/getting-started.html to reflect the use of a later version of the the cloudshell-orch-core package

The integration was developed and tested against OpenFire Server 4.4.1

Setup

The following steps should be taken when using this Shell:

  1. Import this Shell into CloudShell.
  2. Set up the OpenFire Server. It can be installed on the same host as the Quali Server or on a separate machine. The download link is at @ https://www.igniterealtime.org/downloads/index.jsp#openfire (we developed and tested against v4.4.1)
  3. Install the REST API Admin plug-in for OpenFire (this is the one written by Roman Soldatow).

OpenFire Shell Service REST API Plug In

  1. Log in to the Web GUI for the OpenFire server (for example, http://localhost:9090). Move to the "Server" toolbar and then "Server Settings" under this. You should see "REST API" on the bottom left. Select this and then Enable the plug-in with basic authentication.

OpenFire Shell Service REST API Enable

  1. Download and install the Spark client from https://www.igniterealtime.org/downloads/index.jsp#openfire. Log in and test the connectivity to the OpenFire server.

Operational Usage

Adding Services to a blueprint

First, you need to add two instances of the service to a blueprint. Since service shells do not allow concurrent commands, this is necessary since one command needs to be running all the time - the one that monitors a chat room for messages entered outside of CloudShell in order to echo them in the sandbox.

We suggest you name the instances something like "Chat Room Monitor" and "Chat Room Service". Ensure that the properties are entered correctly into both services. Essentially, you need to identify the admin account and location of the OpenFire Server and also the same for CloudShell.

Chatroom Blueprint

Props

Reserving a blueprint and creating the chat room for the sandbox

Reserve your blueprint. Once Active, you should create a chatroom for the sandbox using the "Create Sandbox Chat Room" command. Notice in the Spark client and/or the OpenFire Server web GUI, there is now a new Group Chat room. The owner will be set as the admin user defined in the service properties for OpenFire. The members will reflect the permitted users of the sandbox. It is important that all users that need access to this chat room should be made Permitted Users including the current user.

Sandbox Name

Create Chat Room

Chat Room Create Output

ChatRoom in OpenFire

It is also a good idea to invoke this shell command as part of the automated Setup process.

Start monitoring messages in the sandbox

In the other service instance (let us call it "Chat Room Monitor", click on the "Monitor Chat Room" command. This command will never terminate so simply leave it running. The purpose of this command is to ensure that any messages entered into the chat room outside of the CloudShell GUI are reflected in the Output window in order to keep all permitted users of the sandbox up-to-date. This code is based on the class MucBot in the driver code.

Chat Room Monitor

Sending a chat room message from CloudShell

Sending a message to the sandbox users is simple. Click on the "Chat Room Service" service and click on the command "Send Chat Room Message".

welcome msg

Send Message

Msg in Spark

The message is echo'ed in CloudShell in the Output window, the monitor shows it again and you can see it directly in the Spark client for OpenFire.

Seeing messages entered directly into OpenFire via a Client such as Spark

Let us imagine that someone finds it more convenient to send a message via a client app such as Spark. In this case, you will see the message automatically picked up and reflected in CloudShell.

Msg Outside CS

Auto Monitor Message

Broadcast message

OpenFire offers a simple broadcast facility that displays a pop-up window to all users connected via Spark or some other IM client. An example is shown below.

broadcast1

broadcast1 5

broadcast2

Listing all chat room messages to-date

To get completely up-to-date with all the dialogue that has taken place in the sandbox chat room, simply click on the command "List Chat Room Message History".

ListMessageHistory0

ListMessageHistory

Attach chat room message history

To display and attach a simple text file of the message history to the sandbox, simply click on the command "Attach Chat Room Message History".

attach0

Attach1

Attach2

Attach3

Deleting the chat room

To complete the cycle, you should delete the sandbox chat room when it is no longer required. Simply click on the command "Delete Sandbox Chat Room".

Delete0

Delete1

It is also a good idea to invoke this shell command as part of the automated Teardown process.

Suggested Improvements

  1. If the sandbox name or any of its permitted users change, these are not automatically updated in the respective OpenFire chat room. An option to auto reflect such changes after a change should be offered perhaps.

  2. Enhance the broadcast message command to reflect the message in all sandbox output windows not just the one the sender sent it from.

About

This is a Quali CloudShell Service Shell which integrates Chat Rooms with Quali Sandboxes for Real Time Collaboration (RTC).

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages