About the Application#

This application uses the CatPlugin Example. The application cannot be created if you do not have this plugin correctly created, installed,and running.

Creating the Application Project#

1. Open a Command Prompt window.

2. Navigate to the directory you want to use as your workspace. To use the CUAE command-line tool to create a new application, type the cuae create command and the name of the application project.

c:> cd \workspace
c:\workspace> cuae create CatPluginClient

The tool then prompts you for additional information.

Tip:

Once you are more familiar with the options, you can type the full command rather than answering the prompts by using the following syntax://

cuae create -l language -m namespace -t project type [options] projectname

3. First the tool prompts you to choose between building an application or a plugin. In this example, the correct choice is application:

Project Type? [application or plugin] application

4. Next the tool prompts you to specify the programming language. In this example, the correct choice is java:

Programming language? [java or csharp] java

5. The tool prompts you to choose the build format you prefer. In this example we are using ant.

Build format? [ant or maven2] ant

6. The tool asks you for the namespace for the application. A program might want to use a fully qualified namespace like com.company.catpluginclient or something simple like catpluginclient. The tool offers you a simple namespace based on the project name. Let's accept the tool's suggestion for now and use catpluginclient:

Project namespace? [default: catpluginclient] <Return>

7. Finally, the tool asks if you would like to specify a triggering event. All applications need to register against at least one triggering event. You can specify the triggering event now or wait and specify the triggering event later. You can also change the triggering event during development. Again, since we know that this application needs to be triggered on an incoming call, let's go ahead and specify the triggering event now. Select option 9:

 Available application triggering event:
   0: Skip this step
   1: cisco.uc.cuae.legacy.JTapi.JTapiIncomingCall
   2: cisco.uc.cuae.legacy.JTapi.JTapiCallInitiated
   3: cisco.uc.cuae.legacy.JTapi.JTapiCallEstablished
   4: cisco.uc.cuae.legacy.CallControl.IncomingCall
   5: cisco.uc.cuae.legacy.Http.GotRequest
   6: cisco.uc.cuae.legacy.Presence.SubscriptionTerminated
   7: cisco.uc.cuae.legacy.Presence.Notify
   8: cisco.uc.cuae.legacy.TimerFacility.TimerFire
   9: catplugin.CatPlugin.triggerOnImageUpdate
 Triggering event? [0-9] 9

The tool now has enough information to generate the project template.

   Generating:
   * application named "CatClientPlugin"
   * with namespace "catclientplugin"
   * with language "java"
   * with trigger event "catplugin.CatPlugin.triggerOnImageUpdate"
   * in location C:\workspace\
Created project "CatClientPlugin" in directory
 "C:\workspace\CatClientPlugin\"

Here is the whole sequence again with all of the steps together:

c:/workspace> cuae create CatClientPlugin
Project type? [application or plugin] application
Programming language? [java or csharp] java
Build format? [ant or maven2] ant
Project namespace? [default: catclientplugin]
Available application triggering event:
   0: Skip this step
   1: cisco.uc.cuae.legacy.JTapi.JTapiIncomingCall
   2: cisco.uc.cuae.legacy.JTapi.JTapiCallInitiated
   3: cisco.uc.cuae.legacy.JTapi.JTapiCallEstablished
   4: cisco.uc.cuae.legacy.CallControl.IncomingCall
   5: cisco.uc.cuae.legacy.Http.GotRequest
   6: cisco.uc.cuae.legacy.Presence.SubscriptionTerminated
   7: cisco.uc.cuae.legacy.Presence.Notify
   8: cisco.uc.cuae.legacy.TimerFacility.TimerFire
   9: catplugin.CatPlugin.triggerOnImageUpdate
Triggering event? [0-9] 9
Generating:
   * application named "CatClientPlugin"
   * with namespace "catclientplugin"
   * with laguage "java"
   * with trigger event "catplugin.CatPlugin.triggerOnImageUpdate"
   * in location C:\workspace\
