Skip to content

SipAppArchetype

Jump to bottom Edit New page
deruelle edited this page Dec 17, 2014 · 2 revisions

Creating the Hello SIP World Project

To create your SIP Servlets application 

mvn archetype:generate -DgroupId=com.mycompany.app -DartifactId=my-sipapp -DarchetypeGroupId=org.mobicents.servlet.sip.archetypes -DarchetypeArtifactId=maven-archetype-sipapp -DarchetypeVersion=1.1

this should give a similar output to the one below 

[INFO] Scanning for projects...
[INFO]                                                                         
[INFO] ------------------------------------------------------------------------
[INFO] Building Maven Stub Project (No POM) 1
[INFO] ------------------------------------------------------------------------
[INFO] 
[INFO] >>> maven-archetype-plugin:2.2:generate (default-cli) @ standalone-pom >>>
[INFO] 
[INFO] <<< maven-archetype-plugin:2.2:generate (default-cli) @ standalone-pom <<<
[INFO] 
[INFO] --- maven-archetype-plugin:2.2:generate (default-cli) @ standalone-pom ---
[INFO] Generating project in Interactive mode
[INFO] Archetype repository missing. Using the one from [org.mobicents.servlet.sip.archetypes:maven-archetype-sipapp:1.1] found in catalog local
Downloading: http://repo.maven.apache.org/maven2/org/mobicents/servlet/sip/archetypes/maven-archetype-sipapp/1.1/maven-archetype-sipapp-1.1.jar
Downloaded: http://repo.maven.apache.org/maven2/org/mobicents/servlet/sip/archetypes/maven-archetype-sipapp/1.1/maven-archetype-sipapp-1.1.jar (5 KB at 9.1 KB/sec)
Downloading: http://repo.maven.apache.org/maven2/org/mobicents/servlet/sip/archetypes/maven-archetype-sipapp/1.1/maven-archetype-sipapp-1.1.pom
Downloaded: http://repo.maven.apache.org/maven2/org/mobicents/servlet/sip/archetypes/maven-archetype-sipapp/1.1/maven-archetype-sipapp-1.1.pom (8 KB at 16.1 KB/sec)
[INFO] Using property: groupId = com.mycompany.app
[INFO] Using property: artifactId = my-sipapp
Define value for property 'version':  1.0-SNAPSHOT: : 
[INFO] Using property: package = com.mycompany.app
Confirm properties configuration:
groupId: com.mycompany.app
artifactId: my-sipapp
version: 1.0-SNAPSHOT
package: com.mycompany.app
 Y: : 
[INFO] ----------------------------------------------------------------------------
[INFO] Using following parameters for creating project from Archetype: maven-archetype-sipapp:1.1
[INFO] ----------------------------------------------------------------------------
[INFO] Parameter: groupId, Value: com.mycompany.app
[INFO] Parameter: artifactId, Value: my-sipapp
[INFO] Parameter: version, Value: 1.0-SNAPSHOT
[INFO] Parameter: package, Value: com.mycompany.app
[INFO] Parameter: packageInPathFormat, Value: com/mycompany/app
[INFO] Parameter: version, Value: 1.0-SNAPSHOT
[INFO] Parameter: package, Value: com.mycompany.app
[INFO] Parameter: groupId, Value: com.mycompany.app
[INFO] Parameter: artifactId, Value: my-sipapp
[INFO] project created from Archetype in dir: /temp/applications
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 12.290s
[INFO] Finished at: Tue May 01 17:09:58 CEST 2012
[INFO] Final Memory: 8M/91M
[INFO] ------------------------------------------------------------------------

