OriginateAction (Asterisk-Java 3.29.0 API)

java.lang.Object
- org.asteriskjava.manager.action.AbstractManagerAction
- - org.asteriskjava.manager.action.OriginateAction

All Implemented Interfaces:

Serializable, EventGeneratingAction, ManagerAction
```
public class OriginateAction
extends AbstractManagerAction
implements EventGeneratingAction
```
The OriginateAction generates an outgoing call to the extension in the given context with the given priority or to a given application with optional parameters.
If you want to connect to an extension use the properties context, exten and priority. If you want to connect to an application use the properties application and data if needed. Note that no call detail record will be written when directly connecting to an application, so it may be better to connect to an extension that starts the application you wish to connect to.
The response to this action is sent when the channel has been answered and asterisk starts connecting it to the given extension. So be careful not to choose a too short timeout when waiting for the response.
If you set async to true Asterisk reports an OriginateSuccess- and OriginateFailureEvents. The action id of these events equals the action id of this OriginateAction.

Version:

$Id$

Author:

srt

See Also:

OriginateResponseEvent, Serialized Form

Constructor Summary

Constructors
Constructor and Description

OriginateAction()

Constructors
Constructor and Description
`OriginateAction()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addPjSipHeader(VariableInheritance inheritance, String header)`
`void`	`addSipHeader(VariableInheritance inheritance, String header)`
`String`	`getAccount()` Returns the account code to use for the originated call.
`String`	`getAction()` Returns the name of this action, i.e.
`Class<? extends ResponseEvent>`	`getActionCompleteEventClass()` Returns the event type that indicates that Asterisk is finished sending response events for this action.
`String`	`getApplication()` Returns the name of the application to connect to.
`Boolean`	`getAsync()` Returns true if this is a fast origination.
`String`	`getCallerId()` Returns the caller id to set on the outgoing channel.
`Integer`	`getCallingPres()` Returns the calling presentation for the outgoing channel.
`String`	`getChannel()` Returns the name of the channel to connect to the outgoing call.
`String`	`getChannelId()`
`String`	`getCodecs()` Returns the codecs to use for the call.
`String`	`getContext()` Returns the name of the context of the extension to connect to.
`String`	`getData()` Returns the parameters to pass to the application.
`Boolean`	`getEarlyMedia()`
`String`	`getExten()` Returns the extension to connect to.
`String`	`getOtherChannelId()`
`Integer`	`getPriority()` Returns the priority of the extension to connect to.
`Long`	`getTimeout()` Returns the timeout for the origination.
`Map<String,String>`	`getVariables()` Returns the variables to set on the originated call.
`void`	`setAccount(String account)` Sets the account code to use for the originated call.
`void`	`setApplication(String application)` Sets the name of the application to connect to.
`void`	`setAsync(Boolean async)` Set to true for fast origination.
`void`	`setCallerId(String callerId)` Sets the caller id to set on the outgoing channel.
`void`	`setCallingPres(Integer callingPres)` Sets the calling presentation for the outgoing channel.
`void`	`setChannel(String channel)` Sets the name of the channel to connect to the outgoing call.
`void`	`setChannelId(String channelId)` this will be the channels uniqueID
`void`	`setCodecs(List<String> codecs)` Sets the codecs to use for the call.
`void`	`setCodecs(String codecs)` Sets the codecs to use for the call.
`void`	`setContext(String context)` Sets the name of the context of the extension to connect to.
`void`	`setData(String data)` Sets the parameters to pass to the application.
`void`	`setEarlyMedia(Boolean earlyMedia)`
`void`	`setExten(String exten)` Sets the extension to connect to.
`void`	`setOtherChannelId(String otherChannelId)`
`void`	`setPriority(Integer priority)` Sets the priority of the extension to connect to.
`void`	`setTimeout(Integer timeout)` Deprecated. use `setTimeout(Long)` instead.
`void`	`setTimeout(Long timeout)` Sets the timeout (in milliseconds) for the origination.
`void`	`setVariable(String variable)` Deprecated. use `setVariables(Map)` instead.
`void`	`setVariable(String name, String value)` Sets an variable on the originated call.
`void`	`setVariables(Map<String,String> variables)` Sets the variables to set on the originated call.

Methods inherited from class org.asteriskjava.manager.action.AbstractManagerAction
getActionId, setActionId, toString

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

Methods inherited from interface org.asteriskjava.manager.action.ManagerAction
getActionId, setActionId

- Constructor Detail
  - OriginateAction
```
public OriginateAction()
```
- Method Detail
  - getAction
