01: /**
02: * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
03: * Unpublished - rights reserved under the Copyright Laws of the United States.
04: * Copyright © 2003 Sun Microsystems, Inc. All rights reserved.
05: * Copyright © 2005 BEA Systems, Inc. All rights reserved.
06: *
07: * Use is subject to license terms.
08: *
09: * This distribution may include materials developed by third parties.
10: *
11: * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12: *
13: * Module Name : JSIP Specification
14: * File Name : DialogTerminatedEvent.java
15: * Author : Phelim O'Doherty
16: *
17: * HISTORY
18: * Version Date Author Comments
19: * 1.2 17/06/2005 Pnelim O'Doherty New class
20: *
21: *~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22: */package javax.sip;
23:
24: import java.util.EventObject;
25:
26: /**
27: *
28: * DialogTerminatedEvent is delivered to the Listener when the
29: * dialog transitions to the terminated state. An implementation
30: * is expected to deliver this event to the listener when it discards
31: * all internal book keeping records for a given dialog, allowing the
32: * Listener to unmap its own data structures.
33: *
34: * @author BEA Systems, NIST
35: * @since v1.2
36: *
37: */
38: public class DialogTerminatedEvent extends EventObject {
39:
40: /**
41: * Constructs a DialogTerminatedEvent to indicate a dialog
42: * timeout.
43: *
44: * @param source - the source of TimeoutEvent.
45: * @param dialog - the dialog that timed out.
46: */
47: public DialogTerminatedEvent(Object source, Dialog dialog) {
48: super (source);
49: m_dialog = dialog;
50:
51: }
52:
53: /**
54: * Gets the Dialog associated with the event. This
55: * enables application developers to access the dialog associated to this
56: * event.
57: *
58: * @return the dialog associated with the response event or null if there is no dialog.
59: * @since v1.2
60: */
61: public Dialog getDialog() {
62: return m_dialog;
63: }
64:
65: // internal variables
66: private Dialog m_dialog = null;
67:
68: }
|