org.opennms.netmgt.asterisk.agi.scripts
Class BaseOnmsAgiScript

java.lang.Object
  org.asteriskjava.fastagi.AgiOperations
      org.asteriskjava.fastagi.BaseAgiScript
          org.opennms.netmgt.asterisk.agi.scripts.BaseOnmsAgiScript

All Implemented Interfaces:

org.asteriskjava.fastagi.AgiChannel, org.asteriskjava.fastagi.AgiScript

Direct Known Subclasses:

LouieLouieLyricsAgiScript, ReadNoticeDetailsAgiScript

public abstract class BaseOnmsAgiScript
extends org.asteriskjava.fastagi.BaseAgiScript

Abstract BaseOnmsAgiScript class.

Version:

$Id: $

Author:

jeffg

Field Summary

protected static String	VAR_INTERRUPT_DIGITS Constant VAR_INTERRUPT_DIGITS="INTERRUPT_DIGITS"
static String	VAR_OPENNMS_INTERFACE Constant VAR_OPENNMS_INTERFACE="OPENNMS_INTERFACE"
static String	VAR_OPENNMS_NODEID Constant VAR_OPENNMS_NODEID="OPENNMS_NODEID"
static String	VAR_OPENNMS_NODELABEL Constant VAR_OPENNMS_NODELABEL="OPENNMS_NODELABEL"
static String	VAR_OPENNMS_NOTIFY_BODY Constant VAR_OPENNMS_NOTIFY_BODY="OPENNMS_NOTIFY_BODY"
static String	VAR_OPENNMS_NOTIFY_SUBJECT Constant VAR_OPENNMS_NOTIFY_SUBJECT="OPENNMS_NOTIFY_SUBJECT"
static String	VAR_OPENNMS_SERVICE Constant VAR_OPENNMS_SERVICE="OPENNMS_SERVICE"
static String	VAR_OPENNMS_USER_PIN Constant VAR_OPENNMS_USER_PIN="OPENNMS_USER_PIN"
static String	VAR_OPENNMS_USERNAME Constant VAR_OPENNMS_USERNAME="OPENNMS_USERNAME"

Constructor Summary

BaseOnmsAgiScript()

Method Summary

protected ThreadCategory	log() log
protected char	sayAlphaInterruptible(String text) sayAlphaInterruptible
protected char	sayDateTimeInterruptible(long time) sayDateTimeInterruptible
protected char	sayDigitsInterruptible(String digits) sayDigitsInterruptible
protected char	sayIpAddressInterruptible(InetAddress addr) sayIpAddressInterruptible
protected char	sayIpAddressInterruptible(String addrString) sayIpAddressInterruptible
protected char	sayNumberInterruptible(String number) sayNumberInterruptible
protected char	sayPhoneticInterruptible(String text) sayPhoneticInterruptible
protected char	sayTimeInterruptible(long time) sayTimeInterruptible
protected char	streamFileInterruptible(String file) streamFileInterruptible

Methods inherited from class org.asteriskjava.fastagi.AgiOperations

answer, continueAt, controlStreamFile, controlStreamFile, controlStreamFile, controlStreamFile, databaseDel, databaseDelTree, databaseDelTree, databaseGet, databasePut, exec, exec, getChannel, getChannelStatus, getData, getData, getData, getFullVariable, getFullVariable, getLastReply, getName, getOption, getOption, getUniqueId, getVariable, hangup, playMusicOnHold, playMusicOnHold, recordFile, recordFile, sayAlpha, sayAlpha, sayDateTime, sayDateTime, sayDateTime, sayDateTime, sayDigits, sayDigits, sayNumber, sayNumber, sayPhonetic, sayPhonetic, sayTime, sayTime, sendCommand, setAutoHangup, setCallerId, setContext, setExtension, setPriority, setVariable, speechActivateGrammar, speechCreate, speechCreate, speechDeactivateGrammar, speechDestroy, speechLoadGrammar, speechRecognize, speechRecognize, speechSet, speechUnloadGrammar, stopMusicOnHold, streamFile, streamFile, streamFile, verbose, waitForDigit

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.asteriskjava.fastagi.AgiScript

service

Field Detail

VAR_INTERRUPT_DIGITS

protected static final String VAR_INTERRUPT_DIGITS

Constant VAR_INTERRUPT_DIGITS="INTERRUPT_DIGITS"

See Also:

Constant Field Values

VAR_OPENNMS_INTERFACE

public static final String VAR_OPENNMS_INTERFACE

Constant VAR_OPENNMS_INTERFACE="OPENNMS_INTERFACE"