Once the Maven Archetype plugin creates the project, change directories into the my-sipapp directory and take a look at the pom.xml. You should see the *Initial POM for the my-sipapp Project*. 

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelversion>
  <groupId>com.mycompany.app</groupid>
  <artifactId>my-sipapp</artifactid>
  <packaging>war</packaging>
  <version>1.0-SNAPSHOT</version>
  <name>my-sipapp Maven SipApp</name>
  <url>https://code.google.com/p/sipservlets/</url>
  <dependencies>
    <dependency>
      <groupId>junit</groupid>
      <artifactId>junit</artifactid>
      <version>3.8.1</version>
      <scope>test</scope>
    </dependency>
    
		<dependency>
			<groupId>log4j</groupid>
			<artifactId>log4j</artifactid>
			<version>1.2.14</version>
			<scope>provided</scope>
		</dependency>
		<dependency>
			<groupId>commons-logging</groupid>
			<artifactId>commons-logging-api</artifactid>
			<version>1.0.4</version>
			<scope>provided</scope>
		</dependency>

		
		<dependency>
			<groupId>javax.servlet</groupid>
			<artifactId>servlet-api</artifactid>
			<version>2.5</version>
			<scope>provided</scope>
		</dependency>
		
		<dependency>
			<groupId>org.mobicents.servlet.sip</groupid>
			<artifactId>sip-servlets-spec</artifactid>
			<version>1.7.0.FINAL</version>
			<scope>provided</scope>
		</dependency>

  </dependencies>
	<build>
		<finalName>my-sipapp</finalname>
		<plugins>
			<plugin>
				<artifactId>maven-compiler-plugin</artifactid>
				<version>2.4</version>
				<configuration>
					<source>1.6</source>
					<target>1.6</target>
				</configuration>
			</plugin>
			<plugin>
				<artifactId>maven-war-plugin</artifactid>
				<version>2.2</version>
				<configuration>
					<failOnMissingWebXml>false</failonmissingwebxml>
                                        <warSourceDirectory>${basedir}/src/main/sipapp</warsourcedirectory>
				</configuration>
			</plugin>
		</plugins>		
	</build>
	
	<repositories>
		<repository>
			  <id>mobicents-public-repository-group</id>
			  <name>Mobicens Public Maven Repository Group</name>
			  <url>https://oss.sonatype.org/content/groups/public</url>
			  <layout>default</layout>
			  <releases>
			    <updatePolicy>never</updatepolicy>
			  </releases>
			  <snapshots>
			    <updatePolicy>never</updatepolicy>
			  </snapshots>
		</repository>
		<repository>
			<id>jboss-public-repository-group</id>
			<name>JBoss Public Maven Repository Group</name>
			<url>https://repository.jboss.org/nexus/content/groups/public/</url>
			<layout>default</layout>
			<releases>
				<updatePolicy>never</updatepolicy>
			</releases>
			<snapshots>
				<updatePolicy>never</updatepolicy>
			</snapshots>
		</repository>	 
	</repositories>
</project>

Notice the packaging element contains the value war. This packaging type is what configures Maven to produce a web application archive in a WAR file. A project with war packaging is going to create a WAR file in the target/ directory. The default name of this file is ${artifactId}-${version}.war. In this project, the default WAR would be generated in target/my-sipapp-1.0-SNAPSHOT.war. In the my-sipapp project, we’ve customized the name of the generated WAR file by adding a finalName element inside of this project’s build configuration. With a finalName of my-sipapp, the package phase produces a WAR file in target/my-sipapp.war.

Deploying to Mobicents

Mobicents as described in the User Guide

and deploy your application in either $TOMCAT_HOME/webapps or $JBOSS_HOME/server/default/deploy and copy over the my-sipapp/dar/mobicents-dar.properties to the $TOMCAT_HOME/conf/dars or $JBOSS_HOME/server/default/conf/dars/mobicents-dar.properties

You can now start the container and make a call using your favorite SIP Client 

  Please note the call will probably be terminated right away since this example doesn't handle the Media Part and usually SIP Clients terminate the call if the media path can't be established

Troubleshooting

In case a new version of the maven sipapp archetype has been recently released and is not yet synched to the Maven Central Repository, the oss.sonatype.org maven repository has to be added to the maven global configuration to be able to fetch the archetype. This is achieved by adding the following profile to your M2_HOME/conf/settings.xml 

<profile>
  <id>maven-archectype-sipapp</id>
  <repositories>
    <repository>
      <id>mobicents-public-repository-group</id>
      <name>Mobicens Public Maven Repository Group</name>
      <url>https://oss.sonatype.org/content/groups/public</url>
      <layout>default</layout>
      <releases>
        <enabled>true</enabled>
        <updatePolicy>never</updatepolicy>
      </releases>
      <snapshots>
        <enabled>true</enabled>
        <updatePolicy>never</updatepolicy>
      </snapshots>
    </repository>
  </repositories>
  <pluginRepositories>
    <pluginRepository>
      <id>mobicents-public-repository-group</id>
      <name>Mobicens Public Maven Repository Group</name>
      <url>https://oss.sonatype.org/content/groups/public</url>
      <layout>default</layout>
      <releases>
        <enabled>true</enabled>
        <updatePolicy>never</updatepolicy>
      </releases>
      <snapshots>
        <enabled>true</enabled>
        <updatePolicy>never</updatepolicy>
      </snapshots>
    </pluginrepository>
  </pluginrepositories>
</profile>

and the profile should be added mentioned above to create the application 

mvn archetype:generate -DgroupId=com.mycompany.app -DartifactId=my-sipapp -DarchetypeGroupId=org.mobicents.servlet.sip.archetypes -DarchetypeArtifactId=maven-archetype-sipapp -DarchetypeVersion=1.1 -P maven-archectype-sipapp
Add a custom footer

Table of Contents

Overview

Home

Downloads

Roadmap

Documentation

Community User Guide

SIP Servlets 1.1 Javadoc

RestComm SIP Servlets Extensions Javadoc

Frameworks

CDI Telco Framework

SSF

Examples

 HTML5 WebRTC Video Application

 My First Application

Examples

Contribute

How to Contribute

 Write a Test/Run the Testsuite

RestComm Sip Servlets in Eclipse

Clone this wiki locally