View Javadoc

1   /*
2    * Copyright  2004-2005 Stefan Reuter
3    *
4    *  Licensed under the Apache License, Version 2.0 (the "License");
5    *  you may not use this file except in compliance with the License.
6    *  You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   *  Unless required by applicable law or agreed to in writing, software
11   *  distributed under the License is distributed on an "AS IS" BASIS,
12   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   *  See the License for the specific language governing permissions and
14   *  limitations under the License.
15   *
16   */
17  package net.sf.asterisk.manager.action;
18  
19  import net.sf.asterisk.manager.event.PeerlistCompleteEvent;
20  
21  /***
22   * Retrieves a list of all defined SIP peers.<br>
23   * For each peer that is found a PeerEntryEvent is sent by Asterisk containing
24   * the details. When all peers have been reported a PeerlistCompleteEvent is
25   * sent.<br>
26   * Available since Asterisk 1.2
27   * 
28   * @see net.sf.asterisk.manager.event.PeerEntryEvent
29   * @see net.sf.asterisk.manager.event.PeerlistCompleteEvent
30   * @author srt
31   * @version $Id: SIPPeersAction.java,v 1.2 2005/08/07 16:55:18 srt Exp $
32   * @since 0.2
33   */
34  public class SIPPeersAction extends AbstractManagerAction
35          implements
36              EventGeneratingAction
37  {
38      /***
39       * Serial version identifier
40       */
41      private static final long serialVersionUID = 921037572305993779L;
42  
43      /***
44       * Creates a new SIPPeersAction.
45       */
46      public SIPPeersAction()
47      {
48  
49      }
50  
51      public String getAction()
52      {
53          return "SIPPeers";
54      }
55  
56      public Class getActionCompleteEventClass()
57      {
58          return PeerlistCompleteEvent.class;
59      }
60  }