org.asteriskjava.manager.response

Class ManagerResponse

java.lang.Object

org.asteriskjava.manager.response.ManagerResponse

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ChallengeResponse, CommandResponse, CoreSettingsResponse, CoreStatusResponse, ExtensionStateResponse, GetConfigResponse, GetVarResponse, MailboxCountResponse, MailboxStatusResponse, ManagerError, ModuleCheckResponse, PingResponse, SipShowPeerResponse, SkypeBuddyResponse, SkypeLicenseStatusResponse

public class ManagerResponse
extends Object
implements Serializable

Represents a response received from the Asterisk server as the result of a previously sent ManagerAction.

The response can be linked with the action that caused it by looking the action id attribute that will match the action id of the corresponding action.

Version:

$Id$

Author:

srt

See Also:

ManagerAction, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ManagerResponse()

Method Summary

Modifier and Type	Method and Description
String	getActionId() Returns the user provided action id of the ManagerAction that caused this response.
String	getAttribute(String key) Returns the value of the attribute with the given key.
Map<String,Object>	getAttributes() Returns a Map with all attributes of this response.
Date	getDateReceived() Returns the point in time this response was received from the asterisk server.
String	getEventList() Sent for manager events that reply with a list of events.
String	getEvents()
String	getMessage() Returns the message received with this response.
String	getOutput()
String	getResponse() Returns the value of the "Response:" line.
String	getServer() Returns the name of the Asterisk server from which this response has been received.
String	getUniqueId() Returns the unique id received with this response.
void	setActionId(String actionId) Sets the action id of the ManagerAction that caused this response.
void	setAttributes(Map<String,Object> attributes) Sets the Map with all attributes.
void	setDateReceived(Date dateReceived) Sets the point in time this response was received from the asterisk server.
void	setEventList(String eventList) Sets the eventList.
void	setEvents(String events)
void	setMessage(String message) Sets the message.
void	setOutput(String output)
void	setResponse(String response) Sets the response.
void	setServer(String server) Sets the name of the Asterisk server from which this response has been received.
void	setUniqueId(String uniqueId) Sets the unique id received with this response.
protected Integer	stringToInteger(String s, String suffix)
protected Long	stringToLong(String s, String suffix)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ManagerResponse

public ManagerResponse()

Method Detail

getAttributes

public Map<String,Object> getAttributes()

Returns a Map with all attributes of this response.

The keys are all lower case!

See Also:

getAttribute(String)

setAttributes

public void setAttributes(Map<String,Object> attributes)

Sets the Map with all attributes.

Parameters:

attributes - Map with containing the attributes with all lower case keys.

getAttribute

public String getAttribute(String key)

Returns the value of the attribute with the given key.

This is particulary important when a response contains special attributes that are dependent on the action that has been sent.

An example of this is the response to the GetVarAction. It contains the value of the channel variable as an attribute stored under the key of the variable name.

Example:

 GetVarAction action = new GetVarAction();
 action.setChannel("SIP/1310-22c3");
 action.setVariable("ALERT_INFO");
 ManagerResponse response = connection.sendAction(action);
 String alertInfo = response.getAttribute("ALERT_INFO");
 

As all attributes are internally stored in lower case the key is automatically converted to lower case before lookup.

Parameters:

key - the key to lookup.

Returns:

the value of the attribute stored under this key or null if there is no such attribute.

getDateReceived

public Date getDateReceived()

Returns the point in time this response was received from the asterisk server.

setDateReceived

public void setDateReceived(Date dateReceived)

Sets the point in time this response was received from the asterisk server.

getActionId

public String getActionId()

Returns the user provided action id of the ManagerAction that caused this response. If the application did not set an action id this method returns null.

Returns:

the action id of the ManagerAction that caused this response or null if none was set.

See Also:

ManagerAction.setActionId(String)

getServer

public final String getServer()

Returns the name of the Asterisk server from which this response has been received.
This property is only available when using to AstManProxy.

Returns:

the name of the Asterisk server from which this response has been received or null when directly connected to an Asterisk server instead of AstManProxy.

Since:

1.0.0

setServer

public final void setServer(String server)

Sets the name of the Asterisk server from which this response has been received.

Parameters:

server - the name of the Asterisk server from which this response has been received.

Since:

1.0.0

getEventList

public String getEventList()

Sent for manager events that reply with a list of events.

Returns:

"start", "stop" or "complete"

Since:

1.0.0

setEventList

public void setEventList(String eventList)

Sets the eventList.

Parameters:

eventList - the eventList.

Since:

1.0.0

setActionId

public void setActionId(String actionId)

Sets the action id of the ManagerAction that caused this response.

Parameters:

actionId - the action id of the ManagerAction that caused this response.

getMessage

public String getMessage()

Returns the message received with this response. The content depends on the action that generated this response.

setMessage

public void setMessage(String message)

Sets the message.

getResponse

public String getResponse()

Returns the value of the "Response:" line. This typically a String like "Success" or "Error" but depends on the action that generated this response.

setResponse

public void setResponse(String response)

Sets the response.

getUniqueId

public String getUniqueId()

Returns the unique id received with this response. The unique id is used to keep track of channels created by the action sent, for example an OriginateAction.

setUniqueId

public void setUniqueId(String uniqueId)

Sets the unique id received with this response.

stringToInteger

protected Integer stringToInteger(String s,
                                  String suffix)
                           throws NumberFormatException

Throws:

NumberFormatException

stringToLong

protected Long stringToLong(String s,
                            String suffix)
                     throws NumberFormatException

Throws:

NumberFormatException

toString

public String toString()

Overrides:

toString in class Object

getEvents

public String getEvents()

setEvents

public void setEvents(String events)

getOutput

public String getOutput()

setOutput

public void setOutput(String output)