CdrEvent (Asterisk-Java 3.12.0 API)

java.lang.Object
- java.util.EventObject
- - org.asteriskjava.manager.event.ManagerEvent
  - - org.asteriskjava.manager.event.CdrEvent

All Implemented Interfaces:

Serializable
```
public class CdrEvent
extends ManagerEvent
```
A CdrEvent is triggered when a call detail record is generated, usually at the end of a call.
To enable CdrEvents you have to add enabled = yes to the general section in cdr_manager.conf.
This event is implemented in cdr/cdr_manager.c

Version:

$Id$

Author:

srt

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AMA_FLAG_BILLING`
`static String`	`AMA_FLAG_DOCUMENTATION`
`static String`	`AMA_FLAG_OMIT`
`static String`	`AMA_FLAG_UNKNOWN`
`static String`	`DISPOSITION_ANSWERED`
`static String`	`DISPOSITION_BUSY`
`static String`	`DISPOSITION_FAILED`
`static String`	`DISPOSITION_NO_ANSWER`
`static String`	`DISPOSITION_UNKNOWN`

Fields inherited from class org.asteriskjava.manager.event.ManagerEvent
callerIdName, callerIdNum, channelState, channelStateDesc, connectedLineName, connectedLineNum, context, exten, priority

Fields inherited from class java.util.EventObject
source

Constructor Summary

Constructors
Constructor and Description

CdrEvent(Object source)

Constructors
Constructor and Description
`CdrEvent(Object source)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAccountCode()` Returns the account number that is usually used to identify the party to bill for the call.
`String`	`getAmaFlags()` Returns the AMA (Automated Message Accounting) flags.
`String`	`getAnswerTime()` Returns when the call was answered.
`Date`	`getAnswerTimeAsDate()` Returns the answer time as Date object.
`Date`	`getAnswerTimeAsDate(TimeZone tz)` Returns the answer time as Date object.
`Integer`	`getBillableSeconds()` Returns the total time (in seconds) the call was up from answer to hangup.
`String`	`getCallerId()` Returns the Caller*ID with text.
`String`	`getChannel()` Returns the name of the channel, for example "SIP/1310-asfe".
`String`	`getDestination()` Returns the destination extension.
`String`	`getDestinationChannel()` Returns the name of the destination channel if appropriate.
`String`	`getDestinationContext()` Returns the destination context.
`String`	`getDisposition()` Returns what happened to the call.
`Integer`	`getDuration()` Returns the total time (in seconds) the caller spent in the system from dial to hangup.
`String`	`getEndTime()` Returns when the call has ended.
`Date`	`getEndTimeAsDate()` Returns the end time as Date object.
`Date`	`getEndTimeAsDate(TimeZone tz)` Returns the end time as Date object.
`String`	`getLastApplication()` Returns the last application if appropriate, for example "VoiceMail".
`String`	`getLastData()` Returns the last application's data (arguments), for example "s1234".
`String`	`getRecordfile()` Returns record filename.
`String`	`getSrc()` Returns the Caller*ID number.
`String`	`getStartTime()` Returns when the call has started.
`Date`	`getStartTimeAsDate()` Returns the start time as Date object.
`Date`	`getStartTimeAsDate(TimeZone tz)` Returns the start time as Date object.
`String`	`getUniqueId()` Returns the unique id of the channel.
`String`	`getUserField()` Returns the user-defined field as set by `Set(CDR(userfield)=Value)`.
`void`	`setAccountCode(String accountCode)` Sets the account number.
`void`	`setAmaFlags(String amaFlags)` Sets the AMA (Automated Message Accounting) flags.
`void`	`setAnswerTime(String answerTime)` Sets the date/time when the call was answered.
`void`	`setBillableSeconds(Integer billableSeconds)` Sets the total time in call.
`void`	`setCallerId(String callerId)` Sets the Caller*ID with text.
`void`	`setChannel(String channel)` Sets the name of the channel.
`void`	`setDestination(String destination)` Sets the destination extension.
`void`	`setDestinationChannel(String destinationChannel)` Sets the name of the destination channel.
`void`	`setDestinationContext(String destinationContext)` Sets the destination context.
`void`	`setDisposition(String disposition)` Sets the disposition.
`void`	`setDuration(Integer duration)` Sets the total time in system.
`void`	`setEndTime(String endTime)` Sets the date/time when the call has ended.
`void`	`setLastApplication(String lastApplication)` Sets the last application.
`void`	`setLastData(String lastData)` Set the last application's data.
`void`	`setRecordfile(String recordfile)` Sets record filename.
`void`	`setSrc(String source)` Sets the Caller*ID number.
`void`	`setStartTime(String startTime)` Sets the date/time when the call has started.
`void`	`setUniqueId(String uniqueId)` Sets the unique id of the channel.
`void`	`setUserField(String userField)` Sets the user-defined field.

Methods inherited from class org.asteriskjava.manager.event.ManagerEvent
appendPropertyIfNotNull, getCallerIdName, getCallerIdNum, getChannelState, getChannelStateDesc, getConnectedLineName, getConnectedLineNum, getContext, getDateReceived, getExten, getFile, getFunc, getLine, getPriority, getPrivilege, getSequenceNumber, getServer, getSystemName, getTimestamp, setCallerIdName, setCallerIdNum, setChannelState, setChannelStateDesc, setConnectedLineName, setConnectedLineNum, setContext, setDateReceived, setExten, setFile, setFunc, setLine, setPriority, setPrivilege, setSequenceNumber, setServer, setSystemName, setTimestamp, toString

Methods inherited from class java.util.EventObject
getSource

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DISPOSITION_NO_ANSWER
```
public static final String DISPOSITION_NO_ANSWER
```
    See Also:
    
    Constant Field Values
  - DISPOSITION_FAILED
```
public static final String DISPOSITION_FAILED
```
    See Also:
    
    Constant Field Values
  - DISPOSITION_BUSY
```
public static final String DISPOSITION_BUSY
```
    See Also:
    
    Constant Field Values
  - DISPOSITION_ANSWERED
```
public static final String DISPOSITION_ANSWERED
```
    See Also:
    
    Constant Field Values
  - DISPOSITION_UNKNOWN
```
public static final String DISPOSITION_UNKNOWN
```
    See Also:
    
    Constant Field Values
  - AMA_FLAG_OMIT
```
public static final String AMA_FLAG_OMIT
```
    See Also:
    
    Constant Field Values
  - AMA_FLAG_BILLING
```
public static final String AMA_FLAG_BILLING
```
    See Also:
    
    Constant Field Values
  - AMA_FLAG_DOCUMENTATION
```
public static final String AMA_FLAG_DOCUMENTATION
```
    See Also:
    
    Constant Field Values
  - AMA_FLAG_UNKNOWN
```
public static final String AMA_FLAG_UNKNOWN
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CdrEvent
```
public CdrEvent(Object source)
```
    Parameters:
    
    source -
