org.asteriskjava.manager.event.UserEvent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of asterisk-java Show documentation
The free Java library for Asterisk PBX integration.
The newest version!
/*
 *  Copyright 2004-2006 Stefan Reuter
 *
 *  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 org.asteriskjava.manager.event;

/**
 * Abstract base class for user events.
 * 
 * You can send arbitrary user events via the UserEvent application provided
 * with asterisk. A user event by default has the attributes channel and
 * uniqueId but you can add custom attributes by specifying an event body.
 * 

 * To add your own user events you must subclass this class and name it
 * corresponding to your event. If you plan to send an event by
 * UserEvent(VIPCall) you will create a new class called
 * VIPCallEvent that extends UserEvent. The name of this class is important:
 * Just use the name of the event you will send (VIPCall in this example) and
 * append "Event".
 * 

 * To pass additional data create appropriate attributes with getter and setter
 * methods in your new class.
 * 

 * Example:
 *
 * 
 * public class VIPCallEvent extends UserEvent
 * {
 *     private String firstName;
 *
 *     public VIPCallEvent(Object source)
 *     {
 *         super(source);
 *     }
 *
 *     public String getFirstName()
 *     {
 *         return firstName;
 *     }
 *
 *     public void setFirstName(String firstName)
 *     {
 *         this.firstName = firstName;
 *     }
 * }
 * 
 * 
 * To send this event use UserEvent(VIPCall|firstName: Jon) in your
 * dialplan. Asterisk up to 1.2 (including) does only support one property in
 * the UserEvent so something like
 * UserEvent(VIPCall|firstName: Jon|lastName: Doe) will not work as
 * expected.
 * 

 * The UserEvent is implemented in apps/app_userevent.c.
 * 
 * Note that you must register your UserEvent with the ManagerConnection you are
 * using in order to be recognized.
 *
 * @author srt
 * @version $Id$
 * @see org.asteriskjava.manager.ManagerConnection#registerUserEventClass(Class)
 */
public abstract class UserEvent extends ManagerEvent {
    /**
     * Serial version identifier
     */
    private static final long serialVersionUID = 3256725065466000695L;

    /**
     * The name of the channel.
     */
    private String channel;

    /**
     * The unique id of the channel.
     */
    private String uniqueId;

    public UserEvent(Object source) {
        super(source);
    }

    /**
     * Returns the name of the channel this event occured in.
     *
     * @return the name of the channel this event occured in.
     */
    public String getChannel() {
        return channel;
    }

    /**
     * Sets the name of the channel this event occured in.
     *
     * @param channel the name of the channel this event occured in.
     */
    public void setChannel(String channel) {
        this.channel = channel;
    }

    /**
     * Returns the unqiue id of the channel this event occured in.
     *
     * @return the unqiue id of the channel this event occured in.
     */
    public String getUniqueId() {
        return uniqueId;
    }

    /**
     * Sets the unqiue id of the channel this event occured in.
     *
     * @param uniqueId the unqiue id of the channel this event occured in.
     */
    public void setUniqueId(String uniqueId) {
        this.uniqueId = uniqueId;
    }
}