org.asteriskjava.pbx

Interface PBX

All Known Implementing Classes:

AsteriskPBX

public interface PBX

Provides an abstracted interface for communicating with a PBX.

Author:

bsutton

Method Summary

Modifier and Type	Method and Description
BlindTransferActivity	blindTransfer(Call call, Call.OperandChannel channelToTransfer, EndPoint transferTarget, CallerID toCallerID, boolean autoAnswer, long timeout) The BlindTransferActivity is used by the AsteriksPBX to transfer a live channel to an endpoint that may need to be dialed.
void	blindTransfer(Call call, Call.OperandChannel channelToTransfer, EndPoint transferTarget, CallerID toCallerID, boolean autoAnswer, long timeout, ActivityCallback<BlindTransferActivity> callback) The BlindTransferActivity is used by the AsteriksPBX to transfer a live channel to an endpoint that may need to be dialed.
CallerID	buildCallerID(String number, String name)
EndPoint	buildEndPoint(String fullyQualifiedEndPointName) Builds an end point from a fully qualified end point name.
EndPoint	buildEndPoint(TechType defaultTech, String endPointName) Builds an iEndPoint from an end point name.
EndPoint	buildEndPoint(TechType tech, Trunk trunk, String endPointName)
Trunk	buildTrunk(String string)
void	conference(Channel channelOne, Channel channelTwo, Channel channelThree) Sends a DTMF tone to given channel.
void	conference(Channel channelOne, Channel channelTwo, Channel channelThree, ActivityCallback<Activity> callback) Sends a DTMF tone to the given channel.
DialActivity	dial(EndPoint from, CallerID fromCallerID, EndPoint to, CallerID toCallerID) Dials the given phone number using the specified trunk.
void	dial(EndPoint from, CallerID fromCallerID, EndPoint to, CallerID toCallerID, ActivityCallback<DialActivity> callback) Dials the given phone number using the specified trunk.
Channel	getChannelByEndPoint(EndPoint endPoint) Returns the channel currently attached to the given end point, if one exists.
EndPoint	getExtensionAgi()
void	hangup(Call call) Hangup the given call, not returning until the call is hungup.
void	hangup(Channel channel) Hangs up the given channel.
void	hangup(Channel channel, ActivityCallback<Activity> callback) Hangs up the given channel.
HoldActivity	hold(Channel channel) Put the given channel on hold.
boolean	isBridgeSupported() Returns true if the bridge function is supported.
boolean	isChannel(String channel)
boolean	isMuteSupported() Returns true if the mute function is supported.
JoinActivity	join(Call lhs, Call.OperandChannel originatingOperand, Call rhs, Call.OperandChannel acceptingOperand, CallDirection direction) Joins two calls not returning until the join completes.
void	join(Call lhs, Call.OperandChannel originatingOperand, Call rhs, Call.OperandChannel acceptingOperand, CallDirection direction, ActivityCallback<JoinActivity> listener)
ParkActivity	park(Call call, Channel parkChannel) Parks a call by moving the parkChannel to the parking lot and hanging up the hangupChannel.
void	park(Call call, Channel parkChannel, ActivityCallback<ParkActivity> callback) Parks a call by moving the parkChannel to the parking lot and hanging up the hangupChannel.
void	performPostCreationTasks()
RedirectToActivity	redirectToActivity(Channel channel, ActivityCallback<RedirectToActivity> listener)
void	sendDTMF(Channel channel, DTMFTone tone) Sends a DTMF tone to given channel.
void	sendDTMF(Channel channel, DTMFTone tone, ActivityCallback<Activity> callback) Sends a DTMF tone to the given channel.
void	shutdown() Call this method when shutting down the PBX interface to allow it to cleanup.
void	split(Call callToSplit)
SplitActivity	split(Call callToSplit, ActivityCallback<SplitActivity> listener) Splits a call (with two channels) This call returns once the split action has completed.
void	transferToMusicOnHold(Channel channel)
boolean	waitForChannelsToQuiescent(List<Channel> channels, long timeout)
boolean	waitForChannelToQuiescent(Channel channel, int timeout)

Method Detail

shutdown

void shutdown()

Call this method when shutting down the PBX interface to allow it to cleanup.