- Method Detail
  - getAccountCode
```
public String getAccountCode()
```
    Returns the account number that is usually used to identify the party to bill for the call.
    Corresponds to CDR field accountcode.
    
    Returns:
    
    the account number.
  - setAccountCode
```
public void setAccountCode(String accountCode)
```
    Sets the account number.
    
    Parameters:
    
    accountCode - the account number.
  - getSrc
```
public String getSrc()
```
    Returns the Caller*ID number.
    Corresponds to CDR field src.
    
    Returns:
    
    the Caller*ID number.
  - setSrc
```
public void setSrc(String source)
```
    Sets the Caller*ID number.
    
    Parameters:
    
    source - the Caller*ID number.
  - getDestination
```
public String getDestination()
```
    Returns the destination extension.
    Corresponds to CDR field dst.
    
    Returns:
    
    the destination extension.
  - setDestination
```
public void setDestination(String destination)
```
    Sets the destination extension.
    
    Parameters:
    
    destination - the destination extension.
  - getDestinationContext
```
public String getDestinationContext()
```
    Returns the destination context.
    Corresponds to CDR field dcontext.
    
    Returns:
    
    the destination context.
  - setDestinationContext
```
public void setDestinationContext(String destinationContext)
```
    Sets the destination context.
    
    Parameters:
    
    destinationContext - the destination context.
  - getCallerId
```
public String getCallerId()
```
    Returns the Caller*ID with text.
    Corresponds to CDR field clid.
    
    Returns:
    
    the Caller*ID with text
  - setCallerId
```
public void setCallerId(String callerId)
```
    Sets the Caller*ID with text.
    
    Parameters:
    
    callerId - the Caller*ID with text.
  - getChannel