```
public String getAction()
```
    Returns the name of this action, i.e. "Originate".
    
    Specified by:
    
    getAction in interface ManagerAction
    
    Specified by:
    
    getAction in class AbstractManagerAction
    
    Returns:
    
    the name of this action.
  - getAccount
```
public String getAccount()
```
    Returns the account code to use for the originated call.
    
    Returns:
    
    the account code to use for the originated call.
  - setAccount
```
public void setAccount(String account)
```
    Sets the account code to use for the originated call.
    The account code is included in the call detail record generated for this call and will be used for billing.
    
    Parameters:
    
    account - the account code to use for the originated call.
  - getCallerId
```
public String getCallerId()
```
    Returns the caller id to set on the outgoing channel.
  - setCallerId
```
public void setCallerId(String callerId)
```
    Sets the caller id to set on the outgoing channel.
    This includes both the Caller*Id Number and Caller*Id Name in the form "Jon Doe <1234>".
    
    Parameters:
    
    callerId - the caller id to set on the outgoing channel.
  - getCallingPres
```
public Integer getCallingPres()
```
    Returns the calling presentation for the outgoing channel.
    This property is only available on BRIstuffed Asterisk servers.
    
    Returns:
    
    the calling presentation for the outgoing channel.
    
    See Also:
    
    setCallingPres(Integer)
  - setCallingPres
```
public void setCallingPres(Integer callingPres)
```
    Sets the calling presentation for the outgoing channel.
    The number is an octet and the only bits you need worry about are bits 1,2,6 and 7.
    Bits 1 and 2 define the screening indicator and bits 6 and 7 define the presentation indicator.
    In essence, it says, 'Is the person who has been called allowed to see the callers number?' (presentation) and 'What authority was used to verify that this is a genuine number?' (screening).
    
    Presentation indicator (Bits 6 and 7):
```
 Bits Meaning
  7 6
  0 0 Presentation allowed
  0 1 Presentation restricted
  1 0 Number not available due to interworking
  1 1 Reserved
 
```
    Screening indicator (Bits 1 and 2):
```
 Bits Meaning
  2 1
  0 0 User-provided, not screened
  0 1 User-provided, verified and passed
  1 0 User-provided, verified and failed
  1 1 Network provided
 
```
    Examples for some general settings:
```
 Presentation Allowed, Network Provided: 3 (00000011)
 Presentation Restricted, User-provided, not screened: 32 (00100000)
 Presentation Restricted, User-provided, verified, and passed: 33 (00100001)
 Presentation Restricted, Network Provided: 35 (00100011)
 
```
    This property is only available on BRIstuffed Asterisk servers.
    Parameters:
    
    callingPres - the calling presentation for the outgoing channel.
  - getChannel
```
public String getChannel()
```
    Returns the name of the channel to connect to the outgoing call.
  - setChannel
```
public void setChannel(String channel)
```
    Sets the name of the channel to connect to the outgoing call.
    This property is mandatory.
  - getContext
```
public String getContext()
```
    Returns the name of the context of the extension to connect to.
  - setContext
```
public void setContext(String context)
```
    Sets the name of the context of the extension to connect to.
    If you set the context you also have to set the exten and priority properties.
  - getExten
```
public String getExten()
```
    Returns the extension to connect to.
  - setExten
```
public void setExten(String exten)
```
    Sets the extension to connect to.
    If you set the extension you also have to set the context and priority properties.
  - getPriority
```
public Integer getPriority()
```
    Returns the priority of the extension to connect to.
  - setPriority
```
public void setPriority(Integer priority)
```
    Sets the priority of the extension to connect to. If you set the priority you also have to set the context and exten properties.
  - getApplication
```
public String getApplication()
```
    Returns the name of the application to connect to.
  - setApplication
```
public void setApplication(String application)
```
    Sets the name of the application to connect to.
  - getData
```
public String getData()
```
    Returns the parameters to pass to the application.
  - setData
```
public void setData(String data)
```
    Sets the parameters to pass to the application.
  - getTimeout
```
public Long getTimeout()
```
    Returns the timeout for the origination.
  - setTimeout
```
@Deprecated
public void setTimeout(Integer timeout)
```
    Deprecated. use setTimeout(Long) instead.
    
    Sets the timeout (in milliseconds) for the origination.
    The channel must be answered within this time, otherwise the origination is considered to have failed and an OriginateFailureEvent is generated.
    If not set, Asterisk assumes a default value of 30000 meaning 30 seconds.
    
    Parameters:
    
    timeout - the timeout in milliseconds
  - setTimeout
