SIPSubscribeEvent.java

/**
 * Copyright 2010-2011 Voxeo Corporation
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this
 * file except in compliance with the License.
 *
 * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed
 * under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS
 * OF ANY KIND, either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */

package com.voxeo.moho.sip;

import javax.servlet.sip.SipServletRequest;
import javax.servlet.sip.SipSession;

import com.voxeo.moho.event.SubscribeEvent;

/**
 * SIP specific {@link com.voxeo.moho.event.SubscribeEvent SubscribeEvent}.
 * 
 * @author wchen
 *
 */
public interface SIPSubscribeEvent extends SubscribeEvent {
  
  public static interface SIPSubscriptionContext extends SubscriptionContext {
    String getEventName();
    
    String getNotifyBodyType();
    
    int getExpires();
    
    Runnable sendNotify();
    
    SipSession getDialog();
    
  }
  /**
   * @return the SIP SUBSCRIBE request.
   */
  SipServletRequest getSipRequest();
}