About the Application#

This application is triggered on an http request to create an image of the current time and push a link of the image to the phone. It requires a location that is web accessible and writable from where your plugin is running to write an image file to. Two solutions to this are saving it to the MediaServer\Audio directory on the server and enabling Full Control sharing, or having a web accessible folder on your client.

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 ClockApp_java}}}

The tool then prompts you for additional information.

Note: 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.clockapp_java or something simple like clockapp_java. The tool offers you a simple namespace based on the project name. Let's accept the tool's suggestion for now and use clockapp_java

Project namespace? [default: clockapp_java] <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 http request, let's go ahead and specify the triggering event now. Select option 5:

 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 Triggering event? [0-8] 5}}}

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

   Generating:

• application named "ClockApp_java"
• with namespace "ClockApp_java"
• with laguage "java"
• with trigger event "cisco.uc.cuae.legacy.Http.GotRequest"
• in location C:\workspace\

Created project "ClockApp_java" in directory "C:\workspace\ClockApp_java\"}}}

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

c:/workspace> cuae create ClockApp_java

Project type? [application or plugin] application Programming language? [java or csharp] java Build format? [ant or maven2] ant Project namespace? [default: clockapp_java] 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 Triggering event? [0-8] 5 Generating:

• application named "ClockApp_java"
• with namespace "ClockApp_java"
• with laguage "java"
• with trigger event "cisco.uc.cuae.legacy.Http.GotRequest"
• in location C:\workspace\

Created project "ClockApp_java" in directory "C:\workspace\ClockApp_java\"}}}

Inspecting the Generated Project#

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

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

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

• ClockApp_java\.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.

Note: 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 ClockApp_java

The name of your service.service ClockApp_java{ 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 cisco.uc.cuae.legacy.Http } }}}

Because this application will trigger on an http request and push objects to an IP phone, we need to utilize the Http and CiscoIpPhone services. The default etch file already has a mixin for Http because of the triggering event you selected when creating the application project.

 mixin cisco.uc.cuae.legacy.Http

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

  mixin cisco.uc.cuae.legacy.CiscoIpPhone

The new ClockApp_java.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 ClockApp_java

The name of your service.service ClockApp_java{ 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 cisco.uc.cuae.legacy.Http 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\ClockApp_java>ant

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

• MainClockApp_javaClient.java
• ImplClockApp_javaClient.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 ClockApp_java directory.

3. Click Next.

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

5. Click Open.

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

First example code snippet#

To implement the following code, you will need to include the following import statements in ImpClockApp_javaClient.java:

import java.awt.Color;

import java.awt.Font; import java.awt.Graphics2D; import java.awt.image.BufferedImage; import java.io.File; import java.util.Calendar; import java.util.Date; import javax.imageio.ImageIO;}}}

When the application recieves an http request, it creates a graphic file menu to push an image url to a phone. Note that you will have to change the username and password to that of the end user associated with your phone, as well as changing the the url from localhost to the web accessible location where you are storing your image in "ImplClockApp_javaClient".

Code Sample#

String remoteHost = "";

@Override public void gotRequest( String sessionId, GotRequestOptions options ) { System.out.println( "gotRequest - called" ); if (handleActionRequest(sessionId, options)) return; System.out.println("Creating png file..."); remoteHost = options.remoteHost.substring(0,options.remoteHost.indexOf(":")); createPngFile(); ConstructGraphicFileMenuOptions opt = new ConstructGraphicFileMenuOptions(); opt.locationX = 1; opt.locationY = 1; opt.title = "MyClock"; Change the URL to fetch the application created clock image.opt.uRL = "http://" + remoteHost + "clockImg.png";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 ));server.removeCuaeSession( sessionId );return;}System.out.println("send the response back");server.sendResponse( sessionId, options.remoteHost, 200, "text/xml", res.xmlObject, "OK", null );server.removeCuaeSession( sessionId );}

