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.event;
18  
19  /***
20   * A ZapShowChannelsEvent is triggered in response to a ZapShowChannelsAction and shows the state of
21   * a zap channel.
22   * 
23   * @see net.sf.asterisk.manager.action.ZapShowChannelsAction
24   * 
25   * @author srt
26   * @version $Id: ZapShowChannelsEvent.java,v 1.2 2005/02/23 22:50:58 srt Exp $
27   */
28  public class ZapShowChannelsEvent extends ResponseEvent
29  {
30      /***
31       * Serial version identifier
32       */
33      private static final long serialVersionUID = -3613642267527361400L;
34      private Integer channel;
35      private String signalling;
36      private String context;
37      private String alarm;
38  
39      /***
40       * @param source
41       */
42      public ZapShowChannelsEvent(Object source)
43      {
44          super(source);
45      }
46  
47      /***
48       * Returns the number of this zap channel.
49       */
50      public Integer getChannel()
51      {
52          return channel;
53      }
54  
55      /***
56       * Sets the number of this zap channel.
57       */
58      public void setChannel(Integer channel)
59      {
60          this.channel = channel;
61      }
62  
63      /***
64       * Returns the signalling of this zap channel.<br>
65       * Possible values are:
66       * <ul>
67       * <li>E & M Immediate</li>
68       * <li>E & M Wink</li>
69       * <li>E & M E1</li>
70       * <li>Feature Group D (DTMF)</li>
71       * <li>Feature Group D (MF)</li>
72       * <li>Feature Group B (MF)</li>
73       * <li>E911 (MF)</li>
74       * <li>FXS Loopstart</li>
75       * <li>FXS Groundstart</li>
76       * <li>FXS Kewlstart</li>
77       * <li>FXO Loopstart</li>
78       * <li>FXO Groundstart</li>
79       * <li>FXO Kewlstart</li>
80       * <li>PRI Signalling</li>
81       * <li>R2 Signalling</li>
82       * <li>SF (Tone) Signalling Immediate</li>
83       * <li>SF (Tone) Signalling Wink</li>
84       * <li>SF (Tone) Signalling with Feature Group D (DTMF)</li>
85       * <li>SF (Tone) Signalling with Feature Group D (MF)</li>
86       * <li>SF (Tone) Signalling with Feature Group B (MF)</li>
87       * <li>GR-303 Signalling with FXOKS</li>
88       * <li>GR-303 Signalling with FXSKS</li>
89       * <li>Pseudo Signalling</li>
90       * </ul>
91       */
92      public String getSignalling()
93      {
94          return signalling;
95      }
96  
97      /***
98       * Sets the signalling of this zap channel.
99       */
100     public void setSignalling(String signalling)
101     {
102         this.signalling = signalling;
103     }
104 
105     /***
106      * Returns the context of this zap channel as defined in <code>zapata.conf</code>.
107      */
108     public String getContext()
109     {
110         return context;
111     }
112 
113     /***
114      * Sets the context of this zap channel.
115      */
116     public void setContext(String context)
117     {
118         this.context = context;
119     }
120 
121     /***
122      * Returns the alarm state of this zap channel.<br>
123      * This may be one of
124      * <ul>
125      * <li>Red Alarm</li>
126      * <li>Yellow Alarm</li>
127      * <li>Blue Alarm</li>
128      * <li>Recovering</li>
129      * <li>Loopback</li>
130      * <li>Not Open</li>
131      * <li>No Alarm</li>
132      * </ul>
133      */
134     public String getAlarm()
135     {
136         return alarm;
137     }
138 
139     /***
140      * Sets the alarm state of this zap channel.
141      */
142     public void setAlarm(String alarm)
143     {
144         this.alarm = alarm;
145     }
146 }