isBridgeSupported

boolean isBridgeSupported()

Returns true if the bridge function is supported.

blindTransfer

BlindTransferActivity blindTransfer(Call call,
                                    Call.OperandChannel channelToTransfer,
                                    EndPoint transferTarget,
                                    CallerID toCallerID,
                                    boolean autoAnswer,
                                    long timeout)

The BlindTransferActivity is used by the AsteriksPBX to transfer a live channel to an endpoint that may need to be dialed. Note: this action is a long running action which is dependent on a user action to complete. The action will only complete when the call is answered by the tranferTarget. It is recommended that you use the blindTransfer method which takes a callback as there is no way to cancel this action. Until the transferTarget answers the call or the blind transfer times out.

Parameters:

channelToTransfer - the channel which is to be blind transfered

transferTarget - the endPoint to which the channel is to be tranferred.

toCallerID - - the callerID to display to the transferTarget during the transfer.

autoAnswer - - if true then the transferTarget is to be sent an auto answer header

timeout - - timeout (in seconds) for the blind transfer attempt. When the timeout is reached the Blind Transfer will be cancelled.

ActivityCallback -

blindTransfer

void blindTransfer(Call call,
                   Call.OperandChannel channelToTransfer,
                   EndPoint transferTarget,
                   CallerID toCallerID,
                   boolean autoAnswer,
                   long timeout,
                   ActivityCallback<BlindTransferActivity> callback)

The BlindTransferActivity is used by the AsteriksPBX to transfer a live channel to an endpoint that may need to be dialed. Note: this action is a long running action which is defendant on a user action to complete. The action will only complete when the call is answered by the tranferTarget. You can cancel the action at any time by using the activity object returned from the callback start method.

Parameters:

channelToTransfer - the channel which is to be blind transfered

transferTarget - the endPoint to which the channel is to be transferred.

toCallerID - - the callerID to display to the transferTarget during the transfer.

autoAnswer - - if true then the transferTarget is to be sent an auto answer header

timeout - - timeout for the blind transfer attempt. When the timeout is reached the Blind Transfer will be cancelled.

conference

void conference(Channel channelOne,
                Channel channelTwo,
                Channel channelThree)

Sends a DTMF tone to given channel. Not returning until the tone has been sent.

Parameters:

channel -

conference

void conference(Channel channelOne,
                Channel channelTwo,
                Channel channelThree,
                ActivityCallback<Activity> callback)

Sends a DTMF tone to the given channel. This method returns immediately with progress information passed to the given callback. Note: the callback method will be called from a different thread.

Parameters:

channel -

callback -

dial

DialActivity dial(EndPoint from,
                  CallerID fromCallerID,
                  EndPoint to,
                  CallerID toCallerID)

Dials the given phone number using the specified trunk. Not returning until the call has been dialled. The dial will return as soon as the trunk comes up, it does not wait for remote end to answer.

Returns:

Call - the call resulting from dialing the number.

dial

void dial(EndPoint from,
          CallerID fromCallerID,
          EndPoint to,
          CallerID toCallerID,
          ActivityCallback<DialActivity> callback)

Dials the given phone number using the specified trunk. Not returning until the call has been dialled. The dial will return as soon as the trunk comes up, it does not wait for remote end to answer.

hangup

void hangup(Channel channel)
     throws PBXException

Hangs up the given channel. Not returning until the call is hungup.

Parameters:

channel -

Throws:

PBXException

hangup

void hangup(Channel channel,
            ActivityCallback<Activity> callback)

Hangs up the given channel. This method returns immediately with progress information passed to the given callback. Note: the callback method will be called from a different thread.

Parameters:

channel -

callback -

hangup

void hangup(Call call)
     throws PBXException

Hangup the given call, not returning until the call is hungup.

Parameters:

call -

Throws:

PBXException

hold

HoldActivity hold(Channel channel)

Put the given channel on hold.

Parameters:

channel -

Returns:

isMuteSupported

boolean isMuteSupported()

Returns true if the mute function is supported.

park

ParkActivity park(Call call,
                  Channel parkChannel)