```
public String getChannel()
```
    Returns the name of the channel, for example "SIP/1310-asfe".
    Corresponds to CDR field channel.
    
    Returns:
    
    the name of the channel.
  - setChannel
```
public void setChannel(String channel)
```
    Sets the name of the channel.
    
    Parameters:
    
    channel - the name of the channel.
  - getDestinationChannel
```
public String getDestinationChannel()
```
    Returns the name of the destination channel if appropriate.
    Corresponds to CDR field dstchannel.
    
    Returns:
    
    the name of the destination channel or null if not available.
  - setDestinationChannel
```
public void setDestinationChannel(String destinationChannel)
```
    Sets the name of the destination channel.
    
    Parameters:
    
    destinationChannel - the name of the destination channel.
  - getLastApplication
```
public String getLastApplication()
```
    Returns the last application if appropriate, for example "VoiceMail".
    Corresponds to CDR field lastapp.
    
    Returns:
    
    the last application or null if not avaialble.
  - setLastApplication
```
public void setLastApplication(String lastApplication)
```
    Sets the last application.
    
    Parameters:
    
    lastApplication - the last application.
  - getLastData
```
public String getLastData()
```
    Returns the last application's data (arguments), for example "s1234".
    Corresponds to CDR field lastdata.
    
    Returns:
    
    the last application's data or null if not avaialble.
  - setLastData
```
public void setLastData(String lastData)
```
    Set the last application's data.
    
    Parameters:
    
    lastData - the last application's data.
  - getStartTime
```
public String getStartTime()
```
    Returns when the call has started.
    This corresponds to CDR field start.
    
    Returns:
    
    A string of the format "%Y-%m-%d %T" (strftime(3)) representing the date/time the call has started, for example "2006-05-19 11:54:48".
  - getStartTimeAsDate
```
public Date getStartTimeAsDate()
```
    Returns the start time as Date object.
    This method asumes that the Asterisk server's timezone equals the default timezone of your JVM.
    
    Returns:
    
    the start time as Date object.
    
    Since:
    
    0.3
  - getStartTimeAsDate
```
public Date getStartTimeAsDate(TimeZone tz)
```
    Returns the start time as Date object.
    
    Parameters:
    
    tz - the timezone of the Asterisk server.
    
    Returns:
    
    the start time as Date object.
    
    Since:
    
    0.3
  - setStartTime
```
public void setStartTime(String startTime)
```
    Sets the date/time when the call has started.
    
    Parameters:
    
    startTime - the date/time when the call has started.
  - getAnswerTime
```
public String getAnswerTime()
```
    Returns when the call was answered.
    This corresponds to CDR field answered.
    
    Returns:
    
    A string of the format "%Y-%m-%d %T" (strftime(3)) representing the date/time the call was answered, for example "2006-05-19 11:55:01"
  - getAnswerTimeAsDate
```
public Date getAnswerTimeAsDate()
```
    Returns the answer time as Date object.
    This method asumes that the Asterisk server's timezone equals the default timezone of your JVM.
    
    Returns:
    
    the answer time as Date object.
    
    Since:
    
    0.3
  - getAnswerTimeAsDate
```
public Date getAnswerTimeAsDate(TimeZone tz)
```
    Returns the answer time as Date object.
    
    Parameters:
    
    tz - the timezone of the Asterisk server.
    
    Returns:
    
    the answer time as Date object.
    
    Since:
    
    0.3
  - setAnswerTime
```
public void setAnswerTime(String answerTime)
```
    Sets the date/time when the call was answered.
    
    Parameters:
    
    answerTime - the date/time when the call was answered.
  - getEndTime
```
public String getEndTime()
```
    Returns when the call has ended.
    This corresponds to CDR field end.
    
    Returns:
    
    A string of the format "%Y-%m-%d %T" (strftime(3)) representing the date/time the call has ended, for example "2006-05-19 11:58:21"
  - getEndTimeAsDate
```
public Date getEndTimeAsDate()
```
    Returns the end time as Date object.
    This method asumes that the Asterisk server's timezone equals the default timezone of your JVM.
    
    Returns:
    
    the end time as Date object.
    
    Since:
    
    0.3
  - getEndTimeAsDate
```
public Date getEndTimeAsDate(TimeZone tz)
```
    Returns the end time as Date object.
    
    Parameters:
    
    tz - the timezone of the Asterisk server.
    
    Returns:
    
    the end time as Date object.
    
    Since:
    
    0.3
  - setEndTime