See Also:

Constant Field Values

VAR_OPENNMS_SERVICE

public static final String VAR_OPENNMS_SERVICE

Constant VAR_OPENNMS_SERVICE="OPENNMS_SERVICE"

See Also:

Constant Field Values

VAR_OPENNMS_NODEID

public static final String VAR_OPENNMS_NODEID

Constant VAR_OPENNMS_NODEID="OPENNMS_NODEID"

See Also:

Constant Field Values

VAR_OPENNMS_NODELABEL

public static final String VAR_OPENNMS_NODELABEL

Constant VAR_OPENNMS_NODELABEL="OPENNMS_NODELABEL"

See Also:

Constant Field Values

VAR_OPENNMS_NOTIFY_SUBJECT

public static final String VAR_OPENNMS_NOTIFY_SUBJECT

Constant VAR_OPENNMS_NOTIFY_SUBJECT="OPENNMS_NOTIFY_SUBJECT"

See Also:

Constant Field Values

VAR_OPENNMS_NOTIFY_BODY

public static final String VAR_OPENNMS_NOTIFY_BODY

Constant VAR_OPENNMS_NOTIFY_BODY="OPENNMS_NOTIFY_BODY"

See Also:

Constant Field Values

VAR_OPENNMS_USER_PIN

public static final String VAR_OPENNMS_USER_PIN

Constant VAR_OPENNMS_USER_PIN="OPENNMS_USER_PIN"

See Also:

Constant Field Values

VAR_OPENNMS_USERNAME

public static final String VAR_OPENNMS_USERNAME

Constant VAR_OPENNMS_USERNAME="OPENNMS_USERNAME"

See Also:

Constant Field Values

Constructor Detail

BaseOnmsAgiScript

public BaseOnmsAgiScript()

Method Detail

sayAlphaInterruptible

protected char sayAlphaInterruptible(String text)
                              throws org.asteriskjava.fastagi.AgiException

sayAlphaInterruptible

Parameters:

text - a String object.

Returns:

a char.

Throws:

org.asteriskjava.fastagi.AgiException - if any.

sayDateTimeInterruptible

protected char sayDateTimeInterruptible(long time)
                                 throws org.asteriskjava.fastagi.AgiException

sayDateTimeInterruptible

Parameters:

time - a long.

Returns:

a char.

Throws:

org.asteriskjava.fastagi.AgiException - if any.

sayDigitsInterruptible

protected char sayDigitsInterruptible(String digits)
                               throws org.asteriskjava.fastagi.AgiException

sayDigitsInterruptible

Parameters:

digits - a String object.

Returns:

a char.

Throws:

org.asteriskjava.fastagi.AgiException - if any.

sayNumberInterruptible

protected char sayNumberInterruptible(String number)
                               throws org.asteriskjava.fastagi.AgiException

sayNumberInterruptible

Parameters:

number - a String object.

Returns:

a char.

Throws:

org.asteriskjava.fastagi.AgiException - if any.

sayPhoneticInterruptible

protected char sayPhoneticInterruptible(String text)
                                 throws org.asteriskjava.fastagi.AgiException

sayPhoneticInterruptible

Parameters:

text - a String object.

Returns:

a char.

Throws:

org.asteriskjava.fastagi.AgiException - if any.

sayTimeInterruptible

protected char sayTimeInterruptible(long time)
                             throws org.asteriskjava.fastagi.AgiException

sayTimeInterruptible

Parameters:

time - a long.

Returns:

a char.

Throws:

org.asteriskjava.fastagi.AgiException - if any.

sayIpAddressInterruptible

protected char sayIpAddressInterruptible(InetAddress addr)
                                  throws org.asteriskjava.fastagi.AgiException

sayIpAddressInterruptible

Parameters:

addr - a InetAddress object.

Returns:

a char.

Throws:

org.asteriskjava.fastagi.AgiException - if any.

sayIpAddressInterruptible

protected char sayIpAddressInterruptible(String addrString)
                                  throws org.asteriskjava.fastagi.AgiException

sayIpAddressInterruptible

Parameters:

addrString - a String object.

Returns:

a char.

Throws:

org.asteriskjava.fastagi.AgiException - if any.

streamFileInterruptible

protected char streamFileInterruptible(String file)
                                throws org.asteriskjava.fastagi.AgiException

streamFileInterruptible

Parameters:

file - a String object.

Returns:

a char.

Throws:

org.asteriskjava.fastagi.AgiException - if any.

log

protected ThreadCategory log()

log

Returns:

a ThreadCategory object.