Created project "CatClientPlugin" in directory
 "C:\workspace\CatClientPlugin\"

Inspecting the Generated Project#

Let's inspect the files that were generated by the CUAE command-line tool. It created an CatClientPlugin directory in the directory from which you ran the cuae create command. The CatClientPlugin directory contains the following files and directories:

• CatClientPlugin .etch
• CatClientPlugin .properties
• build.xml
• cuae-resources/
• README.txt
• src/

The most important of which, for your purposes, are:

• CatClientPlugin.etch--CUAE application Etch service definition. Edit this file to use additional CUAE services in your project.
• build.xml--Ant build script file with predefined targets for managing the lifecycle of your CUAE project.
• cuae-resources/--CUAE application resource directory.
• src/--Generated application source files.

Declaring Services#

The first step in building an Etch-based application is identifying which Cisco Unified Application Environment hosted services the application requires and then editing the .etch file to declare the names of those services into the application.

Tip:

Once you identify the services you need, you can familiarize yourself with them by visiting the API Reference for the version of the Unified Application Environment you are using.

The following snippet is the default content of the .etch file that the CUAE command-line tool generates. We use the mixin command to declare the appropriate services.

// CUAE Application Etch Service Definition
//
// This service defines your application and the CUAE services that you
// use in your application.

// The service module namespace, this will be translated to the
// namespace of the generated source code.
module catpluginclient

// The name of your service.
service CatPluginClient
{
    // By default, you must always use the EtchBridge service. Do not
    // remove this mixin, otherwise your application won't work.
    mixin cisco.uc.cuae.EtchBridge

    // You may add any additional service mixins that you require. For
    // example, if you'd like to make and receive phone calls, add the
    // following line:
    //     mixin cisco.uc.cuae.legacy.CallControl
    mixin catplugin.CatPlugin

}

Because this application will use methods in the CatPlugin library to send an image to an IpPhone, we need to utilize the CatPlugin and CiscoIpPhone services. The default etch file already has a mixin for CatPlugin because of the triggering event you selected when creating the application project.

    mixin catplugin.CatPlugin

We need to add a declaration for the CiscoIpPhone service, using the full namespace. Add the following line right after the mixin for CatPlugin but before the final "}":

mixin cisco.uc.cuae.legacy.CiscoIpPhone

The new CatPluginClient.etch file should look like this:

// CUAE Application Etch Service Definition
// 
// This service defines your application and the CUAE services that you
// use in your application.

// The service module namespace, this will be translated to the
// namespace of the generated source code.
module catpluginclient

// The name of your service.
service CatPluginClient
{
    // By default, you must always use the EtchBridge service. Do not
    // remove this mixin, otherwise your application won't work.
    mixin cisco.uc.cuae.EtchBridge

    // You may add any additional service mixins that you require. For
    // example, if you'd like to make and receive phone calls, add the
    // following line:
    //     mixin cisco.uc.cuae.legacy.CallControl
    mixin catplugin.CatPlugin
    mixin cisco.uc.cuae.legacy.CiscoIpPhone
    
}

Building the Application#

After declaring the services you need, you must build the application to generate source files.

1. Open a Command Prompt and navigate to the application directory.

2. Run the ant command to generate source files.

c:\workspace\CatPluginClient>ant

The following source file templates are then created in the directory src\catplugin:

• MainCatPluginClientClient.java
• ImplCatPluginClientClient.java

Writing Application Code#

This section provides instructions and code samples for writing the application logic.

Import the Project into your IDE#

1. Open Eclipse (or another IDE of your preference).

2. Create a new Java project from an existing Ant buildfile by selecting File -> New -> Other -> Java Project from an existing Ant buildfile and selecting the build.xml file from the CatPluginClient directory.

3. Click Next.

4. Browse to C:\workspace\CatPluginClient\ and select the build.xml file.

5. Click Open.

6. Select "javac" task found in target "build[default]".

First example code snippet: ImplCatPluginClientClient.java#