```
public void setEndTime(String endTime)
```
    Sets the date/time when the call has ended.
    
    Parameters:
    
    endTime - the date/time when the call has ended.
  - getDuration
```
public Integer getDuration()
```
    Returns the total time (in seconds) the caller spent in the system from dial to hangup.
    Corresponds to CDR field duration.
    
    Returns:
    
    the total time in system in seconds.
  - setDuration
```
public void setDuration(Integer duration)
```
    Sets the total time in system.
    
    Parameters:
    
    duration - total time in system in seconds.
  - getBillableSeconds
```
public Integer getBillableSeconds()
```
    Returns the total time (in seconds) the call was up from answer to hangup.
    Corresponds to CDR field billsec.
    
    Returns:
    
    the total time in call in seconds.
  - setBillableSeconds
```
public void setBillableSeconds(Integer billableSeconds)
```
    Sets the total time in call.
    
    Parameters:
    
    billableSeconds - the total time in call in seconds.
  - getDisposition
```
public String getDisposition()
```
    Returns what happened to the call.
    This is one of
    Corresponds to CDR field disposition.
    Returns:
    
    the disposition.
  - setDisposition
```
public void setDisposition(String disposition)
```
    Sets the disposition.
    
    Parameters:
    
    disposition - the disposition.
  - getAmaFlags
```
public String getAmaFlags()
```
    Returns the AMA (Automated Message Accounting) flags.
    This is one of
    Corresponds to CDR field amaflags.
    Returns:
    
    the AMA flags.
  - setAmaFlags
```
public void setAmaFlags(String amaFlags)
```
    Sets the AMA (Automated Message Accounting) flags.
    
    Parameters:
    
    amaFlags - the AMA (Automated Message Accounting) flags.
  - getUniqueId
```
public String getUniqueId()
```
    Returns the unique id of the channel.
    
    Returns:
    
    the unique id of the channel.
  - setUniqueId
```
public void setUniqueId(String uniqueId)
```
    Sets the unique id of the channel.
    
    Parameters:
    
    uniqueId - the unique id of the channel.
  - getUserField
```
public String getUserField()
```
    Returns the user-defined field as set by Set(CDR(userfield)=Value).
    Corresponds to CDR field userfield.
    
    Returns:
    
    the user-defined field.
  - setUserField
```
public void setUserField(String userField)
```
    Sets the user-defined field.
    
    Parameters:
    
    userField - the user-defined field
  - getRecordfile
```
public String getRecordfile()
```
    Returns record filename.
    
    Returns:
    
    record filename.
  - setRecordfile
```
public void setRecordfile(String recordfile)
```
    Sets record filename.
    
    Parameters:
    
    recordfile - record filename.

Class CdrEvent

Field Summary

Fields inherited from class org.asteriskjava.manager.event.ManagerEvent

Fields inherited from class java.util.EventObject

Constructor Summary

Method Summary

Methods inherited from class org.asteriskjava.manager.event.ManagerEvent

Methods inherited from class java.util.EventObject

Methods inherited from class java.lang.Object

Field Detail

DISPOSITION_NO_ANSWER

DISPOSITION_FAILED

DISPOSITION_BUSY

DISPOSITION_ANSWERED

DISPOSITION_UNKNOWN

AMA_FLAG_OMIT

AMA_FLAG_BILLING

AMA_FLAG_DOCUMENTATION

AMA_FLAG_UNKNOWN

Constructor Detail

CdrEvent

Method Detail

getAccountCode

setAccountCode

getSrc

setSrc

getDestination

setDestination

getDestinationContext

setDestinationContext

getCallerId

setCallerId

getChannel

setChannel

getDestinationChannel

setDestinationChannel

getLastApplication

setLastApplication

getLastData

setLastData

getStartTime

getStartTimeAsDate

getStartTimeAsDate

setStartTime

getAnswerTime

getAnswerTimeAsDate

getAnswerTimeAsDate

setAnswerTime

getEndTime

getEndTimeAsDate

getEndTimeAsDate

setEndTime

getDuration

setDuration

getBillableSeconds

setBillableSeconds

getDisposition

setDisposition

getAmaFlags

setAmaFlags

getUniqueId

setUniqueId

getUserField

setUserField

getRecordfile

setRecordfile