```
public void setTimeout(Long timeout)
```
    Sets the timeout (in milliseconds) for the origination.
    The channel must be answered within this time, otherwise the origination is considered to have failed and an OriginateFailureEvent is generated.
    If not set, Asterisk assumes a default value of 30000 meaning 30 seconds.
    
    Parameters:
    
    timeout - the timeout in milliseconds
  - setVariable
```
@Deprecated
public void setVariable(String variable)
```
    Deprecated. use setVariables(Map) instead.
    
    Sets the variables to set on the originated call.
    Variable assignments are of the form "VARNAME=VALUE". You can specify multiple variable assignments separated by the '|' character.
    Example: "VAR1=abc|VAR2=def" sets the channel variables VAR1 to "abc" and VAR2 to "def".
  - setVariable
```
public void setVariable(String name,
                        String value)
```
    Sets an variable on the originated call.
    
    Parameters:
    
    name - the name of the variable to set.
    
    value - the value of the variable to set.
    
    Since:
    
    0.3
  - getVariables
```
public Map<String,String> getVariables()
```
    Returns the variables to set on the originated call.
    
    Returns:
    
    a Map containing the variable names as key and their values as value.
    
    Since:
    
    0.2
  - setVariables
```
public void setVariables(Map<String,String> variables)
```
    Sets the variables to set on the originated call.
    
    Parameters:
    
    variables - a Map containing the variable names as key and their values as value.
    
    Since:
    
    0.2
  - getAsync
```
public Boolean getAsync()
```
    Returns true if this is a fast origination.
  - setAsync
```
public void setAsync(Boolean async)
```
    Set to true for fast origination. Only with fast origination Asterisk will send OriginateSuccess- and OriginateFailureEvents.
  - setEarlyMedia
```
public void setEarlyMedia(Boolean earlyMedia)
```
    Parameters:
    
    earlyMedia - the earlyMedia to set
  - getEarlyMedia
```
public Boolean getEarlyMedia()
```
    Returns:
    
    the earlyMedia
  - getCodecs
```
public String getCodecs()
```
    Returns the codecs to use for the call.
    
    Returns:
    
    the codecs to use for the call.
    
    Since:
    
    1.0.0
  - setCodecs
```
public void setCodecs(String codecs)
```
    Sets the codecs to use for the call. For example "alaw, ulaw, h264".
    Available since Asterisk 1.6.
    
    Parameters:
    
    codecs - comma separated list of codecs to use for the call.
    
    Since:
    
    1.0.0
  - setCodecs
```
public void setCodecs(List<String> codecs)
```
    Sets the codecs to use for the call.
    Available since Asterisk 1.6.
    
    Parameters:
    
    codecs - list of codecs to use for the call.
    
    Since:
    
    1.0.0
  - getActionCompleteEventClass
```
public Class<? extends ResponseEvent> getActionCompleteEventClass()
```
    Description copied from interface: EventGeneratingAction
    
    Returns the event type that indicates that Asterisk is finished sending response events for this action.
    
    Specified by:
    
    getActionCompleteEventClass in interface EventGeneratingAction
    
    Returns:
    
    a Class that is an instance of ResponseEvent.
    
    See Also:
    
    ResponseEvent
  - addSipHeader
```
public void addSipHeader(VariableInheritance inheritance,
                         String header)
```
  - addPjSipHeader
```
public void addPjSipHeader(VariableInheritance inheritance,
                           String header)
```
  - setChannelId
```
public void setChannelId(String channelId)
```
    this will be the channels uniqueID
    
    Parameters:
    
    channelId -
  - getChannelId
```
public String getChannelId()
```
  - setOtherChannelId
```
public void setOtherChannelId(String otherChannelId)
```
  - getOtherChannelId
```
public String getOtherChannelId()
```

Class OriginateAction

Constructor Summary

Method Summary

Methods inherited from class org.asteriskjava.manager.action.AbstractManagerAction

Methods inherited from class java.lang.Object

Methods inherited from interface org.asteriskjava.manager.action.ManagerAction

Constructor Detail

OriginateAction

Method Detail

getAction

getAccount

setAccount

getCallerId

setCallerId

getCallingPres

setCallingPres

getChannel

setChannel

getContext

setContext

getExten

setExten

getPriority

setPriority

getApplication

setApplication

getData

setData

getTimeout

setTimeout

setTimeout

setVariable

setVariable

getVariables

setVariables

getAsync

setAsync

setEarlyMedia

getEarlyMedia

getCodecs

setCodecs

setCodecs

getActionCompleteEventClass

addSipHeader

addPjSipHeader

setChannelId

getChannelId

setOtherChannelId

getOtherChannelId