org.red5.server.adapter.AbstractScopeAdapter Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ant-media-server Show documentation
Show all versions of ant-media-server Show documentation
Ant Media Server supports RTMP, RTSP, MP4, HLS, WebRTC, Adaptive Streaming, etc.
/*
* RED5 Open Source Media Server - https://github.com/Red5/
*
* Copyright 2006-2016 by respective authors (see below). All rights reserved.
*
* 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.red5.server.adapter;
import java.util.Map;
import org.red5.server.api.IClient;
import org.red5.server.api.IConnection;
import org.red5.server.api.Red5;
import org.red5.server.api.event.IEvent;
import org.red5.server.api.scope.IBasicScope;
import org.red5.server.api.scope.IScope;
import org.red5.server.api.scope.IScopeHandler;
import org.red5.server.api.service.IServiceCall;
/**
* Base scope handler implementation. Meant to be subclassed.
*/
public abstract class AbstractScopeAdapter implements IScopeHandler {
//private static Logger log = LoggerFactory.getLogger(AbstractScopeAdapter.class);
/**
* Can start flag.
*
*
* true
*
*
* if scope is ready to be activated,
*
*
* false
*
*
* otherwise
*/
private boolean canStart = true;
/**
* Can connect flag.
*
*
* true
*
*
* if connections to scope are allowed,
*
*
* false
*
*
* otherwise
*/
private boolean canConnect;
/**
* Can join flag.
*
*
* true
*
*
* if scope may be joined by users,
*
*
* false
*
*
* otherwise
*/
private boolean canJoin = true;
/**
* Can call service flag.
*
*
* true
*
*
* if remote service calls are allowed for the scope,
*
*
* false
*
*
* otherwise
*/
private boolean canCallService = true;
/**
* Can add child scope flag.
*
*
* true
*
*
* if scope is allowed to add child scopes,
*
*
* false
*
*
* otherwise
*/
private boolean canAddChildScope = true;
/**
* Can handle event flag.
*
*
* true
*
*
* if events handling is allowed,
*
*
* false
*
*
* otherwise
*/
private boolean canHandleEvent = true;
/**
* Setter for can start flag.
*
* @param canStart
*
* true
*
*
* if scope is ready to be activated,
*
*
* false
*
*
* otherwise
*/
public void setCanStart(boolean canStart) {
this.canStart = canStart;
}
/**
* Setter for can call service flag
*
* @param canCallService
*
* true
*
*
* if remote service calls are allowed for the scope,
*
*
* false
*
*
* otherwise
*/
public void setCanCallService(boolean canCallService) {
//log.trace("setCanCallService: {}", canCallService);
this.canCallService = canCallService;
}
/**
* Setter for can connect flag
*
* @param canConnect
*
* true
*
*
* if connections to scope are allowed,
*
*
* false
*
*
* otherwise
*/
public void setCanConnect(boolean canConnect) {
this.canConnect = canConnect;
}
/**
* Setter for 'can join' flag
*
* @param canJoin
*
* true
*
*
* if scope may be joined by users,
*
*
* false
*
*
* otherwise
*/
public void setJoin(boolean canJoin) {
this.canJoin = canJoin;
}
/** {@inheritDoc} */
public boolean start(IScope scope) {
return canStart;
}
/** {@inheritDoc} */
public void stop(IScope scope) {
// nothing
}
/** {@inheritDoc} */
public boolean connect(IConnection conn, IScope scope, Object[] params) {
return canConnect;
}
/** {@inheritDoc} */
public void disconnect(IConnection conn, IScope scope) {
// nothing
}
/** {@inheritDoc} */
public boolean join(IClient client, IScope scope) {
return canJoin;
}
/** {@inheritDoc} */
public void leave(IClient client, IScope scope) {
// nothing
}
/** {@inheritDoc} */
public boolean serviceCall(IConnection conn, IServiceCall call) {
//log.trace("serviceCall - canCallService: {} scope: {} method: {}", canCallService, conn.getScope().getName(), call.getServiceMethodName());
return canCallService;
}
/** {@inheritDoc} */
public boolean addChildScope(IBasicScope scope) {
return canAddChildScope;
}
/** {@inheritDoc} */
public void removeChildScope(IBasicScope scope) {
}
/** {@inheritDoc} */
public boolean handleEvent(IEvent event) {
return canHandleEvent;
}
/**
* Calls the checkBandwidth method on the current client.
*
* @param o
* Object passed from Flash, not used at the moment
*/
public void checkBandwidth(Object o) {
//Incoming object should be null
IClient client = Red5.getConnectionLocal().getClient();
if (client != null) {
client.checkBandwidth();
}
}
/**
* Calls the checkBandwidthUp method on the current client.
*
* @param params
* Object passed from Flash
* @return bandwidth results map
*/
public Map checkBandwidthUp(Object[] params) {
//Incoming object should be null
IClient client = Red5.getConnectionLocal().getClient();
if (client != null) {
return client.checkBandwidthUp(params);
}
return null;
}
}