Class AsteriskOriginator
- java.lang.Object
-
- org.opennms.netmgt.asterisk.utils.AsteriskOriginator
-
public class AsteriskOriginator extends java.lang.Object
Originates a call using the Asterisk Manager API- Version:
- $Id: $
- Author:
- Jeff Gehlbach
-
-
Constructor Summary
Constructors Constructor Description AsteriskOriginator()
Default constructor.AsteriskOriginator(java.util.Properties amiProps)
Constructor for AsteriskOriginator.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description org.asteriskjava.manager.action.OriginateAction
buildOriginateAction()
Build a complete OriginateAction ready for dispatching.java.lang.String
getAmiHost()
getAmiHostjava.util.Properties
getAmiProps()
This returns the properties configured in the asterisk-configuration.properties file.java.lang.String
getCallerId()
getCallerIdjava.lang.String
getChannelVariable(java.lang.String name)
Retrieves a named channel variable for the originated calljava.util.Map<java.lang.String,java.lang.String>
getChannelVariables()
Retrieves a Map of channel variables for the originated calljava.lang.String
getLegAChannel()
getLegAChanneljava.lang.String
getLegAExtension()
getLegAExtensionjava.lang.String
getMessageText()
getMessageTextjava.lang.String
getSubject()
getSubjectboolean
isDebug()
isDebugvoid
originateCall()
Originates a call based on properties set on this bean.void
setAmiHost(java.lang.String amiHost)
setAmiHostvoid
setCallerId(java.lang.String cid)
setCallerIdvoid
setChannelVariable(java.lang.String name, java.lang.String value)
Sets a variable on the channel used for the originated callvoid
setDebug(boolean debug)
setDebugvoid
setLegAChannel(java.lang.String chan)
setLegAChannelvoid
setLegAExtension(java.lang.String exten)
setLegAExtensionvoid
setMessageText(java.lang.String messageText)
setMessageTextvoid
setSubject(java.lang.String subject)
setSubject
-
-
-
Constructor Detail
-
AsteriskOriginator
public AsteriskOriginator(java.util.Properties amiProps) throws AsteriskOriginatorException
Constructor for AsteriskOriginator.
- Parameters:
amiProps
- aProperties
object.- Throws:
AsteriskOriginatorException
- if any.
-
AsteriskOriginator
public AsteriskOriginator() throws AsteriskOriginatorException
Default constructor. Default properties from asterisk-properties are set into session.- Throws:
AsteriskOriginatorException
- if any.
-
-
Method Detail
-
originateCall
public void originateCall() throws AsteriskOriginatorException
Originates a call based on properties set on this bean.- Throws:
AsteriskOriginatorException
- if any.
-
buildOriginateAction
public org.asteriskjava.manager.action.OriginateAction buildOriginateAction() throws AsteriskOriginatorException
Build a complete OriginateAction ready for dispatching.- Returns:
- completed OriginateAction, ready to be passed to ManagerConnection.sendAction
- Throws:
AsteriskOriginatorException
- if any of the underlying operations fail
-
getCallerId
public java.lang.String getCallerId()
getCallerId
- Returns:
- Returns the Caller ID
-
setCallerId
public void setCallerId(java.lang.String cid)
setCallerId
- Parameters:
cid
- The from address to set.
-
getAmiHost
public java.lang.String getAmiHost()
getAmiHost
- Returns:
- Returns the AMI host.
-
setAmiHost
public void setAmiHost(java.lang.String amiHost) throws java.net.UnknownHostException
setAmiHost
- Parameters:
amiHost
- Sets the mail host.- Throws:
java.net.UnknownHostException
- if any.
-
getMessageText
public java.lang.String getMessageText()
getMessageText
- Returns:
- Returns the message text.
-
setMessageText
public void setMessageText(java.lang.String messageText)
setMessageText
- Parameters:
messageText
- Sets the message text.
-
getSubject
public java.lang.String getSubject()
getSubject
- Returns:
- Returns the message Subject.
-
setSubject
public void setSubject(java.lang.String subject)
setSubject
- Parameters:
subject
- Sets the message Subject.
-
getLegAExtension
public java.lang.String getLegAExtension()
getLegAExtension
- Returns:
- Returns the extension for Leg A
-
setLegAExtension
public void setLegAExtension(java.lang.String exten)
setLegAExtension
- Parameters:
exten
- Sets the extension for Leg A
-
getLegAChannel
public java.lang.String getLegAChannel()
getLegAChannel
- Returns:
- Returns the channel for Leg A
-
setLegAChannel
public void setLegAChannel(java.lang.String chan)
setLegAChannel
- Parameters:
chan
- Sets the channel for Leg A
-
isDebug
public boolean isDebug()
isDebug
- Returns:
- a boolean.
-
setDebug
public void setDebug(boolean debug)
setDebug
- Parameters:
debug
- a boolean.
-
getAmiProps
public java.util.Properties getAmiProps()
This returns the properties configured in the asterisk-configuration.properties file.- Returns:
- a
Properties
object.
-
setChannelVariable
public void setChannelVariable(java.lang.String name, java.lang.String value)
Sets a variable on the channel used for the originated call- Parameters:
name
- Name of variable to setvalue
- Value to set for variable
-
getChannelVariables
public java.util.Map<java.lang.String,java.lang.String> getChannelVariables()
Retrieves a Map of channel variables for the originated call- Returns:
- A Map of channel variable names and values
-
getChannelVariable
public java.lang.String getChannelVariable(java.lang.String name)
Retrieves a named channel variable for the originated call- Parameters:
name
- Name of variable to retrieve- Returns:
- Value of named variable
-
-