Parks a call by moving the parkChannel to the parking lot and hanging up the hangupChannel. This method will not return until the park has completed. The park expects two channels which are two legs legs of the same call. The parkChannel will be redirect to the njr-park extension. The hangupChannel (the second leg of the call) will be hung up. The (obvious?) limitation is that we can't park something like a conference call as it has more than two channels. The returned iParkActivty can be used to obtain the extension the call was parked on.

Parameters:

the - call which is to be parked.

parkChannel - - the channel which is going to be redirect to the njr-park extension.

hangupChannel - - the channel which is going to be hungup.

park

void park(Call call,
          Channel parkChannel,
          ActivityCallback<ParkActivity> callback)

Parks a call by moving the parkChannel to the parking lot and hanging up the hangupChannel. This method returns almost immediately call progress can be tracked via the callback. The park expects two channels which are two legs legs of the same call. The parkChannel will be redirect to the njr-park extension. The hangupChannel (the second leg of the call) will be hung up. The (obvious?) limitation is that we can't park something like a conference call as it has more than two channels. The returned iParkActivty can be used to obtain the extension the call was parked on.

Parameters:

the - call which is to be parked.

parkChannel - - the channel which is going to be redirect to the njr-park extension.

sendDTMF

void sendDTMF(Channel channel,
              DTMFTone tone)
       throws PBXException

Sends a DTMF tone to given channel. Not returning until the tone has been sent.

Parameters:

channel -

Throws:

PBXException

sendDTMF

void sendDTMF(Channel channel,
              DTMFTone tone,
              ActivityCallback<Activity> callback)

Sends a DTMF tone to the given channel. This method returns immediately with progress information passed to the given callback. Note: the callback method will be called from a different thread.

Parameters:

channel -

callback -

split

SplitActivity split(Call callToSplit,
                    ActivityCallback<SplitActivity> listener)
             throws PBXException

Splits a call (with two channels) This call returns once the split action has completed.

Throws:

PBXException

redirectToActivity

RedirectToActivity redirectToActivity(Channel channel,
                                      ActivityCallback<RedirectToActivity> listener)

split

void split(Call callToSplit)
    throws PBXException

Throws:

PBXException

join

JoinActivity join(Call lhs,
                  Call.OperandChannel originatingOperand,
                  Call rhs,
                  Call.OperandChannel acceptingOperand,
                  CallDirection direction)

Joins two calls not returning until the join completes. Each call must only have one active channel

join

void join(Call lhs,
          Call.OperandChannel originatingOperand,
          Call rhs,
          Call.OperandChannel acceptingOperand,
          CallDirection direction,
          ActivityCallback<JoinActivity> listener)

getChannelByEndPoint

Channel getChannelByEndPoint(EndPoint endPoint)

Returns the channel currently attached to the given end point, if one exists. If no channel is attached to the given end point then null is returned.

Returns:

the channel attached to the end point or null if the endpoint is not currently in a call.

buildEndPoint

EndPoint buildEndPoint(String fullyQualifiedEndPointName)

Builds an end point from a fully qualified end point name. A fully qualified name includes the tech. How the tech is encoded is pbx specific.

Parameters:

fullyQualifiedEndPointName -

Returns:

buildEndPoint

EndPoint buildEndPoint(TechType defaultTech,
                       String endPointName)

Builds an iEndPoint from an end point name. If the tech isn't passed in the endPointName the tech is set to the defaultTech The encoding for an end point name is pbx specific.

Parameters:

endPointName -

Returns:

buildEndPoint

EndPoint buildEndPoint(TechType tech,
                       Trunk trunk,
                       String endPointName)

transferToMusicOnHold

void transferToMusicOnHold(Channel channel)
                    throws PBXException

Throws:

PBXException

buildCallerID

CallerID buildCallerID(String number,
                       String name)

isChannel

boolean isChannel(String channel)

waitForChannelsToQuiescent

boolean waitForChannelsToQuiescent(List<Channel> channels,
                                   long timeout)

getExtensionAgi

EndPoint getExtensionAgi()

waitForChannelToQuiescent

boolean waitForChannelToQuiescent(Channel channel,
                                  int timeout)

buildTrunk

Trunk buildTrunk(String string)

performPostCreationTasks

void performPostCreationTasks()