When a triggerOnImageUpdate occurs, construct a GraphicFileMenu with the image and send it to an IpPhone with the method SendExecute.

Code Sample#

@Override
public void triggerOnImageUpdate( String sessionId, String name )
{
	String phoneIpAddr = "<phone ip address>";
		
	System.out.println( String.format("ImplCatPluginClientClient.triggerOnImageUpdate - starts, sessionId is %s, name is %s", sessionId, name ) );
	String imgUrl = server.getImageLink( sessionId );
	System.out.println("Image link returned from server: "+imgUrl);

	ConstructGraphicFileMenuOptions opt = new ConstructGraphicFileMenuOptions();
	opt.locationX = 1;
	opt.locationY = 1;
	opt.title = "LolCat";
	opt.uRL = imgUrl;
	opt.formatURL = true;
	ConstructGraphicFileMenuResult res = server.constructGraphicFileMenu(sessionId, opt );
	if (!"success".equalsIgnoreCase( res.returnValue ))
	{
		System.out.println( String
			.format( "ConstructGraphicFile call is not success: %s",
				res.returnValue ) );
	}
	else
	{
		System.out.println( "XML object sent to the phone: " + res.xmlObject );
		server.sendExecute( sessionId, res.xmlObject, phoneIpAddr, new SendExecuteOptions("<username>", "<password>"));
	}
	server.removeCuaeSession( sessionId );
}

• Below given code block is to get an update on any plugin which goes down or restarts while the application is still executing. This code block is to be added into the file ImplCatPluginClientClient.java.

Code Sample#

@Override
public void pluginStatusUpdate(String pluginName, String nameSpace, PluginStatus status )
{
	System.out.println("Plugin Name : " + pluginName + "NameSpace" + nameSpace + "Status" + status);
}

Registering the Application#

The previous steps completed the core logic of the example applications, but before any Etch-based API calls can actually be made, we must register the application with the Cisco Unified Application Server. To register your application, follow these steps:

1. Open the MainCatPluginClientClient file in the /src directory. It contains the following content by default:

// Generated by:
// 0.96.0 (LOCAL-0) / java 0.96.0 (LOCAL-0)
// Wed Jul 16 11:23:49 CDT 2008

package catpluginclient;

/**
 * Main program for CatPluginClientClient. This program makes a connection to the
 * listener created by MainCatPluginClientListener.
 */
public class MainCatPluginClientClient implements CatPluginClientHelper.CatPluginClientClientFactory
{
	/**
	 * Main program for CatPluginClientClient.
	 * 
	 * @param args command line arguments.
	 * @throws Exception
	 */
	public static void main( String[] args ) throws Exception
	{
		// TODO Change to correct URI
		String uri = "tcp://localhost:9000";
		
		RemoteCatPluginClientServer server = CatPluginClientHelper.newServer( uri, null,
			new MainCatPluginClientClient() );

		// Connect to the service
		server._startAndWaitUp( 4000 );

		// TODO Insert Your Code Here
		
		// Disconnect from the service
		server._stopAndWaitDown( 4000 );
	}

	public CatPluginClientClient newCatPluginClientClient( RemoteCatPluginClientServer server )
		throws Exception
	{
		return new ImplCatPluginClientClient( server );
	}
}

2. To make a connection to the listener, add a server.registerApplication() request.

String key = server.registerApplication("CatPluginClient", "Default", "<username>", "<password>");
System.out.println("CatPluginClient registered with key: " + key);
System.out.println("Click any key and hit return to terminate the client...");
System.in.read();

3. Modify the String URI to match the IP address and port of the Cisco Unified Application Server.

URI settings vary slightly between 2.5(1) Beta 1 and more recent versions of 2.5(1), as follows:

2.5(1) and 2.5(1) Beta 2, Beta 3, Beta 4& later releases#

// TODO Change to correct URI
String uri = "tls://appserver_ipaddress:9000?TlsConnection.authReqd=false&filter=KeepAlive
 &KeepAlive.Count=5&Packetizer.maxPktSize=102400&TcpTransport.reconnectDelay=4000;

