Method Specific Annotations

Annotations are defined for each SIP method, such as INVITE, ACK, and REGISTER. Each runtime annotation is annotated with the SIP meta annotation @SipMethod.

A method annotated with @Invite is invoked by the SIP Container for SIP requests or SIP responses based on the type of the first parameter of the method. When the parameter is of type SipServletRequest.class, it is invoked for all SIP requests with the method INVITE. When the parameter is of type SipServletResponse.class, it is invoked for all SIP responses for the method INVITE.

Example 3-1 shows a SIP Servlet POJO that uses the @Invite annotation.

Example 3-1 @Invite Annotation

@SipServlet
public class ExamplePOJO {
  @Invite
  public void handleInviteRequest(SipServletRequest request) {
    //...
  }
  @Invite
  public void handleInviteResponse(SipServletResponse response) {
    //...
  }
}

The following method specific annotations are implemented:

@Invite
@Ack
@Options
@Bye
@Cancel
@Register
@Prack
@Subscribe
@Notify
@Message
@Info
@Update
@Refer
@Publish

For descriptions of the associated SIP request methods, see "SIP Requests".

@AnyMethod Annotation

The @AnyMethod annotation can handle SIP messages corresponding to any SIP method. Applications may use @AnyMethod annotation to receive all SIP requests and SIP responses without checking the method. If the annotation is specified on a method whose first parameter is not a SipServletRequest or SipServletResponse, a deployment error occurs.