org.red5.server.scope.Scope Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ant-media-server-common Show documentation
Show all versions of ant-media-server-common Show documentation
Classes common for multiple Ant Media projects
/*
* 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.scope;
import java.beans.ConstructorProperties;
import java.io.IOException;
import java.lang.management.ManagementFactory;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
import java.util.concurrent.CopyOnWriteArraySet;
import javax.management.MBeanServer;
import javax.management.ObjectName;
import javax.management.StandardMBean;
import javax.management.openmbean.CompositeData;
import org.apache.commons.lang3.StringUtils;
import org.red5.server.AttributeStore;
import org.red5.server.Server;
import org.red5.server.api.IClient;
import org.red5.server.api.IConnection;
import org.red5.server.api.IContext;
import org.red5.server.api.IServer;
import org.red5.server.api.event.IEvent;
import org.red5.server.api.persistence.PersistenceUtils;
import org.red5.server.api.scope.IBasicScope;
import org.red5.server.api.scope.IBroadcastScope;
import org.red5.server.api.scope.IGlobalScope;
import org.red5.server.api.scope.IScope;
import org.red5.server.api.scope.IScopeAware;
import org.red5.server.api.scope.IScopeHandler;
import org.red5.server.api.scope.ScopeType;
import org.red5.server.api.statistics.IScopeStatistics;
import org.red5.server.api.statistics.support.StatisticsCounter;
import org.red5.server.exception.ScopeException;
import org.red5.server.jmx.mxbeans.ScopeMXBean;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.core.io.Resource;
import org.springframework.jmx.export.annotation.ManagedResource;
/**
* The scope object.
* A stateful object shared between a group of clients connected to the same context path. Scopes are arranged in a hierarchical way, so a scope always has a parent unless its a "global" scope. If a client is connected to a scope then they are also connected to its parent scope. The scope object is used to access resources, shared object, streams, etc.
* Scope layout:
*
*
* /Global scope - Contains application scopes
* /Application scope - Contains room, shared object, and stream scopes
* /Room scope - Contains other room, shared object, and / or stream scopes
* /Shared object scope - Contains shared object
* /Broadcast stream scope - Contains a broadcast stream
*
*
* @author The Red5 Project
* @author Paul Gregoire ([email protected])
* @author Nathan Smith ([email protected])
*/
@ManagedResource(objectName = "org.red5.server:type=Scope", description = "Scope")
public class Scope extends BasicScope implements IScope, IScopeStatistics, ScopeMXBean {
protected static Logger log = LoggerFactory.getLogger(Scope.class);
/**
* Unset flag constant
*/
private static final int UNSET = -1;
/**
* Timestamp the scope was created.
*/
private long creationTime;
/**
* Scope nesting depth, unset by default
*/
private int depth = UNSET;
/**
* Whether scope is enabled
*/
private boolean enabled = true;
/**
* Whether scope is running
*/
private boolean running;
/**
* Auto-start flag
*/
private boolean autoStart = true;
/**
* Scope context
*/
private transient IContext context;
/**
* Scope handler
*/
private transient IScopeHandler handler;
/**
* Registered service handlers for this scope. The map is created on-demand only if it's accessed for writing.
*/
private transient volatile ConcurrentMap serviceHandlers;
/**
* Child scopes
*/
private final transient ConcurrentScopeSet children;
/**
* Connected clients map
*/
private final transient CopyOnWriteArraySet clients;
/**
* Statistics about connections to the scope.
*/
protected final transient StatisticsCounter connectionStats = new StatisticsCounter();
/**
* Statistics about sub-scopes.
*/
protected final transient StatisticsCounter subscopeStats = new StatisticsCounter();
/**
* Storage for scope attributes
*/
protected final AttributeStore attributes = new AttributeStore();
/**
* Mbean object name.
*/
protected ObjectName oName;
{
creationTime = System.currentTimeMillis();
}
/**
* Creates a scope
*/
@ConstructorProperties(value = { "" })
public Scope() {
super(null, ScopeType.UNDEFINED, null, false);
children = new ConcurrentScopeSet();
clients = new CopyOnWriteArraySet();
}
/**
* Creates scope using a Builder
*
* @param builder
* Builder
*/
@ConstructorProperties({ "builder" })
public Scope(Builder builder) {
super(builder.parent, builder.type, builder.name, builder.persistent);
children = new ConcurrentScopeSet();
clients = new CopyOnWriteArraySet();
}
/**
* Add child scope to this scope
*
* @param scope Child scope
* @return true on success (if scope has handler and it accepts child scope addition), false otherwise
*/
public boolean addChildScope(IBasicScope scope) {
log.debug("Add child: {}", scope);
boolean added = false;
if (scope.isValid()) {
try {
if (!children.containsKey(scope)) {
log.debug("Adding child scope: {} to {}", scope, this);
added = children.add(scope);
} else {
log.warn("Child scope already exists");
}
} catch (Exception e) {
log.warn("Exception on add subscope", e);
}
} else {
log.warn("Invalid scope rejected: {}", scope);
}
if (added && scope.getStore() == null) {
// if child scope has no persistence store, use same class as parent
try {
if (scope instanceof Scope) {
((Scope) scope).setPersistenceClass(persistenceClass);
}
} catch (Exception error) {
log.error("Could not set persistence class", error);
}
}
return added;
}
/**
* Connect to scope
*
* @param conn Connection object
* @return true on success, false otherwise
*/
public boolean connect(IConnection conn) {
return connect(conn, null);
}
/**
* Connect to scope with parameters. To successfully connect to scope it must have handler that will accept this connection with given set of parameters. Client associated with connection is added to scope clients set, connection is registered as scope event listener.
*
* @param conn Connection object
* @param params Parameters passed with connection
* @return true on success, false otherwise
*/
public boolean connect(IConnection conn, Object[] params) {
log.debug("Connect - scope: {} connection: {}", this, conn);
if (enabled) {
if (hasParent() && !parent.connect(conn, params)) {
log.debug("Connection to parent failed");
return false;
}
if (hasHandler() && !getHandler().connect(conn, this, params)) {
log.debug("Connection to handler failed");
return false;
}
if (!conn.isConnected()) {
log.debug("Connection is not connected");
// timeout while connecting client
return false;
}
final IClient client = conn.getClient();
// we would not get this far if there is no handler
if (hasHandler() && !getHandler().join(client, this)) {
return false;
}
// checking the connection again? why?
if (!conn.isConnected()) {
// timeout while connecting client
return false;
}
// add the client and event listener
if (clients.add(client) && addEventListener(conn)) {
log.debug("Added client");
// increment conn stats
connectionStats.increment();
// get connected scope
IScope connScope = conn.getScope();
log.trace("Connection scope: {}", connScope);
if (this.equals(connScope)) {
final IServer server = getServer();
if (server instanceof Server) {
((Server) server).notifyConnected(conn);
}
}
return true;
}
} else {
log.debug("Connection failed, scope is disabled");
}
return false;
}
/**
* Create child scope of room type, with the given name.
*
* @param name child scope name
* @return true on success, false otherwise
*/
public boolean createChildScope(String name) {
// quick lookup by name
log.debug("createChildScope: {}", name);
if (children.hasName(name)) {
log.debug("Scope: {} already exists, children: {}", name, children.getNames());
} else {
return addChildScope(new Builder(this, ScopeType.ROOM, name, false).build());
}
return false;
}
/**
* Destroys scope
*
* @throws Exception on error
*/
public void destroy() throws Exception {
log.debug("Destroy scope");
if (hasParent()) {
parent.removeChildScope(this);
}
if (hasHandler()) {
// Because handler can be null when there is a parent handler
getHandler().stop(this);
}
// kill all child scopes
for (IBasicScope child : children.keySet()) {
removeChildScope(child);
if (child instanceof Scope) {
((Scope) child).uninit();
}
}
}
/**
* Disconnect connection from scope
*
* @param conn Connection object
*/
public void disconnect(IConnection conn) {
log.debug("Disconnect: {}", conn);
// call disconnect handlers in reverse order of connection. ie. roomDisconnect is called before appDisconnect.
final IClient client = conn.getClient();
if (client == null) {
// early bail out
removeEventListener(conn);
connectionStats.decrement();
if (hasParent()) {
parent.disconnect(conn);
}
return;
}
// remove it if it exists
if (clients.remove(client)) {
IScopeHandler handler = getHandler();
if (handler != null) {
try {
handler.disconnect(conn, this);
} catch (Exception e) {
log.error("Error while executing \"disconnect\" for connection {} on handler {}. {}", new Object[] { conn, handler, e });
}
try {
// there may be a timeout here ?
handler.leave(client, this);
} catch (Exception e) {
log.error("Error while executing \"leave\" for client {} on handler {}. {}", new Object[] { conn, handler, e });
}
}
// remove listener
removeEventListener(conn);
// decrement if there was a set of connections
connectionStats.decrement();
if (this.equals(conn.getScope())) {
final IServer server = getServer();
if (server instanceof Server) {
((Server) server).notifyDisconnected(conn);
}
}
}
if (hasParent()) {
parent.disconnect(conn);
}
}
/** {@inheritDoc} */
@Override
public void dispatchEvent(IEvent event) {
Set conns = getClientConnections();
for (IConnection conn : conns) {
try {
conn.dispatchEvent(event);
} catch (RuntimeException e) {
log.error("Exception during dispatching event: {}", event, e);
}
}
}
/** {@inheritDoc} */
public Object getAttribute(String name) {
return attributes.getAttribute(name);
}
/** {@inheritDoc} */
public boolean setAttribute(String name, Object value) {
return attributes.setAttribute(name, value);
}
/** {@inheritDoc} */
public boolean hasAttribute(String name) {
return attributes.hasAttribute(name);
}
/** {@inheritDoc} */
public boolean removeAttribute(String name) {
return attributes.removeAttribute(name);
}
/** {@inheritDoc} */
public Set getAttributeNames() {
return attributes.getAttributeNames();
}
/** {@inheritDoc} */
public Map getAttributes() {
return attributes.getAttributes();
}
/** {@inheritDoc} */
public int getActiveClients() {
return clients.size();
}
/** {@inheritDoc} */
public int getActiveConnections() {
return connectionStats.getCurrent();
}
/** {@inheritDoc} */
public int getActiveSubscopes() {
return subscopeStats.getCurrent();
}
/**
* Return the broadcast scope for a given name
*
* @param name
* name
* @return broadcast scope or null if not found
*/
public IBroadcastScope getBroadcastScope(String name) {
return (IBroadcastScope) children.getBasicScope(ScopeType.BROADCAST, name);
}
/**
* Return base scope of given type with given name
*
* @param type Scope type
* @param name Scope name
* @return Basic scope object
*/
public IBasicScope getBasicScope(ScopeType type, String name) {
return children.getBasicScope(type, name);
}
/**
* Return basic scope names matching given type
*
* @param type Scope type
* @return set of scope names
*/
public Set getBasicScopeNames(ScopeType type) {
if (type != null) {
Set names = new HashSet();
for (IBasicScope child : children.keySet()) {
if (child.getType().equals(type)) {
names.add(child.getName());
}
}
return names;
}
return getScopeNames();
}
/**
* Return current thread context classloader
*
* @return Current thread context classloader
*/
public ClassLoader getClassLoader() {
return getContext().getClassLoader();
}
/**
* Return set of clients
*
* @return Set of clients bound to scope
*/
public Set getClients() {
return clients;
}
/** {@inheritDoc} */
@Deprecated
public Collection> getConnections() {
Collection> result = new ArrayList>(3);
result.add(getClientConnections());
return result;
}
/** {@inheritDoc} */
public Set getClientConnections() {
Set result = new HashSet(3);
log.debug("Client count: {}", clients.size());
for (IClient cli : clients) {
Set set = cli.getConnections();
log.debug("Client connection count: {}", set.size());
if (set.size() > 1) {
log.warn("Client connections exceeded expected single count; size: {}", set.size());
}
for (IConnection conn : set) {
result.add(conn);
}
}
return result;
}
/** {@inheritDoc} */
@Deprecated
public Set lookupConnections(IClient client) {
HashSet result = new HashSet(1);
if (clients.contains(client)) {
for (IClient cli : clients) {
if (cli.equals(client)) {
Set set = cli.getConnections();
if (set.size() > 1) {
log.warn("Client connections exceeded expected single count; size: {}", set.size());
}
result.add(set.iterator().next());
break;
}
}
}
return result;
}
/** {@inheritDoc} */
public IConnection lookupConnection(IClient client) {
for (IClient cli : clients) {
if (cli.equals(client)) {
Set set = cli.getConnections();
if (set.size() > 1) {
log.warn("Client connections exceeded expected single count; size: {}", set.size());
}
return set.iterator().next();
}
}
return null;
}
/**
* Return scope context. If scope doesn't have context, parent's context is returns, and so forth.
*
* @return Scope context or parent context
*/
public IContext getContext() {
if (!hasContext() && hasParent()) {
//log.debug("returning parent context");
return parent.getContext();
} else {
//log.debug("returning context");
return context;
}
}
/**
* Return scope context path
*
* @return Scope context path
*/
public String getContextPath() {
if (hasContext()) {
return "";
} else if (hasParent()) {
return parent.getContextPath() + '/' + name;
} else {
return null;
}
}
/** {@inheritDoc} */
public long getCreationTime() {
return creationTime;
}
/**
* return scope depth
*
* @return Scope depth
*/
@Override
public int getDepth() {
if (depth == UNSET) {
if (hasParent()) {
depth = parent.getDepth() + 1;
} else {
depth = 0;
}
}
return depth;
}
/**
* Return scope handler or parent's scope handler if this scope doesn't have one.
*
* @return Scope handler (or parent's one)
*/
public IScopeHandler getHandler() {
log.trace("getHandler from {}", name);
if (handler != null) {
return handler;
} else if (hasParent()) {
return getParent().getHandler();
} else {
return null;
}
}
/** {@inheritDoc} */
@Deprecated
public int getMaxClients() {
return connectionStats.getMax();
}
/** {@inheritDoc} */
public int getMaxConnections() {
return connectionStats.getMax();
}
/** {@inheritDoc} */
public int getMaxSubscopes() {
return subscopeStats.getMax();
}
/**
* Return parent scope
*
* @return Parent scope
*/
@Override
public IScope getParent() {
return parent;
}
/**
* Return scope path calculated from parent path and parent scope name
*
* @return Scope path
*/
@Override
public String getPath() {
if (hasParent()) {
return parent.getPath() + '/' + parent.getName();
} else {
return "";
}
}
/**
* Return resource located at given path
*
* @param path Resource path
* @return Resource
*/
public Resource getResource(String path) {
if (hasContext()) {
return context.getResource(path);
}
return getContext().getResource(getContextPath() + '/' + path);
}
/**
* Return array of resources from path string, usually used with pattern path
*
* @param path Resources path
* @return Resources
* @throws IOException I/O exception
*/
public Resource[] getResources(String path) throws IOException {
if (hasContext()) {
return context.getResources(path);
}
return getContext().getResources(getContextPath() + '/' + path);
}
/**
* Return child scope by name
*
* @param name Scope name
* @return Child scope with given name
*/
public IScope getScope(String name) {
IBasicScope child = children.getBasicScope(ScopeType.UNDEFINED, name);
log.debug("Child of {}: {}", this.name, child);
if (child != null) {
if (child instanceof IScope) {
return (IScope) child;
}
log.warn("Requested scope: {} is not of IScope type: {}", name, child.getClass().getName());
StackTraceElement[] stackTrace = Thread.currentThread().getStackTrace();
for(StackTraceElement st : stackTrace){
log.warn(st.toString());
}
}
return null;
}
/**
* Return child scope names iterator
*
* @return Child scope names iterator
*/
public Set getScopeNames() {
log.debug("Children: {}", children);
return children.getNames();
}
/**
* Return service handler by name
*
* @param name Handler name
* @return Service handler with given name
*/
public Object getServiceHandler(String name) {
Map serviceHandlers = getServiceHandlers(false);
if (serviceHandlers == null) {
return null;
}
return serviceHandlers.get(name);
}
/**
* Return set of service handler names. Removing entries from the set unregisters the corresponding service handler.
*
* @return Set of service handler names
*/
@SuppressWarnings("unchecked")
public Set getServiceHandlerNames() {
Map serviceHandlers = getServiceHandlers(false);
if (serviceHandlers == null) {
return Collections.EMPTY_SET;
}
return serviceHandlers.keySet();
}
/**
* Return map of service handlers. The map is created if it doesn't exist yet.
*
* @return Map of service handlers
*/
protected Map getServiceHandlers() {
return getServiceHandlers(true);
}
/**
* Return map of service handlers and optionally created it if it doesn't exist.
*
* @param allowCreate Should the map be created if it doesn't exist?
* @return Map of service handlers
*/
protected Map getServiceHandlers(boolean allowCreate) {
if (serviceHandlers == null) {
if (allowCreate) {
serviceHandlers = new ConcurrentHashMap(3, 0.9f, 1);
}
}
return serviceHandlers;
}
/** {@inheritDoc} */
public IScopeStatistics getStatistics() {
return this;
}
/** {@inheritDoc} */
@Deprecated
public int getTotalClients() {
return connectionStats.getTotal();
}
/** {@inheritDoc} */
public int getTotalConnections() {
return connectionStats.getTotal();
}
/** {@inheritDoc} */
public int getTotalSubscopes() {
return subscopeStats.getTotal();
}
/**
* Handles event. To be implemented in subclasses.
*
* @param event Event to handle
* @return true on success, false otherwise
*/
@Override
public boolean handleEvent(IEvent event) {
return false;
}
/**
* Check whether scope has child scope with given name
*
* @param name Child scope name
* @return true if scope has child node with given name, false otherwise
*/
public boolean hasChildScope(String name) {
log.debug("Has child scope? {} in {}", name, this);
return children.hasName(name);
}
/**
* Check whether scope has child scope with given name and type
*
* @param type Child scope type
* @param name Child scope name
* @return true if scope has child node with given name and type, false otherwise
*/
public boolean hasChildScope(ScopeType type, String name) {
log.debug("Has child scope? {} in {}", name, this);
return children.getBasicScope(type, name) != null;
}
/**
* Check if scope has a context
*
* @return true if scope has context, false otherwise
*/
public boolean hasContext() {
return context != null;
}
/**
* Check if scope or it's parent has handler
*
* @return true if scope or it's parent scope has a handler, false otherwise
*/
public boolean hasHandler() {
return (handler != null || (hasParent() && getParent().hasHandler()));
}
/**
* Check if scope has parent scope
*
* @return true if scope has parent scope, false otherwise`
*/
@Override
public boolean hasParent() {
return (parent != null);
}
/**
* Initialization actions, start if autostart is set to true.
*/
public void init() {
log.debug("Init scope: {} parent: {}", name, parent);
if (hasParent()) {
if (!parent.hasChildScope(name)) {
if (parent.addChildScope(this)) {
log.debug("Scope added to parent");
} else {
log.warn("Scope not added to parent");
//throw new ScopeException("Scope not added to parent");
return;
}
} else {
throw new ScopeException("Scope already exists in parent");
}
} else {
log.debug("Scope has no parent");
}
if (autoStart) {
start();
}
}
/**
* Uninitialize scope and unregister from parent.
*/
public void uninit() {
log.debug("Un-init scope");
for (IBasicScope child : children.keySet()) {
if (child instanceof Scope) {
((Scope) child).uninit();
}
}
stop();
setEnabled(false);
if (hasParent()) {
if (parent.hasChildScope(name)) {
parent.removeChildScope(this);
}
}
}
/**
* Check if scope is enabled
*
* @return true if scope is enabled, false otherwise
*/
public boolean isEnabled() {
return enabled;
}
/**
* Here for JMX only, uses isEnabled()
*/
public boolean getEnabled() {
return isEnabled();
}
/**
* Check if scope is in running state
*
* @return true if scope is in running state, false otherwise
*/
public boolean isRunning() {
return running;
}
/**
* Here for JMX only, uses isEnabled()
*/
public boolean getRunning() {
return isRunning();
}
/**
* Register service handler by name
*
* @param name Service handler name
* @param handler Service handler
*/
public void registerServiceHandler(String name, Object handler) {
Map serviceHandlers = getServiceHandlers();
serviceHandlers.put(name, handler);
}
/**
* Removes child scope
*
* @param scope Child scope to remove
*/
public void removeChildScope(IBasicScope scope) {
log.debug("removeChildScope: {}", scope);
if (children.containsKey(scope)) {
// remove from parent
children.remove(scope);
if (scope instanceof Scope) {
unregisterJMX();
}
}
}
/**
* Removes all the child scopes
*/
public void removeChildren() {
log.trace("removeChildren of {}", name);
for (IBasicScope child : children.keySet()) {
removeChildScope(child);
}
}
/**
* Setter for autostart flag
*
* @param autoStart Autostart flag value
*/
public void setAutoStart(boolean autoStart) {
this.autoStart = autoStart;
}
/**
* Setter for child load path. Should be implemented in subclasses?
*
* @param pattern Load path pattern
*/
public void setChildLoadPath(String pattern) {
}
/**
* Setter for context
*
* @param context Context object
*/
public void setContext(IContext context) {
log.debug("Set context: {}", context);
this.context = context;
}
/**
* Set scope depth
*
* @param depth Scope depth
*/
public void setDepth(int depth) {
this.depth = depth;
}
/**
* Enable or disable scope by setting enable flag
*
* @param enabled Enable flag value
*/
public void setEnabled(boolean enabled) {
this.enabled = enabled;
}
/**
* Setter for scope event handler
*
* @param handler
* Event handler
*/
public void setHandler(IScopeHandler handler) {
log.debug("setHandler: {} on {}", handler, name);
this.handler = handler;
if (handler instanceof IScopeAware) {
((IScopeAware) handler).setScope(this);
}
}
/**
* Setter for scope name
*
* @param name
* Scope name
*/
@Override
public final void setName(String name) {
log.debug("Set name: {}", name);
if (this.name == null && StringUtils.isNotBlank(name)) {
// reset of the name is no longer allowed
this.name = name;
// unregister from jmx
if (oName != null) {
unregisterJMX();
}
// register
registerJMX();
} else {
log.info("Scope {} name reset to: {} disallowed", this.name, name);
}
}
/**
* Setter for parent scope
*
* @param parent
* Parent scope
*/
public void setParent(IScope parent) {
log.debug("Set parent scope: {}", parent);
this.parent = parent;
}
/**
* Set scope persistence class
*
* @param persistenceClass
* Scope's persistence class
* @throws Exception
* Exception
*/
public void setPersistenceClass(String persistenceClass) throws Exception {
this.persistenceClass = persistenceClass;
if (persistenceClass != null) {
store = PersistenceUtils.getPersistenceStore(this, persistenceClass);
}
}
/**
* Starts scope
*
* @return true if scope has handler and it's start method returned true, false otherwise
*/
public boolean start() {
log.debug("Start scope");
boolean result = false;
if (enabled && !running) {
// check for any handlers
if (handler != null) {
log.debug("Scope {} has a handler {}", this.getName(), handler);
} else {
log.debug("{} has no handler, adding parent handler", this);
handler = parent.getHandler();
}
try {
// if we dont have a handler of our own dont try to start it
if (handler != null) {
result = handler.start(this);
} else {
// always start scopes without handlers
log.debug("{} has no handler of its own, allowing start", this);
result = true;
}
} catch (Throwable e) {
log.error("Could not start scope {}", this, e);
} finally {
// post notification
((Server) getServer()).notifyScopeCreated(this);
}
running = result;
}
return result;
}
/**
* Stops scope
*/
public void stop() {
log.debug("stop: {}", name);
if (enabled && running && handler != null) {
try {
// if we dont have a handler of our own dont try to stop it
handler.stop(this);
} catch (Throwable e) {
log.error("Could not stop scope {}", this, e);
} finally {
// post notification
((Server) getServer()).notifyScopeRemoved(this);
}
// remove all children
removeChildren();
}
running = false;
}
/* (non-Javadoc)
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
return "Scope [name=" + getName() + ", path=" + getPath() + ", type=" + type + ", autoStart=" + autoStart + ", creationTime=" + creationTime + ", depth=" + getDepth() + ", enabled=" + enabled + ", running=" + running + "]";
}
/**
* Unregisters service handler by name
*
* @param name
* Service handler name
*/
public void unregisterServiceHandler(String name) {
Map serviceHandlers = getServiceHandlers(false);
if (serviceHandlers != null) {
serviceHandlers.remove(name);
}
}
/**
* Return the server instance connected to this scope.
*
* @return the server instance
*/
public IServer getServer() {
if (hasParent()) {
final IScope parent = getParent();
if (parent instanceof Scope) {
return ((Scope) parent).getServer();
} else if (parent instanceof IGlobalScope) {
return ((IGlobalScope) parent).getServer();
}
}
return null;
}
//for debugging
public void dump() {
if (log.isTraceEnabled()) {
log.trace("Scope: {} {}", this.getClass().getName(), this);
log.trace("Running: {}", running);
if (hasParent()) {
log.trace("Parent: {}", parent);
Set names = parent.getBasicScopeNames(null);
log.trace("Sibling count: {}", names.size());
for (String sib : names) {
log.trace("Siblings - {}", sib);
}
names = null;
}
log.trace("Handler: {}", handler);
log.trace("Child count: {}", children.size());
for (IBasicScope child : children.keySet()) {
log.trace("Child: {}", child);
}
}
}
protected void registerJMX() {
// register with jmx
MBeanServer mbs = ManagementFactory.getPlatformMBeanServer();
try {
String cName = this.getClass().getName();
if (cName.indexOf('.') != -1) {
cName = cName.substring(cName.lastIndexOf('.')).replaceFirst("[\\.]", "");
}
oName = new ObjectName(String.format("org.red5.server:type=%s,name=%s", cName, name));
// don't reregister
if (!mbs.isRegistered(oName)) {
mbs.registerMBean(new StandardMBean(this, ScopeMXBean.class, true), oName);
}
} catch (Exception e) {
log.warn("Error on jmx registration", e);
}
}
protected void unregisterJMX() {
MBeanServer mbs = ManagementFactory.getPlatformMBeanServer();
if (oName != null && mbs.isRegistered(oName)) {
try {
mbs.unregisterMBean(oName);
} catch (Exception e) {
log.warn("Exception unregistering: {}", oName, e);
}
oName = null;
}
}
/**
* Allows for reconstruction via CompositeData.
*
* @param cd composite data
* @return Scope class instance
*/
public static Scope from(CompositeData cd) {
IScope parent = null;
ScopeType type = ScopeType.UNDEFINED;
String name = null;
boolean persistent = false;
if (cd.containsKey("parent")) {
parent = (IScope) cd.get("parent");
}
if (cd.containsKey("type")) {
type = (ScopeType) cd.get("type");
}
if (cd.containsKey("name")) {
name = (String) cd.get("name");
}
if (cd.containsKey("persistent")) {
persistent = (Boolean) cd.get("persistent");
}
return new Scope(new Builder(parent, type, name, persistent));
}
@Override
public int hashCode() {
final int prime = 31;
int result = super.hashCode();
result = prime * result + ((getPath() == null) ? 0 : getPath().hashCode());
result = prime * result + getDepth();
return result;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (!super.equals(obj)) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
Scope other = (Scope) obj;
if (hashCode() != other.hashCode()) {
return false;
}
return true;
}
private final class ConcurrentScopeSet extends ConcurrentHashMap {
private static final long serialVersionUID = -6702012956307490749L;
ConcurrentScopeSet() {
super(3, 0.9f);
}
public boolean add(IBasicScope scope) {
//log.trace("add - Hold counts - read: {} write: {} queued: {}", internalLock.getReadHoldCount(), internalLock.getWriteHoldCount(), internalLock.hasQueuedThreads());
boolean added = false;
// check #1
if (!containsKey(scope)) {
log.debug("Adding child scope: {} to {}", (((IBasicScope) scope).getName()), this);
if (hasHandler()) {
// get the handler for the scope to which we are adding this new scope
IScopeHandler hdlr = getHandler();
// add the scope to the handler
if (!hdlr.addChildScope(scope)) {
log.warn("Failed to add child scope: {} to {}", scope, this);
return false;
}
} else {
log.debug("No handler found for {}", this);
}
try {
// check #2 for entry
if (!containsKey(scope)) {
// add the entry
// expected return from put is null; indicating this scope didn't already exist
added = (super.put(scope, Boolean.TRUE) == null);
if (added) {
subscopeStats.increment();
} else {
log.debug("Subscope was not added");
}
} else {
log.debug("Subscope already exists");
}
} catch (Exception e) {
log.warn("Exception on add", e);
}
if (added && scope instanceof Scope) {
// cast it
Scope scp = (Scope) scope;
// start the scope
if (scp.start()) {
log.debug("Child scope started");
} else {
log.debug("Failed to start child scope: {} in {}", scope, this);
}
}
}
return added;
}
@Override
public Boolean remove(Object scope) {
log.debug("Remove child scope: {}", scope);
//log.trace("remove - Hold counts - read: {} write: {} queued: {}", internalLock.getReadHoldCount(), internalLock.getWriteHoldCount(), internalLock.hasQueuedThreads());
if (hasHandler()) {
IScopeHandler hdlr = getHandler();
log.debug("Removing child scope: {}", (((IBasicScope) scope).getName()));
hdlr.removeChildScope((IBasicScope) scope);
if (scope instanceof Scope) {
// cast it
Scope scp = (Scope) scope;
// stop the scope
scp.stop();
}
} else {
log.debug("No handler found for {}", this);
}
boolean removed = false;
try {
if (containsKey(scope)) {
// remove the entry, ensure removed value is equal to the given object
removed = super.remove(scope).equals(Boolean.TRUE);
if (removed) {
subscopeStats.decrement();
} else {
log.debug("Subscope was not removed");
}
} else {
log.debug("Subscope was not removed, it was not found");
}
} catch (Exception e) {
log.warn("Exception on remove", e);
}
return removed;
}
/**
* Returns whether or not a scope is in the collection; we're only concerned with keys.
*
* @param scope
* @return true if it exists and false otherwise
*/
public boolean contains(Object scope) {
return keySet().contains(scope);
}
/**
* Returns the scope names.
*
* @return names
*/
public Set getNames() {
Set names = new HashSet();
for (IBasicScope child : keySet()) {
names.add(child.getName());
}
return names;
}
/**
* Returns whether or not a named scope exists.
*
* @return true if a matching scope is found, false otherwise
*/
public boolean hasName(String name) {
if (log.isDebugEnabled()) {
log.debug("hasName: {}", name);
}
if (name != null) {
for (IBasicScope child : keySet()) {
if (name.equals(child.getName())) {
return true;
}
}
} else {
log.info("Invalid scope name, null is not allowed");
}
return false;
}
/**
* Returns a child scope for a given name and type.
*
* @param type
* Scope type
* @param name
* Scope name
* @return scope
*/
public IBasicScope getBasicScope(ScopeType type, String name) {
boolean skipTypeCheck = ScopeType.UNDEFINED.equals(type);
if (skipTypeCheck) {
for (IBasicScope child : keySet()) {
if (name.equals(child.getName())) {
log.debug("Returning basic scope: {}", child);
return child;
}
}
} else {
for (IBasicScope child : keySet()) {
if (child.getType().equals(type) && name.equals(child.getName())) {
log.debug("Returning basic scope: {}", child);
return child;
}
}
}
return null;
}
}
/**
* Builder pattern
*/
public final static class Builder {
private IScope parent;
private ScopeType type;
private String name;
private boolean persistent;
public Builder(IScope parent, ScopeType type, String name, boolean persistent) {
this.parent = parent;
this.type = type;
this.name = name;
this.persistent = persistent;
}
public Scope build() {
return new Scope(this);
}
}
}