View Javadoc

1   /*
2    *  Copyright 2004-2006 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 org.asteriskjava.manager.event;
18  
19  /***
20   * A ProtocolIdentifierReceivedEvent is triggered when the network connection to the Asterisk 
21   * server has been established and the protocol identifier has been sent.<p>
22   * It is a pseudo event not directly related to an Asterisk generated event.<p>
23   * The ProtocolIdentifierReceivedEvent is not dispatched to clients so you will
24   * probably never see it.
25   * 
26   * @author srt
27   * @version $Id: ProtocolIdentifierReceivedEvent.java 397 2006-05-26 12:13:32Z srt $
28   */
29  public class ProtocolIdentifierReceivedEvent extends ManagerEvent
30  {
31      /***
32       * Serializable version identifier
33       */
34      private static final long serialVersionUID = 3257845467831284784L;
35  
36      /***
37       * The version of the manager protocol.
38       */
39      private String protocolIdentifier;
40  
41      /***
42       * @param source
43       */
44      public ProtocolIdentifierReceivedEvent(Object source)
45      {
46          super(source);
47      }
48  
49      /***
50       * Returns the version of the protocol.
51       * 
52       * @return the version of the protocol.
53       */
54      public String getProtocolIdentifier()
55      {
56          return protocolIdentifier;
57      }
58  
59      /***
60       * Sets the version of the protocol.
61       * 
62       * @param protocolIdentifier the version of the protocol.
63       */
64      public void setProtocolIdentifier(String protocolIdentifier)
65      {
66          this.protocolIdentifier = protocolIdentifier;
67      }
68  }