org.asteriskjava.manager.response.ManagerResponse Maven / Gradle / Ivy
Show all versions of asterisk-java Show documentation
/*
* Copyright 2004-2006 Stefan Reuter
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package org.asteriskjava.manager.response;
import java.io.Serializable;
import java.util.Date;
import java.util.Locale;
import java.util.Map;
/**
* 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.
*
* @author srt
* @version $Id$
* @see org.asteriskjava.manager.action.ManagerAction
*/
public class ManagerResponse implements Serializable {
private static final long serialVersionUID = 1L;
private Date dateReceived;
private String actionId;
/**
* The server from which this response has been received (only used with
* AstManProxy).
*/
private String server;
private String response;
private String eventList;
private String message;
private String uniqueId;
private String events;
private Map attributes;
private String output;
public ManagerResponse() {
this.attributes = null;
}
/**
* Returns a Map with all attributes of this response.
*
* The keys are all lower case!
*
* @see #getAttribute(String)
*/
public Map getAttributes() {
return attributes;
}
/**
* Sets the Map with all attributes.
*
* @param attributes Map with containing the attributes with all lower case
* keys.
*/
public void setAttributes(Map attributes) {
this.attributes = attributes;
}
/**
* 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.
*
* @param key the key to lookup.
* @return the value of the attribute stored under this key or
* null if there is no such attribute.
*/
public String getAttribute(String key) {
return (String) attributes.get(key.toLowerCase(Locale.ENGLISH));
}
/**
* Returns the point in time this response was received from the asterisk
* server.
*/
public Date getDateReceived() {
return dateReceived;
}
/**
* Sets the point in time this response was received from the asterisk
* server.
*/
public void setDateReceived(Date dateReceived) {
this.dateReceived = dateReceived;
}
/**
* 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.
*
* @return the action id of the ManagerAction that caused this response or
* null if none was set.
* @see org.asteriskjava.manager.action.ManagerAction#setActionId(String)
*/
public String getActionId() {
return actionId;
}
/**
* Returns the name of the Asterisk server from which this response has been
* received.
* This property is only available when using to AstManProxy.
*
* @return 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
*/
public final String getServer() {
return server;
}
/**
* Sets the name of the Asterisk server from which this response has been
* received.
*
* @param server the name of the Asterisk server from which this response
* has been received.
* @since 1.0.0
*/
public final void setServer(String server) {
this.server = server;
}
/**
* Sent for manager events that reply with a list of events.
*
* @return "start", "stop" or "complete"
* @since 1.0.0
*/
public String getEventList() {
return eventList;
}
/**
* Sets the eventList.
*
* @param eventList the eventList.
* @since 1.0.0
*/
public void setEventList(String eventList) {
this.eventList = eventList;
}
/**
* Sets the action id of the ManagerAction that caused this response.
*
* @param actionId the action id of the ManagerAction that caused this
* response.
*/
public void setActionId(String actionId) {
this.actionId = actionId;
}
/**
* Returns the message received with this response. The content depends on
* the action that generated this response.
*/
public String getMessage() {
return message;
}
/**
* Sets the message.
*/
public void setMessage(String message) {
this.message = message;
}
/**
* Returns the value of the "Response:" line. This typically a String like
* "Success" or "Error" but depends on the action that generated this
* response.
*/
public String getResponse() {
return response;
}
/**
* Sets the response.
*/
public void setResponse(String response) {
this.response = response;
}
/**
* 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.
*/
public String getUniqueId() {
return uniqueId;
}
/**
* Sets the unique id received with this response.
*/
public void setUniqueId(String uniqueId) {
this.uniqueId = uniqueId;
}
protected Integer stringToInteger(String s, String suffix) throws NumberFormatException {
if (s == null || s.length() == 0) {
return null;
}
if (suffix != null && s.endsWith(suffix)) {
return Integer.parseInt(s.substring(0, s.length() - suffix.length()).trim());
}
return Integer.parseInt(s.trim());
}
protected Long stringToLong(String s, String suffix) throws NumberFormatException {
if (s == null || s.length() == 0) {
return null;
}
if (suffix != null && s.endsWith(suffix)) {
return Long.parseLong(s.substring(0, s.length() - suffix.length()).trim());
}
return Long.parseLong(s.trim());
}
@Override
public String toString() {
StringBuilder sb;
sb = new StringBuilder(100);
sb.append(getClass().getName()).append(": ");
sb.append("actionId='").append(getActionId()).append("'; ");
sb.append("message='").append(getMessage()).append("'; ");
sb.append("response='").append(getResponse()).append("'; ");
sb.append("uniqueId='").append(getUniqueId()).append("'; ");
sb.append("systemHashcode=").append(System.identityHashCode(this));
return sb.toString();
}
public String getEvents() {
return events;
}
public void setEvents(String events) {
this.events = events;
}
public String getOutput() {
return output;
}
public void setOutput(String output) {
this.output = output;
}
}