AgiRequest (Asterisk-Java 3.31.0 API)

All Known Implementing Classes:

AgiRequestImpl
```
public interface AgiRequest
```
Provides client request information to an AgiScript.
This includes information about the channel the script is invoked on and parameters passed from the dialplan.

Version:

$Id$

Author:

srt

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`getAccountCode()` Returns the account code set for the call.
`String[]`	`getArguments()` Returns the array of arguments passed from the AGI dialplan command.
`AsteriskVersion`	`getAsteriskVersion()`
`String`	`getCallerId()` Deprecated. as of 0.3, use `getCallerIdNumber()` instead.
`String`	`getCallerIdName()` Returns the the Caller*ID Name, for example "John Doe".
`String`	`getCallerIdNumber()` Returns the Caller*ID number, for example "1234".
`Integer`	`getCallingAni2()` Returns the Callerid ANI 2 (Info digits).
`Integer`	`getCallingPres()` Returns the Callerid presentation/screening.
`Integer`	`getCallingTns()` Returns the Callerid Transit Network Select.
`Integer`	`getCallingTon()` Returns the Callerid Type of Number.
`String`	`getChannel()` Returns the name of the channel.
`String`	`getContext()` Returns the context in the dial plan from which the AGI script was called.
`String`	`getDnid()` Returns the number, that has been dialed by the user.
`Boolean`	`getEnhanced()` Returns wheather this agi is passed audio (EAGI - Enhanced AGI).
`String`	`getExtension()` Returns the extension in the dial plan from which the AGI script was called.
`String`	`getLanguage()` Returns the language set for the current channel, for example "en".
`InetAddress`	`getLocalAddress()` Returns the local address this channel, that is the IP address of the AGI server.
`int`	`getLocalPort()` Returns the local port of this channel, that is the port the AGI server is listening on.
`String`	`getParameter(String name)` Returns the value of a request parameter as a String, or `null` if the parameter does not exist.
`Map<String,String[]>`	`getParameterMap()` Returns a Map of the parameters of this request.
`String[]`	`getParameterValues(String name)` Returns an array of String objects containing all of the values the given request parameter has, or an empty array if the parameter does not exist.
`Integer`	`getPriority()` Returns the priority of the dial plan entry the AGI script was called from.
`String`	`getRdnis()` If this call has been forwared, the number of the person doing the redirect is returned (Redirected dialed number identification service).
`InetAddress`	`getRemoteAddress()` Returns the remote address of this channel, that is the IP address of the Asterisk server.
`int`	`getRemotePort()` Returns the remote port of this channel, that is the client port the Asterisk server is using for the AGI connection.
`Map<String,String>`	`getRequest()` Returns a Map containing the raw request name/value pairs.
`String`	`getRequestURL()` Returns the full URL of the requestURL in the form `agi://host[:port][/script][?param1=value1&param2=value2]`.
`String`	`getScript()` Returns the name of the script to execute including its full path.
`String`	`getType()` Returns the type of the channel, for example "SIP".
`String`	`getUniqueId()` Returns the unqiue id of the channel.

- Method Detail
  - getRequest
```
Map<String,String> getRequest()
```
    Returns a Map containing the raw request name/value pairs.
    
    Returns:
    
    Map contain raw request name/value pairs.
  - getScript
```
String getScript()
```
    Returns the name of the script to execute including its full path.
    This corresponds to the request url with protocol, host, port and parameters stripped off.
    As Async AGI does not yet pass a script parameter this property will be null for requests received through Async AGI.
    
    Returns:
    
    the name of the script to execute.
  - getRequestURL
```
String getRequestURL()
```
    Returns the full URL of the requestURL in the form agi://host[:port][/script][?param1=value1&param2=value2].
    
    Returns:
    
    the full URL of the requestURL in the form agi://host[:port][/script][?param1=value1&param2=value2].
  - getChannel
```
String getChannel()
```
    Returns the name of the channel.
    
    Returns:
    
    the name of the channel.
  - getUniqueId
```
String getUniqueId()
```
    Returns the unqiue id of the channel.
    
    Returns:
    
    the unqiue id of the channel.
  - getType
```
String getType()
```
    Returns the type of the channel, for example "SIP".
    
    Returns:
    
    the type of the channel, for example "SIP".
  - getLanguage
```
String getLanguage()
```
    Returns the language set for the current channel, for example "en".
    
    Returns:
    
    the language set for the current channel, for example "en".
  - getCallerId
```
@Deprecated
String getCallerId()
```
    Deprecated. as of 0.3, use getCallerIdNumber() instead.
    
    Returns the Caller*ID number, for example "1234".
    Note: even with Asterisk 1.0 is contains only the numerical part of the Caller ID.
    
    Returns:
    
    the Caller*ID number, for example "1234", if no Caller*ID is set or it is "unknown" null is returned.
  - getCallerIdNumber
```
String getCallerIdNumber()
```
    Returns the Caller*ID number, for example "1234".
    Note: even with Asterisk 1.0 is contains only the numerical part of the Caller ID.
    
    Returns:
    
    the Caller*ID number, for example "1234", if no Caller*ID is set or it is "unknown" null is returned.
  - getCallerIdName
```
String getCallerIdName()
```
    Returns the the Caller*ID Name, for example "John Doe".
    
    Returns:
    
    the the Caller*ID Name, for example "John Doe", if no Caller*ID Name is set or it is "unknown" null is returned.
  - getDnid
