Package org.red5.server.api.so

Interface ISharedObject

All Superinterfaces:

AttributeStoreMXBean, IAttributeStore, IBasicScope, ICastingAttributeStore, ICoreObject, IEventDispatcher, IEventHandler, IEventListener, IEventObservable, IScopeService, IServiceHandlerProvider, ISharedObjectBase, ISharedObjectHandlerProvider, ISharedObjectSecurityService

All Known Implementing Classes:

SharedObjectScope

public interface ISharedObject
extends IBasicScope, ISharedObjectBase, ISharedObjectSecurityService

Serverside access to shared objects.

Author:

The Red5 Project, Joachim Bauch (jojo@struktur.de)

Field Summary

Fields inherited from interface org.red5.server.api.so.ISharedObjectSecurityService

BEAN_NAME

Method Summary

Modifier and Type	Method	Description
void	acquire()	Prevent shared object from being released.
ISharedObjectStatistics	getStatistics()	Return statistics about the shared object.
boolean	isAcquired()	Check if shared object currently is acquired.
void	release()	Release previously acquired shared object.
void	setDirty(boolean dirty)	Deprecated.
void	setDirty(String name)	Sets a "dirty" flag to indicate that the named attribute has been modified.

Methods inherited from interface org.red5.server.api.IAttributeStore

getAttribute, getAttribute, getAttribute, getAttributeNames, getAttributes, hasAttribute, hasAttribute, removeAttribute, removeAttribute, removeAttributes, setAttribute, setAttribute, setAttributes, setAttributes, size

Methods inherited from interface org.red5.server.api.scope.IBasicScope

getDepth, getName, getParent, getPath, getStore, getType, hasParent, isConnectionAllowed, isScopeAllowed, isValid, setKeepDelay, setSecurityHandlers

Methods inherited from interface org.red5.server.api.ICastingAttributeStore

getBoolAttribute, getByteAttribute, getDoubleAttribute, getIntAttribute, getListAttribute, getLongAttribute, getMapAttribute, getSetAttribute, getShortAttribute, getStringAttribute

Methods inherited from interface org.red5.server.api.event.IEventDispatcher

dispatchEvent

Methods inherited from interface org.red5.server.api.event.IEventHandler

handleEvent

Methods inherited from interface org.red5.server.api.event.IEventListener

notifyEvent

Methods inherited from interface org.red5.server.api.event.IEventObservable

addEventListener, getEventListeners, removeEventListener

Methods inherited from interface org.red5.server.api.service.IServiceHandlerProvider

getServiceHandler, getServiceHandlerNames, registerServiceHandler

Methods inherited from interface org.red5.server.api.so.ISharedObjectBase

addSharedObjectListener, beginUpdate, beginUpdate, clear, close, endUpdate, getData, getVersion, isPersistent, removeSharedObjectListener, sendMessage

Methods inherited from interface org.red5.server.api.so.ISharedObjectHandlerProvider

registerServiceHandler, unregisterServiceHandler

Methods inherited from interface org.red5.server.api.so.ISharedObjectSecurityService

getSharedObjectSecurity, registerSharedObjectSecurity, unregisterSharedObjectSecurity

Method Details

acquire

void acquire()

Prevent shared object from being released. Each call to

 acquire
 

must be paired with a call to

 release
 

so the SO isn't held forever. This method basically is a no-op for persistent SOs as their data is stored and they can be released without losing their contents.

isAcquired

boolean isAcquired()

Check if shared object currently is acquired.

Returns:

 true
 

if the SO is acquired, otherwise

 false
 

release

void release()

Release previously acquired shared object. If the SO is non-persistent, no more clients are connected the SO isn't acquired any more, the data is released.

getStatistics

ISharedObjectStatistics getStatistics()

Return statistics about the shared object.

Returns:

statistics

setDirty

@Deprecated
void setDirty(boolean dirty)

Deprecated.

Sets a "dirty" flag to indicate that the attributes have been modified.

Parameters:

dirty - if dirty / modified

setDirty

void setDirty(String name)

Sets a "dirty" flag to indicate that the named attribute has been modified.

Parameters:

name - attribute key which is now dirty