org.asteriskjava.manager.action.PauseMonitorAction 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.action;
/**
* The PauseMonitorAction temporarily stop monitoring (recording) a channel.
*
* It is implemented in res/res_monitor.c
*
* Available since Asterisk 1.4.
*
* @author srt
* @version $Id$
* @see UnpauseMonitorAction
* @since 0.3
*/
public class PauseMonitorAction extends AbstractManagerAction {
/**
* Serializable version identifier
*/
private static final long serialVersionUID = -6316010713240389305L;
/**
* The name of the channel to temporarily stop monitoring.
*/
private String channel;
/**
* Creates a new empty PauseMonitorAction.
*/
public PauseMonitorAction() {
}
/**
* Creates a new PauseMonitorAction that temporarily stops monitoring the
* given channel.
*
* @param channel the name of the channel to temporarily stop monitoring.
*/
public PauseMonitorAction(String channel) {
this.channel = channel;
}
/**
* Returns the name of this action, i.e. "PauseMonitor".
*
* @return the name of this action.
*/
@Override
public String getAction() {
return "PauseMonitor";
}
/**
* Returns the name of the channel to temporarily stop monitoring.
*
* @return the name of the channel to temporarily stop monitoring.
*/
public String getChannel() {
return channel;
}
/**
* Sets the name of the channel to temporarily stop monitoring.
*
* This property is mandatory.
*
* @param channel the name of the channel to temporarily stop monitoring.
*/
public void setChannel(String channel) {
this.channel = channel;
}
}