```
String getDnid()
```
    Returns the number, that has been dialed by the user.
    
    Returns:
    
    the dialed number, if no DNID is available or it is "unknown" null is returned.
  - getRdnis
```
String getRdnis()
```
    If this call has been forwared, the number of the person doing the redirect is returned (Redirected dialed number identification service).
    This is usally only only available on PRI.
    
    Returns:
    
    the number of the person doing the redirect, , if no RDNIS is available or it is "unknown" null is returned.
  - getContext
```
String getContext()
```
    Returns the context in the dial plan from which the AGI script was called.
    
    Returns:
    
    the context in the dial plan from which the AGI script was called.
  - getExtension
```
String getExtension()
```
    Returns the extension in the dial plan from which the AGI script was called.
    
    Returns:
    
    the extension in the dial plan from which the AGI script was called.
  - getPriority
```
Integer getPriority()
```
    Returns the priority of the dial plan entry the AGI script was called from.
    
    Returns:
    
    the priority of the dial plan entry the AGI script was called from.
  - getEnhanced
```
Boolean getEnhanced()
```
    Returns wheather this agi is passed audio (EAGI - Enhanced AGI).
    Enhanced AGI is currently not supported on FastAGI.
    
    Returns:
    
    Boolean.TRUE if this agi is passed audio, Boolean.FALSE otherwise.
  - getAccountCode
```
String getAccountCode()
```
    Returns the account code set for the call.
    
    Returns:
    
    the account code set for the call.
  - getCallingPres
```
Integer getCallingPres()
```
    Returns the Callerid presentation/screening.
    Available since Asterisk 1.2.
    
    Returns:
    
    the Callerid presentation/screening.
    
    Since:
    
    0.2
  - getCallingAni2
```
Integer getCallingAni2()
```
    Returns the Callerid ANI 2 (Info digits).
    Available since Asterisk 1.2.
    
    Returns:
    
    the Callerid ANI 2 (Info digits).
    
    Since:
    
    0.2
  - getCallingTon
```
Integer getCallingTon()
```
    Returns the Callerid Type of Number.
    Available since Asterisk 1.2.
    
    Returns:
    
    the Callerid Type of Number.
    
    Since:
    
    0.2
  - getCallingTns
```
Integer getCallingTns()
```
    Returns the Callerid Transit Network Select.
    Available since Asterisk 1.2.
    
    Returns:
    
    the Callerid Transit Network Select.
    
    Since:
    
    0.2
  - getParameter
```
String getParameter(String name)
```
    Returns the value of a request parameter as a String, or null if the parameter does not exist. You should only use this method when you are sure the parameter has only one value.
    If the parameter might have more than one value, use getParameterValues(String).
    If you use this method with a multivalued parameter, the value returned is equal to the first value in the array returned by getParameterValues.
    
    Parameters:
    
    name - a String containing the name of the parameter whose value is requested.
    
    Returns:
    
    a String representing the single value of the parameter.
    
    See Also:
    
    getParameterValues(String)
  - getParameterValues
```
String[] getParameterValues(String name)
```
    Returns an array of String objects containing all of the values the given request parameter has, or an empty array if the parameter does not exist.
    If the parameter has a single value, the array has a length of 1.
    
    Parameters:
    
    name - a String containing the name of the parameter whose value is requested.
    
    Returns:
    
    an array of String objects containing the parameter's values.
  - getParameterMap
```
Map<String,String[]> getParameterMap()
```
    Returns a Map of the parameters of this request.
    
    Returns:
    
    a java.util.Map containing parameter names as keys and parameter values as map values. The keys in the parameter map are of type String. The values in the parameter map are of type String array.
  - getArguments
```
String[] getArguments()
```
    Returns the array of arguments passed from the AGI dialplan command.
    Example: AGI(agi://localhost/HelloWorld,value1,,value2) results in getArguments()[0] = "value1", getArguments()[1] = null and getArguments()[2] = "value2".
    Available since Asterisk 1.6
    
    Returns:
    
    the array of arguments passed from the AGI command, never null.
    
    Since:
    
    1.0.0
  - getLocalAddress
```
InetAddress getLocalAddress()
```
    Returns the local address this channel, that is the IP address of the AGI server.
    
    Returns:
    
    the local address this channel.
    
    Since:
    
    0.2
  - getLocalPort
```
int getLocalPort()
```
    Returns the local port of this channel, that is the port the AGI server is listening on.
    
    Returns:
    
    the local port of this socket channel.
    
    Since:
    
    0.2
  - getRemoteAddress
```
InetAddress getRemoteAddress()
```
    Returns the remote address of this channel, that is the IP address of the Asterisk server.
    
    Returns:
    
    the remote address of this channel.
    
    Since:
    
    0.2
  - getRemotePort
```
int getRemotePort()
```
    Returns the remote port of this channel, that is the client port the Asterisk server is using for the AGI connection.
    
    Returns:
    
    the remote port of this channel.
    
    Since:
    
    0.2
  - getAsteriskVersion
```
AsteriskVersion getAsteriskVersion()
```

Interface AgiRequest

Method Summary

Method Detail

getRequest

getScript

getRequestURL

getChannel

getUniqueId

getType

getLanguage

getCallerId

getCallerIdNumber

getCallerIdName

getDnid

getRdnis

getContext

getExtension

getPriority

getEnhanced

getAccountCode

getCallingPres

getCallingAni2

getCallingTon

getCallingTns

getParameter

getParameterValues

getParameterMap

getArguments

getLocalAddress

getLocalPort

getRemoteAddress

getRemotePort

getAsteriskVersion