Note:

In Beta 2, the Etch Bridge was updated to use Transport Layer Security for encryption by default. For your applications to work, you must specify TLS as the protocol in the URI and set the authReqd parameter to false. In the example above, the Keep Alive filter and MaxPacketSize and Reconnect Delay parameters have also been set.

2.5(1) Beta 1#

// TODO Change to correct URI
		String uri = "tcp://appserver_ipaddress:9000?&TcpConnection.reconnect_delay=4000";

Note:

In addition to setting the correct IP address and port for the Cisco Unfied Application Server, the Reconnect Delay parameter should be set on all connection URIs.

Packaging The Test Application#

1. Execute a successful build request for your test application within your IDE.

2. To package the application, execute the "cuae package" command from a DOS command shell in the parent directory of the test application.

C:\workspace\CatPluginClient>cuae package
Created package file
"C:\workspace\CatPluginClient\bin\CatPluginClient.mca"

The following files will be added to the "\bin" sub-directory:

• CatPluginClient.mca (application bundle to be uploaded into the application server)
• INSTALLER.xml - (contains the config items in config.yaml)
• MANIFEST.xml - (bundle details for the package comamnd)

Installing The Test Application

• To install the test application on a CUAE server, execute the cuae install command from a DOS command shell in test application parent directory of the test application. The cuae install command varies slightly between 2.5(1) Beta 1 and Beta 2.

2.5(1) Beta 2#

You are prompted to enter an IP address, username, and password (to view the help, run the cuae install -h command). When prompted, enter Y or N to save management settings. This will save the answers to the above three questions in the properties file and remember them the next time you go to install.

Note

You are also prompted for the communications protocol (TCP or TLS). Select the protocol that is set on the Management Service. TLS is the default supported protocol. If you want to use TCP, follow the instructions in Management Service Transport Layer Security (TLS) to change the default URI of the Management Service before running these commands.

C:\workspace\CatPluginClient>cuae package
Created package file
"C:\workspace\CatPluginClient\bin\CatPluginClient.mca"

C:\workspace\CatPluginClient>cuae install
Enter the hostname or IP address of the management service (for example: localhost, 1.1.1.1): localhost
Protocol: tls
Generated mgmt-service uri: tls://localhost:9001?TlsConnection.authReqd=false
Enter management service login username:
Entermanagement service login password: ********
Save the amanagement settings with the project? [yes or no] n
Application : C:\workspace\CatPluginClientbin\CatPluginClient.mca
Uploading :  ===========================> 100%
Application has been installed successfully

2.5(1) Beta 1 #

You are prompted to enter an IP address, username, and password (to view the help, run the cuae install -h command). When prompted, enter Y or N to save management settings. This will save the answers to the above three questions in the properties file and remember them the next time you go to install.

C:\workspace\CatPluginClient>cuae package
Created package file
"C:\workspace\CatPluginClient\bin\CatPluginClient.mca"

C:\workspace\CatPluginClient>cuae install
Enter management service uri or host/IP <for example: localhost, tcp://1.1.1.1.:4001>:
Enter management service login username:
Entermanagement service login password: ********
Save the amanagement settings with the project? [YyNn] n
Application : C:\workspace\CatPluginClient\bin\CatPluginClient.mca
Uploading :  ===========================> 100%
Application ahas been installed successfully

Configuring the Application in the Administration Interface#

Adding a trigger#

1. Log in to the Administration interface.

2. Click Applications>Find/List Triggers to generate a list of applications and their associated triggers.

3. Select the application CatPluginClient in the list.

4. For name enter "name" and for value enter "cat".

5. Click Add Parameter.

Running the Application#

1. Run the class CatPluginClient.MainCatPluginClientClient to register the application.

At this point the application will remain registered and running until either you stop your application or the application loses connectivity to the Unified Application server.

2. The program will automatically detect and download new images as they are posted to the RSS feed. The application does not have to be manually triggered.