@SipApplication

@Target(value=PACKAGE)
@Retention(value=RUNTIME)
public @interface SipApplication

The @SipApplication annotation provides a mechanism to define application-level configuration for a group of SIP servlets. It is applied at the package level and is retained at runtime, ensuring the metadata is available during the execution of the application. This annotation acts as a marker for the SIP application, encapsulating and identifying the collection of servlets that belong to it. By using @SipApplication, you can create SIP applications without relying on external deployment descriptors.

Required Element:

name
public abstract java.lang.String name
It identifies the SIP application uniquely and is essential for the proper deployment and functioning of the application.

Optional Elements:

displayName
public abstract java.lang.String displayName
It provides a human-readable name for the SIP application, often used for descriptive purposes in management tools or logs.
Default Value: "" (empty string)\

smallIcon
public abstract java.lang.String smallIcon
Specifies the file name of a small icon associated with the SIP application. Is used for visual representation in management tools.
Default Value: "" (empty string)

largeIcon
public abstract java.lang.String largeIcon
Specifies the file name of a large icon associated with the SIP application. Similar to smallIcon, but used for larger display formats.
Default Value: "" (empty string)

description
public abstract java.lang.String description
Provides a textual description of the SIP application. This is optional and often used for documentation or display in admin consoles.
Default Value: "" (empty string)

distributable
public abstract boolean distributable
Indicates whether the SIP application is distributable across multiple containers for scalability and redundancy. When true, the application can be deployed in a cluster.
Default Value: false

proxyTimeout
public abstract int proxyTimeout
Specifies the default proxy timeout value in seconds for the application. Determines how long the application will wait for a proxy operation to complete before timing out.
Default Value: 180 (3 minutes)

sessionTimeout
public abstract int sessionTimeout
Specifies the default session timeout value in minutes for the SIP application. This value determines how long a session remains active without activity before it is invalidated.
Default Value: 3 (3 minutes)

mainServlet
public abstract java.lang.String mainServlet
Identifies the main servlet within the SIP application, which serves as the primary handler for requests. This element is used for applications where a specific servlet is designated as the entry point.
Default Value: "" (empty string)