private boolean handleActionRequest(String sessionId, GotRequestOptions options) { if (options.query == null) return false; String[] arr = options.query.split( "&" ); String action = null; String ip = null; String param = null; for (String item : arr) { if (item.startsWith( "action=")) { action = item.substring(7).trim(); } else if (item.startsWith("ip=")) { ip = item.substring( 3).trim(); } else if (item.startsWith( "param=")) { param = item.substring(6).trim(); } } if (ip == null || ip.length() == 0) return false; if (action==null || action.length()==0) action = options.url; else action = "/" + action; String act = action; if (param != null && param.length() > 0) act = action + "?" + param;

String url = "http://" + options.hostname + ":8000" + act;

System.out.println("url " + url);

ConstructTextResult ctr = null; ConstructTextOptions cto = new ConstructTextOptions(); cto.title = "Menu"; cto.prompt = "Action"; cto.text = "Hello"; cto.softKeyItem = new CiscoIPPhoneSoftKeyType[1]; cto.softKeyItem[0] = new CiscoIPPhoneSoftKeyType("Click", url, null, (short)1); ctr = server.constructText(sessionId, cto); SendExecuteResult ser = server.sendExecute(sessionId, ctr.xmlObject, ip, new SendExecuteOptions("cilla", "metreos")); server.sendResponse(sessionId, options.remoteHost, 200, "text/plain", "Check your IP phone: " + ctr.xmlObject, "OK", null); server.removeCuaeSession(sessionId); return true; }

private void createPngFile() { BufferedImage img = new BufferedImage( 298, 168, BufferedImage.TYPE_INT_RGB ); Graphics2D graphics = img.createGraphics(); graphics.setBackground( Color.BLUE ); graphics.clearRect( 0, 0, 298, 168 ); Font f = new Font( "Arial", Font.BOLD, 48 ); graphics.setFont( f ); graphics.setColor( (Color.RED ) ); Date date = new Date(); Calendar cal = Calendar.getInstance(); cal.setTime( date ); StringBuilder sb = new StringBuilder(); int hour = cal.get( Calendar.HOUR_OF_DAY ); sb.append( hour < 10 ? "0" + hour : "" + hour ).append( ":" ); int min = cal.get( Calendar.MINUTE ); sb.append( min < 10 ? "0" + min : "" + min ).append( ":" ); int sec = cal.get( Calendar.SECOND ); sb.append( sec < 10 ? "0" + sec : "" + sec ); graphics.drawString( sb.toString(), 60, 60 ); File file = new

<Path to save the created image in the machine where the application process is running also make this location accessable to IPPhones>File("

<location to save image>
clockImg.png" );try{boolean res = ImageIO.write( img, "png", file);System.out.println( "Return value of ImageIO.write() call: " + res );}catch ( Exception e ){e.printStackTrace( System.out );}} }}}

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 MainClockApp_javaClient file in the /src directory. It contains the following content by default:

package clockapp_java;

/ Main program for ClockApp_javaClient. This program makes a connection to the listener created by MainClockApp_javaListener./public class MainClockApp_javaClient implements ClockApp_javaHelper.ClockApp_javaClientFactory{ /

• Main program for ClockApp_javaClient.
• @param args command line arguments.
• @throws Exception
• /

public static void main( String[] args ) throws Exception { TODO Change to correct URIString uri = "tcp://localhost:9000"; RemoteClockApp_javaServer server = ClockApp_javaHelper.newServer( uri, null, new MainClockApp_javaClient() );

Connect to the serviceserver._startAndWaitUp( 4000 );

TODO Insert Your Code Here

Disconnect from the serviceserver._stopAndWaitDown( 4000 );}

public ClockApp_javaClient newClockApp_javaClient( RemoteClockApp_javaServer server ) throws Exception { return new ImplClockApp_javaClient( server ); } } }}}

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

String key = server.registerApplication("ClockApp_java", null, "<username>", "<password>");

System.out.println("ClockApp_java application registered with key: "+key); System.out.println("Press any key and hit enter to exit."); 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 Securityfor 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 KeepAlive filter and Max Packet Size 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\ClockApp_java>cuae package

Created package file "C:\workspace\ClockApp_java\bin\ClockApp_java.mca"}}}

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

• ClockApp_java.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\ClockApp_java>cuae package
Created package file
"C:\workspace\ClockApp_java\bin\ClockApp_java.mca"

C:\workspace\ClockApp_java>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] no
Application : C:\workspace\ClockApp_java\bin\ClockApp_java.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\ClockApp_java>cuae package

Created package file "C:\workspace\ClockApp_java\bin\ClockApp_java.mca"

C:\workspace\ClockApp_java>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\ClockApp_java\bin\ClockApp_java.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 ClockApp_java in the list.

4. Enter "url" and "/ClockApp_java".

5. Click Add Parameter.

Running the Application#

1. Run the class ClockApp_java.MainClockApp_javaClient 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. Run the program by entering

http://localhost:8000/ClockApp_java?ip=<phoneIP>

in a web browser.