diff --git a/client/pom.xml b/client/pom.xml index 67de76b21..41823e9c2 100644 --- a/client/pom.xml +++ b/client/pom.xml @@ -3,7 +3,7 @@ org.red5 red5-parent - 1.2.24 + 1.2.31 4.0.0 red5-client diff --git a/client/src/main/java/org/red5/client/PublishModes.java b/client/src/main/java/org/red5/client/PublishModes.java index fabf00382..57f605ad3 100644 --- a/client/src/main/java/org/red5/client/PublishModes.java +++ b/client/src/main/java/org/red5/client/PublishModes.java @@ -18,7 +18,7 @@ * recording it. If a file with a name that matches the value passed to the name parameter exists, it is deleted. * * @author Stoian Ivanov (s.ivanov_at_teracomm.bg) - * + * */ public final class PublishModes { diff --git a/client/src/main/java/org/red5/client/Red5Client.java b/client/src/main/java/org/red5/client/Red5Client.java index dff348d7b..25697b4a2 100644 --- a/client/src/main/java/org/red5/client/Red5Client.java +++ b/client/src/main/java/org/red5/client/Red5Client.java @@ -9,7 +9,7 @@ /** * Utility class for accessing Red5 "client" objects. - * + * * @author The Red5 Project * @author Paul Gregoire (mondain@gmail.com) */ @@ -18,7 +18,7 @@ public final class Red5Client { /** * Current server version with revision */ - public static final String VERSION = "Red5 Client 1.2.24"; + public static final String VERSION = "Red5 Client 1.2.31"; /** * Create a new Red5Client object using the connection local to the current thread A bit of magic that lets you access the red5 scope @@ -29,7 +29,7 @@ public Red5Client() { /** * Returns the current version with revision number - * + * * @return String version */ public static String getVersion() { diff --git a/client/src/main/java/org/red5/client/StreamRelay.java b/client/src/main/java/org/red5/client/StreamRelay.java index 37045682d..7e50a6478 100644 --- a/client/src/main/java/org/red5/client/StreamRelay.java +++ b/client/src/main/java/org/red5/client/StreamRelay.java @@ -28,7 +28,7 @@ /** * Relay a stream from one location to another via RTMP. - * + * * @author Paul Gregoire (mondain@gmail.com) */ public class StreamRelay { @@ -47,7 +47,7 @@ public class StreamRelay { /** * Creates a stream client to consume a stream from an end point and a proxy to relay the stream to another end point. - * + * * @param args * application arguments */ diff --git a/client/src/main/java/org/red5/client/net/remoting/DSRemotingClient.java b/client/src/main/java/org/red5/client/net/remoting/DSRemotingClient.java index 4870208be..0299f9044 100644 --- a/client/src/main/java/org/red5/client/net/remoting/DSRemotingClient.java +++ b/client/src/main/java/org/red5/client/net/remoting/DSRemotingClient.java @@ -36,7 +36,7 @@ /** * Client interface for remoting calls directed at an LCDS or BlazeDS style service. - * + * * @author The Red5 Project * @author Paul Gregoire (mondain@gmail.com) */ @@ -59,7 +59,7 @@ public DSRemotingClient() { /** * Create new remoting client for the given url. - * + * * @param url * URL to connect to */ @@ -78,7 +78,7 @@ public void setDataSourceId(String dataSourceId) { /** * Encode the method call. - * + * * @param method * Remote method being called * @param params @@ -116,7 +116,7 @@ private IoBuffer encodeInvoke(String method, Object[] params) { Output.putString(result, method); // Client callback for response //Output.putString(result, ""); - //responseURI + //responseURI Output.putString(result, "/" + sequenceCounter++); // Serialize parameters IoBuffer tmp = IoBuffer.allocate(1024); @@ -142,7 +142,7 @@ private IoBuffer encodeInvoke(String method, Object[] params) { /** * Process any headers sent in the response. - * + * * @param in * Byte buffer with response data */ @@ -199,7 +199,7 @@ protected void processHeaders(IoBuffer in) { /** * Decode response received from remoting server. - * + * * @param data * Result data to decode * @return Object deserialized from byte buffer data @@ -217,7 +217,7 @@ private Object decodeResult(IoBuffer data) { log.debug("NUL: {}", b); //0 log.debug("SOH: {}", data.get()); //1 } else if (b == 1) { - log.debug("SOH: {}", b); //1 + log.debug("SOH: {}", b); //1 } int targetUriLength = data.getShort(); @@ -261,7 +261,7 @@ private Object decodeResult(IoBuffer data) { /** * Invoke a method synchronously on the remoting server. - * + * * @param method * Method name * @param params @@ -322,7 +322,7 @@ public Object invokeMethod(String method, Object[] params) { /** * Used for debugging byte stream. - * + * * @param data * IoBuffer */ @@ -392,7 +392,7 @@ public static void main(String[] args) { do { Thread.sleep(5000); log.info("Done with sleeping"); - //send poll + //send poll //0 messages - returns DSK //n messages - CommandMessage with internal DSA msg = new CommandMessage(); diff --git a/client/src/main/java/org/red5/client/net/rtmp/BaseRTMPClientHandler.java b/client/src/main/java/org/red5/client/net/rtmp/BaseRTMPClientHandler.java index b1dd0bf0d..8cc609547 100644 --- a/client/src/main/java/org/red5/client/net/rtmp/BaseRTMPClientHandler.java +++ b/client/src/main/java/org/red5/client/net/rtmp/BaseRTMPClientHandler.java @@ -153,7 +153,7 @@ protected BaseRTMPClientHandler() { /** * Start network connection to server - * + * * @param server * Server * @param port @@ -163,7 +163,7 @@ protected BaseRTMPClientHandler() { /** * Connect RTMP client to server's application via given port - * + * * @param server * Server * @param port @@ -179,7 +179,7 @@ public void connect(String server, int port, String application) { /** * Connect RTMP client to server's application via given port with given connection callback - * + * * @param server * Server * @param port @@ -198,7 +198,7 @@ public void connect(String server, int port, String application, IPendingService /** * Creates the default connection parameters collection. Many implementations of this handler will create a tcUrl if not found, it is * created with the current server url. - * + * * @param server * the server location * @param port @@ -226,7 +226,7 @@ public Map makeDefaultConnectionParams(String server, int port, /** * Connect RTMP client to server via given port and with given connection parameters - * + * * @param server * Server * @param port @@ -242,7 +242,7 @@ public void connect(String server, int port, Map connectionParam /** * Connect RTMP client to server's application via given port - * + * * @param server * Server * @param port @@ -259,7 +259,7 @@ public void connect(String server, int port, Map connectionParam /** * Connect RTMP client to server's application via given port - * + * * @param server * Server * @param port @@ -286,7 +286,7 @@ public void connect(String server, int port, Map connectionParam /** * Register object that provides methods that can be called by the server. - * + * * @param serviceProvider * Service provider */ @@ -297,7 +297,7 @@ public void setServiceProvider(Object serviceProvider) { /** * Sets a handler for connection close. - * + * * @param connectionClosedHandler * close handler */ @@ -309,7 +309,7 @@ public void setConnectionClosedHandler(Runnable connectionClosedHandler) { /** * Sets a handler for exceptions. - * + * * @param exceptionHandler * exception handler */ @@ -321,7 +321,7 @@ public void setExceptionHandler(ClientExceptionHandler exceptionHandler) { /** * Connect to client shared object. - * + * * @param name * Client shared object name * @param persistent @@ -462,7 +462,7 @@ public void onBWCheck() { /** * Called when negotiating bandwidth. - * + * * @param params * bw parameters */ @@ -472,7 +472,7 @@ public void onBWCheck(Object params) { /** * Called when bandwidth has been configured. - * + * * @param params * bw parameters */ @@ -491,7 +491,7 @@ public void onBWDone() { /** * Invoke a method on the server. - * + * * @param method * Method name * @param callback @@ -513,7 +513,7 @@ public void invoke(String method, IPendingServiceCallback callback) { /** * Invoke a method on the server and pass parameters. - * + * * @param method * Method * @param params @@ -642,15 +642,15 @@ public void play(Number streamId, String name, int start, int length) { /** * Dynamic streaming play method. - * + * * The following properties are supported on the play options: - * + * *
      *         streamName: String. The name of the stream to play or the new stream to switch to.
-     *         oldStreamName: String. The name of the initial stream that needs to be switched out. This is not needed and ignored 
+     *         oldStreamName: String. The name of the initial stream that needs to be switched out. This is not needed and ignored
      *                        when play2 is used for just playing the stream and not switching to a new stream.
-     *         start: Number. The start time of the new stream to play, just as supported by the existing play API. and it has the 
-     *                        same defaults. This is ignored when the method is called for switching (in other words, the transition 
+     *         start: Number. The start time of the new stream to play, just as supported by the existing play API. and it has the
+     *                        same defaults. This is ignored when the method is called for switching (in other words, the transition
      *                        is either NetStreamPlayTransition.SWITCH or NetStreamPlayTransitions.SWAP)
      *         len: Number. The duration of the playback, just as supported by the existing play API and has the same defaults.
      *         transition: String. The transition mode for the playback command. It could be one of the following:
@@ -659,9 +659,9 @@ public void play(Number streamId, String name, int start, int length) {
      *                             NetStreamPlayTransitions.SWITCH
      *                             NetStreamPlayTransitions.SWAP
      * 
- * + * * NetStreamPlayTransitions: - * + * *
      *             APPEND : String = "append" - Adds the stream to a playlist and begins playback with the first stream.
      *             APPEND_AND_WAIT : String = "appendAndWait" - Builds a playlist without starting to play it from the first stream.
@@ -671,7 +671,7 @@ public void play(Number streamId, String name, int start, int length) {
      *             SWAP : String = "swap" - Replaces a content stream with a different content stream and maintains the rest of the playlist.
      *             SWITCH : String = "switch" - Switches from playing one stream to another stream, typically with streams of the same content.
      * 
- * + * * @see ActionScript guide to dynamic * streaming * @see playOptions) { /** * Sends a ping. - * + * * @param pingType * the type of ping * @param streamId @@ -868,7 +868,7 @@ protected void onCommand(RTMPConnection conn, Channel channel, Header source, IC /** * Handle any exceptions that occur. - * + * * @param throwable * Exception thrown */ @@ -884,7 +884,7 @@ public void handleException(Throwable throwable) { /** * Returns a channel based on the given stream id. - * + * * @param streamId * stream id * @return the channel for this stream id @@ -895,7 +895,7 @@ protected int getChannelForStreamId(Number streamId) { /** * Sets the protocol. - * + * * @param protocol * the data protocol to use. * @throws Exception @@ -907,7 +907,7 @@ public void setProtocol(String protocol) throws Exception { /** * Sets a reference to the connection associated with this client handler. - * + * * @param conn * connection */ @@ -918,7 +918,7 @@ public void setConnection(RTMPConnection conn) { /** * Returns the connection associated with this client. - * + * * @return conn connection */ @Override @@ -928,7 +928,7 @@ public RTMPConnection getConnection() { /** * Enables or disables SWF verification. - * + * * @param enabled * state of SWF verification */ @@ -938,7 +938,7 @@ public void setSwfVerification(boolean enabled) { /** * Returns true if swf verification is enabled - * + * * @return the swfVerification */ public boolean isSwfVerification() { @@ -947,7 +947,7 @@ public boolean isSwfVerification() { /** * Returns true if bandwidth done has been invoked - * + * * @return the bandwidthCheckDone */ public boolean isBandwidthCheckDone() { @@ -956,7 +956,7 @@ public boolean isBandwidthCheckDone() { /** * Returns true if this client is subscribed - * + * * @return subscribed state */ public boolean isSubscribed() { @@ -972,7 +972,7 @@ public Map getConnectionParams() { /** * Setter for stream event dispatcher (useful for saving playing stream to file) - * + * * @param streamEventDispatcher * event dispatcher */ @@ -983,7 +983,7 @@ public void setStreamEventDispatcher(IEventDispatcher streamEventDispatcher) { /** * Setter for the stream event handler. - * + * * @param streamEventHandler * event handler */ diff --git a/client/src/main/java/org/red5/client/net/rtmp/OutboundHandshake.java b/client/src/main/java/org/red5/client/net/rtmp/OutboundHandshake.java index b52011e0f..6c1253b96 100644 --- a/client/src/main/java/org/red5/client/net/rtmp/OutboundHandshake.java +++ b/client/src/main/java/org/red5/client/net/rtmp/OutboundHandshake.java @@ -23,7 +23,7 @@ /** * Performs handshaking for client connections. - * + * * @author Paul Gregoire */ public class OutboundHandshake extends RTMPHandshake { @@ -352,7 +352,7 @@ public boolean decodeServerResponse2(byte[] s2) { /** * Gets and verifies the server digest. - * + * * @return true if the server digest is found and verified, false otherwise */ private boolean getServerDigestPosition() { @@ -384,7 +384,7 @@ private boolean getServerDigestPosition() { /** * Determines the validation scheme for given input. - * + * * @param handshake the handshake bytes from the server * @return true if server used a supported validation scheme, false if unsupported */ @@ -433,7 +433,7 @@ private boolean validateScheme(byte[] handshake, int scheme) { /** * Initialize SWF verification data. - * + * * @param swfFilePath path to the swf file or null */ public void initSwfVerification(String swfFilePath) { diff --git a/client/src/main/java/org/red5/client/net/rtmp/RTMPClient.java b/client/src/main/java/org/red5/client/net/rtmp/RTMPClient.java index 5c827c200..a354676ef 100644 --- a/client/src/main/java/org/red5/client/net/rtmp/RTMPClient.java +++ b/client/src/main/java/org/red5/client/net/rtmp/RTMPClient.java @@ -22,7 +22,7 @@ /** * RTMP client implementation supporting "rtmp" and "rtmpe" protocols. - * + * * @author The Red5 Project * @author Christian Eckerle (ce@publishing-etc.de) * @author Joachim Bauch (jojo@struktur.de) @@ -124,7 +124,7 @@ public void disconnect() { /** * Sets the RTMP protocol, the default is "rtmp". If "rtmps" or "rtmpt" are required, the appropriate client type should be selected. - * + * * @param protocol * the protocol to set * @throws Exception thrown diff --git a/client/src/main/java/org/red5/client/net/rtmp/RTMPConnManager.java b/client/src/main/java/org/red5/client/net/rtmp/RTMPConnManager.java index f36a373ae..7a4663661 100644 --- a/client/src/main/java/org/red5/client/net/rtmp/RTMPConnManager.java +++ b/client/src/main/java/org/red5/client/net/rtmp/RTMPConnManager.java @@ -24,7 +24,7 @@ /** * Responsible for management and creation of RTMP based connections. - * + * * @author The Red5 Project */ public class RTMPConnManager implements IConnectionManager { @@ -95,7 +95,7 @@ public RTMPConnection createConnection(Class connCls, String sessionId) { /** * Adds a connection. - * + * * @param conn connection */ @Override @@ -111,7 +111,7 @@ public void setConnection(RTMPConnection conn) { /** * Returns a connection for a given client id. - * + * * @param clientId client id * @return connection if found and null otherwise */ @@ -128,7 +128,7 @@ public RTMPConnection getConnection(int clientId) { /** * Returns a connection for a given session id. - * + * * @param sessionId session id * @return connection if found and null otherwise */ @@ -197,7 +197,7 @@ public Collection removeConnections() { /** * Creates a connection instance based on the supplied type. - * + * * @param cls class * @return connection * @throws Exception thrown diff --git a/client/src/main/java/org/red5/client/net/rtmp/RTMPMinaIoHandler.java b/client/src/main/java/org/red5/client/net/rtmp/RTMPMinaIoHandler.java index ed7e1503d..425abfcce 100644 --- a/client/src/main/java/org/red5/client/net/rtmp/RTMPMinaIoHandler.java +++ b/client/src/main/java/org/red5/client/net/rtmp/RTMPMinaIoHandler.java @@ -167,7 +167,7 @@ public void setHandler(BaseRTMPClientHandler handler) { /** * Setter to enable swf verification in the handshake. - * + * * @param enableSwfVerification to enable SWF verification or not */ public void setEnableSwfVerification(boolean enableSwfVerification) { diff --git a/client/src/main/java/org/red5/client/net/rtmp/codec/RTMPClientProtocolDecoder.java b/client/src/main/java/org/red5/client/net/rtmp/codec/RTMPClientProtocolDecoder.java index 3f349b5e2..6a5581fae 100644 --- a/client/src/main/java/org/red5/client/net/rtmp/codec/RTMPClientProtocolDecoder.java +++ b/client/src/main/java/org/red5/client/net/rtmp/codec/RTMPClientProtocolDecoder.java @@ -16,7 +16,7 @@ public class RTMPClientProtocolDecoder extends RTMPProtocolDecoder { /** * Decode first server response S1. - * + * * @param conn connection * @param state decode state * @param in incoming data @@ -28,7 +28,7 @@ public IoBuffer decodeHandshakeS1(RTMPConnection conn, RTMPDecodeState state, Io /** * Decode second server response S2. - * + * * @param conn connection * @param state decode state * @param in incoming data diff --git a/client/src/main/java/org/red5/client/net/rtmpe/Proxy.java b/client/src/main/java/org/red5/client/net/rtmpe/Proxy.java index dab562e9b..a3a7cee7f 100755 --- a/client/src/main/java/org/red5/client/net/rtmpe/Proxy.java +++ b/client/src/main/java/org/red5/client/net/rtmpe/Proxy.java @@ -76,7 +76,7 @@ public class Proxy implements IClientListener { /** * Starts the process of proxying data. - * + * * @param publishName * @param publishMode */ @@ -116,7 +116,7 @@ public void stop() { /** * Sets the host to proxy to. - * + * * @param host */ public void setHost(String host) { @@ -125,7 +125,7 @@ public void setHost(String host) { /** * Sets the port to proxy to. - * + * * @param port */ public void setPort(int port) { @@ -134,7 +134,7 @@ public void setPort(int port) { /** * Sets the applicaiton to proxy to. - * + * * @param app */ public void setApp(String app) { diff --git a/client/src/main/java/org/red5/client/net/rtmpe/RTMPEClient.java b/client/src/main/java/org/red5/client/net/rtmpe/RTMPEClient.java index 9c4e108d6..c2a6ab85b 100755 --- a/client/src/main/java/org/red5/client/net/rtmpe/RTMPEClient.java +++ b/client/src/main/java/org/red5/client/net/rtmpe/RTMPEClient.java @@ -37,7 +37,7 @@ /** * RTMPE client object based on the original RTMP client. - * + * * @author Paul Gregoire * @author Gavriloaie Eugen-Andrei */ @@ -91,7 +91,7 @@ public void handleException(Throwable throwable) { /** * Adds a listener for receiving rtmp events. - * + * * @param clientListener */ public void addClientListener(IClientListener clientListener) { @@ -100,7 +100,7 @@ public void addClientListener(IClientListener clientListener) { /** * Returns the name of the stream being utilized. - * + * * @return the streamName */ public String getStreamName() { @@ -109,7 +109,7 @@ public String getStreamName() { /** * Sets the name of the stream being utilized. - * + * * @param streamName the streamName to set */ public void setStreamName(String streamName) { @@ -131,7 +131,7 @@ public void setStreamName(String streamName) { /** * Returns the filename if vod is being used. - * + * * @return the fileName */ public String getFileName() { @@ -140,7 +140,7 @@ public String getFileName() { /** * Sets the filename for vod. - * + * * @param fileName the fileName to set */ public void setFileName(String fileName) { @@ -179,7 +179,7 @@ public void dispatchEvent(IEvent event) { /** * Callback method fired when a NetStatusEvent is detected. - * + * * {@link http://help.adobe.com/en_US/FlashPlatform/reference/actionscript/3/flash/events/NetStatusEvent.html} * @param status */ @@ -213,7 +213,7 @@ public void onStatus(Object status) { /** * Callback method fired when a Notify or other stream event is detected. - * + * * @param notify */ @Override @@ -223,7 +223,7 @@ public void onStreamEvent(Notify notify) { /** * Callback method fired when a MetadataEvent is detected. - * + * * {@link http://help.adobe.com/en_US/FlashPlatform/reference/actionscript/3/mx/events/MetadataEvent.html} * {@link http://help.adobe.com/en_US/FlashPlatform/reference/actionscript/3/mx/controls/VideoDisplay.html#metadata} * @param object metadata from a stream. @@ -269,10 +269,10 @@ public void resultReceived(IPendingServiceCall call) { int streamId = ((Number) result).intValue(); log.debug("CreateStream result stream id: {}", streamId); // http://www.adobe.com/livedocs/flash/9.0/ActionScriptLangRefV3/flash/net/NetStream.html#play() - // start: The default value is -2, which looks for a live stream, then a recorded stream, and if it finds neither, opens a live stream. + // start: The default value is -2, which looks for a live stream, then a recorded stream, and if it finds neither, opens a live stream. // If -1, plays only a live stream. If 0 or a positive number, plays a recorded stream, beginning start seconds in. int start = -2; - // duration: The default value is -1, which plays a live or recorded stream until it ends. If 0, plays a single frame that is start seconds + // duration: The default value is -1, which plays a live or recorded stream until it ends. If 0, plays a single frame that is start seconds // from the beginning of a recorded stream. If a positive number, plays a live or recorded stream for len seconds. int duration = -1; //play(streamId, fileName, start, duration); @@ -289,7 +289,7 @@ public void resultReceived(IPendingServiceCall call) { /** * Creates a proxy. - * + * * @param client * @param host destination host * @param port destination port @@ -311,7 +311,7 @@ public static Proxy createProxy(RTMPEClient client, String host, int port, Strin /** * Creates a writer. - * + * * @param client * @return writer */ diff --git a/client/src/main/java/org/red5/client/net/rtmpe/RTMPEIoFilter.java b/client/src/main/java/org/red5/client/net/rtmpe/RTMPEIoFilter.java index c400cfa75..8d6345e49 100644 --- a/client/src/main/java/org/red5/client/net/rtmpe/RTMPEIoFilter.java +++ b/client/src/main/java/org/red5/client/net/rtmpe/RTMPEIoFilter.java @@ -31,7 +31,7 @@ /** * RTMPE IO filter - Client version. - * + * * @author Peter Thomas (ptrthomas@gmail.com) * @author Paul Gregoire (mondain@gmail.com) */ @@ -169,7 +169,7 @@ public void messageReceived(NextFilter nextFilter, IoSession session, Object obj /** * Provides connection completion. - * + * * @param session * @param conn * @param rtmp @@ -185,7 +185,7 @@ private static void completeConnection(IoSession session, RTMPMinaConnection con ((RTMPConnection) conn).setEncrypted(true); // add the ciphers log.debug("Adding ciphers to the session"); - // seems counter intuitive, but it works + // seems counter intuitive, but it works session.setAttribute(RTMPConnection.RTMPE_CIPHER_IN, handshake.getCipherOut()); session.setAttribute(RTMPConnection.RTMPE_CIPHER_OUT, handshake.getCipherIn()); log.trace("Ciphers in: {} out: {}", handshake.getCipherIn(), handshake.getCipherOut()); diff --git a/client/src/main/java/org/red5/client/net/rtmpe/Writer.java b/client/src/main/java/org/red5/client/net/rtmpe/Writer.java index 70cae860c..dbc8ddb6c 100755 --- a/client/src/main/java/org/red5/client/net/rtmpe/Writer.java +++ b/client/src/main/java/org/red5/client/net/rtmpe/Writer.java @@ -27,7 +27,7 @@ /** * A tag writer that may be used to write stream data to disk. - * + * * @author Paul Gregoire */ public class Writer implements IClientListener { @@ -38,7 +38,7 @@ public class Writer implements IClientListener { /** * Instantiates a writer for the given path. - * + * * @param filePath */ public Writer(String filePath) { @@ -53,7 +53,7 @@ public Writer(String filePath) { /** * Instantiates a writer for the given path. - * + * * @param filePath */ public Writer(Path filePath) { diff --git a/client/src/main/java/org/red5/client/net/rtmps/RTMPSClient.java b/client/src/main/java/org/red5/client/net/rtmps/RTMPSClient.java index afd02871b..cfc8da8d2 100644 --- a/client/src/main/java/org/red5/client/net/rtmps/RTMPSClient.java +++ b/client/src/main/java/org/red5/client/net/rtmps/RTMPSClient.java @@ -24,13 +24,13 @@ /** * RTMPS client object (RTMPS Native) - * + * *
  * var nc:NetConnection = new NetConnection();
  * nc.proxyType = "best";
  * nc.connect("rtmps:\\localhost\app");
  * 
- * + * * @author The Red5 Project * @author Paul Gregoire (mondain@gmail.com) * @author Kevin Green (kevygreen@gmail.com) @@ -74,7 +74,7 @@ public void operationComplete(IoFuture future) { // will throw RuntimeException after connection error future.getSession(); } catch (Throwable e) { - //if there isn't an ClientExceptionHandler set, a + //if there isn't an ClientExceptionHandler set, a //RuntimeException may be thrown in handleException handleException(e); } @@ -91,7 +91,7 @@ public void operationComplete(IoFuture future) { /** * Password used to access the keystore file. - * + * * @param password keystore password */ public void setKeyStorePassword(String password) { @@ -100,7 +100,7 @@ public void setKeyStorePassword(String password) { /** * Set the key store type, JKS or PKCS12. - * + * * @param keyStoreType keystore type */ public void setKeyStoreType(String keyStoreType) { diff --git a/client/src/main/java/org/red5/client/net/rtmps/RTMPTSClient.java b/client/src/main/java/org/red5/client/net/rtmps/RTMPTSClient.java index e12558bf2..037ce0cbe 100644 --- a/client/src/main/java/org/red5/client/net/rtmps/RTMPTSClient.java +++ b/client/src/main/java/org/red5/client/net/rtmps/RTMPTSClient.java @@ -14,7 +14,7 @@ /** * RTMPT/S client object - * + * * @author Paul Gregoire */ public class RTMPTSClient extends RTMPTClient { diff --git a/client/src/main/java/org/red5/client/net/rtmps/RTMPTSClientConnector.java b/client/src/main/java/org/red5/client/net/rtmps/RTMPTSClientConnector.java index b0e50bd31..6f4d19390 100644 --- a/client/src/main/java/org/red5/client/net/rtmps/RTMPTSClientConnector.java +++ b/client/src/main/java/org/red5/client/net/rtmps/RTMPTSClientConnector.java @@ -30,7 +30,7 @@ /** * Client connector for RTMPT/S (RTMPS Tunneled) - * + * * @author Paul Gregoire (mondain@gmail.com) */ public class RTMPTSClientConnector extends RTMPTClientConnector { diff --git a/client/src/main/java/org/red5/client/net/rtmpt/RTMPTClient.java b/client/src/main/java/org/red5/client/net/rtmpt/RTMPTClient.java index 8a86d3a26..5feac568b 100644 --- a/client/src/main/java/org/red5/client/net/rtmpt/RTMPTClient.java +++ b/client/src/main/java/org/red5/client/net/rtmpt/RTMPTClient.java @@ -24,7 +24,7 @@ /** * RTMPT client object - * + * * @author Anton Lebedevich */ public class RTMPTClient extends BaseRTMPClientHandler { @@ -60,7 +60,7 @@ protected synchronized void startConnector(String server, int port) { /** * Received message object router. - * + * * @param message * an IoBuffer or Packet */ diff --git a/client/src/main/java/org/red5/client/net/rtmpt/RTMPTClientConnector.java b/client/src/main/java/org/red5/client/net/rtmpt/RTMPTClientConnector.java index 3d06e8609..382e0f744 100644 --- a/client/src/main/java/org/red5/client/net/rtmpt/RTMPTClientConnector.java +++ b/client/src/main/java/org/red5/client/net/rtmpt/RTMPTClientConnector.java @@ -33,7 +33,7 @@ /** * Client connector for RTMPT - * + * * @author Anton Lebedevich (mabrek@gmail.com) * @author Paul Gregoire (mondain@gmail.com) */ diff --git a/client/src/test/java/org/red5/client/net/rtmp/FBLiveConnectTest.java b/client/src/test/java/org/red5/client/net/rtmp/FBLiveConnectTest.java index 36e204563..d3eefaf5a 100644 --- a/client/src/test/java/org/red5/client/net/rtmp/FBLiveConnectTest.java +++ b/client/src/test/java/org/red5/client/net/rtmp/FBLiveConnectTest.java @@ -34,11 +34,11 @@ /** * Tests for connecting to Facebook live servers. - * + * *
  * rtmpdump -V -z -r "rtmp://a.rtmp.youtube.com/live2" -a "live2" -y "" -v -f "WIN 11,2,202,235"
  * 
- * + * * @author Paul Gregoire (mondain@gmail.com) */ public class FBLiveConnectTest { diff --git a/client/src/test/java/org/red5/client/net/rtmp/YouTubeConnectTest.java b/client/src/test/java/org/red5/client/net/rtmp/YouTubeConnectTest.java index d1c948681..89be1e2ec 100644 --- a/client/src/test/java/org/red5/client/net/rtmp/YouTubeConnectTest.java +++ b/client/src/test/java/org/red5/client/net/rtmp/YouTubeConnectTest.java @@ -21,7 +21,7 @@ *
  * rtmpdump -V -z -r "rtmp://a.rtmp.youtube.com/live2" -a "live2" -y "" -v -f "WIN 11,2,202,235"
  * 
- * + * * @author Paul Gregoire (mondain@gmail.com) */ public class YouTubeConnectTest { diff --git a/client/src/test/java/org/red5/client/net/rtmp/codec/RTMPClientProtocolDecoderTest.java b/client/src/test/java/org/red5/client/net/rtmp/codec/RTMPClientProtocolDecoderTest.java index e9c4254b2..158e39e7c 100644 --- a/client/src/test/java/org/red5/client/net/rtmp/codec/RTMPClientProtocolDecoderTest.java +++ b/client/src/test/java/org/red5/client/net/rtmp/codec/RTMPClientProtocolDecoderTest.java @@ -32,10 +32,10 @@ public void tearDown() throws Exception { // public void testDecodeBuffer() { // //byte[] buf = IOUtils.hexStringToByteArray("02000000000004050000000000989680420000000000050600989680024200000000000604000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000"); // byte[] buf = IOUtils.hexStringToByteArray("000000000000008e140d0000000200086f6e537461747573000000000000000000050300056c6576656c0200056572726f720004636f64650200104e657453747265616d2e4661696c6564000b6465736372697074696f6e0200174261642064617461206f6e206368616e6e656c3a203634000764657461696c730200076e6f"); - // + // // RTMPConnection conn = RTMPConnManager.getInstance().createConnection(RTMPMinaConnection.class); // conn.setStateCode(RTMP.STATE_CONNECTED); - // + // // RTMPClientProtocolDecoder decoder = new RTMPClientProtocolDecoder(); // decoder.decodeBuffer(conn, IoBuffer.wrap(buf)); // } @@ -45,7 +45,7 @@ public void tearDown() throws Exception { // byte[] buf = IOUtils.hexStringToByteArray("05ffffff0096a7090100000001000f4a120000878a9c9f1398d7046fddb077f532aa9ff889fff2f2b43be1e8253eeeaab3b9557d436a20eda523de6a9fb74466dee9a22e285700e0eea9fd57c6b7ea2fa7d5ef228a071446a3a36fdbfc4d9047e8edb0514031f5eede7fdeaacfbcc9f959d63014bb15e4c9be9e91a52a201c06920dc288f9eb9dedb07b9bb2cfecce0ebedd512fc76a2c8f7bf7d4f37e0a553208ea10b77d8c658b60f0fc3faf874ab773f2e48a4756f847bc6aa8f01ca07790784ef7cb8a9a57f44aac6af2ed5783cf2caef34cbfc1d7d4c1198f5f16765a23d532db47728ebd2d7ffdf08c3af81db9f50d7f6d68779e934753f5baa044fc0ce296fddf4f6d8ab331bbc82377e235fe5f0ea67e657be0f6cfb3ec9b355f30468a546daa7546eb6da983a73728adcbf69b92ddd1d4a06c44c534753f71529f5f9f8bee6628fff93c05b3f5b1175497cdc57046fd053ba1f2cbc6f9635db83dfabc1dde7e51dc47fad8651f2dbbfc58bd436c0e944d97077e6bebf608c19bf5e72f844dcfb63a614f1bf2ac97de96403b6f0fbe1eee5ecdbee6677d918f7201c6364e50608132be153739147845515508eaa88f599e0392b14747da77918b7b6f7bcee7effb2fd428ff95fae774477c17bfc536cc9546e2b9fcb265c9771999f6f55b60d0bf3ba99955976724616d513d2fb1a83ac1df8743ac3f053314ef39b6b5b93e3d8c7d5f942b1edefd81e1e7c3d1d7766c97ca3aa2285a6b63a557bf5d581a7418eb6c9ebf9556cb954ff64cadc52a14fe732cd93321f8356a227060ff40b8f3dbb3f3c3dd83bbbbaa68eb0fc2c5378077cceee8f740c8ea296b924bbb4bad90d47def07bf9bb102a6e88cabfb68ef37f1adbbe7bb7b66cb628df673a06ee7875725f08f6317ed538f994ba9f666a851076dc1d755e363ccade3dd47766cdc112596fc14dc4fdfd8a47bdcf270cdebdcc1dd99555931bd0517ad11ae49eaa64b8d76c3920c2a9b3ea079f11a0f3fbad27c1ef55a751e1ef1ede3db40c5f5b335aa3b11f40ef799e4beaa200444fb047bf8af8d5f5fb5cfabdaa47954629f08cc0efc010f8db3aa9ad9cfa6c9c537da23c5acf7bd0be34012f7a3cf630a68f55e2a556d5367a4d4db7f3f00e4ad8043f49dd1d26c8ddfdb3d9cb7decdcbe1dd6f47b87defd664e5912c0389e7f8aea754a77d35aa3c0097d11a51d5924dacb1f97d444ef35a4aabfe2e745f6d56d5940eb1e9bb3b3747579bb7189a0d0813de045ec8aa6ec962af7f7d7578c0f40ee829656f03385f2a63d64eb783b60085806b4476b074acfbf251d0ee8f3447c8cf552bc1e65b00de7672fb5d0bb6c51b97b3be9367edd9f1d0f37f739b8d6cd8f719b93eaea8c02e3b1dafbf9e55d11b732fa2d8f84f291d5a0a6a0430757d73297ddeca9f666034106f6f503ce8e957be3aadfb9db9b40ccf41dd57e51b79c501000f4aa79d260ec1572fe0eae58c6455ea3b55dade37002dea29c5623a847dd51e038a55fecb00efaf798aa28fdb7cf74c50ac44fd976d9737944799c1d2bb6d98a4457bfffed7f7fdcf707a071a8ad50e877db36f6f54643bfe078460611f2c85d621e58d4fd557fc80727945d91ef87e8f55a81180c6c9b14fb7e3bff670796d11b747469f24cc68446a7af14453155a3aaa7b6cd66f2a9009ff03bbdfe45407673d93365117df6ea8ea8e8eadb34f40fa8295b96df5b7b66e551e1ddbfacdf491b0cdd3f936f77718b6a9efbf137aabc6d44b3d54dc3af3c0359df2adc5116ecd914feee2d7823ea973e3fd64aa475b3fd11e0f32511bf9074dd50a6dffb3d9dbf7c3a8d96f24dfeb5724abd9fdf6700e4fe51e5503bf864cd8a7aac78a62bf4bb00c01d9e11e76ede2a52b29f986c8b4ba07bb8d29cfc6a7759e81795562a5723a0e4922de9d97d7ec2bb74773277e3a52d4967c1a2fe8d613cfa8cba3d9739fb33dfac0ebaabff1dd51d3ef85f794d1e6fa4dfd9cbb7bb681d11ee48c0efcdcb36064f700e4a225a07475e022a3b38a2aca7253102a2a8daa366e65aa3d245377b9ffc56d0f6ffdae81cdc03d272b397edc1dc900e0e94a850a78da8f4a7e1da99681b6a5519ececdc6a7fd7feb201b03b6e1d82e378ad5453b6c5b38a73e3d03f8224513a3d51647bffe5feb1eefa0eb996583a5704667ba3cffc0d704673ed9f6e7fc067b7ffef9a915da3db4757f83acea8d1db9d144e60f878a251dabd11aedfd1e35726f2d5bd5a068409e33ead9bc1157faa0342246b7bf2fcdaa5b92034107080a4bfcdbced8dce59b6c9ba234572cbfe29be36f9e1d81e51efe35c1d49baa7927f7c3aeef7b37aa6866f6fe66b60792379ec03badcf01cbf916b315e004c2651d629b25f682935b1d41d2ab6359740d49901a1027de68f747b8a076ddbdd50a14f171d797848f0deb2a557bb9629fc4ea37ff6f1501ebaabcc0ec327dbfb60efaba652dca3abef5dbf9ffdf6eaab3629f83410707bf937bb3ddaa6d54df95fc0ec1d028ecb1581dddc83a87dfff6dd1d6177ec6b6fc75fbb7fbe99cfef13fea89da19c24ed11555c0607f19aa53cc6d4f3f4bb78a4477c2a8dbebc9f98a2d1d08dfaa6df7fffba3be77cc7e2b538e7dec1181827cc9c53b954cf5dda235cf6a81d6e641d3e227aea89e5337b33e23fda1ea9d677dda236fd4eabf06729f8a6660eef2019f73142867dbeff58f26a75f032ce7fd3aa7230ad6b7047ccc98076d1d52f57d7c56a84df1eef99d5327a66f7446ef5565052da0d041bf2abedd8a201ae7beae29a23cc8a947540f40ddb65aa370dc87f8a73629fdb6f3db7b681dee3540f08fbde6e3dff707bef7b9d6e4b997d76aa060e1014aad9aaa5fc0685f5e62a53db1402937780a59759c5bca6faf3df6a79cf7d91b6b7683020b54c501000f4a64d57c115b8af3bdcf7d4653f0f07b40ecfefa66aa63d2fa8888b6451b9bb96fcf40e29e2a6fbe116d1d353e3d8d4aa26a8532c9a23c3d1fbcd538ca88ad4afd5423d03bf117823df5d0689fa1aab1e5b83d11f6d1d29ef94fd7f6f80e35399f57c86ffd4f73544eecd9ff7e5fc11ac03f65dbbf032dfd469c7bd37ff7bea846932b73a3a92766eabaaacd92798879ea4632b1b5535bd6728e87db1b5718e5e3a1b36e4fdd8dcc0516cfb4a477d5364f0eed99ca23005418eeb5c4fe9760ed8c9d039fb079a22ddbbc73fd529ffdb6cb6df37f02d68f262f9c6b479f00b87f4533f32d66829b7f777b9ee4ecb3c232b59cf84adc9ecb97fecde28b1446cbfa3a6eccdcc2f0340d0bf3ff846117979e9f1187726b765cbd53ef29d1dfe32016ffcbec8c40426a457772c55b7c82c9d5fca2ab0cdd3b3cc29c8a3a3dbcffab52c55dff39228f411f98f7688b201c0517ae81fe5b9f9ec0607f3544035b7c060f40e71afcd97ca259bb39bb325c03136766405239ef13a3bf373d9267846b3947b14efea8e6cb5559966290cdfcbeef9476e28e5e37bec1dfbb7414b237d03987a093a9fb1ffd57bff7a72a86447523bf51ecc6e834207056fb3ffc52de5d6b608c3a112daa3797d15f5453d0900e373018383e7bfebf1da9ec93075ef2b1d7fbe53329effdb9dfd117dba3b536c51a3b9554f0eac99cfa997de38f76ec83b55ad81e5fd3de6a7f0154a3667d4b75d0bee55006fd235d67fa92f3d6db54794e7ff7f8015273146db940bcd11c46579bfbfbef01a89f91b00b87113b39b54a9de593077d2edbef33beed1155c3affd6874a6795727d47bde54af5affd4c8a3bb95b83ad1d86707e034a2ab6ae5c523d1d4d57bea072c91a6e64b2457c0c9ef5076a679a644757ba07340e64f8f545edc1db4ab47601705c6beaacf66aa5566e6b363392f77ca60f22b11fe0d0be3a7fdb2fe0ec44d1d8f7b31466f87558673faa798f776fd6e2985dc6a0f14ecdbf1edbd654fa0ea6e5d3eff14c2f51796ea8df4fb76d57d11ef629f6efc75822caf79552aaf6fc772ee6c53ec6f7f571165df7760343fcf84b3f1a6c46e4aa5a9d1d5feddd1efe452a24cdf2b3f0765503a82335e9672700dccf42fce75a63fd97ef75558a80e4bbf53967a740d28e29e29cf3331bdc9af7b681497b7077bb27f6455978a477eba3def2d351315c83cdbbc5338a58bd532d1dabf8ebf2e7b62bef4fb7296fd140efaaba3daa7aa80cf3ed019cefff660043e13ec72cc8a74458df25fcee726557cbeaa3dc8f725179ddee7a8e8743b11186b1ad11aaa8a395d0b60307fbbffd97ca7fef7e483bffee7d9e644848f1ffc9f1ecefd373de53b3eda4d6655767d9c7b9f3778b01bbbb2ff3aaf40daaa23efed2e11bd92b9f1bffe88cdeaa9b77f37957dd1d794794aaabf8f3e076feec501000f4a5b40e0eecc11ef847d1de2be08f545d6bce719ff631535cdccb6db40cd543de012579d0c9de8f15f7156e4e8eae7b25ec1eb11bfc9eb9bef123c4d11a313b7339797d7a073f2dfdcfab6f01a40294e375546c458066a89314b53ca6e81bfff2f7bf7c64e48076b4a14c938a6af6a9fdc031eb65fe923dd7933f3fb5b8a14fe6411afdaa3cbf95bbf51f1e453c2f00983eaa039d4de56ae65039fd1d4bec8d6c1dcad7ee866e6d5f6b565f2a03cda7c9edd57ededf5fb3db643ef83b03798a7d3aa5408fa0567b38a75afee7acdaf7fc52b51d46bdcf0ee818976c11d401de01f1d7bcf81dec6cbfda3b11a64a06a5c57251db4a73b14fb990337b30f37f35611fc057d67f5bc03797fbe6bf9148342fd0bba3dcd1dcbdff57f777445a3c53ff5f88fe1d4f00438c8d60ea67f446f7ea9f46d05d1d4c1e4f550a15d742df7981d450afb3e3d559900ec031fcdf5dc540700df35d023a11325e555bc8ae816c1e67fa23767bfcbc50f8983d9b83aeb7b15ca3bb9cf2897f3f8aa4bee6b5ef438f82adaac035e11ec51d54b5ea8faa523d996dbc6bed805c262a55b77fe11bf7ada6aaf6a990bdab3db147f36500a6f5783db7aa9428db8de01f95388d79976888d1f88a220eb73d8caace6f9b56a2e5032ab074a3a23b9e65fcb727847a3a93c0a5f4b3d315e357e3b9b6e0ef3d69e87e6f55cf4927e73f479fcccb1af66ff25bb3f334f3e1bf8d0ef5aefd56caad8a22cdccaa764b544dc819bd0ebddb2aafee8ebc3a69802d364fe58d58a72aaf3dfb9475ff0e9951155ea7edbe93ff51cb9ebc6b01a0837dfff97dc59529914adfb67c799cb73915abbda3a3713e93077976d1d46fe07e7b8a04653aa2f740aa8879e2ef3ddd503bd600b7947bfe6e8eaaaf4c513ba71edea24557f3366dceaaf51d4f08d1b9bcb446eb061f810ef9bc579262699cbac5bb77f8c27f78328c51d1155ffffe7c147c93928304f8a7ddf566b6a7f0cc7e46af846a0740e81bad0307fa3b537f1bfd11274eb58eb7e2301f96e7ace5577534dde6d4ff1d2a527217d625a3df338dd96f3cd79468eb1a1eee6b9ef3231f6e81ce0e87b6a8e58a9401c97f7806ef255833ff5162951d8d65edff94f444aa54eaf075f83a537c19bc8ea8f22903939fcb8a94e6d4a3af5cff578d8342051ba3bb1a805e7476afc3d11a81df81dcfaa8c608aaa1f89fff140f540efb414b64a23c6e7f954eb3bb37a016eb1abffdf7673648ab88edf88d9cb688c06fb0029efd1ae45a0199f973962d5683b52a95fa55219bd754b5db7bf54bdf5e28664be03a23f010f047ae89f59725d1e499075d2f03bcd1e35352e2b8d804bec80655a966cf450c88e3daae4de55c0edff2dd3d17d98a228927dbf4d6a29f6779bc9aa736295301a182ff11a01ec11aaab55f2df5b557e49eb3d92814594c6cf3ec501000f4a2dbd8dcff7c224500764e551cea86d5fff281cbbeb032ff97a3a8a55778ca8ef32f875bbd99cf6dd937e01718c8f5995b9d9eceef7992d67db27b6df2bfe3e17f172e694f47554fa4b324f779e035b7b8c678f365baca8f7a36dd96291d60ef73d373719a3aa010ef281fb2fe30232a576dd8a2b0d8ebb3bcc5006e5af7bf828afc18403b73de2e62a85f1b9d9f52be99850313eaa31b66780f298b411bbd4fff7d41d839477c9147bfd539fb7474a766b324b636a770e3f0ebfc9dce6c927f236a5b537f237147aa81d81c52e841d67447503b8a4bee59a3d97b8b0e875f1d88ed005bc77b26d052b5f1ea8037229ef6028affd4776df8f1b8012f7753b2fc46c53b336fa457ce6e4518b56a7b6834304eb95b039fbd523b983d03d556e35e665f7e95034204f9377546679a517b558eee4ea8a07e62ab8c64db7d1d13dcce8ec0c56eddbb8074181059eb8aeedefadb7f70fbdfaab51c9e038d51dee7b046f665ecaa9aefd9d051be1b3760f79d96d9aadbb24ea81e88b266d9547e64ffe064f75953fbea73f806548e98dfc8d6d513dd4a193e77414ca392ea9f5b8a3147ff00ba8ad363d534025f7be1dca07aa857246e6c940946366f877ebb187c101d823b77fbd51c56d71479b0530eb7db00e64a19b46fe0eb99362ad9b98d5c9c9228dd9a8b4fc36d684582381d9ecf627d1d7ff54818513d1bb0fbdda4b9bbd039bef6f945fde8f7d3fcfedbd9d8dfa4bd740fbaa35ba0779efdd665ea883dd0313a9d55f8043ea8cfdb67146ea7ff9ae497267a37e4d00ef81a0047962cf8292411e29b6f7b62bcb8238f25e511d41f8df0303f707bddf29676ff1a8a014cd7bc9c79375cf3f1ec5e666c1ecada8f4f2bbf6447a3d8a720efa71efde9b6a8b6db00d7231c0609f074a15d1ef8782354aa8f3ae4cdb83bee41d29a9714a8f29dfd9a3c03deabc741343ab3f55f145df88e060757674181fcefa4b267315b9a3c079b914028f3ac58c4cb7fee29e646f3d643cebb782301bf2ffa3dc113157a5b014be99f11fb0750328cf0ea4b97d40dfee974b548ea36236d823377b69e7bad65b6f9ef64aa0743bbfb5be0e969ecb1578d437d459e9bfcedea611a720e95d523bcfcbecccd39ff148ec479c11d4cab88ad4fde029778bc0088203b6645b7dffe29dc1d7f6b176d9f92fc7b144be73daa9cecff954999b00efb2df48226eea996b3769d84e8eb8b7e720f4be28d51efc53cdb75577ffec6948043e1eedbc67fa3af67ef6b5aca81e2bb92551de487e0ec503bb327f78d6f37010d8b3feccf37c51387de64f08bb7fab2957aa632a7fd0203d5555377c0d0814188b2700d01dcee2f9fe2afb39e50a1528fefb95efeddd03ad829b628573b2dda23d6d47eb1ecf77ce81e4cf7bd36d9e6d88a4bb935529ba3da3d1d6ef734e3de7f199efdca3b1d2c501000f4a8bd9ef3199b93fb33382361f819f51b65cfde5f49997f1bdeb4af340e08b3973ce7c11b3b7a07a2be089447bddcc50aed1ec0609f16af87d9e5325529aaa6a4ffa6ec9ba226a86b2e0e9547bd68eaf340e0f67fdffcf6679a9d9c50d5edb2451e876233f57a0c1fedacd654b6a478234b544cfcd00b7c3e28f26ec57beb9fc4d271bcf67f2f7d996d73ed51db366b50145df37152a1d323dee0f72c93b6fabdd94c05131c1d5e34d629cbeb15715ff66a81df076e7bb319c1d59740d7d5376291e5c1db1e5768eb00dda19bcdaadbc91becf4c927e5b66b43bb41497fe503becf866fff8dee7b32f7c07332628039c1de71430a6eca79ef14756e030309ef6f9befc0ccb1bac4b83c05270fbb8f07bd51eea9c53bd4f55ede28e377db7d9fcc8197ffd56f925b24d52a3ff49ef71911ab37bd00881cff2552ab581192ddad450aa51e7b6829b87ffe79a67c93f9ff72453bcd55714cc919d1d4f065fec4df8ed50f24c807ff5a83ad8a36a81114a8fcc53b879ee91554cbcf6cbb077ca3d523d60778232e233fffbe9e2e577767fb94760a5a3bdf5626a9bed96db7286529da0a7fd5119dd11b5451de4955c9f50df167c36089dd667c74077fd503d1e46ea8bedb92f15c52010f7ea23c971afc9e6ff73f1bc55fa3d51e11b2eca2329fbe31528c57a3b9e66cfd92c1eb4a2ab53d57b732629f88faf7fff8753aa314a91f01f1dde72db6a8cf48075adcd6541f749ea056a96b5481dcaa44796777aa5adffbd3d701a0fd8a53f52d4fff9eaa77f9a2264627aa8a05c7aa714be267e6ad9558efdf9facb7b9a3da06875bbff0342fbfff9b6d55f99faa0461d725060df3739b72333f00e9e7f9b34790789ad579e91ac11fb71b4fe98d9f7ba45192767d6f2853b20fee0e9bdfa996ec8d4c87646eefa4c55288debffaffbdb2028fca5a5293823be1077fdea95383af2bcf747583b9df5bcfc556e7d44dd3bffb1550323b926cfec8c88ea00c5543acf269d742ad145ff6a855baaa7acc54a54d90763bcff475718f1eff9c1d707bbe1de339ed92ff601c9273a3d976b47defad5513968129f9e82288eae830509154d1d37bb03376533eaadfff315b322b9a053c23caa479bc54c670ec2c62376edf31477bfbcefa5a22f2fa4b3aa2804badef55ec6ff3ca2b736676dbfac555e51078ab7678e42c51f9e53cada811a6e8f00d88f4777667e7a714dbfba19ffc1e7dab7fbff45377907bed54ab7a235baca8efc7475f05ce2a664060811aec532fb65517ec4d03aae8ef321f864dd117d54567d54dfcdeaa57338a879a06228aa4328850a608d9f6a49d96772a96acb1281dbefe67f0338ff6f7fb773e0667f6029ee4cfee29c6ef2b53c0172507bcfde089dc53edbb6c1ecc1ed9ffdcbf5ffc5471d154e01ccbe513aac0f550db78ae4dea9feaabbb6293ec501000f4af82b33117d4d4bff5053f73ca7144bcd6cb8ebb4d11445998dffdf96b3144be823e6e6681c3702cfd56f31b9608f6c53fb0757fdd9b9fb2d5114e8f1cfbe1da9f503bbf1d7fbbd82388d9f543ae777f83c51d0ce1fd797e0a2e816537d47ba3ce29e36a14ece4c9c3eebc9e53f9676e6ecdcfc1dfc793555ac6eaed8f7e016f83f31547bea354e5cff3dbfe45167556aa4d6fb92d8e8ab40e5de08f8dcaaff9557d4d039eb67d9dbfad5ed7c0e8ef91abc5577806846ef315f5465557feff4468e7efddc573b3cb7eaa64798affc5091b9ada8aacfc3767a29a91857ea3a031755f268293f4763b96ba247567365bf6b2adce8880715fbdaa3f7fc5794dbdfef00ecfffd3ca6d54cedb7362eac756f27999a61f95cb40e371ae5f4c8ab5ba3bbe403abaaacbff81f7c3dcdb14dee4e714c8226abfef6d517773f3bdfe3e22cfeb623cf7355452a277b68ef38dc57eda3b520d0ff7fea6f8f54ce6b23caa8149f67faa1663dcc0ce0f9dfc80a9a077e5d7f1bfd5bc5db67fdfeea8c9fec8193e37f9664a3d926e7e5dc11b5368f502adf7402dfc44fdbcd9f9014ffff4757de8978a00e60d22a5ccb73f354faf75befe56b7ecaa1efbcbc3f16c5cdded031f2ea3a8894fb7dfbfe6f94ca4ef4a4471e365ebdf5fdfdf37eb3ff6bbd1d403bef4901a1fe88e81deec9d8bdaac7bf977d97b14cfcef1481ea0d0c13df599fb9383c914f6fbffbef64b3d66e6f6c5e555819c3efe5cb377354c03fef4dea9b6cf08f2da2376fedcbe8193b6299fe76772dbe595c03ad88d8a14f8479e03f046819435f8f3324f4e31faa201d54a045b39b47583b1ef8776d7bf889baac145628579ebcdcbff56d464ab7b2ce66d0cdeead54a9eecf566aa03606b00d2d00e7272febdf17a92b0aed6f37e3ba9afb7f98a446fcd0687fa1544f35f9c50ac46fedfd1dfbb6ce0ebb771a52d5ae7550077ffbcc6ffaded6b7e3bbb075cd5359f28f47bde6b3e822f3d96289b40a6e45760eace7a60343fd0cd0ea7add6e5d9ec517fa3dfff14caa40ecb6635d87e236c9997a06a7c7b6e88a235d1d288ab28edbbadb9f0314f736e8f2efc0e0ea7dadb3476c0f1a614506840df36b623483bcf73933ed0ee7a62bbe02f7bf53b4021e67b2caa3955ff1bad2911dbeb3b355fb7eaac512f8338303f8d67ef773c0672296f3a5f25052e0e81a38273e5c655a88af281a039301493bd4dd1e2ca0fb9a893776a86a6e7ae4fe5eb5146b4aaf96c8012f85993f18b3ea6eb7edf3137de49c1d0f37edc00a6fedddc5605945dcfcdfb514ca3bcef8bc47e88e75c6289f93dff0e96f6da98476f2d1e88df039e1d4f477fe6e4dde1748dc1eccfeeeff9b2fd8fa8f6ce69d81edbb724aca8c978cfb996ffd47422fd61d2b73ddcea6b9474ad4ff79eadf94700e5eea85307a012f9011b147545fc501000f4a0ef93315028d4cfdc520707bd9547fdd1d9c7fd9fec119b83a9ff2bfb4a47973e3baa80f01d57f1dab5cebbb6aaf2a8c1e289147f2cf7b25ced6679ba3a96834404fa3bf7c4750c01d9304651b35bd53bdc6fcab5478e336ff2e51ee7e6f629f6facbde2a10f83d3ef8a39e83b557cd4d97f7fdd5007637791466d50afcc9e7bf5cac6554ddf76490bb3f3d59ad7877df7ef29effb9b93aae7637f6bbcb7caef077e900cef54b9cbbaa393aa045ed1dfb9ba3ab146faab9cf4503ba1942fb3fb2d52a75428938a6fb99f5fffef7ba3b53e1db9af2ff740bc1e76737fbf9d9b96aafa9b266714ff4fc44cff589db07971b4d55df7f9477932ef55997ffa982328807542896abe4ca81be5111493bb747796b6a4462fd80754b533823f633f512aa52e85e6660ed54b2ed69a9ac6028ff1328f6688f432811dd997daa3e23e4ed9547940e976ef6aaf324fff24c93ea076ad4e01d1dfaf6abe2b83ce7ee7ef80c31e3fff3dc1dc5423b0d29be998a3544dffa688c3a890337bc0f2f6f235be99f1dfbe22a99ebe93ca6678743c5da00b87cf74773fcf0306f9bffd516c914ea8a5f714b3790337798a477355dfecb3725ef2d5762dff7a016dba71e66df7f8a0743b53ef64dbcb14e31be5772b593f6864f23ab7a23772550abd7bf51caaa59014b9d93dbfb3f7ef77bec8a72f875bda3b939db47dfd519ee7bf9d94767deeffb2503d1501c92d94476edf68ec743ab446bce66b019c335d11fb2555807208967ffdf666f276efbf7ca4db835d993e07347bf1dd1d592ec54d3527d5c6e2b11baf7a933eaf6d66658ae4bb9b54a999b667475b677243d0e06c14bfe4516629b6d8d511aabeda3ae550a6f341a17e86db32abbadf1a119546f26fa74468aa08f47b70fbe162a993714a9b414def9773f77928f228117147f9c98adcfb5401deb77f1be819cb73396017ddffe5fd00aff8a3cafbb6a8c6810d46450a7234a6373ca53d6e3e277cdfd47b25d8ab9b3733229f2852a40fcea99e5207647bdc035954e4aabbc1da9b3281c052fa667aeef942b1e5b0f485ffbb9faab76b547554a99d80677db3d7954dc1db9ee993f6977393db075319f64b754fb8dd2f806fdb1a0ce175b9e8a14e6645023f14a953efdf7375401d9b7270f416fc77b6daa37324df722baaf92d93f075ef8f3e3c5242ec3a55fea9f41d5da535bd6f3779651d7e43f0ca2467f6fa760f36ea8680ef9ae88f97672ed008ffdb7c940dd51ab4fb45f32d493157e4df1a7bf01a8a26f14714337f555b8dcdecbedf40378df9ef18a608e3b11fca6caa6defa818f73ead4780e4bcfb16064fd15c039e52a25bb2a8fea846225edb476075803de52f851d493807ea8a23fe7e0ee51ea7dadfdafeca0695004c388fc523a53965940dc52a5bce5536d11bfe983a920f432841d6c1e62057b1c501000f4a46ff8dedec57823a9ed9c0420c9f163dbedf551f9d4fd57cfa9f4dd1df6a85222cf299ed0c9ce56c74a362a116d1eb6234a3bdbbf920eac6d5dd3516b75408f9700e4daa2ab55de08ca72e7e6733bf7b6a8eff6db55a9ff5acaa22896eddbe1e601cbcd55eb3fa79e54e4be9264dbfcbd52d5b37694c1eaadad86505778c0170515f0ea733d7d477804c79208e79ef6a2e776c1e8f3fefd112d51f502337f6955aafba22e8671dbbe6a5aab7b6cb76df29da0c23ec529d4cc9b01a0838d532cb1a53b474aea9aa956af7e3d1d73c2334ccd00882f01bbaba8b3d170525b5bf7db52d4aa79e1d0670aad337aabf1b67db914888dd85dbb4461e19ff6f96ee88b5af4b8a3931b1e64be51fd940e49a0d07ebdd3caa4f7ec937fcbb54a8dec03be6bd967ee4caa74026220ed4fbd823a8ba3b96d117f3715ff96ff37def651da8f1efffb17d3bec0526551201db9547f2eee29ce976669f9efcfddb7d64aa791ae4d4bb700ee8ed147ffdd977d2e0f78d29cb55c62c1e7bea6a8e79af28977ef7553637ebbcd53d1d814bfe6d9bcd1ec97a3de864f8a043563cce5ccf0ee37b6f726fb135e718fe1f7de7f2666b6a877ef592288db4a15b593f77acd3ce7de65aa73f2dcc6b9e9c2e8a4763a513fb300d01b0ca3a7f147c7bcc514181fb57d1edb33bb075ef739a9fa79eb7cc44fffdcb2db92550a724b8072b5db0bba19c44cde356ffcaba0719fe01eb1467e8e940eaee28aa54834106f7edcddf01b1d88fcfa98a73d2f879b9aa95f36dfcf4f81dd73e5ad7a6df7281c6e6edfc6a0eef94d5023f201cf50687fa43725b6e457ed9fadfec6b958f29ee6ef66ff002626e4e632224e71afa8f59765538d4f8303f9d80d0813ce6f077f9bc995a6879fffc0ba86ffcbdbb3c7e0d4b536f8bafef3b33f3d3ecc5326d958b80766594021f19318f569af6fed61a039cd9d823372fbd871e00fe4f7b9b9b60f0743cc6e8f3f78de5972b7997c7e6acbe807630cdd97ea7740bd6ad9799ea3b9c8e901180bc9707bd50a154b33fc6d5aafe7a46ab57b8e93b649fea8bffd5714d11e5cb93046aa67bb7f309222ea8bdbf11bf7ea54975efe7046b3daa14df01ab37964a19be094ff4462db3db14e0f155eb73a07afff9a3c1df032ffd8af54d64472fc6b40ecf29532cc96d5055478193a75b11a794dcde0e8742377ca26d85fdb56512804437ae4f58c5e65f81ae6ec8c7eeabbdfa8c03d69c839ebfed57cd53079e65af5bf9e6d2aca948eed3cf33bcf7bb54c8a7f25ed57e1dfa27510773f044f79a0097c0de511f7bce4e08b6c8a64cfc2f534794758abffcd3cd354d6c79f03f99914c9d55b7bd5006f8b2a9d0ca0a8ebc0715cbef7e4bddcc1180b28acb2dff2daa0029e6a8e4b363724cbd0383bcf8ef713abcf6c03f941a10283cc2fd9b7d6e363c6f3725cdc501000f4aacca9b7fbfc0cddc7b64664aa27e5523d53b6c8d7b0753324fc5e5f1b7b86df2bfb59bcbd9f654376e68efca77ca07779558342fd0bfb7446fff9783d112f8763abddaaa818f66e7a591cf3b6681ebe03a3a9ef49c8a3d760f1b51fdf73f9efdd5321f8afdffe667bfb8d7bfefd051a81dde49b66502e0483384fff8cd6e28bd1dc9aaef143223d53fa5db2e4bb002a1355ecdac819512decbf9fac289fd1e26fc11eb9f0dbbfaad408d249f83acabdfea8d11b9bb660ee400982b6ffc3c6e4f77678095d967f157144513ff9dea90087251db55d9efdc53d6383bf51d71bb65b754665be3f0bcdbb67fea54403966ca3a57b354677fb35556ee01da19c0e625f67ed4d9732fefaeb7d8b01d51eb203400913eaaa596fffec1e8eff27aff9d1e700cdfdea8fe64ee7cf3e1ed93aa3d446de29db91462af56157ee732a8947bb63df5b6cbe35bbb83d579ef5b14c1d36a3cd5d937c0d08143cdddc1eb72fe5513bb767fdb9fef5435c9d954be0d5d1d720303f95ae8eecfdb38dd9bcdb664a2308c0110d24dbc9c57b3cc6794ee291e6dde6de295be71aa0ef39fb9f1e4baa6fdabfcfddb933475bfc64ba1f7b98ec78b3007ecf499bd503be6fb3f67046b00b064ebd807ac5bf6cf6fe6eb3f823d037477714cb0ec3a899140e9beee6b3681c83a5fbfc518ddaa43277034d65b6d50a52ef79b4beaab7bfffa77db0025f5560ee01dc032ddad67fc3ad052cfe677d7760344fcd1f1d67d4fe4d99ed9e1e5dd50de667339c6e88d5cf83efbbcf819bb231aa217f3d915c5176dc1d653eedc955c56d88d3dec69b512583dce457143528153eef9b2e9751d8eeea8fa9eb6ce64d9e9cf0eef69f83ef1a6a88f73f0badac4036b0e874a78a144555ededf3397a3cb3446aa2e29cc57d9ee3554cc00b82972efb4baea8be83bbd53f9e935429b54f2a892ec51b0fbda6c92fa8898a7c237c7aac470393c05779ee818becae7ebde4b18b446dfcc8d33ee4ccefb31837fed7ffacdcb651dcb5b51f6d4d1dc1da88230183af20a7051d032c4dbb94441e28fecfb32f54debdf942d3fe8071abd51cb1a917a3bb724dfcdaa9ef58cf2c6ff72cf6298d664ee0eeb7ebee6d0687f5ef7f11aff5481c53abc56c4f0f075aa2dfda3bcc3b0d62a1dfbc2397ff36f19ffa37ebd113f9e99aa14f6fdf09992291d4fed956ed1d64f64b822f955daa0bfde1d6ba200cdce08dc83a99ef7ee5f637fc1e6e3347bbfae816e4bfdd5395a9074a36ff64fccfc54a59efbd2dfd0cdf7cc8ebfb900c8ebd3eaadf7773e9f446f4578014f76bb66cac667acf499d498a681ddf2aff2ee7a7cfc130a3df110bc46cacf97b9b276d6f7f32d740e08fbdfc1d4cf088a87755455444bc9e515acf8e81a17e7f518d796ada9e7ed0353634a6df65fcb681bdba193d7bdf51e5c0ff5481be72ac501000f"); // RTMPConnection conn = RTMPConnManager.getInstance().createConnection(RTMPMinaConnection.class); // conn.setStateCode(RTMP.STATE_CONNECTED); - // + // // RTMPClientProtocolDecoder decoder = new RTMPClientProtocolDecoder(); // decoder.decodeBuffer(conn, IoBuffer.wrap(buf)); // } diff --git a/common/pom.xml b/common/pom.xml index b44ec62cd..7936d78f0 100644 --- a/common/pom.xml +++ b/common/pom.xml @@ -3,7 +3,7 @@ org.red5 red5-parent - 1.2.24 + 1.2.31 4.0.0 red5-server-common diff --git a/common/src/main/java/org/red5/logging/LoggingContextSelector.java b/common/src/main/java/org/red5/logging/LoggingContextSelector.java index d464d0df8..852f8a73a 100644 --- a/common/src/main/java/org/red5/logging/LoggingContextSelector.java +++ b/common/src/main/java/org/red5/logging/LoggingContextSelector.java @@ -28,9 +28,9 @@ /** * A class that allows the LoggerFactory to access an web context based LoggerContext. - * + * * Add this java option -Dlogback.ContextSelector=org.red5.logging.LoggingContextSelector - * + * * @author Paul Gregoire (mondain@gmail.com) */ public class LoggingContextSelector implements ContextSelector { @@ -205,7 +205,7 @@ public void setContextConfigFile(String contextConfigFile) { /** * Returns the number of managed contexts Used for testing purposes - * + * * @return the number of managed contexts */ public int getCount() { @@ -214,9 +214,9 @@ public int getCount() { /** * These methods are used by the LoggerContextFilter. - * + * * They provide a way to tell the selector which context to use, thus saving the cost of a JNDI call at each new request. - * + * * @param context * logging context */ diff --git a/common/src/main/java/org/red5/logging/Red5LoggerFactory.java b/common/src/main/java/org/red5/logging/Red5LoggerFactory.java index a91d8e058..2547c3ee9 100644 --- a/common/src/main/java/org/red5/logging/Red5LoggerFactory.java +++ b/common/src/main/java/org/red5/logging/Red5LoggerFactory.java @@ -18,7 +18,7 @@ /** * LoggerFactory to simplify requests for Logger instances within Red5 applications. This class is expected to be run only once per logger * request and is optimized as such. - * + * * @author Paul Gregoire (mondain@gmail.com) */ public class Red5LoggerFactory { diff --git a/common/src/main/java/org/red5/server/AttributeStore.java b/common/src/main/java/org/red5/server/AttributeStore.java index 49cfc1616..771638de5 100644 --- a/common/src/main/java/org/red5/server/AttributeStore.java +++ b/common/src/main/java/org/red5/server/AttributeStore.java @@ -41,7 +41,7 @@ public AttributeStore() { /** * Creates attribute store with initial values. Object is not associated with a persistence storage. - * + * * @param values * map */ @@ -51,7 +51,7 @@ public AttributeStore(Map values) { /** * Creates attribute store with initial values. Object is not associated with a persistence storage. - * + * * @param values * map */ @@ -61,13 +61,13 @@ public AttributeStore(IAttributeStore values) { /** * Filter - * + * *
      * null
      * 
- * + * * keys and values from given map. - * + * * @param values * the map to filter * @return filtered map @@ -365,7 +365,7 @@ public String getStringAttribute(String name) { /** * Allows for reconstruction via CompositeData. - * + * * @param cd * composite data * @return AttributeStore class instance diff --git a/common/src/main/java/org/red5/server/BaseConnection.java b/common/src/main/java/org/red5/server/BaseConnection.java index eb0f99174..bb7f666fe 100644 --- a/common/src/main/java/org/red5/server/BaseConnection.java +++ b/common/src/main/java/org/red5/server/BaseConnection.java @@ -213,7 +213,7 @@ public void removeListener(IConnectionListener listener) { /** * Notifies listeners of a property change. - * + * * @param evt PropertyChangeEvent containing details */ public void notifyPropertyChanged(PropertyChangeEvent evt) { @@ -241,7 +241,7 @@ public void setStreamId(Number id) { /** * Initializes client - * + * * @param client * Client bound to connection */ @@ -313,7 +313,7 @@ public String getSessionId() { /** * Return connection parameters - * + * * @return connection parameters */ public Map getConnectParams() { @@ -332,7 +332,7 @@ public IClient getClient() { /** * Check whether connection is alive - * + * * @return true if connection is bound to scope, false otherwise */ public boolean isConnected() { @@ -342,7 +342,7 @@ public boolean isConnected() { /** * Connect to another scope on server - * + * * @param newScope * New scope * @return true on success, false otherwise @@ -353,7 +353,7 @@ public boolean connect(IScope newScope) { /** * Connect to another scope on server with given parameters - * + * * @param newScope * New scope * @param params @@ -375,7 +375,7 @@ public boolean connect(IScope newScope, Object[] params) { /** * Return the current scope. - * + * * @return scope */ public IScope getScope() { @@ -427,7 +427,7 @@ public void close() { /** * Notified on event - * + * * @param event * Event */ @@ -437,7 +437,7 @@ public void notifyEvent(IEvent event) { /** * Dispatches event - * + * * @param event * Event */ @@ -447,7 +447,7 @@ public void dispatchEvent(IEvent event) { /** * Handles event - * + * * @param event * Event * @return true if associated scope was able to handle event, false otherwise @@ -466,7 +466,7 @@ public Iterator getBasicScopes() { /** * Registers basic scope - * + * * @param basicScope * Basic scope to register */ @@ -477,7 +477,7 @@ public void registerBasicScope(IBroadcastScope basicScope) { /** * Registers basic scope - * + * * @param basicScope * Basic scope to register */ @@ -537,7 +537,7 @@ public long getDroppedMessages() { /** * Returns whether or not the reader is idle. - * + * * @return queued messages */ public boolean isReaderIdle() { @@ -546,7 +546,7 @@ public boolean isReaderIdle() { /** * Returns whether or not the writer is idle. - * + * * @return queued messages */ public boolean isWriterIdle() { @@ -555,7 +555,7 @@ public boolean isWriterIdle() { /** * Returns whether or not a connection is closed. - * + * * @return true if closed */ public boolean isClosed() { @@ -564,7 +564,7 @@ public boolean isClosed() { /** * Count of outgoing messages not yet written. - * + * * @return pending messages */ public long getPendingMessages() { @@ -573,7 +573,7 @@ public long getPendingMessages() { /** * Count of outgoing video messages not yet written. - * + * * @param streamId * the id you want to know about * @return pending messages for this streamId diff --git a/common/src/main/java/org/red5/server/Client.java b/common/src/main/java/org/red5/server/Client.java index 183a627f0..219bb5a00 100644 --- a/common/src/main/java/org/red5/server/Client.java +++ b/common/src/main/java/org/red5/server/Client.java @@ -180,7 +180,7 @@ public Set getConnections(IScope scope) { /** * Returns the time at which the client was created. - * + * * @return creation time */ public long getCreationTime() { @@ -189,7 +189,7 @@ public long getCreationTime() { /** * Returns the client id. - * + * * @return client id */ public String getId() { @@ -232,7 +232,7 @@ public List iterateScopeNameList() { /** * Returns registration status of given connection. - * + * * @param conn * connection * @return true if registered and false otherwise @@ -243,7 +243,7 @@ public boolean isRegistered(IConnection conn) { /** * Associate connection with client - * + * * @param conn * Connection object */ @@ -270,7 +270,7 @@ protected void register(IConnection conn) { /** * Removes client-connection association for given connection - * + * * @param conn * Connection object */ @@ -280,7 +280,7 @@ protected void unregister(IConnection conn) { /** * Removes client-connection association for given connection - * + * * @param conn * Connection object * @param deleteIfNoConns diff --git a/common/src/main/java/org/red5/server/ClientList.java b/common/src/main/java/org/red5/server/ClientList.java index fa0b7d4c0..2da881270 100644 --- a/common/src/main/java/org/red5/server/ClientList.java +++ b/common/src/main/java/org/red5/server/ClientList.java @@ -17,7 +17,7 @@ /** * Client list, implemented using weak references to prevent memory leaks. - * + * * @author Paul Gregoire (mondain@gmail.com) * @param * type of class diff --git a/common/src/main/java/org/red5/server/ClientRegistry.java b/common/src/main/java/org/red5/server/ClientRegistry.java index 7023e7964..cb2f0fbc3 100644 --- a/common/src/main/java/org/red5/server/ClientRegistry.java +++ b/common/src/main/java/org/red5/server/ClientRegistry.java @@ -72,7 +72,7 @@ public ClientRegistry(String name) { /** * Add client to registry - * + * * @param client * Client to add */ @@ -117,9 +117,9 @@ public ClientList getClientList() { * @return
      * True
      * 
- * + * * if clients exist, otherwise - * + * *
      * False
      * 
@@ -130,7 +130,7 @@ protected boolean hasClients() { /** * Return collection of clients - * + * * @return Collection of clients */ @SuppressWarnings("unchecked") @@ -191,7 +191,7 @@ public IClient newClient(Object[] params) throws ClientNotFoundException, Client /** * Return next client id - * + * * @return Next client id */ public String nextId() { @@ -208,7 +208,7 @@ public String nextId() { /** * Return previous client id - * + * * @return Previous client id */ public String previousId() { @@ -217,7 +217,7 @@ public String previousId() { /** * Removes client from registry - * + * * @param client * Client to remove */ diff --git a/common/src/main/java/org/red5/server/ContextLoader.java b/common/src/main/java/org/red5/server/ContextLoader.java index 565de2dfc..7f9b8f5b6 100644 --- a/common/src/main/java/org/red5/server/ContextLoader.java +++ b/common/src/main/java/org/red5/server/ContextLoader.java @@ -40,7 +40,7 @@ /** * Red5 applications loader - * + * * @author The Red5 Project * @author Tiago Jacobs (tiago@imdt.com.br) * @author Paul Gregoire (mondain@gmail.com) @@ -77,7 +77,7 @@ public class ContextLoader implements ApplicationContextAware, InitializingBean, /** * Registers with JMX and registers a shutdown hook. - * + * * @throws Exception * I/O exception, casting exception and others */ @@ -141,7 +141,7 @@ public void init() throws IOException { /** * Loads a context (Red5 application) and stores it in a context map, then adds it's beans to parent (that is, Red5) - * + * * @param name * Context name * @param config @@ -196,7 +196,7 @@ public void loadContext(String name, String config) { /** * Unloads a context (Red5 application) and removes it from the context map, then removes it's beans from the parent (that is, Red5) - * + * * @param name * Context name */ @@ -264,7 +264,7 @@ public void shutdown() { /** * Return context by name - * + * * @param name * Context name * @return Application context for given name @@ -279,7 +279,7 @@ public ApplicationContext getContext(String name) { /** * Sets a parent context for child context based on a given key. - * + * * @param parentContextKey * key for the parent context * @param appContextId @@ -338,7 +338,7 @@ public void setApplicationContext(ApplicationContext applicationContext) throws /** * Setter for parent application context - * + * * @param parentContext * Parent Spring application context */ @@ -348,7 +348,7 @@ public void setParentContext(ApplicationContext parentContext) { /** * Return parent context - * + * * @return parent application context */ public ApplicationContext getParentContext() { @@ -357,7 +357,7 @@ public ApplicationContext getParentContext() { /** * Setter for context config name - * + * * @param contextsConfig * Context config name */ diff --git a/common/src/main/java/org/red5/server/LoaderBase.java b/common/src/main/java/org/red5/server/LoaderBase.java index f1f9bb5fd..49488806f 100644 --- a/common/src/main/java/org/red5/server/LoaderBase.java +++ b/common/src/main/java/org/red5/server/LoaderBase.java @@ -21,7 +21,7 @@ /** * Base class for all JEE application loaders. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) * @author Paul Gregoire (mondain@gmail.com) @@ -52,7 +52,7 @@ public abstract class LoaderBase implements ApplicationContextAware { /** * Getter for the application loader. - * + * * @return Application loader */ public static IApplicationLoader getApplicationLoader() { @@ -62,7 +62,7 @@ public static IApplicationLoader getApplicationLoader() { /** * Setter for the application loader. - * + * * @param loader * Application loader */ @@ -73,7 +73,7 @@ public static void setApplicationLoader(IApplicationLoader loader) { /** * Returns the map containing all of the registered Red5 application contexts. - * + * * @return a map */ public static Map getRed5ApplicationContexts() { @@ -83,10 +83,10 @@ public static Map getRed5ApplicationContexts() { /** * Getter for a Red5 application context. - * + * * @param path * path - * + * * @return Red5 application context */ public static IApplicationContext getRed5ApplicationContext(String path) { @@ -97,10 +97,10 @@ public static IApplicationContext getRed5ApplicationContext(String path) { /** * Setter for a Red5 application context. - * + * * @param path * path - * + * * @param context * Red5 application context */ @@ -117,10 +117,10 @@ public static void setRed5ApplicationContext(String path, IApplicationContext co /** * Remover for a Red5 application context. - * + * * @param path * path - * + * * @return Red5 application context */ public static IApplicationContext removeRed5ApplicationContext(String path) { @@ -130,7 +130,7 @@ public static IApplicationContext removeRed5ApplicationContext(String path) { /** * Getter for application context - * + * * @return Application context */ public static ApplicationContext getApplicationContext() { @@ -140,7 +140,7 @@ public static ApplicationContext getApplicationContext() { /** * Setter for application context. - * + * * @param context * Application context * @throws BeansException @@ -153,7 +153,7 @@ public void setApplicationContext(ApplicationContext context) throws BeansExcept /** * Set the folder containing webapps. - * + * * @param webappFolder * web app folder */ @@ -171,7 +171,7 @@ public void setWebappFolder(String webappFolder) { /** * Remove context from the current host. - * + * * @param path * Path */ diff --git a/common/src/main/java/org/red5/server/Server.java b/common/src/main/java/org/red5/server/Server.java index 6fb80b861..55a0b85a0 100644 --- a/common/src/main/java/org/red5/server/Server.java +++ b/common/src/main/java/org/red5/server/Server.java @@ -73,7 +73,7 @@ public class Server implements IServer, ApplicationContextAware, InitializingBea /** * Setter for Spring application context - * + * * @param applicationContext * Application context */ @@ -97,7 +97,7 @@ public void destroy() throws Exception { /** * Return scope key. Scope key consists of host name concatenated with context path by slash symbol - * + * * @param hostName * Host name * @param contextPath @@ -110,7 +110,7 @@ protected String getKey(String hostName, String contextPath) { /** * Does global scope lookup for host name and context path - * + * * @param hostName * Host name * @param contextPath @@ -161,7 +161,7 @@ public IGlobalScope lookupGlobal(String hostName, String contextPath) { /** * Return global scope by name - * + * * @param name * Global scope name * @return Global scope @@ -175,7 +175,7 @@ public IGlobalScope getGlobal(String name) { /** * Register global scope - * + * * @param scope * Global scope to register */ @@ -186,7 +186,7 @@ public void registerGlobal(IGlobalScope scope) { /** * Map key (host + / + context path) and global scope name - * + * * @param hostName * Host name * @param contextPath @@ -204,7 +204,7 @@ public boolean addMapping(String hostName, String contextPath, String globalName /** * Remove mapping with given key - * + * * @param hostName * Host name * @param contextPath @@ -220,7 +220,7 @@ public boolean removeMapping(String hostName, String contextPath) { /** * Remove all mappings with given context path - * + * * @param contextPath * Context path * @return true if mapping was removed, false if key doesn't exist @@ -234,7 +234,7 @@ public boolean removeMapping(String contextPath) { /** * Return mapping - * + * * @return Map of "scope key / scope name" pairs */ public Map getMappingTable() { @@ -243,7 +243,7 @@ public Map getMappingTable() { /** * Return global scope names set iterator - * + * * @return Iterator */ public Iterator getGlobalNames() { @@ -252,7 +252,7 @@ public Iterator getGlobalNames() { /** * Return global scopes set iterator - * + * * @return Iterator */ public Iterator getGlobalScopes() { @@ -261,7 +261,7 @@ public Iterator getGlobalScopes() { /** * String representation of server - * + * * @return String representation of server */ @Override @@ -291,7 +291,7 @@ public void removeListener(IConnectionListener listener) { /** * Notify listeners about a newly created scope. - * + * * @param scope * the scope that was created */ @@ -301,7 +301,7 @@ public void notifyScopeCreated(IScope scope) { /** * Notify listeners that a scope was removed. - * + * * @param scope * the scope that was removed */ @@ -311,7 +311,7 @@ public void notifyScopeRemoved(IScope scope) { /** * Notify listeners that a new connection was established. - * + * * @param conn * the new connection */ @@ -321,7 +321,7 @@ public void notifyConnected(IConnection conn) { /** * Notify listeners that a connection was disconnected. - * + * * @param conn * the disconnected connection */ diff --git a/common/src/main/java/org/red5/server/adapter/AbstractScopeAdapter.java b/common/src/main/java/org/red5/server/adapter/AbstractScopeAdapter.java index 3d8dfe162..923b5776f 100644 --- a/common/src/main/java/org/red5/server/adapter/AbstractScopeAdapter.java +++ b/common/src/main/java/org/red5/server/adapter/AbstractScopeAdapter.java @@ -27,102 +27,102 @@ public abstract class AbstractScopeAdapter implements IScopeHandler { /** * 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; @@ -134,13 +134,13 @@ public abstract class AbstractScopeAdapter implements IScopeHandler { * * true * - * + * * if scope is ready to be activated, - * + * * * false * - * + * * otherwise */ public void setCanStart(boolean canStart) { @@ -154,13 +154,13 @@ public void setCanStart(boolean canStart) { * * true * - * + * * if remote service calls are allowed for the scope, - * + * * * false * - * + * * otherwise */ public void setCanCallService(boolean canCallService) { @@ -175,13 +175,13 @@ public void setCanCallService(boolean canCallService) { * * true * - * + * * if connections to scope are allowed, - * + * * * false * - * + * * otherwise */ public void setCanConnect(boolean canConnect) { @@ -195,13 +195,13 @@ public void setCanConnect(boolean canConnect) { * * true * - * + * * if scope may be joined by users, - * + * * * false * - * + * * otherwise */ public void setJoin(boolean canJoin) { @@ -260,7 +260,7 @@ public boolean handleEvent(IEvent event) { /** * Calls the checkBandwidth method on the current client. - * + * * @param o * Object passed from Flash, not used at the moment */ @@ -274,7 +274,7 @@ public void checkBandwidth(Object o) { /** * Calls the checkBandwidthUp method on the current client. - * + * * @param params * Object passed from Flash * @return bandwidth results map diff --git a/common/src/main/java/org/red5/server/adapter/ApplicationAdapter.java b/common/src/main/java/org/red5/server/adapter/ApplicationAdapter.java index f1a7b21b9..150e851e0 100644 --- a/common/src/main/java/org/red5/server/adapter/ApplicationAdapter.java +++ b/common/src/main/java/org/red5/server/adapter/ApplicationAdapter.java @@ -17,10 +17,10 @@ /** * Base class for applications, takes care that callbacks are executed single-threaded. If you want to have maximum performance, use * {@link MultiThreadedApplicationAdapter} instead. - * + * * Using this class may lead to problems if accepting a client in the Connect or Join methods takes too * long, so using the multi-threaded version is preferred. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) * @author Paul Gregoire (mondain@gmail.com) diff --git a/common/src/main/java/org/red5/server/adapter/IApplication.java b/common/src/main/java/org/red5/server/adapter/IApplication.java index 9bca652fb..298a46a19 100644 --- a/common/src/main/java/org/red5/server/adapter/IApplication.java +++ b/common/src/main/java/org/red5/server/adapter/IApplication.java @@ -13,33 +13,33 @@ /** * IApplication provides lifecycle methods that most communication applications will use. This interface defines the methods that are called by Red5 through an applications life. It is suggested that you NOT implement this interface yourself, but instead you should subclass org.red5.server.adapter.MultiThreadedApplicationAdapter or org.red5.server.adapter.ApplicationAdapter. - * + * * @author Dominick Accattato */ public interface IApplication { /** * Called once when application or room starts - * + * * @param app * Application or room level scope. See {@link org.red5.server.api.scope.IScope} for details * @return
      * true
      * 
- * + * * continues application run, - * + * *
      * false
      * 
- * + * * terminates */ public boolean appStart(IScope app); /** * Called per each client connect - * + * * @param conn * Connection object used to provide basic connection methods. See {@link org.red5.server.api.IConnection} * @param params @@ -47,20 +47,20 @@ public interface IApplication { * @return
      * true
      * 
- * + * * accepts the connection, - * + * *
      * false
      * 
- * + * * rejects it */ public boolean appConnect(IConnection conn, Object[] params); /** * Called every time client joins app level scope - * + * * @param client * Client object * @param app @@ -68,20 +68,20 @@ public interface IApplication { * @return
      * true
      * 
- * + * * accepts the client, - * + * *
      * false
      * 
- * + * * rejects it */ public boolean appJoin(IClient client, IScope app); /** * Called every time client disconnects from the application - * + * * @param conn * Connection object See {@link org.red5.server.api.IConnection} */ @@ -89,7 +89,7 @@ public interface IApplication { /** * Called every time client leaves the application scope - * + * * @param client * Client object * @param app @@ -99,7 +99,7 @@ public interface IApplication { /** * Called on application stop - * + * * @param app * Scope object */ @@ -107,26 +107,26 @@ public interface IApplication { /** * Called on application room start - * + * * @param room * Scope object * @return
      * true
      * 
- * + * * if scope can be started, - * + * *
      * false
      * 
- * + * * otherwise */ public boolean roomStart(IScope room); /** * Called every time client connects to the room - * + * * @param conn * Connection object * @param params @@ -134,20 +134,20 @@ public interface IApplication { * @return
      * true
      * 
- * + * * accepts the connection, - * + * *
      * false
      * 
- * + * * rejects it */ public boolean roomConnect(IConnection conn, Object[] params); /** * Called when user joins room scope - * + * * @param client * Client object * @param room @@ -155,20 +155,20 @@ public interface IApplication { * @return
      * true
      * 
- * + * * accepts the client, - * + * *
      * false
      * 
- * + * * rejects it */ public boolean roomJoin(IClient client, IScope room); /** * Called when client disconnects from room scope - * + * * @param conn * Connection object used to provide basic connection methods. See {@link org.red5.server.api.IConnection} */ @@ -176,7 +176,7 @@ public interface IApplication { /** * Called when user leaves room scope - * + * * @param client * Client object * @param room @@ -186,7 +186,7 @@ public interface IApplication { /** * Called on room scope stop - * + * * @param room * Scope object */ diff --git a/common/src/main/java/org/red5/server/adapter/MultiThreadedApplicationAdapter.java b/common/src/main/java/org/red5/server/adapter/MultiThreadedApplicationAdapter.java index 8d345820c..513ffd226 100644 --- a/common/src/main/java/org/red5/server/adapter/MultiThreadedApplicationAdapter.java +++ b/common/src/main/java/org/red5/server/adapter/MultiThreadedApplicationAdapter.java @@ -75,25 +75,25 @@ * methods added in subclasses can be called from client side with NetConnection.call method. Unlike to Flash Media server which requires * you to keep methods on Client object at server side, Red5 offers much more convenient way to add methods
* EXAMPLE:
- * + * * * public List<String> getLiveStreams() { * // Implementation goes here, say, use Red5 object to obtain scope and all it's streams * } * - * + * *
* This method added to ApplicationAdapter subclass can be called from client side with the following code:
- * + * * * var nc:NetConnection = new NetConnection(); * nc.connect(...); * nc.call("getLiveStreams", resultHandlerObj); * - * + * *
* If you want to build a server-side framework this is a place to start and wrap it around ApplicationAdapter subclass. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) * @author Paul Gregoire (mondain@gmail.com) @@ -138,7 +138,7 @@ public class MultiThreadedApplicationAdapter extends StatefulScopeWrappingAdapte /** * Register a listener that will get notified about application events. - * + * * @param listener * object to register */ @@ -148,7 +148,7 @@ public void addListener(IApplication listener) { /** * Unregister handler that will not get notified about application events any longer. - * + * * @param listener * object to unregister */ @@ -158,7 +158,7 @@ public void removeListener(IApplication listener) { /** * Return handlers that get notified about application events. - * + * * @return list of handlers */ public Set getListeners() { @@ -212,7 +212,7 @@ public Set getSharedObjectSecurity() { /** * Reject the currently connecting client without a special error message. This method throws {@link ClientRejectedException} exception. - * + * * @return never returns * @throws org.red5.server.exception.ClientRejectedException * Thrown when client connection must be rejected by application logic @@ -223,13 +223,13 @@ protected boolean rejectClient() throws ClientRejectedException { /** * Reject the currently connecting client with an error message. - * + * * The passed object will be available as "application" property of the information object that is returned to the caller. - * + * * @param reason * Additional error message to return to client-side Flex/Flash application * @return never returns - * + * * @throws org.red5.server.exception.ClientRejectedException * Thrown when client connection must be rejected by application logic */ @@ -241,7 +241,7 @@ protected boolean rejectClient(Object reason) throws ClientRejectedException { * Returns connection result for given scope and parameters. Whether the scope is room or app level scope, this method distinguishes it * and acts accordingly. You override {@link ApplicationAdapter#appConnect(IConnection, Object[])} or * {@link ApplicationAdapter#roomConnect(IConnection, Object[])} in your application to make it act the way you want. - * + * * @param conn * Connection object * @return true if connect is successful, false otherwise @@ -261,7 +261,7 @@ public boolean connect(IConnection conn) { * Returns connection result for given scope and parameters. Whether the scope is room or app level scope, this method distinguishes it * and acts accordingly. You override {@link ApplicationAdapter#appConnect(IConnection, Object[])} or * {@link ApplicationAdapter#roomConnect(IConnection, Object[])} in your application to make it act the way you want. - * + * * @param conn * Connection object * @param scope @@ -271,13 +271,13 @@ public boolean connect(IConnection conn) { * @return * true * - * + * * if connect is successful, - * + * * * false * - * + * * otherwise */ @Override @@ -312,19 +312,19 @@ public boolean connect(IConnection conn, IScope scope, Object[] params) { /** * Starts scope. Scope can be both application or room level. - * + * * @param scope * Scope object * @return * true * - * + * * if scope can be started, - * + * * * false * - * + * * otherwise. See {@link AbstractScopeAdapter#start(IScope)} for details. */ @Override @@ -411,7 +411,7 @@ public boolean start(IScope scope) { /** * Returns disconnection result for given scope and parameters. Whether the scope is room or app level scope, this method distinguishes * it and acts accordingly. - * + * * @param conn * Connection object * @param scope @@ -443,7 +443,7 @@ public void disconnect(IConnection conn, IScope scope) { * Stops scope handling (that is, stops application if given scope is app level scope and stops room handling if given scope has lower * scope level). This method calls {@link ApplicationAdapter#appStop(IScope)} or {@link ApplicationAdapter#roomStop(IScope)} handlers * respectively. - * + * * @param scope * Scope to stop */ @@ -454,7 +454,7 @@ public void stop(IScope scope) { if (ScopeUtils.isApp(scope)) { // we don't allow connections after we stop super.setCanConnect(false); - // we also don't allow service calls + // we also don't allow service calls super.setCanCallService(false); // stop the app appStop(scope); @@ -468,7 +468,7 @@ public void stop(IScope scope) { * Adds client to scope. Scope can be both application or room. Can be applied to both application scope and scopes of lower level. This * method calls {@link ApplicationAdapter#appJoin(IClient, IScope)} or {@link ApplicationAdapter#roomJoin(IClient, IScope)} handlers * respectively. - * + * * @param client * Client object * @param scope @@ -489,7 +489,7 @@ public boolean join(IClient client, IScope scope) { /** * Disconnects client from scope. Can be applied to both application scope and scopes of lower level. This method calls * {@link ApplicationAdapter#appLeave(IClient, IScope)} or {@link ApplicationAdapter#roomLeave(IClient, IScope)} handlers respectively. - * + * * @param client * Client object * @param scope @@ -509,19 +509,19 @@ public void leave(IClient client, IScope scope) { /** * Called once on scope (that is, application or application room) start. You override {@link ApplicationAdapter#appStart(IScope)} or * {@link ApplicationAdapter#roomStart(IScope)} in your application to make it act the way you want. - * + * * @param app * Application scope object * @return * true * - * + * * if scope can be started, - * + * * * false * - * + * * otherwise */ public boolean appStart(IScope app) { @@ -536,7 +536,7 @@ public boolean appStart(IScope app) { /** * Handler method. Called when application is stopped. - * + * * @param app * Scope object */ @@ -549,7 +549,7 @@ public void appStop(IScope app) { /** * Handler method. Called when room scope is started. - * + * * @param room * Room scope * @return Boolean value @@ -567,7 +567,7 @@ public boolean roomStart(IScope room) { /** * Handler method. Called when room scope is stopped. - * + * * @param room * Room scope. */ @@ -582,37 +582,37 @@ public void roomStop(IScope room) { * Handler method. Called every time new client connects (that is, new IConnection object is created after call from a SWF movie) to the * application.
* You override this method to pass additional data from client to server application using - * + * * * NetConnection.connect * - * + * * method.
* EXAMPLE:
* In this simple example we pass user's skin of choice identifier from client to the server.
* Client-side:
- * + * * * NetConnection.connect("rtmp://localhost/killerred5app", "silver"); * - * + * *
* Server-side:
- * + * * * if (params.length > 0) * log.debug("Theme selected: {}", params[0]); * - * + * * @param conn * Connection object * @param params * List of parameters after connection URL passed to - * + * * * NetConnection.connect * - * + * * method. * @return Boolean value */ @@ -629,17 +629,17 @@ public boolean appConnect(IConnection conn, Object[] params) { /** * Handler method. Called every time new client connects (that is, new IConnection object is created after call from a SWF movie) to the * application. - * + * * You override this method to pass additional data from client to server application using - * + * * * NetConnection.connect * - * + * * method. - * + * * See {@link ApplicationAdapter#appConnect(IConnection, Object[])} for code example. - * + * * @param conn * Connection object * @param params @@ -658,7 +658,7 @@ public boolean roomConnect(IConnection conn, Object[] params) { /** * Handler method. Called every time client disconnects from the application. - * + * * @param conn * Disconnected connection object */ @@ -671,7 +671,7 @@ public void appDisconnect(IConnection conn) { /** * Handler method. Called every time client disconnects from the room. - * + * * @param conn * Disconnected connection object */ @@ -694,7 +694,7 @@ public boolean appJoin(IClient client, IScope app) { /** * Handler method. Called every time client leaves application scope. - * + * * @param client * Client object that left * @param app @@ -719,7 +719,7 @@ public boolean roomJoin(IClient client, IScope room) { /** * Handler method. Called every time client leaves room scope. - * + * * @param client * Disconnected client object * @param room @@ -734,7 +734,7 @@ public void roomLeave(IClient client, IScope room) { /** * Try to measure bandwidth of current connection. - * + * * This is required for some FLV player to work because they require the "onBWDone" method to be called on the connection. */ public void measureBandwidth() { @@ -743,9 +743,9 @@ public void measureBandwidth() { /** * Try to measure bandwidth of given connection. - * + * * This is required for some FLV player to work because they require the "onBWDone" method to be called on the connection. - * + * * @param conn * the connection to measure the bandwidth for */ @@ -759,20 +759,20 @@ public void measureBandwidth(IConnection conn) { /** * Creates a new shared object for given scope. Server-side shared objects (also known as Remote SO) are special kind of objects those * variable are synchronized between clients. To get an instance of RSO at client-side, use - * + * * * SharedObject.getRemote() * - * + * * . SharedObjects can be persistent and transient. Persistent RSO are stateful, i.e. store their data between sessions. If you need to * store some data on server while clients go back and forth use persistent SO (just use - * + * * * true * - * + * * ), otherwise prefer usage of transient for extra performance. - * + * * @param scope * Scope that shared object belongs to * @param name @@ -788,7 +788,7 @@ public boolean createSharedObject(IScope scope, String name, boolean persistent) /** * Returns shared object from given scope by name. - * + * * @param scope * Scope that shared object belongs to * @param name @@ -802,7 +802,7 @@ public ISharedObject getSharedObject(IScope scope, String name) { /** * Returns shared object from given scope by name. - * + * * @param scope * Scope that shared object belongs to * @param name @@ -818,7 +818,7 @@ public ISharedObject getSharedObject(IScope scope, String name, boolean persiste /** * Returns available SharedObject names as List - * + * * @param scope * Scope that SO belong to */ @@ -829,7 +829,7 @@ public Set getSharedObjectNames(IScope scope) { /** * Checks whether there's a SO with given scope and name - * + * * @param scope * Scope that SO belong to * @param name @@ -850,7 +850,7 @@ public boolean clearSharedObjects(IScope scope, String name) { /** * Returns the registered "provider" scope service. - * + * * @return IProviderService */ private IProviderService getProviderService() { @@ -886,13 +886,13 @@ public IBroadcastStream getBroadcastStream(IScope scope, String name) { * Returns list of stream names broadcasted in scope. Broadcast stream name is somewhat different from server stream name. Server stream * name is just an ID assigned by Red5 to every created stream. Broadcast stream name is the name that is being used to subscribe to the * stream at client side, that is, in - * + * * * NetStream.play * - * + * * call. - * + * * @param scope * Scope to retrieve broadcasted stream names * @return List of broadcasted stream names. @@ -903,12 +903,12 @@ public Set getBroadcastStreamNames(IScope scope) { /** * Check whether scope has VOD stream with given name or not - * + * * @param scope * Scope * @param name * VOD stream name - * + * * @return true if scope has VOD stream with given name, false otherwise. */ public boolean hasOnDemandStream(IScope scope, String name) { @@ -921,12 +921,12 @@ public boolean hasOnDemandStream(IScope scope, String name) { /** * Returns VOD stream with given name from specified scope. - * + * * @param scope * Scope object * @param name * VOD stream name - * + * * @return IOnDemandStream object that represents stream that can be played on demand, seekable and so forth. See * {@link IOnDemandStream} for details. */ @@ -938,12 +938,12 @@ public IOnDemandStream getOnDemandStream(IScope scope, String name) { /** * Returns subscriber stream with given name from specified scope. Subscriber stream is a stream that clients can subscribe to. - * + * * @param scope * Scope * @param name * Stream name - * + * * @return ISubscriberStream object */ public ISubscriberStream getSubscriberStream(IScope scope, String name) { @@ -955,12 +955,12 @@ public ISubscriberStream getSubscriberStream(IScope scope, String name) { /** * Wrapper around ISchedulingService, adds a scheduled job to be run periodically. We store this service in the scope as it can be * shared across all rooms of the applications. - * + * * @param interval * Time interval to run the scheduled job * @param job * Scheduled job object - * + * * @return Name of the scheduled job */ public String addScheduledJob(int interval, IScheduledJob job) { @@ -972,12 +972,12 @@ public String addScheduledJob(int interval, IScheduledJob job) { /** * Adds a scheduled job that's gonna be executed once. Please note that the jobs are not saved if Red5 is restarted in the meantime. - * + * * @param timeDelta * Time offset in milliseconds from the current date when given job should be run * @param job * Scheduled job object - * + * * @return Name of the scheduled job */ public String addScheduledOnceJob(long timeDelta, IScheduledJob job) { @@ -990,12 +990,12 @@ public String addScheduledOnceJob(long timeDelta, IScheduledJob job) { /** * Adds a scheduled job that's gonna be executed once on given date. Please note that the jobs are not saved if Red5 is restarted in the * meantime. - * + * * @param date * When to run scheduled job * @param job * Scheduled job object - * + * * @return Name of the scheduled job */ public String addScheduledOnceJob(Date date, IScheduledJob job) { @@ -1007,7 +1007,7 @@ public String addScheduledOnceJob(Date date, IScheduledJob job) { /** * Adds a scheduled job which starts after the specified delay period and fires periodically. - * + * * @param interval * time in milliseconds between two notifications of the job * @param job @@ -1025,7 +1025,7 @@ public String addScheduledJobAfterDelay(int interval, IScheduledJob job, int del /** * Pauses a scheduled job - * + * * @param name * Scheduled job name */ @@ -1038,7 +1038,7 @@ public void pauseScheduledJob(String name) { /** * Resumes a scheduled job - * + * * @param name * Scheduled job name */ @@ -1051,7 +1051,7 @@ public void resumeScheduledJob(String name) { /** * Removes scheduled job from scheduling service list - * + * * @param name * Scheduled job name */ @@ -1064,7 +1064,7 @@ public void removeScheduledJob(String name) { /** * Returns list of scheduled job names - * + * * @return List of scheduled job names as list of Strings. */ public List getScheduledJobNames() { @@ -1076,7 +1076,7 @@ public List getScheduledJobNames() { /** * Returns stream length. This is a hook so it may be removed. - * + * * @param name * Stream name * @return Stream length in seconds (?) @@ -1110,7 +1110,7 @@ public double getStreamLength(String name) { /** * Client time to live is max allowed connection ping return time in seconds - * + * * @return TTL value used in seconds */ @Deprecated @@ -1120,7 +1120,7 @@ public long getClientTTL() { /** * Client time to live is max allowed connection ping return time in seconds - * + * * @param clientTTL * New TTL value in seconds */ @@ -1130,7 +1130,7 @@ public void setClientTTL(int clientTTL) { /** * Return period of ghost connections cleanup task call - * + * * @return Ghost connections cleanup period */ @Deprecated @@ -1140,7 +1140,7 @@ public int getGhostConnsCleanupPeriod() { /** * Set new ghost connections cleanup period - * + * * @param ghostConnsCleanupPeriod * New ghost connections cleanup period */ @@ -1151,9 +1151,9 @@ public void setGhostConnsCleanupPeriod(int ghostConnsCleanupPeriod) { /** * Start transmission notification from Flash Player 11.1+. This command asks the server to transmit more data because the buffer is * running low. - * + * * http://help.adobe.com/en_US/flashmediaserver/devguide/WSd391de4d9c7bd609-569139412a3743e78e-8000.html - * + * * @param bool * boolean * @param num @@ -1172,7 +1172,7 @@ public void stopTransmit() { /** * Stop transmission notification from Flash Player 11.1+. This command asks the server to suspend transmission until the client sends a * startTransmit event because there is enough data in the buffer. - * + * * @param bool * boolean * @param num @@ -1183,7 +1183,7 @@ public void stopTransmit(Boolean bool, int num) { /** * Notification method that is sent by FME just before publishing starts. - * + * * @param streamName * Name of stream that is about to be published. */ @@ -1198,7 +1198,7 @@ public void FCUnpublish() { /** * Notification method that is sent by FME when publishing of a stream ends. - * + * * @param streamName * Name of stream that is about to be un-published. */ @@ -1207,7 +1207,7 @@ public void FCUnpublish(String streamName) { /** * Notification method that is sent by some clients just before playback starts. - * + * * @param streamName * Name of stream that is about to be played. */ @@ -1216,7 +1216,7 @@ public void FCSubscribe(String streamName) { /** * Notification that a broadcasting stream is closing. - * + * * @param stream * stream */ diff --git a/common/src/main/java/org/red5/server/adapter/StatefulScopeWrappingAdapter.java b/common/src/main/java/org/red5/server/adapter/StatefulScopeWrappingAdapter.java index 6985837be..69df04ffd 100644 --- a/common/src/main/java/org/red5/server/adapter/StatefulScopeWrappingAdapter.java +++ b/common/src/main/java/org/red5/server/adapter/StatefulScopeWrappingAdapter.java @@ -58,7 +58,7 @@ public IScope getScope() { /** * Returns any plug-ins descriptors added - * + * * @return plug-in descriptor list */ public List getPlugins() { @@ -67,7 +67,7 @@ public List getPlugins() { /** * Adds a list of plug-in descriptors - * + * * @param plugins * plugins */ @@ -101,7 +101,7 @@ public Set getAttributeNames() { /** * Wrapper for Scope#getAttributes - * + * * @return Scope attributes map */ public Map getAttributes() { @@ -177,7 +177,7 @@ public boolean setAttributes(Map attributes) { /** * Creates child scope - * + * * @param name * Child scope name * @return true on success, false otherwise @@ -191,7 +191,7 @@ public boolean createChildScope(String name) { /** * Return child scope - * + * * @param name * Child scope name * @return Child scope with given name @@ -287,7 +287,7 @@ public String getPath() { /** * Whether this scope has a child scope with given name - * + * * @param name * Child scope name * @return true if it does have it, false otherwise @@ -298,7 +298,7 @@ public boolean hasChildScope(String name) { /** * If this scope has a parent - * + * * @return true if this scope has a parent scope, false otherwise */ public boolean hasParent() { @@ -307,7 +307,7 @@ public boolean hasParent() { /** * Returns array of resources (as Spring core Resource class instances) - * + * * @param pattern * Resource pattern * @return Returns array of resources @@ -320,7 +320,7 @@ public Resource[] getResources(String pattern) throws IOException { /** * Return resource by name - * + * * @param path * Resource name * @return Resource with given name diff --git a/common/src/main/java/org/red5/server/api/IApplicationContext.java b/common/src/main/java/org/red5/server/api/IApplicationContext.java index cb5ed2a8c..534b30dab 100644 --- a/common/src/main/java/org/red5/server/api/IApplicationContext.java +++ b/common/src/main/java/org/red5/server/api/IApplicationContext.java @@ -9,7 +9,7 @@ /** * Interface that wraps the application server context. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ diff --git a/common/src/main/java/org/red5/server/api/IApplicationLoader.java b/common/src/main/java/org/red5/server/api/IApplicationLoader.java index 29bd50207..47896d4a3 100644 --- a/common/src/main/java/org/red5/server/api/IApplicationLoader.java +++ b/common/src/main/java/org/red5/server/api/IApplicationLoader.java @@ -11,7 +11,7 @@ /** * Interface for servers that can load new applications. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ @@ -19,7 +19,7 @@ public interface IApplicationLoader { /** * Load a new application for the given context path from a directory. - * + * * @param contextPath * context path * @param virtualHosts @@ -33,7 +33,7 @@ public interface IApplicationLoader { /** * Return the root {@link ApplicationContext}. - * + * * @return application context */ public ApplicationContext getRootContext(); diff --git a/common/src/main/java/org/red5/server/api/IAttributeStore.java b/common/src/main/java/org/red5/server/api/IAttributeStore.java index 56956efe0..3bb437a79 100644 --- a/common/src/main/java/org/red5/server/api/IAttributeStore.java +++ b/common/src/main/java/org/red5/server/api/IAttributeStore.java @@ -14,7 +14,7 @@ /** * Base interface for all API objects with attributes - * + * * @author The Red5 Project * @author Luke Hubbard (luke@codegent.com) */ @@ -22,21 +22,21 @@ public interface IAttributeStore extends AttributeStoreMXBean { /** * Get the attribute names. The resulting set will be read-only. - * + * * @return set containing all attribute names */ public Set getAttributeNames(); /** * Get the attributes. The resulting map will be read-only. - * + * * @return map containing all attributes */ public Map getAttributes(); /** * Set an attribute on this object. - * + * * @param name * the name of the attribute to change * @param value @@ -58,7 +58,7 @@ public interface IAttributeStore extends AttributeStoreMXBean { /** * Set multiple attributes on this object. - * + * * @param values * the attributes to set * @return true if the attribute values changed otherwise false @@ -67,7 +67,7 @@ public interface IAttributeStore extends AttributeStoreMXBean { /** * Set multiple attributes on this object. - * + * * @param values * the attributes to set * @return true if the attribute values changed otherwise false @@ -76,7 +76,7 @@ public interface IAttributeStore extends AttributeStoreMXBean { /** * Return the value for a given attribute. - * + * * @param name * the name of the attribute to get * @return the attribute value or null if the attribute doesn't exist @@ -94,15 +94,15 @@ public interface IAttributeStore extends AttributeStoreMXBean { /** * Return the value for a given attribute and set it if it doesn't exist. - * + * * This is a utility function that internally performs the following code:
- * + * *
      * if (!hasAttribute(name))
      *     setAttribute(name, defaultValue);
      * return getAttribute(name);
      * 
- * + * * @param name * the name of the attribute to get * @param defaultValue @@ -113,7 +113,7 @@ public interface IAttributeStore extends AttributeStoreMXBean { /** * Check the object has an attribute. - * + * * @param name * the name of the attribute to check * @return true if the attribute exists otherwise false @@ -131,7 +131,7 @@ public interface IAttributeStore extends AttributeStoreMXBean { /** * Remove an attribute. - * + * * @param name * the name of the attribute to remove * @return true if the attribute was found and removed otherwise false @@ -154,7 +154,7 @@ public interface IAttributeStore extends AttributeStoreMXBean { /** * Size of the attribute store. - * + * * @return count of attributes */ public int size(); diff --git a/common/src/main/java/org/red5/server/api/ICastingAttributeStore.java b/common/src/main/java/org/red5/server/api/ICastingAttributeStore.java index 9e0b98c8f..d74beb923 100644 --- a/common/src/main/java/org/red5/server/api/ICastingAttributeStore.java +++ b/common/src/main/java/org/red5/server/api/ICastingAttributeStore.java @@ -13,7 +13,7 @@ /** * Attribute storage with automatic object casting support. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ @@ -21,7 +21,7 @@ public interface ICastingAttributeStore extends IAttributeStore { /** * Get Boolean attribute by name - * + * * @param name * Attribute name * @return Attribute @@ -30,7 +30,7 @@ public interface ICastingAttributeStore extends IAttributeStore { /** * Get Byte attribute by name - * + * * @param name * Attribute name * @return Attribute @@ -39,7 +39,7 @@ public interface ICastingAttributeStore extends IAttributeStore { /** * Get Double attribute by name - * + * * @param name * Attribute name * @return Attribute @@ -48,7 +48,7 @@ public interface ICastingAttributeStore extends IAttributeStore { /** * Get Integer attribute by name - * + * * @param name * Attribute name * @return Attribute @@ -57,7 +57,7 @@ public interface ICastingAttributeStore extends IAttributeStore { /** * Get List attribute by name - * + * * @param name * Attribute name * @return Attribute @@ -66,7 +66,7 @@ public interface ICastingAttributeStore extends IAttributeStore { /** * Get boolean attribute by name - * + * * @param name * Attribute name * @return Attribute @@ -75,7 +75,7 @@ public interface ICastingAttributeStore extends IAttributeStore { /** * Get Long attribute by name - * + * * @param name * Attribute name * @return Attribute @@ -84,7 +84,7 @@ public interface ICastingAttributeStore extends IAttributeStore { /** * Get Set attribute by name - * + * * @param name * Attribute name * @return Attribute @@ -93,7 +93,7 @@ public interface ICastingAttributeStore extends IAttributeStore { /** * Get Short attribute by name - * + * * @param name * Attribute name * @return Attribute @@ -102,7 +102,7 @@ public interface ICastingAttributeStore extends IAttributeStore { /** * Get String attribute by name - * + * * @param name * Attribute name * @return Attribute diff --git a/common/src/main/java/org/red5/server/api/IClient.java b/common/src/main/java/org/red5/server/api/IClient.java index 8544dbe39..149df342f 100644 --- a/common/src/main/java/org/red5/server/api/IClient.java +++ b/common/src/main/java/org/red5/server/api/IClient.java @@ -16,10 +16,10 @@ /** * The client object represents a single client. One client may have multiple connections to different scopes on the same host. In some ways the client object is like a HTTP session. You can create IClient objects with {@link IClientRegistry#newClient(Object[])} - * - * + * + * * NOTE: I removed session, since client serves the same purpose as a client with attributes - * + * * @author The Red5 Project * @author Luke Hubbard (luke@codegent.com) */ @@ -32,28 +32,28 @@ public interface IClient extends IAttributeStore { /** * Get the unique ID for this client. This will be generated by the server if not passed upon connection from client-side Flex/Flash app. To assign a custom ID to the client use - * + * *
      * params
      * 
- * + * * object of {@link IApplication#appConnect(IConnection, Object[])} method, that contains 2nd all the rest values you pass to - * + * *
      * NetConnection.connect
      * 
- * + * * method.
* Example:
* At client side: - * + * *
      * NetConnection.connect("http://localhost/killerapp/", "user123");
      * 
- * + * *
* then at server side: - * + * *
      * public boolean appConnect(IConnection connection, Object[] params) {
      *     try {
@@ -63,35 +63,35 @@ public interface IClient extends IAttributeStore {
      *     }
      * }
      * 
- * + * * @return client id */ public String getId(); /** * Get the creation time for this client object. - * + * * @return Creation time in milliseconds */ public long getCreationTime(); /** * Get a set of scopes the client is connected to. - * + * * @return Set of scopes */ public Collection getScopes(); /** * Get a set of connections. - * + * * @return Set of connections */ public Set getConnections(); /** * Get a set of connections of a given scope. - * + * * @param scope * scope to get connections for * @return Set of connections to the passed scope @@ -105,23 +105,23 @@ public interface IClient extends IAttributeStore { /** * Set the permissions for this client in a given context. - * + * * @param conn * Connection specifying the context to set the permissions for. * @param permissions * Permissions the client has in this context or - * + * *
      * null
      * 
- * + * * for no permissions. */ public void setPermissions(IConnection conn, Collection permissions); /** * Return the permissions in a given context. - * + * * @param conn * Connection specifying the context to get the permissions for. * @return Permission names. @@ -130,7 +130,7 @@ public interface IClient extends IAttributeStore { /** * Check if the client has a permission in the given context. - * + * * @param conn * Connection specifying the context to check the permissions for * @param permissionName @@ -138,9 +138,9 @@ public interface IClient extends IAttributeStore { * @return
      * true
      * 
- * + * * if the client has the permission, otherwise - * + * *
      * false
      * 
@@ -154,7 +154,7 @@ public interface IClient extends IAttributeStore { /** * Performs a bandwidth checking callback for the client. Information may be found here: http://www.adobe.com/devnet/flashmediaserver/articles/dynamic_stream_switching_04.html - * + * * @param params * parameters * @return bandwidth results @@ -163,7 +163,7 @@ public interface IClient extends IAttributeStore { /** * Returns whether or not a bandwidth check has been requested. - * + * * @return true if requested and false otherwise */ public boolean isBandwidthChecked(); diff --git a/common/src/main/java/org/red5/server/api/IClientRegistry.java b/common/src/main/java/org/red5/server/api/IClientRegistry.java index 04422b001..1e7248766 100644 --- a/common/src/main/java/org/red5/server/api/IClientRegistry.java +++ b/common/src/main/java/org/red5/server/api/IClientRegistry.java @@ -12,7 +12,7 @@ /** * Provides a registry of client objects. You can lookup a client by its client id / session id using lookupClient method. This interface implementations also create new client objects from given params, usually passed from client-side Flex/Flash application upon initial connection. - * + * * @author The Red5 Project * @author Luke Hubbard (luke@codegent.com) */ @@ -20,26 +20,26 @@ public interface IClientRegistry { /** * Check if a client with a given id exists. - * + * * @param id * the id of the client to check for * @return
      * true
      * 
- * + * * if the client exists, - * + * *
      * false
      * 
- * + * * otherwise */ public boolean hasClient(String id); /** * Create a new client client object from connection params. - * + * * @param params * the parameters the client passed during connection * @return the new client @@ -52,7 +52,7 @@ public interface IClientRegistry { /** * Return an existing client from a client id. - * + * * @param id * the id of the client to return * @return the client object @@ -63,7 +63,7 @@ public interface IClientRegistry { /** * Adds a client to the registry. - * + * * @param client * client */ diff --git a/common/src/main/java/org/red5/server/api/IConnection.java b/common/src/main/java/org/red5/server/api/IConnection.java index 79fd2cb08..966f2f4f1 100644 --- a/common/src/main/java/org/red5/server/api/IConnection.java +++ b/common/src/main/java/org/red5/server/api/IConnection.java @@ -17,9 +17,9 @@ /** * The connection object. - * + * * Each connection has an associated client and scope. Connections may be persistent, polling, or transient. The aim of this interface is to provide basic connection methods shared between different types of connections. - * + * * @author The Red5 Project * @author Luke Hubbard (luke@codegent.com) * @author Paul Gregoire (mondain@gmail.com) @@ -52,7 +52,7 @@ public static enum Type { /** * Get the connection type. - * + * * @return string containing one of connection types */ @Deprecated @@ -60,35 +60,35 @@ public static enum Type { /** * Get the connection type. - * + * * @return connection type containing one of connection types */ //public Type getType(); // PERSISTENT | POLLING | TRANSIENT /** * Get the object encoding in use for this connection. - * + * * @return encoding type */ public Encoding getEncoding(); /** * Get the duty for this connection; this is not meant nor expected to remain static. - * + * * @return duty type */ public Duty getDuty(); /** * Initialize the connection. - * + * * @param client Client object associated with connection */ public void initialize(IClient client); /** * Try to connect to the scope. - * + * * @return true on success, false otherwise * @param scope Scope object */ @@ -96,7 +96,7 @@ public static enum Type { /** * Try to connect to the scope with a list of connection parameters. - * + * * @param params Connections parameters * @return true on success, false otherwise * @param scope Scope object @@ -106,7 +106,7 @@ public static enum Type { /** * Is the client connected to the scope. Result depends on connection type, true for persistent and polling connections, * false for transient. - * + * * @return true if the connection is persistent or polling, otherwise false */ public boolean isConnected(); @@ -118,112 +118,112 @@ public static enum Type { /** * Return the parameters that were given in the call to "connect". - * + * * @return Connection parameters passed from client-side (Flex/Flash application) */ public Map getConnectParams(); /** * Sets the Client. - * + * * @param client client */ public void setClient(IClient client); /** * Get the client object associated with this connection. - * + * * @return Client object */ public IClient getClient(); /** * Get the hostname that the client is connected to. If they are connected to an IP, the IP address will be returned as a String. - * + * * @return String containing the hostname */ public String getHost(); /** * Get the IP address the client is connected from. - * + * * @return The IP address of the client */ public String getRemoteAddress(); /** * Get the IP addresses the client is connected from. If a client is connected through RTMPT and uses a proxy to connect, this will contain all hosts the client used to connect to the server. - * + * * @return The IP addresses of the client */ public List getRemoteAddresses(); /** * Get the port the client is connected from. - * + * * @return The port of the client */ public int getRemotePort(); /** * Get the path for this connection. This is not updated if you switch scope. - * + * * @return path Connection path */ public String getPath(); /** * Get the session id, this may be null. - * + * * @return Session id */ public String getSessionId(); /** * Total number of bytes read from the connection. - * + * * @return Number of read bytes */ public long getReadBytes(); /** * Total number of bytes written to the connection. - * + * * @return Number of written bytes */ public long getWrittenBytes(); /** * Total number of messages read from the connection. - * + * * @return Number of read messages */ public long getReadMessages(); /** * Total number of messages written to the connection. - * + * * @return Number of written messages */ public long getWrittenMessages(); /** * Total number of messages that have been dropped. - * + * * @return Number of dropped messages */ public long getDroppedMessages(); /** * Total number of messages that are pending to be sent to the connection. - * + * * @return Number of pending messages */ public long getPendingMessages(); /** * Return number of written bytes the client reports to have received. This is the last value of the BytesRead message received from a client. - * + * * @see org.red5.server.net.rtmp.event.BytesRead * @return number of written bytes received by the client */ @@ -236,63 +236,63 @@ public static enum Type { /** * Return round-trip time of last ping command. - * + * * @return round-trip time in milliseconds */ public int getLastPingTime(); /** * Get the scope this is connected to. - * + * * @return The connected scope */ public IScope getScope(); /** * Get the basic scopes this connection has subscribed. This list will contain the shared objects and broadcast streams the connection connected to. - * + * * @return List of basic scopes */ public Iterator getBasicScopes(); /** * Sets the bandwidth using a mbit/s value. - * + * * @param mbits target */ public void setBandwidth(int mbits); /** * Adds a listener to this object - * + * * @param listener connection listener */ public void addListener(IConnectionListener listener); /** * Removes the listener from this object - * + * * @param listener connection listener */ public void removeListener(IConnectionListener listener); /** * Returns the current stream id. - * + * * @return stream id */ public Number getStreamId(); /** * Sets the current stream id. - * + * * @param id stream id */ public void setStreamId(Number id); /** * Returns the protocol type for this connection. eg. rtmp, rtmpt, http - * + * * @return protocol type */ public String getProtocol(); diff --git a/common/src/main/java/org/red5/server/api/IContext.java b/common/src/main/java/org/red5/server/api/IContext.java index 30e8a950d..69c9d2a44 100644 --- a/common/src/main/java/org/red5/server/api/IContext.java +++ b/common/src/main/java/org/red5/server/api/IContext.java @@ -17,7 +17,7 @@ /** * The current context, this object basically wraps the Spring context or in the case of the .Net version, any similar system. - * + * */ public interface IContext extends ResourcePatternResolver { @@ -33,28 +33,28 @@ public interface IContext extends ResourcePatternResolver { // public IScopeResolver getScopeResolver(); /** * Get client registry. Client registry is a place where all clients are registred. - * + * * @return Client registry object */ IClientRegistry getClientRegistry(); /** * Returns service invoker object. Service invokers are objects that make service calls to client side NetConnection objects. - * + * * @return Service invoker object */ IServiceInvoker getServiceInvoker(); /** * Returns persistence store object, a storage for persistent objects like persistent SharedObjects. - * + * * @return Persistence store object */ IPersistenceStore getPersistanceStore(); /** * Returns scope handler (object that handle all actions related to the scope) by path. See {@link IScopeHandler} for details. - * + * * @param path * Path of scope handler * @return Scope handler @@ -63,7 +63,7 @@ public interface IContext extends ResourcePatternResolver { /** * Returns scope by path. You can think of IScope as of tree items, used to separate context and resources between users. See {@link IScope} for more details. - * + * * @param path * Path of scope * @return IScope object @@ -72,7 +72,7 @@ public interface IContext extends ResourcePatternResolver { /** * Returns scope by path from given root. You can think of IScope as of tree items, used to separate context and resources between users. See {@link IScope} for more details. - * + * * @param root * Root to start from * @param path @@ -83,14 +83,14 @@ public interface IContext extends ResourcePatternResolver { /** * Returns global scope reference - * + * * @return global scope reference */ IGlobalScope getGlobalScope(); /** * Returns service by name. - * + * * @param serviceName * Name of service * @return Service object @@ -99,7 +99,7 @@ public interface IContext extends ResourcePatternResolver { /** * Returns bean by ID - * + * * @param beanId * Bean ID * @return Given bean instance @@ -108,7 +108,7 @@ public interface IContext extends ResourcePatternResolver { /** * Returns true if the context contains a certain bean, false otherwise. - * + * * @param beanId * The name of the bean to find. * @return True if the bean exists, false otherwise. @@ -117,7 +117,7 @@ public interface IContext extends ResourcePatternResolver { /** * Returns core service by bean id - * + * * @param beanId * Bean ID * @return Core service @@ -126,7 +126,7 @@ public interface IContext extends ResourcePatternResolver { /** * Returns IMappingStrategy object - * + * * @return IMappingStrategy object */ public IMappingStrategy getMappingStrategy(); diff --git a/common/src/main/java/org/red5/server/api/ICoreObject.java b/common/src/main/java/org/red5/server/api/ICoreObject.java index f6087790e..c8ccc7429 100644 --- a/common/src/main/java/org/red5/server/api/ICoreObject.java +++ b/common/src/main/java/org/red5/server/api/ICoreObject.java @@ -13,7 +13,7 @@ /** * Base marker interface for all core objects. - * + * * @author The Red5 Project * @author Luke Hubbard (luke@codegent.com) * diff --git a/common/src/main/java/org/red5/server/api/IMappingStrategy.java b/common/src/main/java/org/red5/server/api/IMappingStrategy.java index 02f31c75f..e26f48236 100644 --- a/common/src/main/java/org/red5/server/api/IMappingStrategy.java +++ b/common/src/main/java/org/red5/server/api/IMappingStrategy.java @@ -14,7 +14,7 @@ public interface IMappingStrategy { /** * Map a name to the name of a service. - * + * * @param name * name to map * @return The name of the service with the passed name @@ -23,7 +23,7 @@ public interface IMappingStrategy { /** * Map a context path to the name of a scope handler. - * + * * @param contextPath * context path to map * @return The name of a scope handler @@ -32,7 +32,7 @@ public interface IMappingStrategy { /** * Map a context path to a path prefix for resources. - * + * * @param contextPath * context path to map * @return The path prefix for resources with the given name diff --git a/common/src/main/java/org/red5/server/api/IServer.java b/common/src/main/java/org/red5/server/api/IServer.java index 76d2bcce1..e57f5c309 100644 --- a/common/src/main/java/org/red5/server/api/IServer.java +++ b/common/src/main/java/org/red5/server/api/IServer.java @@ -16,10 +16,10 @@ /** * The interface that represents the Red5 server. - * + * * @author The Red5 Project * @author Luke Hubbard (luke@codegent.com) - * + * */ public interface IServer { /** @@ -29,7 +29,7 @@ public interface IServer { /** * Get the global scope with given name. - * + * * @param name * Name of the global scope * @return the global scope @@ -38,7 +38,7 @@ public interface IServer { /** * Register a global scope. - * + * * @param scope * The global scope to register */ @@ -46,13 +46,13 @@ public interface IServer { /** * Lookup the global scope for a host. - * + * * @param hostName * The name of the host * @param contextPath * The path in the host * @return The found global scope or - * + * *
      * null
      * 
@@ -61,7 +61,7 @@ public interface IServer { /** * Map a virtual hostname and a path to the name of a global scope. - * + * * @param hostName * The name of the host to map * @param contextPath @@ -71,9 +71,9 @@ public interface IServer { * @return
      * true
      * 
- * + * * if the name was mapped, otherwise - * + * *
      * false
      * 
@@ -82,7 +82,7 @@ public interface IServer { /** * Unregister a previously mapped global scope. - * + * * @param hostName * The name of the host to unmap * @param contextPath @@ -90,9 +90,9 @@ public interface IServer { * @return
      * true
      * 
- * + * * if the global scope was unmapped, otherwise - * + * *
      * false
      * 
@@ -101,28 +101,28 @@ public interface IServer { /** * Query informations about the global scope mappings. - * + * * @return Map containing informations about the mappings */ public Map getMappingTable(); /** * Get list of global scope names. - * + * * @return Iterator for names of global scopes */ public Iterator getGlobalNames(); /** * Get list of global scopes. - * + * * @return Iterator for global scopes objects */ public Iterator getGlobalScopes(); /** * Add listener to get notified about scope events. - * + * * @param listener * the listener to add */ @@ -130,7 +130,7 @@ public interface IServer { /** * Add listener to get notified about connection events. - * + * * @param listener * the listener to add */ @@ -138,7 +138,7 @@ public interface IServer { /** * Remove listener that got notified about scope events. - * + * * @param listener * the listener to remove */ @@ -146,7 +146,7 @@ public interface IServer { /** * Remove listener that got notified about connection events. - * + * * @param listener * the listener to remove */ diff --git a/common/src/main/java/org/red5/server/api/Red5.java b/common/src/main/java/org/red5/server/api/Red5.java index 41ee02ac2..fd7155e80 100644 --- a/common/src/main/java/org/red5/server/api/Red5.java +++ b/common/src/main/java/org/red5/server/api/Red5.java @@ -21,9 +21,9 @@ * Utility class for accessing Red5 API objects. * * This class uses a thread local, and will be setup by the service invoker. - * + * * The code below shows various uses.
- * + * *
  * IConnection conn = Red5.getConnectionLocal();
  * Red5 r5 = new Red5();
@@ -32,7 +32,7 @@
  * r5 = new Red5(conn);
  * IClient client = r5.getClient();
  * 
- * + * * @author The Red5 Project * @author Luke Hubbard (luke@codegent.com) * @author Paul Gregoire (mondain@gmail.com) @@ -55,12 +55,12 @@ public final class Red5 { /** * Server version with revision */ - public static final String VERSION = "Red5 Server 1.2.24"; + public static final String VERSION = "Red5 Server 1.2.31"; /** * Server version for fmsVer requests */ - public static final String FMS_VERSION = "RED5/1,2,24,0"; + public static final String FMS_VERSION = "RED5/1,2,31,0"; /** * Server capabilities @@ -96,7 +96,7 @@ public final class Red5 { /** * Create a new Red5 object using given connection. - * + * * @param conn * Connection object. */ @@ -141,7 +141,7 @@ public static void setConnectionLocal(IConnection connection) { /** * Get the connection associated with the current thread. This method allows you to get connection object local to current thread. When you need to get a connection associated with event handler and so forth, this method provides you with it. - * + * * @return Connection object */ public static IConnection getConnectionLocal() { @@ -157,7 +157,7 @@ public static IConnection getConnectionLocal() { /** * Get the connection object. - * + * * @return Connection object */ public IConnection getConnection() { @@ -166,7 +166,7 @@ public IConnection getConnection() { /** * Get the scope - * + * * @return Scope object */ public IScope getScope() { @@ -175,7 +175,7 @@ public IScope getScope() { /** * Get the client - * + * * @return Client object */ public IClient getClient() { @@ -184,7 +184,7 @@ public IClient getClient() { /** * Get the spring application context - * + * * @return Application context */ public IContext getContext() { @@ -193,7 +193,7 @@ public IContext getContext() { /** * Returns the current version with revision number - * + * * @return String version */ public static String getVersion() { @@ -219,7 +219,7 @@ public static Object getDataVersion() { /** * Returns true if java debugging was detected. - * + * * @return true if debugging, false otherwise */ public static boolean isDebug() { @@ -237,7 +237,7 @@ public static long getUpTime() { /** * Allows for reconstruction via CompositeData. - * + * * @param cd * composite data * @return Red5 class instance @@ -259,7 +259,7 @@ public static Red5 from(CompositeData cd) { /** * Sets the target chunk size to use for publish and play invocations. Default is 128. - * + * * @param targetChunkSize the chunk size to use */ public static void setTargetChunkSize(int targetChunkSize) { @@ -268,7 +268,7 @@ public static void setTargetChunkSize(int targetChunkSize) { /** * Returns the target chunk size. - * + * * @return targetChunkSize */ public static int getTargetChunkSize() { diff --git a/common/src/main/java/org/red5/server/api/event/IEvent.java b/common/src/main/java/org/red5/server/api/event/IEvent.java index 362a55f8c..c4a844f39 100644 --- a/common/src/main/java/org/red5/server/api/event/IEvent.java +++ b/common/src/main/java/org/red5/server/api/event/IEvent.java @@ -14,38 +14,38 @@ public interface IEvent { /** * Returns even type - * + * * @return Event type enumeration */ public Type getType(); /** * Returns event context object - * + * * @return Event context object */ public Object getObject(); /** * Whether event has source (event listener(s)) - * + * * @return
      * true
      * 
- * + * * if so, - * + * *
      * false
      * 
- * + * * otherwise */ public boolean hasSource(); /** * Returns event listener - * + * * @return Event listener object */ public IEventListener getSource(); diff --git a/common/src/main/java/org/red5/server/api/event/IEventDispatcher.java b/common/src/main/java/org/red5/server/api/event/IEventDispatcher.java index 882e864f9..d0a3e5f9b 100644 --- a/common/src/main/java/org/red5/server/api/event/IEventDispatcher.java +++ b/common/src/main/java/org/red5/server/api/event/IEventDispatcher.java @@ -14,7 +14,7 @@ public interface IEventDispatcher { /** * Dispatches event - * + * * @param event * Event object */ diff --git a/common/src/main/java/org/red5/server/api/event/IEventHandler.java b/common/src/main/java/org/red5/server/api/event/IEventHandler.java index 9e1047966..65e07caa6 100644 --- a/common/src/main/java/org/red5/server/api/event/IEventHandler.java +++ b/common/src/main/java/org/red5/server/api/event/IEventHandler.java @@ -11,7 +11,7 @@ public interface IEventHandler { /** * Handle an event. - * + * * @param event * to handle * @return true if event was handled, false if it should bubble diff --git a/common/src/main/java/org/red5/server/api/event/IEventListener.java b/common/src/main/java/org/red5/server/api/event/IEventListener.java index b0c968b62..38c92286f 100644 --- a/common/src/main/java/org/red5/server/api/event/IEventListener.java +++ b/common/src/main/java/org/red5/server/api/event/IEventListener.java @@ -11,7 +11,7 @@ public interface IEventListener { /** * Notify of event. - * + * * @param event * the event object */ diff --git a/common/src/main/java/org/red5/server/api/event/IEventObservable.java b/common/src/main/java/org/red5/server/api/event/IEventObservable.java index d3ea28566..b40e24ce2 100644 --- a/common/src/main/java/org/red5/server/api/event/IEventObservable.java +++ b/common/src/main/java/org/red5/server/api/event/IEventObservable.java @@ -16,7 +16,7 @@ public interface IEventObservable { /** * Add event listener to this observable - * + * * @param listener * Event listener * @return true if listener is added and false otherwise @@ -25,7 +25,7 @@ public interface IEventObservable { /** * Remove event listener from this observable - * + * * @param listener * Event listener * @return true if listener is removed and false otherwise diff --git a/common/src/main/java/org/red5/server/api/listeners/AbstractConnectionListener.java b/common/src/main/java/org/red5/server/api/listeners/AbstractConnectionListener.java index f6602d1ce..aa5211266 100644 --- a/common/src/main/java/org/red5/server/api/listeners/AbstractConnectionListener.java +++ b/common/src/main/java/org/red5/server/api/listeners/AbstractConnectionListener.java @@ -6,7 +6,7 @@ /** * Abstract implementation / adapter for connection listeners. - * + * * @author Paul Gregoire (mondain@gmail.com) * */ @@ -20,7 +20,7 @@ public abstract class AbstractConnectionListener implements IConnectionListener @Override public void propertyChange(PropertyChangeEvent evt) { - // empty implementation to prevent breaking previous apps. + // empty implementation to prevent breaking previous apps. } } diff --git a/common/src/main/java/org/red5/server/api/listeners/IConnectionListener.java b/common/src/main/java/org/red5/server/api/listeners/IConnectionListener.java index 0d5aa5bb1..eb3a6ae02 100644 --- a/common/src/main/java/org/red5/server/api/listeners/IConnectionListener.java +++ b/common/src/main/java/org/red5/server/api/listeners/IConnectionListener.java @@ -13,17 +13,17 @@ /** * Interface for listeners to connection events and property changes. - * + * * @author The Red5 Project * @author Joachim Bauch (bauch@struktur.de) * @author Paul Gregoire (mondain@gmail.com) - * + * */ public interface IConnectionListener extends PropertyChangeListener { /** * A new connection was established. - * + * * @param conn * the new connection */ @@ -31,7 +31,7 @@ public interface IConnectionListener extends PropertyChangeListener { /** * A connection was disconnected. - * + * * @param conn * the disconnected connection */ diff --git a/common/src/main/java/org/red5/server/api/listeners/IScopeListener.java b/common/src/main/java/org/red5/server/api/listeners/IScopeListener.java index 90d292b68..07f95c17f 100644 --- a/common/src/main/java/org/red5/server/api/listeners/IScopeListener.java +++ b/common/src/main/java/org/red5/server/api/listeners/IScopeListener.java @@ -11,7 +11,7 @@ /** * Interface for listeners to scope events. - * + * * @author The Red5 Project * @author Joachim Bauch (bauch@struktur.de) */ @@ -19,7 +19,7 @@ public interface IScopeListener { /** * A scope has been created. - * + * * @param scope * the new scope */ @@ -27,7 +27,7 @@ public interface IScopeListener { /** * A scope has been removed. - * + * * @param scope * the removed scope */ diff --git a/common/src/main/java/org/red5/server/api/persistence/IPersistable.java b/common/src/main/java/org/red5/server/api/persistence/IPersistable.java index 51956ae58..f316ead64 100644 --- a/common/src/main/java/org/red5/server/api/persistence/IPersistable.java +++ b/common/src/main/java/org/red5/server/api/persistence/IPersistable.java @@ -14,14 +14,14 @@ /** * Base interface for objects that can be made persistent. - * + * * Every object that complies to this interface must provide either a constructor that takes an input stream as only parameter or an empty constructor so it can be loaded from the persistence store. - * + * * However this is not required for objects that are created by the application and initialized afterwards. - * + * * @see org.red5.io.object.Input * @see IPersistenceStore#load(String) - * + * * @author The Red5 Project * @author Luke Hubbard (luke@codegent.com) * @author Joachim Bauch (jojo@struktur.de) @@ -36,61 +36,61 @@ public interface IPersistable { /** * Returns - * + * *
      * true
      * 
- * + * * if the object is persistent, - * + * *
      * false
      * 
- * + * * otherwise. - * + * * @return
      * true
      * 
- * + * * if object is persistent, - * + * *
      * false
      * 
- * + * * otherwise */ public boolean isPersistent(); /** * Set the persistent flag of the object. - * + * * @param persistent *
      * true
      * 
- * + * * if object is persistent, - * + * *
      * false
      * 
- * + * * otherwise */ public void setPersistent(boolean persistent); /** * Returns the name of the persistent object. - * + * * @return Object name */ public String getName(); /** * Set the name of the persistent object. - * + * * @param name * New object name */ @@ -98,21 +98,21 @@ public interface IPersistable { /** * Returns the type of the persistent object. - * + * * @return Object type */ public String getType(); /** * Returns the path of the persistent object. - * + * * @return Persisted object path */ public String getPath(); /** * Set the path of the persistent object. - * + * * @param path * New persisted object path */ @@ -120,21 +120,21 @@ public interface IPersistable { /** * Returns the timestamp when the object was last modified. - * + * * @return Last modification date in milliseconds */ public long getLastModified(); /** * Returns the persistence store this object is stored in - * + * * @return This object's persistence store */ public IPersistenceStore getStore(); /** * Store a reference to the persistence store in the object. - * + * * @param store * Store the object is saved in */ @@ -142,7 +142,7 @@ public interface IPersistable { /** * Write the object to the passed output stream. - * + * * @param output * Output stream to write to * @throws java.io.IOException @@ -152,7 +152,7 @@ public interface IPersistable { /** * Load the object from the passed input stream. - * + * * @param input * Input stream to load from * @throws java.io.IOException diff --git a/common/src/main/java/org/red5/server/api/persistence/IPersistenceStore.java b/common/src/main/java/org/red5/server/api/persistence/IPersistenceStore.java index bac908f99..30a90a7b4 100644 --- a/common/src/main/java/org/red5/server/api/persistence/IPersistenceStore.java +++ b/common/src/main/java/org/red5/server/api/persistence/IPersistenceStore.java @@ -12,7 +12,7 @@ /** * Storage for persistent objects. - * + * * @author The Red5 Project * @author Luke Hubbard (luke@codegent.com) * @author Joachim Bauch (jojo@struktur.de) @@ -22,41 +22,41 @@ public interface IPersistenceStore { /** * Persist given object. - * + * * @param obj * Object to store * @return
      * true
      * 
- * + * * on success, - * + * *
      * false
      * 
- * + * * otherwise */ public boolean save(IPersistable obj); /** * Load a persistent object with the given name. The object must provide either a constructor that takes an input stream as only parameter or an empty constructor so it can be loaded from the persistence store. - * + * * @param name * the name of the object to load * @return The loaded object or - * + * *
      * null
      * 
- * + * * if no such object was found */ public IPersistable load(String name); /** * Load state of an already instantiated persistent object. - * + * * @param obj * the object to initializ * @return true if the object was initialized, false otherwise @@ -65,52 +65,52 @@ public interface IPersistenceStore { /** * Delete the passed persistent object. - * + * * @param obj * the object to delete * @return
      * true
      * 
- * + * * if object was persisted and thus can be removed, - * + * *
      * false
      * 
- * + * * otherwise */ public boolean remove(IPersistable obj); /** * Delete the persistent object with the given name. - * + * * @param name * the name of the object to delete * @return
      * true
      * 
- * + * * if object was persisted and thus can be removed, - * + * *
      * false
      * 
- * + * * otherwise */ public boolean remove(String name); /** * Return iterator over the names of all already loaded objects in the storage. - * + * * @return Set of all object names */ public Set getObjectNames(); /** * Return iterator over the already loaded objects in the storage. - * + * * @return Set of all objects */ public Collection getObjects(); diff --git a/common/src/main/java/org/red5/server/api/persistence/PersistenceUtils.java b/common/src/main/java/org/red5/server/api/persistence/PersistenceUtils.java index d1bc11aa0..16d3df22f 100644 --- a/common/src/main/java/org/red5/server/api/persistence/PersistenceUtils.java +++ b/common/src/main/java/org/red5/server/api/persistence/PersistenceUtils.java @@ -13,7 +13,7 @@ /** * Helper class for persistence. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ @@ -21,7 +21,7 @@ public class PersistenceUtils { /** * Returns persistence store object class constructor - * + * * @param theClass * Persistence store class * @param interfaces @@ -50,7 +50,7 @@ private static Constructor getPersistenceStoreConstructor(Class theClass, /** * Returns persistence store object. Persistence store is a special object that stores persistence objects and provides methods to manipulate them (save, load, remove, list). - * + * * @param resolver * Resolves connection pattern into Resource object * @param className diff --git a/common/src/main/java/org/red5/server/api/plugin/IRed5Plugin.java b/common/src/main/java/org/red5/server/api/plugin/IRed5Plugin.java index 4b613796d..114e1192e 100644 --- a/common/src/main/java/org/red5/server/api/plugin/IRed5Plugin.java +++ b/common/src/main/java/org/red5/server/api/plugin/IRed5Plugin.java @@ -12,21 +12,21 @@ /** * Base interface for a Red5 server Plug-in. - * + * * @author Paul Gregoire (mondain@gmail.com) */ public interface IRed5Plugin { /** * Returns a name / identifier for the plug-in. - * + * * @return plug-in's name */ String getName(); /** * Sets the top-most ApplicationContext within Red5. - * + * * @param context * application context */ @@ -34,7 +34,7 @@ public interface IRed5Plugin { /** * Sets a reference to the server. - * + * * @param server * server */ @@ -42,7 +42,7 @@ public interface IRed5Plugin { /** * Lifecycle method called when the plug-in is started. - * + * * @throws Exception * on start error */ @@ -50,7 +50,7 @@ public interface IRed5Plugin { /** * Lifecycle method called when the plug-in is stopped. - * + * * @throws Exception * on stop error */ diff --git a/common/src/main/java/org/red5/server/api/plugin/IRed5PluginHandler.java b/common/src/main/java/org/red5/server/api/plugin/IRed5PluginHandler.java index 2e0020598..ce301b836 100644 --- a/common/src/main/java/org/red5/server/api/plugin/IRed5PluginHandler.java +++ b/common/src/main/java/org/red5/server/api/plugin/IRed5PluginHandler.java @@ -13,7 +13,7 @@ /** * Base interface for handlers originating from plug-ins. - * + * * @author Paul Gregoire */ public interface IRed5PluginHandler { @@ -25,7 +25,7 @@ public interface IRed5PluginHandler { /** * Set the application making use of this plug-in handler. - * + * * @param application * application adapter */ @@ -33,7 +33,7 @@ public interface IRed5PluginHandler { /** * Set properties to be used by this handler. - * + * * @param props * plugin properties map */ diff --git a/common/src/main/java/org/red5/server/api/remoting/IRemotingHeader.java b/common/src/main/java/org/red5/server/api/remoting/IRemotingHeader.java index 8f492e295..9b9d230ba 100644 --- a/common/src/main/java/org/red5/server/api/remoting/IRemotingHeader.java +++ b/common/src/main/java/org/red5/server/api/remoting/IRemotingHeader.java @@ -9,7 +9,7 @@ /** * A Remoting header. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ @@ -32,21 +32,21 @@ public interface IRemotingHeader { /** * Return name of header. - * + * * @return name of header */ public String getName(); /** * Return value of header. - * + * * @return value of header */ public Object getValue(); /** * Return boolean flag if receiver must process header before handling other headers or messages. - * + * * @return must understand */ public boolean getMustUnderstand(); diff --git a/common/src/main/java/org/red5/server/api/scheduling/IScheduledJob.java b/common/src/main/java/org/red5/server/api/scheduling/IScheduledJob.java index 11724fcc5..db083dd01 100644 --- a/common/src/main/java/org/red5/server/api/scheduling/IScheduledJob.java +++ b/common/src/main/java/org/red5/server/api/scheduling/IScheduledJob.java @@ -9,7 +9,7 @@ /** * Interface that must be implemented by classes that can be scheduled for periodic execution. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ @@ -17,7 +17,7 @@ public interface IScheduledJob { /** * Called each time the job is triggered by the scheduling service. - * + * * @param service * the service that called the job * @throws CloneNotSupportedException diff --git a/common/src/main/java/org/red5/server/api/scheduling/ISchedulingService.java b/common/src/main/java/org/red5/server/api/scheduling/ISchedulingService.java index 76c474082..41378f274 100644 --- a/common/src/main/java/org/red5/server/api/scheduling/ISchedulingService.java +++ b/common/src/main/java/org/red5/server/api/scheduling/ISchedulingService.java @@ -14,7 +14,7 @@ /** * Service that supports periodic execution of jobs, adding, removing and getting their name as list. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) * @author Paul Gregoire (mondain@gmail.com) @@ -35,7 +35,7 @@ public interface ISchedulingService extends IScopeService { /** * Schedule a job for periodic execution. - * + * * @param interval * time in milliseconds between two notifications of the job * @param job @@ -46,7 +46,7 @@ public interface ISchedulingService extends IScopeService { /** * Schedule a job for single execution in the future. Please note that the jobs are not saved if Red5 is restarted in the meantime. - * + * * @param timeDelta * time delta in milliseconds from the current date * @param job @@ -57,7 +57,7 @@ public interface ISchedulingService extends IScopeService { /** * Schedule a job for single execution at a given date. Please note that the jobs are not saved if Red5 is restarted in the meantime. - * + * * @param date * date when the job should be executed * @param job @@ -68,7 +68,7 @@ public interface ISchedulingService extends IScopeService { /** * Schedule a job for periodic execution which will start after the specified delay. - * + * * @param interval * time in milliseconds between two notifications of the job * @param job @@ -81,7 +81,7 @@ public interface ISchedulingService extends IScopeService { /** * Pauses the trigger which initiates job execution. - * + * * @param name * name of the job to stop */ @@ -89,7 +89,7 @@ public interface ISchedulingService extends IScopeService { /** * Resumes the trigger which initiates job execution. - * + * * @param name * name of the job to stop */ @@ -97,7 +97,7 @@ public interface ISchedulingService extends IScopeService { /** * Stop executing a previously scheduled job. - * + * * @param name * name of the job to stop */ @@ -105,7 +105,7 @@ public interface ISchedulingService extends IScopeService { /** * Return names of scheduled jobs. - * + * * @return list of job names */ public List getScheduledJobNames(); diff --git a/common/src/main/java/org/red5/server/api/scope/IBasicScope.java b/common/src/main/java/org/red5/server/api/scope/IBasicScope.java index e82740a95..0ff75a95d 100644 --- a/common/src/main/java/org/red5/server/api/scope/IBasicScope.java +++ b/common/src/main/java/org/red5/server/api/scope/IBasicScope.java @@ -16,7 +16,7 @@ /** * Base interface for all scope objects, including SharedObjects. - * + * * @author The Red5 Project * @author Luke Hubbard (luke@codegent.com) */ @@ -24,63 +24,63 @@ public interface IBasicScope extends ICoreObject, IEventObservable { /** * Does this scope have a parent? You can think of scopes as of tree items where scope may have a parent and children (child). - * + * * @return true if this scope has a parent, otherwise false */ public boolean hasParent(); /** * Get this scopes parent. - * + * * @return parent scope, or null if this scope doesn't have a parent */ public IScope getParent(); /** * Get the scopes depth, how far down the scope tree is it. The lowest depth is 0x00, the depth of Global scope. Application scope depth is 0x01. Room depth is 0x02, 0x03 and so forth. - * + * * @return the depth */ public int getDepth(); /** * Get the name of this scope. Eg. someroom - * + * * @return the name */ public String getName(); /** * Get the persistable store - * + * * @return the store */ public IPersistenceStore getStore(); /** * Get the full absolute path. Eg. host / myapp / someroom - * + * * @return absolute scope path */ public String getPath(); /** * Get the type of the scope. - * + * * @return type of scope */ public ScopeType getType(); /** * Sets the amount of time to keep the scope available after the last disconnect. - * + * * @param keepDelay delay */ public void setKeepDelay(int keepDelay); /** * Validates a scope based on its name and type - * + * * @return true if both name and type are valid, false otherwise */ public boolean isValid(); @@ -88,7 +88,7 @@ public interface IBasicScope extends ICoreObject, IEventObservable { /** * Provides a means to allow a scope to perform processing on a connection prior to the actual * connection attempt or other handling. - * + * * @param conn connection * @return true if connection is allowed and false if it is not allowed */ @@ -96,7 +96,7 @@ public interface IBasicScope extends ICoreObject, IEventObservable { /** * Provides a means to allow a scope to perform processing on another scope prior to additional scope handling. - * + * * @param scope scope * @return true if scope is allowed and false if it is not allowed */ @@ -104,7 +104,7 @@ public interface IBasicScope extends ICoreObject, IEventObservable { /** * Sets the scope security handlers. - * + * * @param securityHandlers scope security handlers */ public void setSecurityHandlers(Set securityHandlers); diff --git a/common/src/main/java/org/red5/server/api/scope/IGlobalScope.java b/common/src/main/java/org/red5/server/api/scope/IGlobalScope.java index 16bc8edea..3c228c378 100644 --- a/common/src/main/java/org/red5/server/api/scope/IGlobalScope.java +++ b/common/src/main/java/org/red5/server/api/scope/IGlobalScope.java @@ -11,7 +11,7 @@ /** * The global scope that acts as root for all applications in a host. - * + * * @author The Red5 Project * @author Luke Hubbard (luke@codegent.com) * @@ -25,7 +25,7 @@ public interface IGlobalScope extends IScope { /** * Return the server this global scope runs in. - * + * * @return the server */ public IServer getServer(); diff --git a/common/src/main/java/org/red5/server/api/scope/IScope.java b/common/src/main/java/org/red5/server/api/scope/IScope.java index 2e3f08c48..711bd8aee 100644 --- a/common/src/main/java/org/red5/server/api/scope/IScope.java +++ b/common/src/main/java/org/red5/server/api/scope/IScope.java @@ -20,13 +20,13 @@ /** * The scope object. - * - * A stateful object shared between a group of clients connected to the same context path. Scopes are arranged in hierarchical way, + * + * A stateful object shared between a group of clients connected to the same context path. Scopes are arranged in hierarchical way, * so its possible for a scope to have a parent and children scopes. If a client connects 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 is a general option for grouping things in an application. - * + * * The following are all names for scopes: application, room, place, lobby. - * + * * @author The Red5 Project * @author Luke Hubbard (luke@codegent.com) * @author Paul Gregoire (mondain@gmail.com) @@ -40,7 +40,7 @@ public interface IScope extends IBasicScope, ResourcePatternResolver, IServiceHa /** * Check to see if this scope has a child scope matching a given name. - * + * * @param name the name of the child scope * @return true if a child scope exists, otherwise false */ @@ -48,7 +48,7 @@ public interface IScope extends IBasicScope, ResourcePatternResolver, IServiceHa /** * Checks whether scope has a child scope with given name and type - * + * * @param type Child scope type * @param name Child scope name * @return true if a child scope exists, otherwise false @@ -57,7 +57,7 @@ public interface IScope extends IBasicScope, ResourcePatternResolver, IServiceHa /** * Creates child scope with name given and returns success value. Returns true on success and false if given scope already exists among children. - * + * * @param name New child scope name * @return true if child scope was successfully created, false otherwise */ @@ -65,7 +65,7 @@ public interface IScope extends IBasicScope, ResourcePatternResolver, IServiceHa /** * Adds scope as a child scope. Returns true on success and false if given scope is already a child of current. - * + * * @param scope Scope given * @return true if child scope was successfully added, false otherwise */ @@ -73,7 +73,7 @@ public interface IScope extends IBasicScope, ResourcePatternResolver, IServiceHa /** * Removes scope from the children scope list. - * + * * @param scope Scope given */ public void removeChildScope(IBasicScope scope); @@ -85,7 +85,7 @@ public interface IScope extends IBasicScope, ResourcePatternResolver, IServiceHa /** * Get a set of the child scope names. - * + * * @return set containing child scope names */ public Set getScopeNames(); @@ -94,7 +94,7 @@ public interface IScope extends IBasicScope, ResourcePatternResolver, IServiceHa /** * Return the broadcast scope for a given name. - * + * * @param name name * @return broadcast scope or null if not found */ @@ -102,7 +102,7 @@ public interface IScope extends IBasicScope, ResourcePatternResolver, IServiceHa /** * Get a child scope by name. - * + * * @param name Name of the child scope * @return the child scope, or null if no scope is found */ @@ -110,7 +110,7 @@ public interface IScope extends IBasicScope, ResourcePatternResolver, IServiceHa /** * Get a child scope by type and name. - * + * * @param type Child scope type * @param name Name of the child scope * @return the child scope, or null if no scope is found @@ -119,7 +119,7 @@ public interface IScope extends IBasicScope, ResourcePatternResolver, IServiceHa /** * Return scope by name - * + * * @param name Scope name * @return Scope with given name */ @@ -127,7 +127,7 @@ public interface IScope extends IBasicScope, ResourcePatternResolver, IServiceHa /** * Get a set of connected clients. You can get the connections by passing the scope to the clients {@link IClient#getConnections()} method. - * + * * @return Set containing all connected clients * @see org.red5.server.api.IClient#getConnections(IScope) */ @@ -135,7 +135,7 @@ public interface IScope extends IBasicScope, ResourcePatternResolver, IServiceHa /** * Get a connection iterator. You can call remove, and the connection will be closed. - * + * * @deprecated Use {@link IScope#getClientConnections()} instead * @return Iterator holding all connections */ @@ -144,14 +144,14 @@ public interface IScope extends IBasicScope, ResourcePatternResolver, IServiceHa /** * Get all current connections. You can call remove, and the connection will be closed. - * + * * @return Set containing all connections */ public Set getClientConnections(); /** * Lookup connections. - * + * * @deprecated Use {@link IScope#lookupConnection(IClient)} instead * @param client object * @return Set of connection objects (read-only) @@ -161,7 +161,7 @@ public interface IScope extends IBasicScope, ResourcePatternResolver, IServiceHa /** * Lookup connection for a given client. - * + * * @param client object * @return connection object */ @@ -169,35 +169,35 @@ public interface IScope extends IBasicScope, ResourcePatternResolver, IServiceHa /** * Returns scope context - * + * * @return Scope context */ public IContext getContext(); /** * Checks whether scope has handler or not. - * + * * @return true if scope has a handler, false otherwise */ public boolean hasHandler(); /** * Return handler of the scope - * + * * @return Scope handler */ public IScopeHandler getHandler(); /** * Return context path. - * + * * @return Context path */ public String getContextPath(); /** * Adds given connection to the scope - * + * * @param conn Given connection * @return true on success, false if given connection already belongs to this scope */ @@ -205,7 +205,7 @@ public interface IScope extends IBasicScope, ResourcePatternResolver, IServiceHa /** * Add given connection to the scope, overloaded for parameters pass case. - * + * * @param conn Given connection * @param params Parameters passed * @return true on success, false if given connection already belongs to this scope @@ -214,21 +214,21 @@ public interface IScope extends IBasicScope, ResourcePatternResolver, IServiceHa /** * Removes given connection from list of scope connections. This disconnects all clients of given connection from the scope. - * + * * @param conn Connection given */ public void disconnect(IConnection conn); /** * Return statistics informations about the scope. - * + * * @return statistics */ public IScopeStatistics getStatistics(); /** * Set attribute by name - * + * * @param name name * @param value value * @return true if added, false if not added @@ -237,7 +237,7 @@ public interface IScope extends IBasicScope, ResourcePatternResolver, IServiceHa /** * Get attribute by name - * + * * @param name name * @return value for the given name in the attributes or null if not found */ @@ -245,7 +245,7 @@ public interface IScope extends IBasicScope, ResourcePatternResolver, IServiceHa /** * Whether or not an attribute exists, keyed by the given name - * + * * @param name name * @return true if it exists, false otherwise */ @@ -253,7 +253,7 @@ public interface IScope extends IBasicScope, ResourcePatternResolver, IServiceHa /** * Remove attribute by name - * + * * @param name name * @return true if removed, false otherwise */ @@ -261,14 +261,14 @@ public interface IScope extends IBasicScope, ResourcePatternResolver, IServiceHa /** * Return attribute names - * + * * @return attribute names */ public Set getAttributeNames(); /** * Return scope attributes - * + * * @return attributes */ public Map getAttributes(); diff --git a/common/src/main/java/org/red5/server/api/scope/IScopeAware.java b/common/src/main/java/org/red5/server/api/scope/IScopeAware.java index 54b2dc88b..7fed170bb 100644 --- a/common/src/main/java/org/red5/server/api/scope/IScopeAware.java +++ b/common/src/main/java/org/red5/server/api/scope/IScopeAware.java @@ -9,7 +9,7 @@ /** * Maker interface for all objects that are aware of the scope they are located in. - * + * * @author The Red5 Project * @author Luke Hubbard (luke@codegent.com) */ @@ -17,7 +17,7 @@ public interface IScopeAware { /** * Set the scope the object is located in. - * + * * @param scope * Scope for this object */ diff --git a/common/src/main/java/org/red5/server/api/scope/IScopeHandler.java b/common/src/main/java/org/red5/server/api/scope/IScopeHandler.java index db82b3b32..fbca20d79 100644 --- a/common/src/main/java/org/red5/server/api/scope/IScopeHandler.java +++ b/common/src/main/java/org/red5/server/api/scope/IScopeHandler.java @@ -14,11 +14,11 @@ /** * The scope handler controls actions performed against a scope object, and also is notified of all events. - * + * * Gives fine grained control over what actions can be performed with the can* methods. Allows for detailed reporting on what is happening within the scope with the on* methods. This is the core interface users implement to create applications. - * + * * The thread local connection is always available via the Red5 object within these methods - * + * * @author The Red5 Project * @author Luke Hubbard (luke@codegent.com) */ @@ -26,7 +26,7 @@ public interface IScopeHandler extends IEventHandler { /** * Called when a scope is created for the first time. - * + * * @param scope * the new scope object * @return true to allow, false to deny @@ -35,7 +35,7 @@ public interface IScopeHandler extends IEventHandler { /** * Called just before a scope is disposed. - * + * * @param scope * Scope that id disposed */ @@ -43,7 +43,7 @@ public interface IScopeHandler extends IEventHandler { /** * Called just before every connection to a scope. You can pass additional params from client using NetConnection.connect method (see below). - * + * * @param conn * Connection object * @param params @@ -57,7 +57,7 @@ public interface IScopeHandler extends IEventHandler { /** * Called just after the a connection is disconnected. - * + * * @param conn * Connection object * @param scope @@ -67,7 +67,7 @@ public interface IScopeHandler extends IEventHandler { /** * Called just before a child scope is added. - * + * * @param scope * Scope that will be added * @return true to allow, false to deny @@ -76,7 +76,7 @@ public interface IScopeHandler extends IEventHandler { /** * Called just after a child scope has been removed. - * + * * @param scope * Scope that has been removed */ @@ -84,7 +84,7 @@ public interface IScopeHandler extends IEventHandler { /** * Called just before a client enters the scope. - * + * * @param client * Client object * @param scope @@ -95,7 +95,7 @@ public interface IScopeHandler extends IEventHandler { /** * Called just after the client leaves the scope. - * + * * @param client * Client object * @param scope @@ -105,12 +105,12 @@ public interface IScopeHandler extends IEventHandler { /** * Called when a service is called. - * + * * @param conn * The connection object * @param call * The call object. - * + * * @return true to allow, false to deny */ boolean serviceCall(IConnection conn, IServiceCall call); diff --git a/common/src/main/java/org/red5/server/api/scope/IScopeSecurityHandler.java b/common/src/main/java/org/red5/server/api/scope/IScopeSecurityHandler.java index 0c595a53b..732cd7cd1 100644 --- a/common/src/main/java/org/red5/server/api/scope/IScopeSecurityHandler.java +++ b/common/src/main/java/org/red5/server/api/scope/IScopeSecurityHandler.java @@ -11,14 +11,14 @@ /** * Provides an interface for scope security handling. - * + * * @author Paul Gregoire (mondain@gmail.com) */ public interface IScopeSecurityHandler { /** * Determines whether or not a given connection is allowed. - * + * * @param conn connection * @return true if allowed and false otherwise */ @@ -26,7 +26,7 @@ public interface IScopeSecurityHandler { /** * Determines whether or not a given scope is allowed. - * + * * @param conn connection * @return true if allowed and false otherwise */ diff --git a/common/src/main/java/org/red5/server/api/scope/IScopeService.java b/common/src/main/java/org/red5/server/api/scope/IScopeService.java index 09186070c..0fdac9638 100644 --- a/common/src/main/java/org/red5/server/api/scope/IScopeService.java +++ b/common/src/main/java/org/red5/server/api/scope/IScopeService.java @@ -8,7 +8,7 @@ /** * Base marker interface for all scope services. Used by the ScopeUtils to lookup services defined as beans in Spring application context. A scope service usually can perform various tasks on a scope like managing shared objects, streams, etc. - * + * * @author The Red5 Project * @author Joachim Bauch (bauch@struktur.de) */ diff --git a/common/src/main/java/org/red5/server/api/scope/ScopeType.java b/common/src/main/java/org/red5/server/api/scope/ScopeType.java index 4b47df024..7713b7f52 100644 --- a/common/src/main/java/org/red5/server/api/scope/ScopeType.java +++ b/common/src/main/java/org/red5/server/api/scope/ScopeType.java @@ -2,7 +2,7 @@ /** * Represents all the supported scope types. - * + * * @author Paul Gregoire (mondain@gmail.com) */ public enum ScopeType { diff --git a/common/src/main/java/org/red5/server/api/service/IBroadcastStreamService.java b/common/src/main/java/org/red5/server/api/service/IBroadcastStreamService.java index 5a317b9c1..e6f37e6e2 100644 --- a/common/src/main/java/org/red5/server/api/service/IBroadcastStreamService.java +++ b/common/src/main/java/org/red5/server/api/service/IBroadcastStreamService.java @@ -18,7 +18,7 @@ public interface IBroadcastStreamService { /** * Does the scope have a broadcast stream registered with a given name - * + * * @param scope * the scope to check for the stream * @param name @@ -29,7 +29,7 @@ public interface IBroadcastStreamService { /** * Get a broadcast stream by name - * + * * @param scope * the scope to return the stream from * @param name @@ -40,7 +40,7 @@ public interface IBroadcastStreamService { /** * Get a set containing the names of all the broadcasts - * + * * @param scope * the scope to search for streams * @return set containing all broadcast names diff --git a/common/src/main/java/org/red5/server/api/service/IOnDemandStreamService.java b/common/src/main/java/org/red5/server/api/service/IOnDemandStreamService.java index e1e67b769..25f9f888e 100644 --- a/common/src/main/java/org/red5/server/api/service/IOnDemandStreamService.java +++ b/common/src/main/java/org/red5/server/api/service/IOnDemandStreamService.java @@ -17,7 +17,7 @@ public interface IOnDemandStreamService extends IScopeService { /** * Has the service an on-demand stream with the passed name? - * + * * @param scope * the scope to check for the stream * @param name @@ -28,7 +28,7 @@ public interface IOnDemandStreamService extends IScopeService { /** * Get a stream that can be used for playback of the on-demand stream - * + * * @param scope * the scope to return the stream from * @param name diff --git a/common/src/main/java/org/red5/server/api/service/IPendingServiceCall.java b/common/src/main/java/org/red5/server/api/service/IPendingServiceCall.java index 2de91a316..2e6cdc9a6 100644 --- a/common/src/main/java/org/red5/server/api/service/IPendingServiceCall.java +++ b/common/src/main/java/org/red5/server/api/service/IPendingServiceCall.java @@ -11,14 +11,14 @@ /** * IPendingServiceCall is a call that have a list of callbacks. - * + * * */ public interface IPendingServiceCall extends IServiceCall { /** * Returns service call result - * + * * @return Remote call result */ public abstract Object getResult(); @@ -33,7 +33,7 @@ public interface IPendingServiceCall extends IServiceCall { /** * Registers callback object usually represented as an anonymous class instance that implements IPendingServiceCallback interface. - * + * * @param callback * Callback object */ @@ -41,7 +41,7 @@ public interface IPendingServiceCall extends IServiceCall { /** * Unregisters callback object usually represented as an anonymous class instance that implements IPendingServiceCallback interface. - * + * * @param callback * Callback object */ @@ -49,7 +49,7 @@ public interface IPendingServiceCall extends IServiceCall { /** * Returns list of callback objects, usually callback object represented as an anonymous class instance that implements IPendingServiceCallback interface. - * + * * @return Set of pending operations callbacks */ public Set getCallbacks(); diff --git a/common/src/main/java/org/red5/server/api/service/IPendingServiceCallback.java b/common/src/main/java/org/red5/server/api/service/IPendingServiceCallback.java index 1f0e447e0..72e7fe3b6 100644 --- a/common/src/main/java/org/red5/server/api/service/IPendingServiceCallback.java +++ b/common/src/main/java/org/red5/server/api/service/IPendingServiceCallback.java @@ -9,7 +9,7 @@ /** * Callback that will be executed when the result of a pending service call has been received. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) * @@ -18,7 +18,7 @@ public interface IPendingServiceCallback { /** * Triggered when results are recieved - * + * * @param call * Call object this callback is applied to */ diff --git a/common/src/main/java/org/red5/server/api/service/IServiceCall.java b/common/src/main/java/org/red5/server/api/service/IServiceCall.java index bf167304b..9b845b563 100644 --- a/common/src/main/java/org/red5/server/api/service/IServiceCall.java +++ b/common/src/main/java/org/red5/server/api/service/IServiceCall.java @@ -14,73 +14,73 @@ public interface IServiceCall { /** * Whether call was successful or not - * + * * @return
      * true
      * 
- * + * * on success, - * + * *
      * false
      * 
- * + * * otherwise */ public abstract boolean isSuccess(); /** * Returns service method name - * + * * @return Service method name as string */ public abstract String getServiceMethodName(); /** * Returns service name - * + * * @return Service name */ public abstract String getServiceName(); /** * Returns array of service method arguments - * + * * @return array of service method arguments */ public abstract Object[] getArguments(); /** * Get service call status - * + * * @return service call status */ public abstract byte getStatus(); /** * Returns the time stamp at which this object was deserialized. - * + * * @return the readTime */ public long getReadTime(); /** * Returns the time stamp at which this object was serialized. - * + * * @return the writeTime */ public long getWriteTime(); /** * Get service call exception - * + * * @return service call exception */ public abstract Exception getException(); /** * Sets status - * + * * @param status * Status as byte */ @@ -88,7 +88,7 @@ public interface IServiceCall { /** * Sets exception - * + * * @param exception * Call exception */ diff --git a/common/src/main/java/org/red5/server/api/service/IServiceCapableConnection.java b/common/src/main/java/org/red5/server/api/service/IServiceCapableConnection.java index cb04fdbe6..d4434111b 100644 --- a/common/src/main/java/org/red5/server/api/service/IServiceCapableConnection.java +++ b/common/src/main/java/org/red5/server/api/service/IServiceCapableConnection.java @@ -17,7 +17,7 @@ public interface IServiceCapableConnection extends IConnection { /** * Invokes service using remoting call object. - * + * * @param call * Service call object */ @@ -25,7 +25,7 @@ public interface IServiceCapableConnection extends IConnection { /** * Invoke service using call and channel. - * + * * @param call * Service call * @param channel @@ -35,7 +35,7 @@ public interface IServiceCapableConnection extends IConnection { /** * Invoke method by name. - * + * * @param method * Called method name */ @@ -43,7 +43,7 @@ public interface IServiceCapableConnection extends IConnection { /** * Invoke method by name with callback. - * + * * @param method * Called method name * @param callback @@ -53,7 +53,7 @@ public interface IServiceCapableConnection extends IConnection { /** * Invoke method with parameters. - * + * * @param method * Method name * @param params @@ -101,7 +101,7 @@ public interface IServiceCapableConnection extends IConnection { /** * Notify method with parameters. - * + * * @param method * by name * @param params @@ -111,7 +111,7 @@ public interface IServiceCapableConnection extends IConnection { /** * Sends a status object to the connection. - * + * * @param status * Status */ @@ -119,7 +119,7 @@ public interface IServiceCapableConnection extends IConnection { /** * Sends a status object to the connection on a given channel. - * + * * @param status * Status * @param channel diff --git a/common/src/main/java/org/red5/server/api/service/IServiceHandlerProvider.java b/common/src/main/java/org/red5/server/api/service/IServiceHandlerProvider.java index c3e5e5e1b..0371584bd 100644 --- a/common/src/main/java/org/red5/server/api/service/IServiceHandlerProvider.java +++ b/common/src/main/java/org/red5/server/api/service/IServiceHandlerProvider.java @@ -11,7 +11,7 @@ /** * Supports registration and lookup of service handlers. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ @@ -21,25 +21,25 @@ public interface IServiceHandlerProvider { * Register an object that provides methods which can be called from a client.
* Example:
* If you registered a handler with the name " - * + * *
      * one.two
      * 
- * + * * " that provides a method " - * + * *
      * callMe
      * 
- * + * * ", you can call a method " - * + * *
      * one.two.callMe
      * 
- * + * * " from the client. - * + * * @param name * the name of the handler * @param handler @@ -49,7 +49,7 @@ public interface IServiceHandlerProvider { /** * Unregister service handler. - * + * * @param name * the name of the handler */ @@ -57,7 +57,7 @@ public interface IServiceHandlerProvider { /** * Return a previously registered service handler. - * + * * @param name * the name of the handler to return * @return the previously registered handler @@ -66,7 +66,7 @@ public interface IServiceHandlerProvider { /** * Get list of registered service handler names. - * + * * @return the names of the registered handlers */ public Set getServiceHandlerNames(); diff --git a/common/src/main/java/org/red5/server/api/service/IServiceHandlerProviderAware.java b/common/src/main/java/org/red5/server/api/service/IServiceHandlerProviderAware.java index 4b3b9bc64..c86f9f829 100644 --- a/common/src/main/java/org/red5/server/api/service/IServiceHandlerProviderAware.java +++ b/common/src/main/java/org/red5/server/api/service/IServiceHandlerProviderAware.java @@ -9,7 +9,7 @@ /** * Class that knows about objects which can provide service handlers. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ @@ -17,7 +17,7 @@ public interface IServiceHandlerProviderAware { /** * Return object that knows about service handlers. - * + * * @return service handler provider */ public IServiceHandlerProvider getServiceHandlerProvider(); diff --git a/common/src/main/java/org/red5/server/api/service/IServiceInvoker.java b/common/src/main/java/org/red5/server/api/service/IServiceInvoker.java index 20ab18ba5..b3e580832 100644 --- a/common/src/main/java/org/red5/server/api/service/IServiceInvoker.java +++ b/common/src/main/java/org/red5/server/api/service/IServiceInvoker.java @@ -11,7 +11,7 @@ /** * Interface for objects that execute service calls (remote calls from client). - * + * * @author The Red5 Project * @author Luke Hubbard (luke@codegent.com) */ @@ -19,7 +19,7 @@ public interface IServiceInvoker { /** * Execute the passed service call in the given scope. This looks up the handler for the call in the scope and the context of the scope. - * + * * @param call * the call to invoke * @param scope @@ -27,9 +27,9 @@ public interface IServiceInvoker { * @return
      * true
      * 
- * + * * if the call was performed, otherwise - * + * *
      * false
      * 
@@ -38,7 +38,7 @@ public interface IServiceInvoker { /** * Execute the passed service call in the given object. - * + * * @param call * the call to invoke * @param service @@ -46,9 +46,9 @@ public interface IServiceInvoker { * @return
      * true
      * 
- * + * * if the call was performed, otherwise - * + * *
      * false
      * 
diff --git a/common/src/main/java/org/red5/server/api/service/IStreamSecurityService.java b/common/src/main/java/org/red5/server/api/service/IStreamSecurityService.java index d3f117abe..dd0eda896 100644 --- a/common/src/main/java/org/red5/server/api/service/IStreamSecurityService.java +++ b/common/src/main/java/org/red5/server/api/service/IStreamSecurityService.java @@ -15,7 +15,7 @@ /** * Service that supports protecting access to streams. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ @@ -28,7 +28,7 @@ public interface IStreamSecurityService extends IScopeService { /** * Add handler that protects stream publishing. - * + * * @param handler * Handler to add. */ @@ -36,7 +36,7 @@ public interface IStreamSecurityService extends IScopeService { /** * Remove handler that protects stream publishing. - * + * * @param handler * Handler to remove. */ @@ -44,14 +44,14 @@ public interface IStreamSecurityService extends IScopeService { /** * Get handlers that protect stream publishing. - * + * * @return list of handlers */ public Set getStreamPublishSecurity(); /** * Add handler that protects stream playback. - * + * * @param handler * Handler to add. */ @@ -59,7 +59,7 @@ public interface IStreamSecurityService extends IScopeService { /** * Remove handler that protects stream playback. - * + * * @param handler * Handler to remove. */ @@ -67,7 +67,7 @@ public interface IStreamSecurityService extends IScopeService { /** * Get handlers that protect stream plaback. - * + * * @return list of handlers */ public Set getStreamPlaybackSecurity(); diff --git a/common/src/main/java/org/red5/server/api/service/IStreamableFileService.java b/common/src/main/java/org/red5/server/api/service/IStreamableFileService.java index 570dc8f8e..52a811fd0 100644 --- a/common/src/main/java/org/red5/server/api/service/IStreamableFileService.java +++ b/common/src/main/java/org/red5/server/api/service/IStreamableFileService.java @@ -19,7 +19,7 @@ public interface IStreamableFileService { /** * Sets the prefix. - * + * * @param prefix * prefix */ @@ -34,7 +34,7 @@ public interface IStreamableFileService { /** * Sets the file extensions serviced. If there are more than one, they are separated by commas. - * + * * @param extension * extension */ @@ -49,7 +49,7 @@ public interface IStreamableFileService { /** * Prepair given string to conform filename requirements, for example, add extension to the end if missing. - * + * * @param name * String to format * @return Correct filename @@ -58,7 +58,7 @@ public interface IStreamableFileService { /** * Check whether file can be used by file service, that is, it does exist and have valid extension - * + * * @param file * File object * @return true if file exist and has valid extension, false otherwise diff --git a/common/src/main/java/org/red5/server/api/service/ISubscriberStreamService.java b/common/src/main/java/org/red5/server/api/service/ISubscriberStreamService.java index 35136eec3..61a581b31 100644 --- a/common/src/main/java/org/red5/server/api/service/ISubscriberStreamService.java +++ b/common/src/main/java/org/red5/server/api/service/ISubscriberStreamService.java @@ -17,7 +17,7 @@ public interface ISubscriberStreamService extends IScopeService { /** * Returns a stream that can subscribe a broadcast stream with the given name using "IBroadcastStream.subscribe". - * + * * @param scope * the scope to return the stream from * @param name diff --git a/common/src/main/java/org/red5/server/api/service/ServiceUtils.java b/common/src/main/java/org/red5/server/api/service/ServiceUtils.java index f0ffdf25b..7c0a328e7 100644 --- a/common/src/main/java/org/red5/server/api/service/ServiceUtils.java +++ b/common/src/main/java/org/red5/server/api/service/ServiceUtils.java @@ -18,7 +18,7 @@ /** * Utility functions to invoke methods on connections. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) * @author Paul Gregoire (mondain@gmail.com) @@ -29,7 +29,7 @@ public class ServiceUtils { /** * Invoke a method on the current connection. - * + * * @param method * name of the method to invoke * @param params @@ -42,7 +42,7 @@ public static boolean invokeOnConnection(String method, Object[] params) { /** * Invoke a method on the current connection and handle result. - * + * * @param method * name of the method to invoke * @param params @@ -64,7 +64,7 @@ public static boolean invokeOnConnection(String method, Object[] params, IPendin /** * Invoke a method on a given connection. - * + * * @param conn * connection to invoke method on * @param method @@ -79,7 +79,7 @@ public static boolean invokeOnConnection(IConnection conn, String method, Object /** * Invoke a method on a given connection and handle result. - * + * * @param conn * connection to invoke method on * @param method @@ -105,7 +105,7 @@ public static boolean invokeOnConnection(IConnection conn, String method, Object /** * Invoke a method on all connections to the current scope. - * + * * @param method * name of the method to invoke * @param params @@ -117,7 +117,7 @@ public static void invokeOnAllConnections(String method, Object[] params) { /** * Invoke a method on all connections to the current scope and handle result. - * + * * @param method * name of the method to invoke * @param params @@ -139,7 +139,7 @@ public static void invokeOnAllConnections(String method, Object[] params, IPendi /** * Invoke a method on all connections to a given scope. - * + * * @param scope * scope to get connections for * @param method @@ -155,7 +155,7 @@ public static void invokeOnAllConnections(IScope scope, String method, Object[] /** * Invoke a method on all connections to a given scope and handle result. - * + * * @param scope * scope to get connections for * @param method @@ -171,7 +171,7 @@ public static void invokeOnAllConnections(IScope scope, String method, Object[] /** * Invoke a method on all connections of a scope and handle result. - * + * * @param scope * scope to get connections from * @param method @@ -188,7 +188,7 @@ public static void invokeOnAllScopeConnections(IScope scope, String method, Obje /** * Invoke a method on all connections of a client to a given scope. - * + * * @param client * client to get connections for * @param scope @@ -204,7 +204,7 @@ public static void invokeOnClient(IClient client, IScope scope, String method, O /** * Invoke a method on all connections of a client to a given scope and handle result. - * + * * @param client * client to get connections for * @param scope @@ -235,7 +235,7 @@ public static void invokeOnClient(IClient client, IScope scope, String method, O /** * Notify a method on the current connection. - * + * * @param method * name of the method to notify * @param params @@ -243,9 +243,9 @@ public static void invokeOnClient(IClient client, IScope scope, String method, O * @return
      * true
      * 
- * + * * if the connection supports method calls, otherwise - * + * *
      * false
      * 
@@ -263,7 +263,7 @@ public static boolean notifyOnConnection(String method, Object[] params) { /** * Notify a method on a given connection. - * + * * @param conn * connection to notify method on * @param method @@ -273,9 +273,9 @@ public static boolean notifyOnConnection(String method, Object[] params) { * @return
      * true
      * 
- * + * * if the connection supports method calls, otherwise - * + * *
      * false
      * 
@@ -291,7 +291,7 @@ public static boolean notifyOnConnection(IConnection conn, String method, Object /** * Notify a method on all connections to the current scope. - * + * * @param method * name of the method to notify * @param params @@ -311,7 +311,7 @@ public static void notifyOnAllConnections(String method, Object[] params) { /** * Notify a method on all connections to a given scope. - * + * * @param scope * scope to get connections for * @param method @@ -327,7 +327,7 @@ public static void notifyOnAllConnections(IScope scope, String method, Object[] /** * Notify a method on all connections of a scope. - * + * * @param scope * scope to dispatch event * @param method @@ -342,7 +342,7 @@ public static void notifyOnAllScopeConnections(IScope scope, String method, Obje /** * Notify a method on all connections of a client to a given scope. - * + * * @param client * client to get connections for * @param scope diff --git a/common/src/main/java/org/red5/server/api/so/IClientSharedObject.java b/common/src/main/java/org/red5/server/api/so/IClientSharedObject.java index 9437c4cca..cd057f428 100644 --- a/common/src/main/java/org/red5/server/api/so/IClientSharedObject.java +++ b/common/src/main/java/org/red5/server/api/so/IClientSharedObject.java @@ -11,7 +11,7 @@ /** * Clientside access to shared objects. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ @@ -19,7 +19,7 @@ public interface IClientSharedObject extends ISharedObjectBase { /** * Connect the shared object using the passed connection. - * + * * @param conn * connect to connect to */ @@ -27,7 +27,7 @@ public interface IClientSharedObject extends ISharedObjectBase { /** * Check if the shared object is connected to the server. - * + * * @return is connected */ public boolean isConnected(); diff --git a/common/src/main/java/org/red5/server/api/so/ISharedObject.java b/common/src/main/java/org/red5/server/api/so/ISharedObject.java index 32c81b720..3bac3211b 100644 --- a/common/src/main/java/org/red5/server/api/so/ISharedObject.java +++ b/common/src/main/java/org/red5/server/api/so/ISharedObject.java @@ -12,7 +12,7 @@ /** * Serverside access to shared objects. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ @@ -20,32 +20,32 @@ public interface ISharedObject extends IBasicScope, ISharedObjectBase, ISharedOb /** * 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. */ public void acquire(); /** * Check if shared object currently is acquired. - * + * * @return
      * true
      * 
- * + * * if the SO is acquired, otherwise - * + * *
      * false
      * 
@@ -59,14 +59,14 @@ public interface ISharedObject extends IBasicScope, ISharedObjectBase, ISharedOb /** * Return statistics about the shared object. - * + * * @return statistics */ public ISharedObjectStatistics getStatistics(); /** * Sets a "dirty" flag to indicate that the attributes have been modified. - * + * * @param dirty if dirty / modified */ @Deprecated @@ -74,7 +74,7 @@ public interface ISharedObject extends IBasicScope, ISharedObjectBase, ISharedOb /** * Sets a "dirty" flag to indicate that the named attribute has been modified. - * + * * @param name attribute key which is now dirty */ void setDirty(String name); diff --git a/common/src/main/java/org/red5/server/api/so/ISharedObjectBase.java b/common/src/main/java/org/red5/server/api/so/ISharedObjectBase.java index 2ef78377b..97cb918c8 100644 --- a/common/src/main/java/org/red5/server/api/so/ISharedObjectBase.java +++ b/common/src/main/java/org/red5/server/api/so/ISharedObjectBase.java @@ -15,9 +15,9 @@ /** * Base interface for shared objects. Changes to the shared objects are propagated to all subscribed clients. - * + * * If you want to modify multiple attributes and notify the clients about all changes at once, you can use code like this: - * + * *
  * SharedObject.beginUpdate();
  * SharedObject.setAttribute("One", '1');
@@ -25,9 +25,9 @@
  * SharedObject.removeAttribute("Three");
  * SharedObject.endUpdate();
  * 
- * + * * All changes between "beginUpdate" and "endUpdate" will be sent to the clients using one notification event. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ @@ -35,14 +35,14 @@ public interface ISharedObjectBase extends ISharedObjectHandlerProvider, ICastin /** * Returns the version of the shared object. The version is incremented automatically on each modification. - * + * * @return the version of the shared object */ public int getVersion(); /** * Check if the object has been created as persistent shared object by the client. - * + * * @return true if the shared object is persistent, false otherwise */ public boolean isPersistent(); @@ -50,14 +50,14 @@ public interface ISharedObjectBase extends ISharedObjectHandlerProvider, ICastin /** * Return a map containing all attributes of the shared object.
* NOTE: The returned map will be read-only. - * + * * @return a map containing all attributes of the shared object */ public Map getData(); /** * Send a message to a handler of the shared object. - * + * * @param handler * the name of the handler to call * @param arguments @@ -72,7 +72,7 @@ public interface ISharedObjectBase extends ISharedObjectHandlerProvider, ICastin /** * Start performing multiple updates to the shared object from a connected client. - * + * * @param source * Update events listener */ @@ -85,7 +85,7 @@ public interface ISharedObjectBase extends ISharedObjectHandlerProvider, ICastin /** * Register object that will be notified about update events. - * + * * @param listener * the object to notify */ @@ -93,7 +93,7 @@ public interface ISharedObjectBase extends ISharedObjectHandlerProvider, ICastin /** * Unregister object to not longer receive update events. - * + * * @param listener * the object to unregister */ @@ -101,7 +101,7 @@ public interface ISharedObjectBase extends ISharedObjectHandlerProvider, ICastin /** * Deletes all the attributes and sends a clear event to all listeners. The persistent data object is also removed from a persistent shared object. - * + * * @return true if successful; false otherwise */ public boolean clear(); diff --git a/common/src/main/java/org/red5/server/api/so/ISharedObjectHandlerProvider.java b/common/src/main/java/org/red5/server/api/so/ISharedObjectHandlerProvider.java index 6754bdfd2..7549a0fdc 100644 --- a/common/src/main/java/org/red5/server/api/so/ISharedObjectHandlerProvider.java +++ b/common/src/main/java/org/red5/server/api/so/ISharedObjectHandlerProvider.java @@ -11,7 +11,7 @@ /** * Supports registration and lookup of shared object handlers. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) * @@ -20,7 +20,7 @@ public interface ISharedObjectHandlerProvider extends IServiceHandlerProvider { /** * Register an object that provides methods which handle calls without a service name to a shared object. - * + * * @param handler * the handler object */ diff --git a/common/src/main/java/org/red5/server/api/so/ISharedObjectListener.java b/common/src/main/java/org/red5/server/api/so/ISharedObjectListener.java index 3685255eb..ecacd66fe 100644 --- a/common/src/main/java/org/red5/server/api/so/ISharedObjectListener.java +++ b/common/src/main/java/org/red5/server/api/so/ISharedObjectListener.java @@ -14,7 +14,7 @@ /** * Notifications about shared object updates. - * + * * @author The Red5 Project * @author Luke Hubbard (luke@codegent.com) * @author Joachim Bauch (jojo@struktur.de) @@ -23,7 +23,7 @@ public interface ISharedObjectListener { /** * Called when a client connects to a shared object. - * + * * @param so * the shared object */ @@ -31,7 +31,7 @@ public interface ISharedObjectListener { /** * Called when a client disconnects from a shared object. - * + * * @param so * the shared object */ @@ -39,7 +39,7 @@ public interface ISharedObjectListener { /** * Called when a shared object attribute is updated. - * + * * @param so * the shared object * @param key @@ -51,7 +51,7 @@ public interface ISharedObjectListener { /** * Called when multiple attributes of a shared object are updated. - * + * * @param so * the shared object * @param values @@ -61,7 +61,7 @@ public interface ISharedObjectListener { /** * Called when multiple attributes of a shared object are updated. - * + * * @param so * the shared object * @param values @@ -71,7 +71,7 @@ public interface ISharedObjectListener { /** * Called when an attribute is deleted from the shared object. - * + * * @param so * the shared object * @param key @@ -81,7 +81,7 @@ public interface ISharedObjectListener { /** * Called when all attributes of a shared object are removed. - * + * * @param so * the shared object */ @@ -89,7 +89,7 @@ public interface ISharedObjectListener { /** * Called when a shared object method call is sent. - * + * * @param so * the shared object * @param method diff --git a/common/src/main/java/org/red5/server/api/so/ISharedObjectSecurity.java b/common/src/main/java/org/red5/server/api/so/ISharedObjectSecurity.java index 0afe4e5da..8b1d12547 100644 --- a/common/src/main/java/org/red5/server/api/so/ISharedObjectSecurity.java +++ b/common/src/main/java/org/red5/server/api/so/ISharedObjectSecurity.java @@ -13,7 +13,7 @@ /** * Interface for handlers that control access to shared objects. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ @@ -21,7 +21,7 @@ public interface ISharedObjectSecurity { /** * Check if the a shared object may be created in the given scope. - * + * * @param scope * scope * @param name @@ -34,7 +34,7 @@ public interface ISharedObjectSecurity { /** * Check if a connection to the given existing shared object is allowed. - * + * * @param so * shared ojbect * @return is connection alowed @@ -43,7 +43,7 @@ public interface ISharedObjectSecurity { /** * Check if a modification is allowed on the given shared object. - * + * * @param so * shared object * @param key @@ -56,7 +56,7 @@ public interface ISharedObjectSecurity { /** * Check if the deletion of a property is allowed on the given shared object. - * + * * @param so * shared object * @param key @@ -67,7 +67,7 @@ public interface ISharedObjectSecurity { /** * Check if sending a message to the shared object is allowed. - * + * * @param so * shared object * @param message diff --git a/common/src/main/java/org/red5/server/api/so/ISharedObjectSecurityService.java b/common/src/main/java/org/red5/server/api/so/ISharedObjectSecurityService.java index 4665f9747..18932ff36 100644 --- a/common/src/main/java/org/red5/server/api/so/ISharedObjectSecurityService.java +++ b/common/src/main/java/org/red5/server/api/so/ISharedObjectSecurityService.java @@ -13,7 +13,7 @@ /** * Service that supports protecting access to shared objects. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ @@ -26,7 +26,7 @@ public interface ISharedObjectSecurityService extends IScopeService { /** * Add handler that protects shared objects. - * + * * @param handler * Handler to add. */ @@ -34,7 +34,7 @@ public interface ISharedObjectSecurityService extends IScopeService { /** * Remove handler that protects shared objects. - * + * * @param handler * Handler to remove. */ @@ -42,7 +42,7 @@ public interface ISharedObjectSecurityService extends IScopeService { /** * Get handlers that protect shared objects. - * + * * @return list of handlers */ public Set getSharedObjectSecurity(); diff --git a/common/src/main/java/org/red5/server/api/so/ISharedObjectService.java b/common/src/main/java/org/red5/server/api/so/ISharedObjectService.java index a8acfef0e..e51af8f11 100644 --- a/common/src/main/java/org/red5/server/api/so/ISharedObjectService.java +++ b/common/src/main/java/org/red5/server/api/so/ISharedObjectService.java @@ -14,7 +14,7 @@ /** * Service that manages shared objects for given scope. - * + * */ public interface ISharedObjectService extends IScopeService { @@ -22,7 +22,7 @@ public interface ISharedObjectService extends IScopeService { /** * Get a set of the shared object names. - * + * * @param scope * the scope to return the shared object names from * @return set containing the shared object names @@ -31,7 +31,7 @@ public interface ISharedObjectService extends IScopeService { /** * Create a new shared object. - * + * * @param scope * the scope to create the shared object in * @param name @@ -41,9 +41,9 @@ public interface ISharedObjectService extends IScopeService { * @return
      * true
      * 
- * + * * if the shared object was created or already exists, otherwise - * + * *
      * false
      * 
@@ -52,24 +52,24 @@ public interface ISharedObjectService extends IScopeService { /** * Get a shared object by name. - * + * * @param scope * the scope to get the shared object from * @param name * the name of the shared object * @return shared object, or - * + * *
      * null
      * 
- * + * * if not found */ public ISharedObject getSharedObject(IScope scope, String name); /** * Get a shared object by name and create it if it doesn't exist. - * + * * @param scope * the scope to get the shared object from * @param name @@ -82,7 +82,7 @@ public interface ISharedObjectService extends IScopeService { /** * Check if a shared object exists. - * + * * @param scope * the scope to check for the shared object * @param name @@ -90,9 +90,9 @@ public interface ISharedObjectService extends IScopeService { * @return
      * true
      * 
- * + * * if the shared object exists, otherwise - * + * *
      * false
      * 
@@ -115,7 +115,7 @@ public interface ISharedObjectService extends IScopeService { * If you call the clearSharedObjects() method and the specified path matches a shared object that is currently active, all its properties are deleted, and a "clear" event is sent to all subscribers of the shared object. If it is a persistent shared object, the persistent store is also cleared. *

*
- * + * * @param scope * the scope to check for the shared object * @param name diff --git a/common/src/main/java/org/red5/server/api/statistics/IClientBroadcastStreamStatistics.java b/common/src/main/java/org/red5/server/api/statistics/IClientBroadcastStreamStatistics.java index e3af71959..51f95538a 100644 --- a/common/src/main/java/org/red5/server/api/statistics/IClientBroadcastStreamStatistics.java +++ b/common/src/main/java/org/red5/server/api/statistics/IClientBroadcastStreamStatistics.java @@ -9,7 +9,7 @@ /** * Statistical informations about a stream that is broadcasted by a client. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ @@ -17,54 +17,54 @@ public interface IClientBroadcastStreamStatistics extends IStreamStatistics { /** * Get the filename the stream is being saved as. - * + * * @return The filename relative to the scope or - * + * *
      * null
      * 
- * + * * if the stream is not being saved. */ public String getSaveFilename(); /** * Get stream publish name. Publish name is the value of the first parameter had been passed to - * + * *
      * NetStream.publish
      * 
- * + * * on client side in SWF. - * + * * @return Stream publish name */ public String getPublishedName(); /** * Return total number of subscribers. - * + * * @return number of subscribers */ public int getTotalSubscribers(); /** * Return maximum number of concurrent subscribers. - * + * * @return number of subscribers */ public int getMaxSubscribers(); /** * Return current number of subscribers. - * + * * @return number of subscribers */ public int getActiveSubscribers(); /** * Return total number of bytes received from client for this stream. - * + * * @return number of bytes */ public long getBytesReceived(); diff --git a/common/src/main/java/org/red5/server/api/statistics/IPlaylistSubscriberStreamStatistics.java b/common/src/main/java/org/red5/server/api/statistics/IPlaylistSubscriberStreamStatistics.java index f09b8fe92..0e698deb0 100644 --- a/common/src/main/java/org/red5/server/api/statistics/IPlaylistSubscriberStreamStatistics.java +++ b/common/src/main/java/org/red5/server/api/statistics/IPlaylistSubscriberStreamStatistics.java @@ -9,7 +9,7 @@ /** * Statistical informations about a stream that is subscribed by a client. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ @@ -17,21 +17,21 @@ public interface IPlaylistSubscriberStreamStatistics extends IStreamStatistics { /** * Return total number of bytes sent to the client from this stream. - * + * * @return number of bytes */ public long getBytesSent(); /** * Return the buffer duration as requested by the client. - * + * * @return the buffer duration in milliseconds */ public int getClientBufferDuration(); /** * Return estimated fill ratio of the client buffer. - * + * * @return fill ratio in percent */ public double getEstimatedBufferFill(); diff --git a/common/src/main/java/org/red5/server/api/statistics/IScopeStatistics.java b/common/src/main/java/org/red5/server/api/statistics/IScopeStatistics.java index 2b2946ecd..4364c6f99 100644 --- a/common/src/main/java/org/red5/server/api/statistics/IScopeStatistics.java +++ b/common/src/main/java/org/red5/server/api/statistics/IScopeStatistics.java @@ -9,7 +9,7 @@ /** * Statistical informations about a scope. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ @@ -17,96 +17,96 @@ public interface IScopeStatistics extends IStatisticsBase { /** * Get the name of this scope. Eg. - * + * *
      * someroom
      * 
- * + * * . - * + * * @return the name */ public String getName(); /** * Get the full absolute path. Eg. - * + * *
      * host / myapp / someroom
      * 
- * + * * . - * + * * @return Absolute scope path */ public String getPath(); /** * Get the scopes depth, how far down the scope tree is it. The lowest depth is 0x00, the depth of Global scope. Application scope depth is 0x01. Room depth is 0x02, 0x03 and so forth. - * + * * @return the depth */ public int getDepth(); /** * Return total number of connections to the scope. - * + * * @return number of connections */ public int getTotalConnections(); /** * Return maximum number of concurrent connections to the scope. - * + * * @return number of connections */ public int getMaxConnections(); /** * Return current number of connections to the scope. - * + * * @return number of connections */ public int getActiveConnections(); /** * Return total number of clients connected to the scope. - * + * * @return number of clients */ public int getTotalClients(); /** * Return maximum number of clients concurrently connected to the scope. - * + * * @return number of clients */ public int getMaxClients(); /** * Return current number of clients connected to the scope. - * + * * @return number of clients */ public int getActiveClients(); /** * Return total number of subscopes created. - * + * * @return number of subscopes created */ public int getTotalSubscopes(); /** * Return maximum number of concurrently existing subscopes. - * + * * @return number of subscopes */ public int getMaxSubscopes(); /** * Return number of currently existing subscopes. - * + * * @return number of subscopes */ public int getActiveSubscopes(); diff --git a/common/src/main/java/org/red5/server/api/statistics/ISharedObjectStatistics.java b/common/src/main/java/org/red5/server/api/statistics/ISharedObjectStatistics.java index 6f9df3db6..cc8cede89 100644 --- a/common/src/main/java/org/red5/server/api/statistics/ISharedObjectStatistics.java +++ b/common/src/main/java/org/red5/server/api/statistics/ISharedObjectStatistics.java @@ -9,7 +9,7 @@ /** * Statistics informations about a shared object. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ @@ -17,20 +17,20 @@ public interface ISharedObjectStatistics extends IStatisticsBase { /** * Return the name of the shared object. - * + * * @return the name of the shared object */ public String getName(); /** * Check if the shared object is persistent. - * + * * @return
      * True
      * 
- * + * * if the shared object is persistent, otherwise - * + * *
      * False
      * 
@@ -39,49 +39,49 @@ public interface ISharedObjectStatistics extends IStatisticsBase { /** * Return the version number of the shared object. - * + * * @return the version */ public int getVersion(); /** * Return total number of subscribed listeners. - * + * * @return number of listeners */ public int getTotalListeners(); /** * Return maximum number of concurrent subscribed listenes. - * + * * @return number of listeners */ public int getMaxListeners(); /** * Return current number of subscribed listeners. - * + * * @return number of listeners */ public int getActiveListeners(); /** * Return number of attribute changes. - * + * * @return number of changes */ public int getTotalChanges(); /** * Return number of attribute deletes. - * + * * @return number of deletes */ public int getTotalDeletes(); /** * Return number of times a message was sent. - * + * * @return number of sends */ public int getTotalSends(); diff --git a/common/src/main/java/org/red5/server/api/statistics/IStatisticsBase.java b/common/src/main/java/org/red5/server/api/statistics/IStatisticsBase.java index 3c2b3ae2a..cdf931861 100644 --- a/common/src/main/java/org/red5/server/api/statistics/IStatisticsBase.java +++ b/common/src/main/java/org/red5/server/api/statistics/IStatisticsBase.java @@ -9,7 +9,7 @@ /** * Base class for all statistics informations. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ @@ -17,7 +17,7 @@ public interface IStatisticsBase { /** * Return the timestamp the object was created. - * + * * @return the timestamp in milliseconds since midnight, January 1, 1970 UTC. */ public long getCreationTime(); diff --git a/common/src/main/java/org/red5/server/api/statistics/IStreamStatistics.java b/common/src/main/java/org/red5/server/api/statistics/IStreamStatistics.java index 030668092..f1f581124 100644 --- a/common/src/main/java/org/red5/server/api/statistics/IStreamStatistics.java +++ b/common/src/main/java/org/red5/server/api/statistics/IStreamStatistics.java @@ -9,7 +9,7 @@ /** * Base class for all stream statistics. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ @@ -17,7 +17,7 @@ public interface IStreamStatistics extends IStatisticsBase { /** * Return the currently active timestamp inside the stream. - * + * * @return the timestamp in milliseconds */ public int getCurrentTimestamp(); diff --git a/common/src/main/java/org/red5/server/api/statistics/support/StatisticsCounter.java b/common/src/main/java/org/red5/server/api/statistics/support/StatisticsCounter.java index 2d4ec4de0..4b7915fe4 100644 --- a/common/src/main/java/org/red5/server/api/statistics/support/StatisticsCounter.java +++ b/common/src/main/java/org/red5/server/api/statistics/support/StatisticsCounter.java @@ -11,7 +11,7 @@ /** * Counts numbers used by the statistics. Keeps track of current and total numbers. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ @@ -43,7 +43,7 @@ public void decrement() { /** * Get current number. - * + * * @return current number */ public int getCurrent() { @@ -52,7 +52,7 @@ public int getCurrent() { /** * Get total number. - * + * * @return total */ public int getTotal() { @@ -61,7 +61,7 @@ public int getTotal() { /** * Get maximum number. Use total instead. - * + * * @return max */ public int getMax() { diff --git a/common/src/main/java/org/red5/server/api/stream/IBroadcastStream.java b/common/src/main/java/org/red5/server/api/stream/IBroadcastStream.java index 95e5c2505..dd5973c34 100644 --- a/common/src/main/java/org/red5/server/api/stream/IBroadcastStream.java +++ b/common/src/main/java/org/red5/server/api/stream/IBroadcastStream.java @@ -15,8 +15,8 @@ /** * A broadcast stream is a stream source to be subscribed to by clients. To subscribe to a stream from your client Flash application use NetStream.play method. Broadcast stream can be saved at the server-side. - * - * + * + * * @author The Red5 Project * @author Luke Hubbard (luke@codegent.com) * @author Steven Gong (steven.gong@gmail.com) @@ -25,7 +25,7 @@ public interface IBroadcastStream extends IStream { /** * Save the broadcast stream as a file. - * + * * @param filePath * The path of the file relative to the scope. * @param isAppend @@ -41,39 +41,39 @@ public interface IBroadcastStream extends IStream { /** * Get the filename the stream is being saved as. - * + * * @return The filename relative to the scope or - * + * *
      * null
      * 
- * + * * if the stream is not being saved. */ String getSaveFilename(); /** * Get the provider corresponding to this stream. Provider objects are object that - * + * * @return the provider */ IProvider getProvider(); /** * Get stream publish name. Publish name is the value of the first parameter had been passed to - * + * *
      * NetStream.publish
      * 
- * + * * on client side in SWF. - * + * * @return Stream publish name */ String getPublishedName(); /** - * + * * @param name * Set stream publish name */ @@ -81,7 +81,7 @@ public interface IBroadcastStream extends IStream { /** * Add a listener to be notified about received packets. - * + * * @param listener * the listener to add */ @@ -89,7 +89,7 @@ public interface IBroadcastStream extends IStream { /** * Remove a listener from being notified about received packets. - * + * * @param listener * the listener to remove */ @@ -97,14 +97,14 @@ public interface IBroadcastStream extends IStream { /** * Return registered stream listeners. - * + * * @return the registered listeners */ public Collection getStreamListeners(); /** * Returns the metadata for the associated stream, if it exists. - * + * * @return stream meta data */ public Notify getMetaData(); diff --git a/common/src/main/java/org/red5/server/api/stream/IClientBroadcastStream.java b/common/src/main/java/org/red5/server/api/stream/IClientBroadcastStream.java index 10c428192..df5c0e951 100644 --- a/common/src/main/java/org/red5/server/api/stream/IClientBroadcastStream.java +++ b/common/src/main/java/org/red5/server/api/stream/IClientBroadcastStream.java @@ -14,7 +14,7 @@ /** * A broadcast stream that comes from client. - * + * * @author The Red5 Project * @author Steven Gong (steven.gong@gmail.com) * @author Paul Gregoire (mondain@gmail.com) @@ -28,14 +28,14 @@ public interface IClientBroadcastStream extends IClientStream, IBroadcastStream /** * Return statistics about the stream. - * + * * @return statistics */ IClientBroadcastStreamStatistics getStatistics(); /** * Sets streaming parameters as supplied by the publishing application. - * + * * @param params * parameter map */ @@ -43,14 +43,14 @@ public interface IClientBroadcastStream extends IClientStream, IBroadcastStream /** * Returns streaming parameters. - * + * * @return parameters */ Map getParameters(); /** * Adds a stream name subscribe-side alias. - * + * * @param alias * @return true if added to the aliases, false otherwise */ @@ -58,21 +58,21 @@ public interface IClientBroadcastStream extends IClientStream, IBroadcastStream /** * Returns whether or not an subscribe-side alias for this stream exists. - * + * * @return true if an alias has been added and false otherwise */ boolean hasAlias(); /** * Returns an subscribe-side alias. - * + * * @return alias if at least one exists or null when there are none */ String getAlias(); /** * Returns whether or not a given subscribe-side alias exists. - * + * * @param alias * @return true if found and false otherwise */ @@ -80,21 +80,21 @@ public interface IClientBroadcastStream extends IClientStream, IBroadcastStream /** * Returns all the subscribe-side aliases. - * + * * @return all aliases for this instance or an empty set */ Set getAliases(); /** * Sets the publish-side alias for the streams name. Subsequent calls will replace an existing alias if already set. - * + * * @param nameAlias alias to set for the streams name or null to clear it */ void setNameAlias(String nameAlias); /** * Returns the publish-side alias, if configured. - * + * * @return alias for the streams name or null if not set */ String getNameAlias(); @@ -102,7 +102,7 @@ public interface IClientBroadcastStream extends IClientStream, IBroadcastStream /** * Returns whether or not an alias is in-use / registered already; this includes both publish and subscribe aliases * within a server instance. - * + * * @param alias the name to check against publish and subscribe aliases * @return true if registered and false otherwise */ diff --git a/common/src/main/java/org/red5/server/api/stream/IClientStream.java b/common/src/main/java/org/red5/server/api/stream/IClientStream.java index 4697301a3..ab736a4b8 100644 --- a/common/src/main/java/org/red5/server/api/stream/IClientStream.java +++ b/common/src/main/java/org/red5/server/api/stream/IClientStream.java @@ -9,7 +9,7 @@ /** * A stream that is bound to a client. - * + * * @author The Red5 Project * @author Steven Gong (steven.gong@gmail.com) */ @@ -27,28 +27,28 @@ public interface IClientStream extends IStream { /** * Get stream id allocated in a connection. - * + * * @return the stream id */ Number getStreamId(); /** * Get connection containing the stream. - * + * * @return the connection object or null if the connection is no longer active */ IStreamCapableConnection getConnection(); /** * Set the buffer duration for this stream as requested by the client. - * + * * @param bufferTime duration in ms the client wants to buffer */ void setClientBufferDuration(int bufferTime); /** * Get the buffer duration for this stream as requested by the client. - * + * * @return bufferTime duration in ms the client wants to buffer */ int getClientBufferDuration(); @@ -62,7 +62,7 @@ public interface IClientStream extends IStream { /** * Returns the published stream name that this client is consuming. - * + * * @return stream name of stream being consumed */ String getBroadcastStreamPublishName(); diff --git a/common/src/main/java/org/red5/server/api/stream/IOnDemandStream.java b/common/src/main/java/org/red5/server/api/stream/IOnDemandStream.java index 4ae71f058..5f8a7e57e 100644 --- a/common/src/main/java/org/red5/server/api/stream/IOnDemandStream.java +++ b/common/src/main/java/org/red5/server/api/stream/IOnDemandStream.java @@ -9,7 +9,7 @@ /** * Extends stream to add methods for on demand access. - * + * * @author The Red5 Project * @author Luke Hubbard (luke@codegent.com) */ @@ -22,7 +22,7 @@ public interface IOnDemandStream extends IStream { /** * Start playback with a given maximum duration. - * + * * @param length * maximum duration in milliseconds */ @@ -30,7 +30,7 @@ public interface IOnDemandStream extends IStream { /** * Seek to the keyframe nearest to position - * + * * @param position * position in milliseconds */ @@ -53,21 +53,21 @@ public interface IOnDemandStream extends IStream { /** * Is the stream paused - * + * * @return true if the stream is paused */ public boolean isPaused(); /** * Is the stream stopped - * + * * @return true if the stream is stopped */ public boolean isStopped(); /** * Is the stream playing - * + * * @return true if the stream is playing */ public boolean isPlaying(); diff --git a/common/src/main/java/org/red5/server/api/stream/IPlayItem.java b/common/src/main/java/org/red5/server/api/stream/IPlayItem.java index 4a9aa9b0f..fbdeffa65 100644 --- a/common/src/main/java/org/red5/server/api/stream/IPlayItem.java +++ b/common/src/main/java/org/red5/server/api/stream/IPlayItem.java @@ -16,28 +16,28 @@ public interface IPlayItem { /** * Get name of item. The VOD or Live stream provider is found according to this name. - * + * * @return the name */ String getName(); /** * Start time in milliseconds. - * + * * @return start time */ long getStart(); /** * Play length in milliseconds. - * + * * @return length in milliseconds */ long getLength(); /** * Get a message input for play. This object overrides the default algorithm for finding the appropriate VOD or Live stream provider according to the item name. - * + * * @return message input */ IMessageInput getMessageInput(); diff --git a/common/src/main/java/org/red5/server/api/stream/IPlaylist.java b/common/src/main/java/org/red5/server/api/stream/IPlaylist.java index be58fba13..96699d8ac 100644 --- a/common/src/main/java/org/red5/server/api/stream/IPlaylist.java +++ b/common/src/main/java/org/red5/server/api/stream/IPlaylist.java @@ -13,7 +13,7 @@ public interface IPlaylist { /** * Add an item to the list. - * + * * @param item * Playlist item */ @@ -21,7 +21,7 @@ public interface IPlaylist { /** * Add an item to specific index. - * + * * @param item * Playlist item * @param index @@ -31,7 +31,7 @@ public interface IPlaylist { /** * Remove an item from list. - * + * * @param index * Index in list */ @@ -51,21 +51,21 @@ public interface IPlaylist { /** * Get currently playing item index. - * + * * @return Currently playing item index. */ int getCurrentItemIndex(); /** * Get currently playing item - * + * * @return Item */ IPlayItem getCurrentItem(); /** * Get the item according to the index. - * + * * @param index * Item index * @return Item at that index in list @@ -74,17 +74,17 @@ public interface IPlaylist { /** * Check if the playlist has more items after the currently playing one. - * + * * @return
      * true
      * 
- * + * * if more items are available, - * + * *
      * false
      * 
- * + * * otherwise */ boolean hasMoreItems(); @@ -101,7 +101,7 @@ public interface IPlaylist { /** * Set the current item for playing. - * + * * @param index * Position in list */ @@ -109,24 +109,24 @@ public interface IPlaylist { /** * Whether items are randomly played. - * + * * @return
      * true
      * 
- * + * * if shuffle is on for this list, - * + * *
      * false
      * 
- * + * * otherwise */ boolean isRandom(); /** * Set whether items should be randomly played. - * + * * @param random * Shuffle flag */ @@ -134,24 +134,24 @@ public interface IPlaylist { /** * Whether rewind the list. - * + * * @return
      * true
      * 
- * + * * if playlist is rewind on end, - * + * *
      * false
      * 
- * + * * otherwise */ boolean isRewind(); /** * Set whether rewind the list. - * + * * @param rewind * New vallue for rewind flag */ @@ -159,24 +159,24 @@ public interface IPlaylist { /** * Whether repeat playing an item. - * + * * @return
      * true
      * 
- * + * * if repeat mode is on for this playlist, - * + * *
      * false
      * 
- * + * * otherwise */ boolean isRepeat(); /** * Set whether repeat playing an item. - * + * * @param repeat * New value for item playback repeat flag */ @@ -184,7 +184,7 @@ public interface IPlaylist { /** * Set list controller. - * + * * @param controller * Playlist controller */ diff --git a/common/src/main/java/org/red5/server/api/stream/IPlaylistController.java b/common/src/main/java/org/red5/server/api/stream/IPlaylistController.java index 75fc1dd97..6f7bd16d4 100644 --- a/common/src/main/java/org/red5/server/api/stream/IPlaylistController.java +++ b/common/src/main/java/org/red5/server/api/stream/IPlaylistController.java @@ -9,14 +9,14 @@ /** * A play list controller that controls the order of play items. - * + * * @author The Red5 Project * @author Steven Gong (steven.gong@gmail.com) */ public interface IPlaylistController { /** * Get next item to play. - * + * * @param playlist * The related play list. * @param itemIndex @@ -27,7 +27,7 @@ public interface IPlaylistController { /** * Get previous item to play. - * + * * @param playlist * The related play list. * @param itemIndex diff --git a/common/src/main/java/org/red5/server/api/stream/IPlaylistSubscriberStream.java b/common/src/main/java/org/red5/server/api/stream/IPlaylistSubscriberStream.java index 41ff80fbb..d5e32020d 100644 --- a/common/src/main/java/org/red5/server/api/stream/IPlaylistSubscriberStream.java +++ b/common/src/main/java/org/red5/server/api/stream/IPlaylistSubscriberStream.java @@ -16,14 +16,14 @@ public interface IPlaylistSubscriberStream extends ISubscriberStream, IPlaylist /** * Return statistics about this stream. - * + * * @return statistics */ public IPlaylistSubscriberStreamStatistics getStatistics(); /** * Handles a change occurring on the stream. - * + * * @param state * stream state that we are changing to or notifying of * @param changed @@ -33,7 +33,7 @@ public interface IPlaylistSubscriberStream extends ISubscriberStream, IPlaylist /** * Replaces an item in the list with another item. - * + * * @param oldItem * old play item * @param newItem diff --git a/common/src/main/java/org/red5/server/api/stream/IRtmpSampleAccess.java b/common/src/main/java/org/red5/server/api/stream/IRtmpSampleAccess.java index c1089f82e..1b89057ac 100644 --- a/common/src/main/java/org/red5/server/api/stream/IRtmpSampleAccess.java +++ b/common/src/main/java/org/red5/server/api/stream/IRtmpSampleAccess.java @@ -15,7 +15,7 @@ public interface IRtmpSampleAccess { /** * Return true if sample access allowed on audio stream. - * + * * @param scope * scope * @return true if sample access allowed on audio stream @@ -24,7 +24,7 @@ public interface IRtmpSampleAccess { /** * Return true if sample access allowed on video stream. - * + * * @param scope * scope * @return true if sample access allowed on video stream diff --git a/common/src/main/java/org/red5/server/api/stream/ISingleItemSubscriberStream.java b/common/src/main/java/org/red5/server/api/stream/ISingleItemSubscriberStream.java index 6e5db5644..0b206014e 100644 --- a/common/src/main/java/org/red5/server/api/stream/ISingleItemSubscriberStream.java +++ b/common/src/main/java/org/red5/server/api/stream/ISingleItemSubscriberStream.java @@ -9,7 +9,7 @@ /** * A subscriber stream that has only one item for play. - * + * * @author The Red5 Project * @author Steven Gong (steven.gong@gmail.com) */ diff --git a/common/src/main/java/org/red5/server/api/stream/IStream.java b/common/src/main/java/org/red5/server/api/stream/IStream.java index 0f119d34f..ba5c0d93b 100644 --- a/common/src/main/java/org/red5/server/api/stream/IStream.java +++ b/common/src/main/java/org/red5/server/api/stream/IStream.java @@ -17,21 +17,21 @@ public interface IStream { /** * Get the name of the stream. The name is unique across the server. This is just an id of the stream and NOT the name that is used at client side to subscribe to the stream. For that name, use {@link IBroadcastStream#getPublishedName()} - * + * * @return the name of the stream */ public String getName(); /** * Get Codec info for a stream. - * + * * @return codec info */ IStreamCodecInfo getCodecInfo(); /** * Get the scope this stream is associated with. - * + * * @return scope object */ public IScope getScope(); @@ -53,14 +53,14 @@ public interface IStream { /** * Returns the timestamp at which the stream was created. - * + * * @return creation timestamp */ public long getCreationTime(); /** * Returns the timestamp at which the stream was started. - * + * * @return started timestamp */ long getStartTime(); diff --git a/common/src/main/java/org/red5/server/api/stream/IStreamAwareScopeHandler.java b/common/src/main/java/org/red5/server/api/stream/IStreamAwareScopeHandler.java index cf4394ead..976b93b70 100644 --- a/common/src/main/java/org/red5/server/api/stream/IStreamAwareScopeHandler.java +++ b/common/src/main/java/org/red5/server/api/stream/IStreamAwareScopeHandler.java @@ -11,14 +11,14 @@ /** * A scope handler that is stream aware. - * + * * @author The Red5 Project * @author Steven Gong (steven.gong@gmail.com) */ public interface IStreamAwareScopeHandler extends IScopeHandler { /** * A broadcast stream starts being published. This will be called when the first video packet has been received. - * + * * @param stream * stream */ @@ -26,7 +26,7 @@ public interface IStreamAwareScopeHandler extends IScopeHandler { /** * A broadcast stream starts being recorded. This will be called when the first video packet has been received. - * + * * @param stream * stream */ @@ -42,7 +42,7 @@ public interface IStreamAwareScopeHandler extends IScopeHandler { /** * Notified when a broadcaster starts. - * + * * @param stream * stream */ @@ -50,7 +50,7 @@ public interface IStreamAwareScopeHandler extends IScopeHandler { /** * Notified when a broadcaster closes. - * + * * @param stream * stream */ @@ -58,7 +58,7 @@ public interface IStreamAwareScopeHandler extends IScopeHandler { /** * Notified when a subscriber starts. - * + * * @param stream * stream */ @@ -66,7 +66,7 @@ public interface IStreamAwareScopeHandler extends IScopeHandler { /** * Notified when a subscriber closes. - * + * * @param stream * stream */ @@ -74,7 +74,7 @@ public interface IStreamAwareScopeHandler extends IScopeHandler { /** * Notified when a play item plays. - * + * * @param stream * stream * @param item @@ -86,7 +86,7 @@ public interface IStreamAwareScopeHandler extends IScopeHandler { /** * Notified when a play item stops. - * + * * @param stream * stream * @param item @@ -96,7 +96,7 @@ public interface IStreamAwareScopeHandler extends IScopeHandler { /** * Notified when a play item pauses. - * + * * @param stream * stream * @param item @@ -108,7 +108,7 @@ public interface IStreamAwareScopeHandler extends IScopeHandler { /** * Notified when a play item resumes. - * + * * @param stream * stream * @param item @@ -120,7 +120,7 @@ public interface IStreamAwareScopeHandler extends IScopeHandler { /** * Notified when a play item seeks. - * + * * @param stream * stream * @param item diff --git a/common/src/main/java/org/red5/server/api/stream/IStreamCapableConnection.java b/common/src/main/java/org/red5/server/api/stream/IStreamCapableConnection.java index 8f946faac..3fb1ab4fb 100644 --- a/common/src/main/java/org/red5/server/api/stream/IStreamCapableConnection.java +++ b/common/src/main/java/org/red5/server/api/stream/IStreamCapableConnection.java @@ -13,7 +13,7 @@ /** * A connection that supports streaming. - * + * * @author The Red5 Project * @author Luke Hubbard (luke@codegent.com) * @author Steven Gong (steven.gong@gmail.com) @@ -22,7 +22,7 @@ public interface IStreamCapableConnection extends IConnection { /** * Return a reserved stream id for use. According to FCS/FMS regulation, the base is 1. - * + * * @return Reserved stream id * @throws IndexOutOfBoundsException * when it is impossible to reserve new stream @@ -31,7 +31,7 @@ public interface IStreamCapableConnection extends IConnection { /** * Return a reserved stream id for use with a preference for the one supplied. - * + * * @param streamId * supplied stream id * @return Reserved stream id @@ -42,7 +42,7 @@ public interface IStreamCapableConnection extends IConnection { /** * Unreserve this id for future use. - * + * * @param streamId * ID of stream to unreserve */ @@ -50,7 +50,7 @@ public interface IStreamCapableConnection extends IConnection { /** * Deletes the stream with the given id. - * + * * @param streamId * ID of stream to delete */ @@ -58,7 +58,7 @@ public interface IStreamCapableConnection extends IConnection { /** * Get a stream by its id. - * + * * @param streamId * Stream id * @return Stream with given id @@ -67,7 +67,7 @@ public interface IStreamCapableConnection extends IConnection { /** * Create a stream that can play only one item. - * + * * @param streamId * Stream id * @return New subscriber stream that can play only one item @@ -76,7 +76,7 @@ public interface IStreamCapableConnection extends IConnection { /** * Create a stream that can play a list. - * + * * @param streamId * Stream id * @return New stream that can play sequence of items @@ -85,7 +85,7 @@ public interface IStreamCapableConnection extends IConnection { /** * Create a broadcast stream. - * + * * @param streamId * Stream id * @return New broadcast stream diff --git a/common/src/main/java/org/red5/server/api/stream/IStreamFilenameGenerator.java b/common/src/main/java/org/red5/server/api/stream/IStreamFilenameGenerator.java index 48e58363f..de151ec76 100644 --- a/common/src/main/java/org/red5/server/api/stream/IStreamFilenameGenerator.java +++ b/common/src/main/java/org/red5/server/api/stream/IStreamFilenameGenerator.java @@ -12,7 +12,7 @@ /** * A class that can generate filenames for streams. - * + * * @author The Red5 Project * @author Joachim Bauch (bauch@struktur.de) */ @@ -28,7 +28,7 @@ public static enum GenerationType { /** * Generate a filename without an extension. - * + * * @param scope * Scope to use * @param name @@ -56,21 +56,21 @@ public static enum GenerationType { /** * True if returned filename is an absolute path, else relative to application. - * + * * If relative to application, you need to use - * + * *
      * scope.getContext().getResources(fileName)[0].getFile()
      * 
- * + * * to resolve this to a file. - * + * * If absolute (ie returns true) simply use - * + * *
      * new File(generateFilename(scope, name))
      * 
- * + * * @return true if an absolute path; else false */ public boolean resolvesToAbsolutePath(); diff --git a/common/src/main/java/org/red5/server/api/stream/IStreamListener.java b/common/src/main/java/org/red5/server/api/stream/IStreamListener.java index e1a536cf2..3aa65267c 100644 --- a/common/src/main/java/org/red5/server/api/stream/IStreamListener.java +++ b/common/src/main/java/org/red5/server/api/stream/IStreamListener.java @@ -9,7 +9,7 @@ /** * Listener that is notified about packets received from a stream. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ @@ -17,7 +17,7 @@ public interface IStreamListener { /** * A packet has been received from a stream. - * + * * @param stream * the stream the packet has been received for * @param packet diff --git a/common/src/main/java/org/red5/server/api/stream/IStreamPacket.java b/common/src/main/java/org/red5/server/api/stream/IStreamPacket.java index 4e89fae42..1677c7c0e 100644 --- a/common/src/main/java/org/red5/server/api/stream/IStreamPacket.java +++ b/common/src/main/java/org/red5/server/api/stream/IStreamPacket.java @@ -11,7 +11,7 @@ /** * Packet containing stream data. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ @@ -19,27 +19,27 @@ public interface IStreamPacket { /** * Type of this packet. This is one of the - * + * *
      * TYPE_
      * 
- * + * * constants. - * + * * @return the type */ public byte getDataType(); /** * Timestamp of this packet. - * + * * @return the timestamp in milliseconds */ public int getTimestamp(); /** * Packet contents. - * + * * @return the contents */ public IoBuffer getData(); diff --git a/common/src/main/java/org/red5/server/api/stream/IStreamPlaybackSecurity.java b/common/src/main/java/org/red5/server/api/stream/IStreamPlaybackSecurity.java index f8add3d2a..5dc2550c3 100644 --- a/common/src/main/java/org/red5/server/api/stream/IStreamPlaybackSecurity.java +++ b/common/src/main/java/org/red5/server/api/stream/IStreamPlaybackSecurity.java @@ -11,7 +11,7 @@ /** * Interface for handlers that control access to stream playback. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ @@ -19,7 +19,7 @@ public interface IStreamPlaybackSecurity { /** * Check if playback of a stream with the given name is allowed. - * + * * @param scope * Scope the stream is about to be played back from. * @param name @@ -33,9 +33,9 @@ public interface IStreamPlaybackSecurity { * @return
      * True
      * 
- * + * * if playback is allowed, otherwise - * + * *
      * False
      * 
diff --git a/common/src/main/java/org/red5/server/api/stream/IStreamPublishSecurity.java b/common/src/main/java/org/red5/server/api/stream/IStreamPublishSecurity.java index 3392e3dfb..780820a6e 100644 --- a/common/src/main/java/org/red5/server/api/stream/IStreamPublishSecurity.java +++ b/common/src/main/java/org/red5/server/api/stream/IStreamPublishSecurity.java @@ -11,7 +11,7 @@ /** * Interface for handlers that control access to stream publishing. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ @@ -19,7 +19,7 @@ public interface IStreamPublishSecurity { /** * Check if publishing a stream with the given name is allowed. - * + * * @param scope * Scope the stream is about to be published in. * @param name @@ -29,9 +29,9 @@ public interface IStreamPublishSecurity { * @return
      * True
      * 
- * + * * if publishing is allowed, otherwise - * + * *
      * False
      * 
diff --git a/common/src/main/java/org/red5/server/api/stream/IStreamService.java b/common/src/main/java/org/red5/server/api/stream/IStreamService.java index a607e8553..c919e8fb2 100644 --- a/common/src/main/java/org/red5/server/api/stream/IStreamService.java +++ b/common/src/main/java/org/red5/server/api/stream/IStreamService.java @@ -19,14 +19,14 @@ public interface IStreamService extends IScopeService { /** * Create a stream and return a corresponding id. - * + * * @return ID of created stream */ public Number createStream(); /** * Create a stream and return a corresponding id. - * + * * @param streamId * Stream id * @return ID of created stream @@ -35,7 +35,7 @@ public interface IStreamService extends IScopeService { /** * Close the stream but not deallocate the resources. - * + * * @param connection * Connection * @param streamId @@ -45,7 +45,7 @@ public interface IStreamService extends IScopeService { /** * Close the stream if not been closed. Deallocate the related resources. - * + * * @param streamId * Stream id */ @@ -53,7 +53,7 @@ public interface IStreamService extends IScopeService { /** * Called by FMS. - * + * * @param streamId * Stream id */ @@ -61,7 +61,7 @@ public interface IStreamService extends IScopeService { /** * Called by FMS. - * + * * @param streamId * Stream id * @param idk @@ -71,7 +71,7 @@ public interface IStreamService extends IScopeService { /** * Called by FME. - * + * * @param streamName * stream name */ @@ -79,7 +79,7 @@ public interface IStreamService extends IScopeService { /** * Delete stream - * + * * @param conn * Stream capable connection * @param streamId @@ -89,7 +89,7 @@ public interface IStreamService extends IScopeService { /** * Play stream without initial stop - * + * * @param dontStop * Stoppage flag */ @@ -97,7 +97,7 @@ public interface IStreamService extends IScopeService { /** * Play stream with name - * + * * @param name * Stream name */ @@ -105,7 +105,7 @@ public interface IStreamService extends IScopeService { /** * Play stream with name from start position - * + * * @param name * Stream name * @param start @@ -115,7 +115,7 @@ public interface IStreamService extends IScopeService { /** * Play stream with name from start position and for given amount if time - * + * * @param name * Stream name * @param start @@ -127,7 +127,7 @@ public interface IStreamService extends IScopeService { /** * Publishes stream from given position for given amount of time - * + * * @param name * Stream published name * @param start @@ -141,7 +141,7 @@ public interface IStreamService extends IScopeService { /** * Publishes stream with given name - * + * * @param name * Stream published name */ @@ -149,7 +149,7 @@ public interface IStreamService extends IScopeService { /** * Publishes stream with given name and mode - * + * * @param name * Stream published name * @param mode @@ -159,7 +159,7 @@ public interface IStreamService extends IScopeService { /** * Publish - * + * * @param dontStop * Whether need to stop first */ @@ -167,7 +167,7 @@ public interface IStreamService extends IScopeService { /** * Seek to position - * + * * @param position * Seek position */ @@ -175,7 +175,7 @@ public interface IStreamService extends IScopeService { /** * Pauses playback - * + * * @param pausePlayback * Pause or resume flash * @param position @@ -185,7 +185,7 @@ public interface IStreamService extends IScopeService { /** * Undocumented Flash Plugin 10 call, assuming to be the alias to pause(boolean, int) - * + * * @param pausePlayback * Pause or resume flash * @param position @@ -195,7 +195,7 @@ public interface IStreamService extends IScopeService { /** * Can recieve video? - * + * * @param receive * Boolean flag */ @@ -203,7 +203,7 @@ public interface IStreamService extends IScopeService { /** * Can recieve audio? - * + * * @param receive * Boolean flag */ diff --git a/common/src/main/java/org/red5/server/api/stream/ISubscriberStream.java b/common/src/main/java/org/red5/server/api/stream/ISubscriberStream.java index aa5ed2e46..c496564e9 100644 --- a/common/src/main/java/org/red5/server/api/stream/ISubscriberStream.java +++ b/common/src/main/java/org/red5/server/api/stream/ISubscriberStream.java @@ -17,7 +17,7 @@ public interface ISubscriberStream extends IClientStream { /** * Start playing. - * + * * @throws IOException * if an IO error occurred while starting to play the stream */ @@ -25,7 +25,7 @@ public interface ISubscriberStream extends IClientStream { /** * Pause at a position for current playing item. - * + * * @param position * Position for pause in millisecond. */ @@ -33,7 +33,7 @@ public interface ISubscriberStream extends IClientStream { /** * Resume from a position for current playing item. - * + * * @param position * Position for resume in millisecond. */ @@ -46,7 +46,7 @@ public interface ISubscriberStream extends IClientStream { /** * Seek into a position for current playing item. - * + * * @param position * Position for seek in millisecond. * @throws OperationNotSupportedException @@ -56,14 +56,14 @@ public interface ISubscriberStream extends IClientStream { /** * Check if the stream is currently paused. - * + * * @return stream is paused */ boolean isPaused(); /** * Should the stream send video to the client? - * + * * @param receive * toggle */ @@ -71,7 +71,7 @@ public interface ISubscriberStream extends IClientStream { /** * Should the stream send audio to the client? - * + * * @param receive * toggle */ @@ -79,14 +79,14 @@ public interface ISubscriberStream extends IClientStream { /** * Return the streams state enum. - * + * * @return current state */ public StreamState getState(); /** * Sets the streams state enum. - * + * * @param state * sets current state */ @@ -94,7 +94,7 @@ public interface ISubscriberStream extends IClientStream { /** * Notification of state change and associated parameters. - * + * * @param state * new state * @param changed @@ -104,7 +104,7 @@ public interface ISubscriberStream extends IClientStream { /** * Schedule a job to be executed only once after a 10ms delay. - * + * * @param job * scheduled job * @return jobName @@ -113,7 +113,7 @@ public interface ISubscriberStream extends IClientStream { /** * Schedule a job to be executed regularly at the given interval. - * + * * @param job * scheduled job * @param interval @@ -124,7 +124,7 @@ public interface ISubscriberStream extends IClientStream { /** * Cancels a scheduled job by name. - * + * * @param jobName * job name */ diff --git a/common/src/main/java/org/red5/server/api/stream/OperationNotSupportedException.java b/common/src/main/java/org/red5/server/api/stream/OperationNotSupportedException.java index 7c51b4e29..f84fb5ee1 100644 --- a/common/src/main/java/org/red5/server/api/stream/OperationNotSupportedException.java +++ b/common/src/main/java/org/red5/server/api/stream/OperationNotSupportedException.java @@ -9,12 +9,12 @@ /** * The requested operation is not supported by the stream. - * + * */ public class OperationNotSupportedException extends Exception { /** - * + * */ private static final long serialVersionUID = -6166602683688991431L; diff --git a/common/src/main/java/org/red5/server/api/stream/StreamState.java b/common/src/main/java/org/red5/server/api/stream/StreamState.java index 80a713b87..5746095e1 100644 --- a/common/src/main/java/org/red5/server/api/stream/StreamState.java +++ b/common/src/main/java/org/red5/server/api/stream/StreamState.java @@ -9,7 +9,7 @@ /** * Represents all the states that a stream may be in at a requested point in time. - * + * * @author Paul Gregoire (mondain@gmail.com) */ public enum StreamState { diff --git a/common/src/main/java/org/red5/server/api/stream/support/DynamicPlayItem.java b/common/src/main/java/org/red5/server/api/stream/support/DynamicPlayItem.java index 66bd62845..ca4502130 100644 --- a/common/src/main/java/org/red5/server/api/stream/support/DynamicPlayItem.java +++ b/common/src/main/java/org/red5/server/api/stream/support/DynamicPlayItem.java @@ -60,7 +60,7 @@ private DynamicPlayItem(String name, long start, long length, double offset) { /** * Returns play item length in milliseconds - * + * * @return Play item length in milliseconds */ public long getLength() { @@ -69,7 +69,7 @@ public long getLength() { /** * Returns IMessageInput object. IMessageInput is an endpoint for a consumer to connect. - * + * * @return IMessageInput object */ public IMessageInput getMessageInput() { @@ -78,7 +78,7 @@ public IMessageInput getMessageInput() { /** * Returns item name - * + * * @return item name */ public String getName() { @@ -94,7 +94,7 @@ public long getStart() { /** * Alias for getMessageInput - * + * * @return Message input source */ public IMessageInput getMsgInput() { @@ -113,7 +113,7 @@ public void setMsgInput(IMessageInput msgInput) { /** * Returns size in bytes - * + * * @return size */ public long getSize() { @@ -122,7 +122,7 @@ public long getSize() { /** * Set the size in bytes - * + * * @param size * size in bytes */ @@ -163,7 +163,7 @@ public boolean equals(Object obj) { /** * Builder for DynamicPlayItem - * + * * @param name * name * @param start @@ -179,7 +179,7 @@ public static DynamicPlayItem build(String name, long start, long length) { /** * Builder for DynamicPlayItem - * + * * @param name * name * @param start diff --git a/common/src/main/java/org/red5/server/api/stream/support/SimplePlayItem.java b/common/src/main/java/org/red5/server/api/stream/support/SimplePlayItem.java index 1cae7a773..acd9c1e0f 100644 --- a/common/src/main/java/org/red5/server/api/stream/support/SimplePlayItem.java +++ b/common/src/main/java/org/red5/server/api/stream/support/SimplePlayItem.java @@ -51,7 +51,7 @@ private SimplePlayItem(String name, long start, long length) { /** * Returns play item length in milliseconds - * + * * @return Play item length in milliseconds */ public long getLength() { @@ -60,7 +60,7 @@ public long getLength() { /** * Returns IMessageInput object. IMessageInput is an endpoint for a consumer to connect. - * + * * @return IMessageInput object */ public IMessageInput getMessageInput() { @@ -69,7 +69,7 @@ public IMessageInput getMessageInput() { /** * Returns item name - * + * * @return item name */ public String getName() { @@ -85,7 +85,7 @@ public long getStart() { /** * Alias for getMessageInput - * + * * @return Message input source */ public IMessageInput getMsgInput() { @@ -157,7 +157,7 @@ public int compareTo(SimplePlayItem that) { /** * Builder for SimplePlayItem - * + * * @param name * name * @return play item instance @@ -169,7 +169,7 @@ public static SimplePlayItem build(String name) { /** * Builder for SimplePlayItem - * + * * @param name * name * @param start diff --git a/common/src/main/java/org/red5/server/exception/ClientDetailsException.java b/common/src/main/java/org/red5/server/exception/ClientDetailsException.java index 941c9cf43..5af065a21 100644 --- a/common/src/main/java/org/red5/server/exception/ClientDetailsException.java +++ b/common/src/main/java/org/red5/server/exception/ClientDetailsException.java @@ -9,7 +9,7 @@ /** * Exception class than contains additional parameters to return to the client. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ @@ -29,7 +29,7 @@ public class ClientDetailsException extends RuntimeException { /** * Create new exception object from message and parameters. By default, no stacktrace is returned to the client. - * + * * @param message * message * @param params @@ -41,7 +41,7 @@ public ClientDetailsException(String message, Object params) { /** * Create new exception object from message and parameters with optional stacktrace. - * + * * @param message * message * @param params @@ -57,7 +57,7 @@ public ClientDetailsException(String message, Object params, boolean includeStac /** * Get parameters to return to the client. - * + * * @return parameters */ public Object getParameters() { @@ -66,7 +66,7 @@ public Object getParameters() { /** * Should the stacktrace returned to the client? - * + * * @return stacktrace */ public boolean includeStacktrace() { diff --git a/common/src/main/java/org/red5/server/exception/ClientNotFoundException.java b/common/src/main/java/org/red5/server/exception/ClientNotFoundException.java index 7a737b069..ea35da5b4 100644 --- a/common/src/main/java/org/red5/server/exception/ClientNotFoundException.java +++ b/common/src/main/java/org/red5/server/exception/ClientNotFoundException.java @@ -13,13 +13,13 @@ public class ClientNotFoundException extends RuntimeException { /** - * + * */ private static final long serialVersionUID = 3135070223941800751L; /** * Create exception from given string message - * + * * @param id * id */ diff --git a/common/src/main/java/org/red5/server/exception/ClientRejectedException.java b/common/src/main/java/org/red5/server/exception/ClientRejectedException.java index 48c8a2f18..e3ff2c215 100644 --- a/common/src/main/java/org/red5/server/exception/ClientRejectedException.java +++ b/common/src/main/java/org/red5/server/exception/ClientRejectedException.java @@ -25,7 +25,7 @@ public ClientRejectedException() { /** * Create new exception with given rejection reason - * + * * @param reason * Rejection reason */ diff --git a/common/src/main/java/org/red5/server/exception/ScopeNotFoundException.java b/common/src/main/java/org/red5/server/exception/ScopeNotFoundException.java index 9dd8ff45e..3bfa2b0a5 100644 --- a/common/src/main/java/org/red5/server/exception/ScopeNotFoundException.java +++ b/common/src/main/java/org/red5/server/exception/ScopeNotFoundException.java @@ -18,7 +18,7 @@ public class ScopeNotFoundException extends RuntimeException { /** * Create exception from given scope object and given child subscope - * + * * @param scope * Scope * @param childName diff --git a/common/src/main/java/org/red5/server/exception/ScopeShuttingDownException.java b/common/src/main/java/org/red5/server/exception/ScopeShuttingDownException.java index 40091efbd..ea79215f1 100644 --- a/common/src/main/java/org/red5/server/exception/ScopeShuttingDownException.java +++ b/common/src/main/java/org/red5/server/exception/ScopeShuttingDownException.java @@ -18,7 +18,7 @@ public class ScopeShuttingDownException extends RuntimeException { /** * Create exception from given scope object - * + * * @param scope * Scope */ diff --git a/common/src/main/java/org/red5/server/jmx/mxbeans/RTMPMinaTransportMXBean.java b/common/src/main/java/org/red5/server/jmx/mxbeans/RTMPMinaTransportMXBean.java index 74342073f..c1bf5e7bd 100644 --- a/common/src/main/java/org/red5/server/jmx/mxbeans/RTMPMinaTransportMXBean.java +++ b/common/src/main/java/org/red5/server/jmx/mxbeans/RTMPMinaTransportMXBean.java @@ -9,8 +9,8 @@ import javax.management.MXBean; -/** - * +/** + * */ @MXBean public interface RTMPMinaTransportMXBean { diff --git a/common/src/main/java/org/red5/server/jmx/mxbeans/ScopeMXBean.java b/common/src/main/java/org/red5/server/jmx/mxbeans/ScopeMXBean.java index 88be03225..ed59b45da 100644 --- a/common/src/main/java/org/red5/server/jmx/mxbeans/ScopeMXBean.java +++ b/common/src/main/java/org/red5/server/jmx/mxbeans/ScopeMXBean.java @@ -24,24 +24,24 @@ public interface ScopeMXBean { /** * Check if scope is enabled - * + * * @return
      * true
      * 
- * + * * if scope is enabled, - * + * *
      * false
      * 
- * + * * otherwise */ public boolean getEnabled(); /** * Enable or disable scope by setting enable flag - * + * * @param enabled * Enable flag value */ @@ -49,24 +49,24 @@ public interface ScopeMXBean { /** * Check if scope is in running state - * + * * @return
      * true
      * 
- * + * * if scope is in running state, - * + * *
      * false
      * 
- * + * * otherwise */ public boolean getRunning(); /** * Setter for autostart flag - * + * * @param autoStart * Autostart flag value */ @@ -74,7 +74,7 @@ public interface ScopeMXBean { /** * Initialization actions, start if autostart is set to - * + * *
      * true
      * 
@@ -83,17 +83,17 @@ public interface ScopeMXBean { /** * Starts scope - * + * * @return
      * true
      * 
- * + * * if scope has handler and it's start method returned true, - * + * *
      * false
      * 
- * + * * otherwise */ public boolean start(); @@ -105,7 +105,7 @@ public interface ScopeMXBean { /** * Destroys scope - * + * * @throws Exception * on error */ @@ -123,7 +123,7 @@ public interface ScopeMXBean { /** * Setter for child load path. Should be implemented in subclasses? - * + * * @param pattern * Load path pattern */ @@ -131,26 +131,26 @@ public interface ScopeMXBean { /** * 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); /** * Check whether scope has child scope with given name and type - * + * * @param type * Child scope type * @param name @@ -158,44 +158,44 @@ public interface ScopeMXBean { * @return
      * true
      * 
- * + * * if scope has child node with given name and type, - * + * *
      * false
      * 
- * + * * otherwise */ public boolean hasChildScope(ScopeType type, String name); /** * Check if scope has a context - * + * * @return
      * true
      * 
- * + * * if scope has context, - * + * *
      * false
      * 
- * + * * otherwise */ public boolean hasContext(); /** * Return scope context path - * + * * @return Scope context path */ public String getContextPath(); /** * Setter for scope name - * + * * @param name * Scope name */ @@ -203,48 +203,48 @@ public interface ScopeMXBean { /** * Return scope path calculated from parent path and parent scope name - * + * * @return Scope path */ public String getPath(); /** * 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(); /** * Check if scope has parent scope - * + * * @return
      * true
      * 
- * + * * if scope has parent scope, - * + * *
      * false
      * 
- * + * * otherwise` */ public boolean hasParent(); /** * Set scope depth - * + * * @param depth * Scope depth */ @@ -252,33 +252,33 @@ public interface ScopeMXBean { /** * return scope depth - * + * * @return Scope depth */ public int getDepth(); /** * Create child scope with given name - * + * * @param name * Child scope name * @return
      * true
      * 
- * + * * on success, - * + * *
      * false
      * 
- * + * * otherwise */ public boolean createChildScope(String name); /** * Unregisters service handler by name - * + * * @param name * Service handler name */ @@ -286,70 +286,70 @@ public interface ScopeMXBean { /** * Return set of service handler names - * + * * @return Set of service handler names */ public Set getServiceHandlerNames(); /** * Return total number of connections to the scope. - * + * * @return number of connections */ public int getTotalConnections(); /** * Return maximum number of concurrent connections to the scope. - * + * * @return number of connections */ public int getMaxConnections(); /** * Return current number of connections to the scope. - * + * * @return number of connections */ public int getActiveConnections(); /** * Return total number of clients connected to the scope. - * + * * @return number of clients */ public int getTotalClients(); /** * Return maximum number of clients concurrently connected to the scope. - * + * * @return number of clients */ public int getMaxClients(); /** * Return current number of clients connected to the scope. - * + * * @return number of clients */ public int getActiveClients(); /** * Return total number of subscopes created. - * + * * @return number of subscopes created */ public int getTotalSubscopes(); /** * Return maximum number of concurrently existing subscopes. - * + * * @return number of subscopes */ public int getMaxSubscopes(); /** * Return number of currently existing subscopes. - * + * * @return number of subscopes */ public int getActiveSubscopes(); diff --git a/common/src/main/java/org/red5/server/messaging/AbstractPipe.java b/common/src/main/java/org/red5/server/messaging/AbstractPipe.java index 755a4281f..6d089dc11 100644 --- a/common/src/main/java/org/red5/server/messaging/AbstractPipe.java +++ b/common/src/main/java/org/red5/server/messaging/AbstractPipe.java @@ -20,7 +20,7 @@ /** * Abstract pipe that books providers/consumers and listeners. Aim to ease the implementation of concrete pipes. For more information on what pipe is, see IPipe interface documentation. - * + * * @author The Red5 Project * @author Steven Gong (steven.gong@gmail.com) * @@ -89,7 +89,7 @@ public boolean subscribe(IProvider provider, Map paramMap) { /** * Disconnects provider from this pipe. Fires pipe connection event. - * + * * @param provider * Provider that should be removed * @return true on success, false otherwise @@ -106,7 +106,7 @@ public boolean unsubscribe(IProvider provider) { /** * Disconnects consumer from this pipe. Fires pipe connection event. - * + * * @param consumer * Consumer that should be removed * @return true on success, false otherwise @@ -123,7 +123,7 @@ public boolean unsubscribe(IConsumer consumer) { /** * Registers pipe connect events listener - * + * * @param listener * Listener */ @@ -133,7 +133,7 @@ public void addPipeConnectionListener(IPipeConnectionListener listener) { /** * Removes pipe connection listener - * + * * @param listener * Listener */ @@ -231,7 +231,7 @@ protected void fireConsumerConnectionEvent(IConsumer consumer, PipeConnectionEve /** * Broadcast provider connection event - * + * * @param provider * Provider that has connected * @param type @@ -245,7 +245,7 @@ protected void fireProviderConnectionEvent(IProvider provider, PipeConnectionEve /** * Fire any pipe connection event and run all it's tasks - * + * * @param event * Pipe connection event */ diff --git a/common/src/main/java/org/red5/server/messaging/IConsumer.java b/common/src/main/java/org/red5/server/messaging/IConsumer.java index 58c3de5be..2ad413832 100644 --- a/common/src/main/java/org/red5/server/messaging/IConsumer.java +++ b/common/src/main/java/org/red5/server/messaging/IConsumer.java @@ -9,7 +9,7 @@ /** * Signature for the message consumer. - * + * * @author The Red5 Project * @author Steven Gong (steven.gong@gmail.com) */ diff --git a/common/src/main/java/org/red5/server/messaging/IMessage.java b/common/src/main/java/org/red5/server/messaging/IMessage.java index d241405f7..613d0c008 100644 --- a/common/src/main/java/org/red5/server/messaging/IMessage.java +++ b/common/src/main/java/org/red5/server/messaging/IMessage.java @@ -27,14 +27,14 @@ public interface IMessage { /** * Return message id - * + * * @return Message id */ String getMessageID(); /** * Setter for new message id - * + * * @param id * Message id */ @@ -42,14 +42,14 @@ public interface IMessage { /** * Return correlation id - * + * * @return Correlation id */ String getCorrelationID(); /** * Setter for correlation id - * + * * @param id * Correlation id */ @@ -57,14 +57,14 @@ public interface IMessage { /** * Return message type - * + * * @return Message type */ String getMessageType(); /** * Setter for message type - * + * * @param type * Message type */ @@ -72,7 +72,7 @@ public interface IMessage { /** * Getter for boolean property - * + * * @param name * Boolean property name * @return Boolean property @@ -81,7 +81,7 @@ public interface IMessage { /** * Add boolean property to message - * + * * @param name * Boolean property name * @param value @@ -91,7 +91,7 @@ public interface IMessage { /** * Add byte property to message - * + * * @param name * Byte property name * @return Byte property value @@ -100,7 +100,7 @@ public interface IMessage { /** * Add byte property to message - * + * * @param name * Byte property name * @param value @@ -110,7 +110,7 @@ public interface IMessage { /** * Return double property by name - * + * * @param name * Double property name * @return Double property value @@ -119,7 +119,7 @@ public interface IMessage { /** * Add double property to message - * + * * @param name * Double property name * @param value @@ -129,7 +129,7 @@ public interface IMessage { /** * Return float property by name - * + * * @param name * Float property name * @return Float property value @@ -138,7 +138,7 @@ public interface IMessage { /** * Add float property to message - * + * * @param name * Float property name * @param value @@ -148,7 +148,7 @@ public interface IMessage { /** * Return int property by name - * + * * @param name * Int property name * @return Int property value @@ -157,7 +157,7 @@ public interface IMessage { /** * Add int property to message - * + * * @param name * Int property name * @param value @@ -167,7 +167,7 @@ public interface IMessage { /** * Return long property to message - * + * * @param name * Long property name * @return Long property value @@ -176,7 +176,7 @@ public interface IMessage { /** * Add long property to message - * + * * @param name * Long property name * @param value @@ -186,7 +186,7 @@ public interface IMessage { /** * Return short property to message - * + * * @param name * Short property name * @return Short property value @@ -195,7 +195,7 @@ public interface IMessage { /** * Add short property to message - * + * * @param name * Short property name * @param value @@ -205,7 +205,7 @@ public interface IMessage { /** * Return string property to message - * + * * @param name * String property name * @return String property value @@ -214,7 +214,7 @@ public interface IMessage { /** * Add string property to message - * + * * @param name * String property name * @param value @@ -224,7 +224,7 @@ public interface IMessage { /** * Return object property to message - * + * * @param name * Object property name * @return Object property value @@ -233,7 +233,7 @@ public interface IMessage { /** * Add object property to message - * + * * @param name * Object property name * @param value diff --git a/common/src/main/java/org/red5/server/messaging/IMessageComponent.java b/common/src/main/java/org/red5/server/messaging/IMessageComponent.java index c40c1405d..970c01e84 100644 --- a/common/src/main/java/org/red5/server/messaging/IMessageComponent.java +++ b/common/src/main/java/org/red5/server/messaging/IMessageComponent.java @@ -12,7 +12,7 @@ */ public interface IMessageComponent { /** - * + * * @param source * Message component source * @param pipe diff --git a/common/src/main/java/org/red5/server/messaging/IMessageInput.java b/common/src/main/java/org/red5/server/messaging/IMessageInput.java index 361f484b4..0deb4af32 100644 --- a/common/src/main/java/org/red5/server/messaging/IMessageInput.java +++ b/common/src/main/java/org/red5/server/messaging/IMessageInput.java @@ -13,14 +13,14 @@ /** * Input Endpoint for a consumer to connect. - * + * * @author The Red5 Project * @author Steven Gong (steven.gong@gmail.com) */ public interface IMessageInput { /** * Pull message from this input endpoint. Return w/o waiting. - * + * * @return The pulled message or null if message is not available. * @throws IOException * on error @@ -29,7 +29,7 @@ public interface IMessageInput { /** * Pull message from this input endpoint. Wait wait milliseconds if message is not available. - * + * * @param wait * milliseconds to wait when message is not available. * @return The pulled message or null if message is not available. @@ -38,7 +38,7 @@ public interface IMessageInput { /** * Connect to a consumer. - * + * * @param consumer * Consumer * @param paramMap @@ -49,7 +49,7 @@ public interface IMessageInput { /** * Disconnect from a consumer. - * + * * @param consumer * Consumer to disconnect * @return true when successfully unsubscribed, false otherwise. @@ -65,7 +65,7 @@ public interface IMessageInput { /** * Send OOB Control Message to all providers on the other side of pipe. - * + * * @param consumer * The consumer that sends the message * @param oobCtrlMsg diff --git a/common/src/main/java/org/red5/server/messaging/IMessageOutput.java b/common/src/main/java/org/red5/server/messaging/IMessageOutput.java index c57e9efc5..93181184b 100644 --- a/common/src/main/java/org/red5/server/messaging/IMessageOutput.java +++ b/common/src/main/java/org/red5/server/messaging/IMessageOutput.java @@ -13,14 +13,14 @@ /** * Output Endpoint for a provider to connect. - * + * * @author The Red5 Project * @author Steven Gong (steven.gong@gmail.com) */ public interface IMessageOutput { /** * Push a message to this output endpoint. May block the pusher when output can't handle the message at the time. - * + * * @param message * Message to be pushed. * @throws IOException @@ -30,7 +30,7 @@ public interface IMessageOutput { /** * Connect to a provider. Note that params passed has nothing to do with NetConnection.connect in client-side Flex/Flash RIA. - * + * * @param provider * Provider * @param paramMap @@ -41,7 +41,7 @@ public interface IMessageOutput { /** * Disconnect from a provider. - * + * * @param provider * Provider * @return true when successfully unsubscribed, false otherwise. @@ -57,7 +57,7 @@ public interface IMessageOutput { /** * Send OOB Control Message to all consumers on the other side of pipe. - * + * * @param provider * The provider that sends the message * @param oobCtrlMsg diff --git a/common/src/main/java/org/red5/server/messaging/IPassive.java b/common/src/main/java/org/red5/server/messaging/IPassive.java index 8b848b0f7..1f4a817d0 100644 --- a/common/src/main/java/org/red5/server/messaging/IPassive.java +++ b/common/src/main/java/org/red5/server/messaging/IPassive.java @@ -9,7 +9,7 @@ /** * Signature to mark a provider/consumer never actively providers/consumers messages. - * + * * @author The Red5 Project * @author Steven Gong (steven.gong@gmail.com) */ diff --git a/common/src/main/java/org/red5/server/messaging/IPipe.java b/common/src/main/java/org/red5/server/messaging/IPipe.java index 2eaf5aa61..936051975 100644 --- a/common/src/main/java/org/red5/server/messaging/IPipe.java +++ b/common/src/main/java/org/red5/server/messaging/IPipe.java @@ -11,7 +11,7 @@ * A pipe is an object that connects message providers and message consumers. Its main function is to transport messages in kind of ways it provides. * * Pipes fire events as they go, these events are common way to work with pipes for higher level parts of server. - * + * * @author The Red5 Project * @author Steven Gong (steven.gong@gmail.com) */ @@ -19,7 +19,7 @@ public interface IPipe extends IMessageInput, IMessageOutput { /** * Add connection event listener to pipe - * + * * @param listener * Connection event listener */ @@ -27,7 +27,7 @@ public interface IPipe extends IMessageInput, IMessageOutput { /** * Add connection event listener to pipe - * + * * @param listener * Connection event listener */ diff --git a/common/src/main/java/org/red5/server/messaging/IPipeConnectionListener.java b/common/src/main/java/org/red5/server/messaging/IPipeConnectionListener.java index 730366e24..fc6c78f4e 100644 --- a/common/src/main/java/org/red5/server/messaging/IPipeConnectionListener.java +++ b/common/src/main/java/org/red5/server/messaging/IPipeConnectionListener.java @@ -9,14 +9,14 @@ /** * A listener that wants to listen to events when provider/consumer connects to or disconnects from a specific pipe. - * + * * @author The Red5 Project * @author Steven Gong (steven.gong@gmail.com) */ public interface IPipeConnectionListener { /** * Pipe connection event handler - * + * * @param event * Pipe connection event */ diff --git a/common/src/main/java/org/red5/server/messaging/IProvider.java b/common/src/main/java/org/red5/server/messaging/IProvider.java index d03833d4a..c828fb1f9 100644 --- a/common/src/main/java/org/red5/server/messaging/IProvider.java +++ b/common/src/main/java/org/red5/server/messaging/IProvider.java @@ -9,7 +9,7 @@ /** * Signature for message provider. - * + * * @author The Red5 Project * @author Steven Gong (steven.gong@gmail.com) */ diff --git a/common/src/main/java/org/red5/server/messaging/IPushableConsumer.java b/common/src/main/java/org/red5/server/messaging/IPushableConsumer.java index 70805aede..409717d9f 100644 --- a/common/src/main/java/org/red5/server/messaging/IPushableConsumer.java +++ b/common/src/main/java/org/red5/server/messaging/IPushableConsumer.java @@ -11,7 +11,7 @@ /** * A consumer that supports event-driven message handling and message pushing through pipes. - * + * * @author The Red5 Project * @author Steven Gong (steven.gong@gmail.com) */ diff --git a/common/src/main/java/org/red5/server/messaging/InMemoryPushPushPipe.java b/common/src/main/java/org/red5/server/messaging/InMemoryPushPushPipe.java index a3ab93069..c530779ce 100644 --- a/common/src/main/java/org/red5/server/messaging/InMemoryPushPushPipe.java +++ b/common/src/main/java/org/red5/server/messaging/InMemoryPushPushPipe.java @@ -15,7 +15,7 @@ /** * A simple in-memory version of push-push pipe. It is triggered by an active provider to push messages through it to an event-driven consumer. - * + * * @author Steven Gong (steven.gong@gmail.com) * @author Paul Gregoire (mondain@gmail.com) */ @@ -74,7 +74,7 @@ public IMessage pullMessage(long wait) { /** * Pushes a message out to all the PushableConsumers. - * + * * @param message * the message to be pushed to consumers * @throws IOException diff --git a/common/src/main/java/org/red5/server/messaging/OOBControlMessage.java b/common/src/main/java/org/red5/server/messaging/OOBControlMessage.java index 6ee624905..1194b3801 100644 --- a/common/src/main/java/org/red5/server/messaging/OOBControlMessage.java +++ b/common/src/main/java/org/red5/server/messaging/OOBControlMessage.java @@ -11,10 +11,10 @@ import java.util.Map; /** - * Out-of-band control message used by inter-components communication which are connected with pipes. + * Out-of-band control message used by inter-components communication which are connected with pipes. * Out-of-band data is a separate data stream used for specific purposes (in TCP it's referenced as "urgent data"), like lifecycle control. * - * 'Target' is used to represent the receiver who may be interested for receiving. + * 'Target' is used to represent the receiver who may be interested for receiving. * It's a string of any form. XXX shall we design a standard form for Target, like "class.instance"? * * @author The Red5 Project diff --git a/common/src/main/java/org/red5/server/messaging/PipeConnectionEvent.java b/common/src/main/java/org/red5/server/messaging/PipeConnectionEvent.java index 13123ada3..a6ce7a23d 100644 --- a/common/src/main/java/org/red5/server/messaging/PipeConnectionEvent.java +++ b/common/src/main/java/org/red5/server/messaging/PipeConnectionEvent.java @@ -15,9 +15,9 @@ import java.util.concurrent.ConcurrentMap; /** - * Event object corresponds to the connect/disconnect events among providers/consumers on pipes. + * Event object corresponds to the connect/disconnect events among providers/consumers on pipes. * This object is immutable except for the parameter map and tasks. - * + * * @author The Red5 Project * @author Steven Gong (steven.gong@gmail.com) * @author Paul Gregoire (mondain@gmail.com) @@ -69,7 +69,7 @@ public enum EventType { /** * Construct an object with the specific pipe as the source - * + * * @param source pipe that triggers this event * @param type event type * @param consumer the consumer @@ -85,7 +85,7 @@ private PipeConnectionEvent(AbstractPipe source, EventType type, IConsumer consu /** * Construct an object with the specific pipe as the source - * + * * @param source pipe that triggers this event * @param type event type * @param provider the provider @@ -101,7 +101,7 @@ private PipeConnectionEvent(AbstractPipe source, EventType type, IProvider provi /** * Return pipe connection provider - * + * * @return Provider */ public IProvider getProvider() { @@ -110,7 +110,7 @@ public IProvider getProvider() { /** * Return pipe connection consumer - * + * * @return Consumer */ public IConsumer getConsumer() { @@ -119,7 +119,7 @@ public IConsumer getConsumer() { /** * Return event type - * + * * @return Event type */ public EventType getType() { @@ -128,7 +128,7 @@ public EventType getType() { /** * Return event parameters as Map - * + * * @return Event parameters as Map */ public Map getParamMap() { @@ -137,7 +137,7 @@ public Map getParamMap() { /** * Setter for event parameters map - * + * * @param paramMap * Event parameters as Map */ @@ -149,7 +149,7 @@ public void setParamMap(Map paramMap) { /** * Add task to list - * + * * @param task * Task to add */ @@ -159,7 +159,7 @@ public void addTask(Runnable task) { /** * Return list of tasks - * + * * @return List of tasks */ List getTaskList() { @@ -168,7 +168,7 @@ List getTaskList() { /** * Builds a PipeConnectionEvent with a source pipe and consumer. - * + * * @param source pipe that triggers this event * @param type event type * @param consumer the consumer @@ -181,7 +181,7 @@ public final static PipeConnectionEvent build(AbstractPipe source, EventType typ /** * Builds a PipeConnectionEvent with a source pipe and provider. - * + * * @param source pipe that triggers this event * @param type event type * @param provider the provider diff --git a/common/src/main/java/org/red5/server/net/ICommand.java b/common/src/main/java/org/red5/server/net/ICommand.java index 9b975d78a..30dbaf14f 100644 --- a/common/src/main/java/org/red5/server/net/ICommand.java +++ b/common/src/main/java/org/red5/server/net/ICommand.java @@ -7,7 +7,7 @@ /** * Represents a "command" sent to or received from an end-point. - * + * * @author Paul Gregoire (mondain@gmail.com) */ public interface ICommand { diff --git a/common/src/main/java/org/red5/server/net/IConnectionManager.java b/common/src/main/java/org/red5/server/net/IConnectionManager.java index a1b7efd3a..352fdfc90 100644 --- a/common/src/main/java/org/red5/server/net/IConnectionManager.java +++ b/common/src/main/java/org/red5/server/net/IConnectionManager.java @@ -13,7 +13,7 @@ public interface IConnectionManager { /** * Returns a connection matching the given client id. - * + * * @param clientId * client id * @return connection @@ -22,7 +22,7 @@ public interface IConnectionManager { /** * Adds a connection. - * + * * @param conn * connection */ @@ -30,7 +30,7 @@ public interface IConnectionManager { /** * Returns a connection matching the given session id. - * + * * @param sessionId * session id * @return connection @@ -39,14 +39,14 @@ public interface IConnectionManager { /** * Returns all the current connections. It doesn't remove anything. - * + * * @return list of connections */ Collection getAllConnections(); /** * Creates a connection based on the given type class. - * + * * @param connCls * class * @return connection @@ -55,7 +55,7 @@ public interface IConnectionManager { /** * Creates a connection of the type specified with associated session id. - * + * * @param connCls * class * @param sessionId @@ -66,7 +66,7 @@ public interface IConnectionManager { /** * Removes a connection matching the client id specified. If found, the connection will be returned. - * + * * @param clientId * client id * @return connection @@ -75,7 +75,7 @@ public interface IConnectionManager { /** * Removes a connection by the given sessionId. - * + * * @param sessionId * session id * @return connection that was removed @@ -84,7 +84,7 @@ public interface IConnectionManager { /** * Removes all the connections from the set. - * + * * @return connections */ Collection removeConnections(); diff --git a/common/src/main/java/org/red5/server/net/IHandshake.java b/common/src/main/java/org/red5/server/net/IHandshake.java index 16ce21bd7..c3335766c 100644 --- a/common/src/main/java/org/red5/server/net/IHandshake.java +++ b/common/src/main/java/org/red5/server/net/IHandshake.java @@ -11,7 +11,7 @@ /** * Base interface for Handshake classes. - * + * * @author Paul Gregoire (mondain@gmail.com) */ public interface IHandshake { diff --git a/common/src/main/java/org/red5/server/net/protocol/RTMPDecodeState.java b/common/src/main/java/org/red5/server/net/protocol/RTMPDecodeState.java index e4d825854..1f206ffa1 100644 --- a/common/src/main/java/org/red5/server/net/protocol/RTMPDecodeState.java +++ b/common/src/main/java/org/red5/server/net/protocol/RTMPDecodeState.java @@ -50,7 +50,7 @@ public int getDecoderBufferAmount() { /** * Specifies buffer decoding amount needed. - * + * * @param amount Buffer decoding amount */ public void bufferDecoding(int amount) { @@ -67,7 +67,7 @@ public void continueDecoding() { /** * Checks whether remaining buffer size is greater or equal than buffer amount and so if it makes sense to start decoding. - * + * * @param remaining Remaining buffer size * @return true if there is data to decode, false otherwise */ diff --git a/common/src/main/java/org/red5/server/net/remoting/IRemotingCallback.java b/common/src/main/java/org/red5/server/net/remoting/IRemotingCallback.java index 752986638..5a2f859a2 100644 --- a/common/src/main/java/org/red5/server/net/remoting/IRemotingCallback.java +++ b/common/src/main/java/org/red5/server/net/remoting/IRemotingCallback.java @@ -9,7 +9,7 @@ /** * Callback for asynchronous remoting calls. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ @@ -17,7 +17,7 @@ public interface IRemotingCallback { /** * The result of a remoting call has been received. - * + * * @param client * Remoting client * @param method @@ -31,7 +31,7 @@ public interface IRemotingCallback { /** * An error occured while performing the remoting call. - * + * * @param client * Remoting client * @param method diff --git a/common/src/main/java/org/red5/server/net/remoting/RemotingClient.java b/common/src/main/java/org/red5/server/net/remoting/RemotingClient.java index 5a726917f..b52aff66e 100644 --- a/common/src/main/java/org/red5/server/net/remoting/RemotingClient.java +++ b/common/src/main/java/org/red5/server/net/remoting/RemotingClient.java @@ -33,7 +33,7 @@ /** * Client interface for remoting calls. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) * @author Paul Gregoire (mondain@gmail.com) @@ -75,7 +75,7 @@ public RemotingClient() { /** * Create new remoting client for the given url. - * + * * @param url * URL to connect to */ @@ -86,7 +86,7 @@ public RemotingClient(String url) { /** * Create new remoting client for the given url and given timeout. - * + * * @param url * URL to connect to * @param timeout @@ -109,7 +109,7 @@ public void setPoolSize(int poolSize) { /** * Encode the method call. - * + * * @param method * Remote method being called * @param params @@ -173,7 +173,7 @@ private IoBuffer encodeInvoke(String method, Object[] params) { /** * Process any headers sent in the response. - * + * * @param in * Byte buffer with response data */ @@ -222,7 +222,7 @@ protected void processHeaders(IoBuffer in) { /** * Decode response received from remoting server. - * + * * @param data * Result data to decode * @return Object deserialized from byte buffer data @@ -245,7 +245,7 @@ private Object decodeResult(IoBuffer data) { /** * Send authentication data with each remoting request. - * + * * @param userid * User identifier * @param password @@ -268,7 +268,7 @@ public void resetCredentials() { /** * Send an additional header to the server. - * + * * @param name * Header name * @param required @@ -283,7 +283,7 @@ public void addHeader(String name, boolean required, Object value) { /** * Stop sending a given header. - * + * * @param name * Header name */ @@ -293,7 +293,7 @@ public void removeHeader(String name) { /** * Invoke a method synchronously on the remoting server. - * + * * @param method * Method name * @param params @@ -352,7 +352,7 @@ public Object invokeMethod(String method, Object[] params) { /** * Invoke a method asynchronously on the remoting server. - * + * * @param method * Method name * @param methodParams @@ -384,7 +384,7 @@ public final static class RemotingWorker implements Runnable { /** * Execute task. - * + * * @param client * Remoting client * @param method diff --git a/common/src/main/java/org/red5/server/net/remoting/RemotingHeader.java b/common/src/main/java/org/red5/server/net/remoting/RemotingHeader.java index 28d9841ec..55c3e25dd 100644 --- a/common/src/main/java/org/red5/server/net/remoting/RemotingHeader.java +++ b/common/src/main/java/org/red5/server/net/remoting/RemotingHeader.java @@ -11,7 +11,7 @@ /** * Remoting header to be sent to a server. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ @@ -34,7 +34,7 @@ public class RemotingHeader implements IRemotingHeader { /** * Create a new header to be sent through remoting. - * + * * @param name * Header name * @param required diff --git a/common/src/main/java/org/red5/server/net/rtmp/BaseRTMPHandler.java b/common/src/main/java/org/red5/server/net/rtmp/BaseRTMPHandler.java index 3b41d1b42..cd24320a9 100644 --- a/common/src/main/java/org/red5/server/net/rtmp/BaseRTMPHandler.java +++ b/common/src/main/java/org/red5/server/net/rtmp/BaseRTMPHandler.java @@ -45,7 +45,7 @@ /** * Base class for all RTMP handlers. - * + * * @author The Red5 Project * @author Andy Shaules * @author Paul Gregoire @@ -207,7 +207,7 @@ public void connectionClosed(RTMPConnection conn) { /** * Return hostname for URL. - * + * * @param url * URL * @return Hostname from that URL @@ -232,7 +232,7 @@ protected String getHostname(String url) { /** * Handler for pending call result. Dispatches results to all pending call handlers. - * + * * @param conn * Connection * @param invoke @@ -265,7 +265,7 @@ protected void handlePendingCallResult(RTMPConnection conn, Invoke invoke) { /** * Chunk size change event handler. Abstract, to be implemented in subclasses. - * + * * @param conn * Connection * @param channel @@ -279,7 +279,7 @@ protected void handlePendingCallResult(RTMPConnection conn, Invoke invoke) { /** * Command event handler, which current consists of an Invoke or Notify type object. - * + * * @param conn * Connection * @param channel @@ -293,7 +293,7 @@ protected void handlePendingCallResult(RTMPConnection conn, Invoke invoke) { /** * Ping event handler. - * + * * @param conn * Connection * @param channel @@ -307,7 +307,7 @@ protected void handlePendingCallResult(RTMPConnection conn, Invoke invoke) { /** * Server bandwidth / Window ACK size event handler. - * + * * @param conn * Connection * @param channel @@ -321,7 +321,7 @@ protected void onServerBandwidth(RTMPConnection conn, Channel channel, ServerBW /** * Client bandwidth / Peer bandwidth set event handler. - * + * * @param conn * Connection * @param channel @@ -335,7 +335,7 @@ protected void onClientBandwidth(RTMPConnection conn, Channel channel, ClientBW /** * Stream bytes read event handler. - * + * * @param conn * Connection * @param channel @@ -351,7 +351,7 @@ protected void onStreamBytesRead(RTMPConnection conn, Channel channel, Header so /** * Shared object event handler. - * + * * @param conn * Connection * @param channel @@ -364,7 +364,7 @@ protected void onStreamBytesRead(RTMPConnection conn, Channel channel, Header so protected abstract void onSharedObject(RTMPConnection conn, Channel channel, Header source, SharedObjectMessage message); /** - * Class ensures a stream's event dispatching occurs on only one core at any one time. Eliminates thread racing internal to ClientBroadcastStream + * Class ensures a stream's event dispatching occurs on only one core at any one time. Eliminates thread racing internal to ClientBroadcastStream * and keeps all incoming events in order. */ private static class EnsuresPacketExecutionOrder implements Runnable { @@ -387,7 +387,7 @@ public EnsuresPacketExecutionOrder(IEventDispatcher stream, RTMPConnection conn) } /** - * Add packet to the stream's incoming queue. + * Add packet to the stream's incoming queue. * @param packet */ public void addPacket(IRTMPEvent packet) { diff --git a/common/src/main/java/org/red5/server/net/rtmp/Channel.java b/common/src/main/java/org/red5/server/net/rtmp/Channel.java index 6262e9056..b4c822dbb 100644 --- a/common/src/main/java/org/red5/server/net/rtmp/Channel.java +++ b/common/src/main/java/org/red5/server/net/rtmp/Channel.java @@ -45,7 +45,7 @@ public class Channel { /** * Creates channel from connection and channel id - * + * * @param conn * Connection * @param channelId @@ -123,14 +123,14 @@ private void write(IRTMPEvent event, Number streamId) { } header.setStreamId(streamId); header.setDataType(event.getDataType()); - // should use RTMPConnection specific method.. + // should use RTMPConnection specific method.. //log.trace("Connection type for write: {}", connection.getClass().getName()); connection.write(packet); } /** * Discard an event routed to this channel. - * + * * @param event */ @SuppressWarnings("unused") diff --git a/common/src/main/java/org/red5/server/net/rtmp/DeferredResult.java b/common/src/main/java/org/red5/server/net/rtmp/DeferredResult.java index 90cca3d4f..147bab5d8 100644 --- a/common/src/main/java/org/red5/server/net/rtmp/DeferredResult.java +++ b/common/src/main/java/org/red5/server/net/rtmp/DeferredResult.java @@ -16,7 +16,7 @@ /** * Can be returned to delay returning the result of invoked methods. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ @@ -48,7 +48,7 @@ public class DeferredResult { /** * Set the result of a method call and send to the caller. - * + * * @param result * deferred result of the method call */ @@ -72,13 +72,13 @@ public void setResult(Object result) { /** * Check if the result has been sent to the client. - * + * * @return
      * true
      * 
- * + * * if the result has been sent, otherwise - * + * *
      * false
      * 
diff --git a/common/src/main/java/org/red5/server/net/rtmp/IRTMPHandler.java b/common/src/main/java/org/red5/server/net/rtmp/IRTMPHandler.java index 6e22fedef..df5943bc7 100644 --- a/common/src/main/java/org/red5/server/net/rtmp/IRTMPHandler.java +++ b/common/src/main/java/org/red5/server/net/rtmp/IRTMPHandler.java @@ -16,7 +16,7 @@ public interface IRTMPHandler { /** * Connection open event. - * + * * @param conn * Connection */ @@ -24,7 +24,7 @@ public interface IRTMPHandler { /** * Message received. - * + * * @param conn * Connection * @param packet @@ -36,7 +36,7 @@ public interface IRTMPHandler { /** * Message sent. - * + * * @param conn * Connection * @param packet @@ -46,7 +46,7 @@ public interface IRTMPHandler { /** * Connection closed. - * + * * @param conn * Connection */ diff --git a/common/src/main/java/org/red5/server/net/rtmp/RTMPConnection.java b/common/src/main/java/org/red5/server/net/rtmp/RTMPConnection.java index 6d8c5b1ac..ee607d2cc 100755 --- a/common/src/main/java/org/red5/server/net/rtmp/RTMPConnection.java +++ b/common/src/main/java/org/red5/server/net/rtmp/RTMPConnection.java @@ -188,7 +188,7 @@ public abstract class RTMPConnection extends BaseConnection implements IStreamCa /** * Connection channels - * + * * @see org.red5.server.net.rtmp.Channel */ protected transient ConcurrentMap channels = new ConcurrentHashMap<>(channelsInitalCapacity, 0.9f, channelsConcurrencyLevel); @@ -202,7 +202,7 @@ public abstract class RTMPConnection extends BaseConnection implements IStreamCa /** * Client streams - * + * * @see org.red5.server.api.stream.IClientStream */ protected transient ConcurrentMap streams = new ConcurrentHashMap<>(streamsInitalCapacity, 0.9f, streamsConcurrencyLevel); @@ -224,7 +224,7 @@ public abstract class RTMPConnection extends BaseConnection implements IStreamCa /** * Deferred results set. - * + * * @see org.red5.server.net.rtmp.DeferredResult */ protected transient CopyOnWriteArraySet deferredResults = new CopyOnWriteArraySet<>(); @@ -390,7 +390,7 @@ public abstract class RTMPConnection extends BaseConnection implements IStreamCa /** * Creates anonymous RTMP connection without scope. - * + * * @param type * Connection type */ @@ -433,7 +433,7 @@ public byte getStateCode() { /** * Sets the state by code and fires property chanage notifications. - * + * * @param stateCode */ public void setStateCode(byte stateCode) { @@ -497,7 +497,7 @@ public void setBandwidth(int mbits) { /** * Returns a usable timestamp for written packets. - * + * * @return timestamp */ public int getTimer() { @@ -609,7 +609,7 @@ private void stopRoundTripMeasurement() { /** * Initialize connection. - * + * * @param host * Connection host * @param path @@ -631,7 +631,7 @@ public void setup(String host, String path, Map params) { /** * Return AMF protocol encoding used by this connection. - * + * * @return AMF encoding used by connection */ public Encoding getEncoding() { @@ -640,7 +640,7 @@ public Encoding getEncoding() { /** * Getter for next available channel id. - * + * * @return Next available channel id */ public int getNextAvailableChannelId() { @@ -653,7 +653,7 @@ public int getNextAvailableChannelId() { /** * Checks whether channel is used. - * + * * @param channelId * Channel id * @return true if channel is in use, false otherwise @@ -664,7 +664,7 @@ public boolean isChannelUsed(int channelId) { /** * Return channel by id. - * + * * @param channelId * Channel id * @return Channel by id @@ -685,7 +685,7 @@ public Channel getChannel(int channelId) { /** * Closes channel. - * + * * @param channelId * Channel id */ @@ -710,7 +710,7 @@ public void closeChannel(int channelId) { /** * Getter for client streams. - * + * * @return Client streams as array */ protected Collection getStreams() { @@ -748,7 +748,7 @@ public Number reserveStreamId(Number streamId) { /** * Returns whether or not a given stream id is valid. - * + * * @param streamId * stream id * @return true if its valid, false if its invalid @@ -776,7 +776,7 @@ public boolean isValidStreamId(Number streamId) { /** * Returns whether or not the connection has been idle for a maximum period. - * + * * @return true if max idle period has been exceeded, false otherwise */ public boolean isIdle() { @@ -791,7 +791,7 @@ public boolean isIdle() { /** * Returns whether or not the connection is disconnected. - * + * * @return true if connection state is RTMP.STATE_DISCONNECTED, false otherwise */ public boolean isDisconnected() { @@ -856,7 +856,7 @@ public void removeClientStream(Number streamId) { /** * Getter for used stream count. - * + * * @return Value for property 'usedStreamCount'. */ protected int getUsedStreamCount() { @@ -870,7 +870,7 @@ public IClientStream getStreamById(Number streamId) { /** * Return stream id for given channel id. - * + * * @param channelId * Channel id * @return ID of stream that channel belongs to @@ -888,7 +888,7 @@ public Number getStreamIdForChannelId(int channelId) { /** * Return stream by given channel id. - * + * * @param channelId * Channel id * @return Stream that channel belongs to @@ -907,7 +907,7 @@ public IClientStream getStreamByChannelId(int channelId) { /** * Return channel id for given stream id. - * + * * @param streamId * Stream id * @return ID of channel that belongs to the stream @@ -922,7 +922,7 @@ public int getChannelIdForStreamId(Number streamId) { /** * Creates output stream object from stream id. Output stream consists of audio, video, and data channels. - * + * * @see org.red5.server.stream.OutputStream * @param streamId * Stream id @@ -963,7 +963,7 @@ private void customizeStream(Number streamId, AbstractClientStream stream) { /** * Store a stream in the connection. - * + * * @param stream */ private boolean registerStream(IClientStream stream) { @@ -977,7 +977,7 @@ private boolean registerStream(IClientStream stream) { /** * Remove a stream from the connection. - * + * * @param stream */ @SuppressWarnings("unused") @@ -1052,7 +1052,7 @@ public void close() { /** * Dispatches event - * + * * @param event * Event */ @@ -1136,7 +1136,7 @@ public void deleteStreamById(Number streamId) { /** * Handler for ping event. - * + * * @param ping * Ping event context */ @@ -1146,7 +1146,7 @@ public void ping(Ping ping) { /** * Write packet. - * + * * @param out * Packet */ @@ -1154,7 +1154,7 @@ public void ping(Ping ping) { /** * Write raw byte buffer. - * + * * @param out * IoBuffer */ @@ -1177,7 +1177,7 @@ protected void updateBytesRead() { /** * Read number of received bytes. - * + * * @param bytes * Number of bytes */ @@ -1190,7 +1190,7 @@ public void receivedBytesRead(int bytes) { /** * Get number of bytes the client reported to have received. - * + * * @return Number of bytes */ public long getClientBytesRead() { @@ -1204,7 +1204,7 @@ public void invoke(IServiceCall call) { /** * Generate next invoke id. - * + * * @return Next invoke id for RPC */ public int getTransactionId() { @@ -1213,7 +1213,7 @@ public int getTransactionId() { /** * Register pending call (remote function call that is yet to finish). - * + * * @param invokeId * Deferred operation id * @param call @@ -1323,7 +1323,7 @@ public long getWrittenBytes() { /** * Get pending call service by id. - * + * * @param invokeId * Pending call service id * @return Pending call service object @@ -1334,7 +1334,7 @@ public IPendingServiceCall getPendingCall(int invokeId) { /** * Retrieves and removes the pending call service by id. - * + * * @param invokeId * Pending call service id * @return Pending call service object @@ -1345,7 +1345,7 @@ public IPendingServiceCall retrievePendingCall(int invokeId) { /** * Generates new stream name. - * + * * @return New stream name */ protected String createStreamName() { @@ -1354,7 +1354,7 @@ protected String createStreamName() { /** * Mark message as being written. - * + * * @param message * Message to mark */ @@ -1430,7 +1430,7 @@ public String messageTypeToName(byte headerDataType) { /** * Handle the incoming message. - * + * * @param packet * incoming message packet */ @@ -1603,7 +1603,7 @@ public void onSuccess(Packet packet) { /** * Mark message as sent. - * + * * @param message * Message to mark */ @@ -1639,7 +1639,7 @@ protected void messageDropped() { /** * Returns the current received message queue size. - * + * * @return current message queue size */ protected int currentQueueSize() { @@ -1658,7 +1658,7 @@ public long getPendingVideoMessages(Number streamId) { /** * Send a shared object message. - * + * * @param name * shared object name * @param currentVersion @@ -1699,7 +1699,7 @@ public void ping() { /** * Marks that ping back was received. - * + * * @param pong * Ping object */ @@ -1728,7 +1728,7 @@ public void pingReceived(Ping pong) { /** * Difference between when the last ping was sent and when the last pong was received. - * + * * @return last interval of ping minus pong */ public int getLastPingSentAndLastPongReceivedInterval() { @@ -1742,7 +1742,7 @@ public int getLastPingTime() { /** * Setter for ping interval. - * + * * @param pingInterval * Interval in ms to ping clients. Set to 0 to disable ghost detection code. */ @@ -1752,7 +1752,7 @@ public void setPingInterval(int pingInterval) { /** * Setter for maximum inactivity. - * + * * @param maxInactivity * Maximum time in ms after which a client is disconnected in case of inactivity. */ @@ -1767,7 +1767,7 @@ public void setMaxInactivity(int maxInactivity) { /** * Sets the scheduler. - * + * * @param scheduler * scheduling service / thread executor */ @@ -1801,7 +1801,7 @@ public ThreadPoolTaskScheduler getDeadlockGuardScheduler() { /** * Thread pool for guarding deadlocks - * + * * @param deadlockGuardScheduler * the deadlockGuardScheduler to set */ @@ -1811,7 +1811,7 @@ public void setDeadlockGuardScheduler(ThreadPoolTaskScheduler deadlockGuardSched /** * Registers deferred result. - * + * * @param result * Result to register */ @@ -1821,7 +1821,7 @@ public void registerDeferredResult(DeferredResult result) { /** * Unregister deferred result - * + * * @param result * Result to unregister */ @@ -1835,7 +1835,7 @@ public void rememberStreamBufferDuration(int streamId, int bufferDuration) { /** * Set maximum time to wait for valid handshake in milliseconds. - * + * * @param maxHandshakeTimeout * Maximum time in milliseconds */ @@ -1917,7 +1917,7 @@ public void setReservedStreamsConcurrencyLevel(int reservedStreamsConcurrencyLev /** * Specify the size of queue that will trigger audio packet dropping, disabled if it's 0 - * + * * @param executorQueueSizeToDropAudioPackets * queue size */ diff --git a/common/src/main/java/org/red5/server/net/rtmp/RTMPHandler.java b/common/src/main/java/org/red5/server/net/rtmp/RTMPHandler.java index 78f06d2e6..df6c967eb 100644 --- a/common/src/main/java/org/red5/server/net/rtmp/RTMPHandler.java +++ b/common/src/main/java/org/red5/server/net/rtmp/RTMPHandler.java @@ -100,7 +100,7 @@ public void destroy() throws Exception { /** * Setter for server object. - * + * * @param server * Red5 server instance */ @@ -110,7 +110,7 @@ public void setServer(IServer server) { /** * Setter for status object service. - * + * * @param statusObjectService * Status object service. */ @@ -174,7 +174,7 @@ protected void onChunkSize(RTMPConnection conn, Channel channel, Header source, /** * Remoting call invocation handler. - * + * * @param conn * RTMP connection * @param call @@ -202,7 +202,7 @@ protected void invokeCall(RTMPConnection conn, IServiceCall call) { /** * Remoting call invocation handler. - * + * * @param conn * RTMP connection * @param call @@ -547,7 +547,7 @@ protected void onPing(RTMPConnection conn, Channel channel, Header source, Ping /** * Create and send SO message stating that a SO could not be created. - * + * * @param conn * @param message * Shared object message that incurred the failure diff --git a/common/src/main/java/org/red5/server/net/rtmp/RTMPHandshake.java b/common/src/main/java/org/red5/server/net/rtmp/RTMPHandshake.java index 9dbdd1041..45013b844 100644 --- a/common/src/main/java/org/red5/server/net/rtmp/RTMPHandshake.java +++ b/common/src/main/java/org/red5/server/net/rtmp/RTMPHandshake.java @@ -41,7 +41,7 @@ /** * Generates and validates the RTMP handshake response for Flash Players. Client versions equal to or greater than Flash 9,0,124,0 require a * nonzero value as the fifth byte of the handshake request. - * + * * @author Jacinto Shy II (jacinto.m.shy@ieee.org) * @author Steven Zimmer (stevenlzimmer@gmail.com) * @author Gavriloaie Eugen-Andrei @@ -173,7 +173,7 @@ public RTMPHandshake(byte handshakeType) { /** * Prepare the ciphers. - * + * * @param sharedSecret * shared secret byte sequence */ @@ -217,7 +217,7 @@ protected void initBlowfishEncryption(int keyId) { /** * Creates a Diffie-Hellman key pair. - * + * * @return dh keypair */ protected KeyPair generateKeyPair() { @@ -238,7 +238,7 @@ protected KeyPair generateKeyPair() { /** * Returns the public key for a given key pair. - * + * * @param keyPair * key pair * @return public key @@ -254,7 +254,7 @@ protected byte[] getPublicKey(KeyPair keyPair) { /** * Determines the validation scheme for given input. - * + * * @param publicKeyBytes * public key bytes * @param agreement @@ -283,7 +283,7 @@ protected byte[] getSharedSecret(byte[] publicKeyBytes, KeyAgreement agreement) /** * Determines the validation scheme for given input. - * + * * @param handshake * handshake byte sequence * @return true if its a supported validation scheme, false if unsupported @@ -292,7 +292,7 @@ protected byte[] getSharedSecret(byte[] publicKeyBytes, KeyAgreement agreement) /** * Calculates the digest given the its offset in the handshake data. - * + * * @param digestPos * digest position * @param handshakeMessage @@ -324,7 +324,7 @@ public void calculateDigest(int digestPos, byte[] handshakeMessage, int handshak /** * Verifies the digest. - * + * * @param digestPos * digest position * @param handshakeMessage @@ -349,7 +349,7 @@ public boolean verifyDigest(int digestPos, byte[] handshakeMessage, byte[] key, /** * Calculates an HMAC SHA256 hash into the digest at the given offset. - * + * * @param message * incoming bytes * @param messageOffset @@ -391,7 +391,7 @@ public void calculateHMAC_SHA256(byte[] message, int messageOffset, int messageL /** * Calculates the swf verification token. - * + * * @param handshakeMessage * servers handshake bytes * @param swfHash @@ -420,7 +420,7 @@ public void calculateSwfVerification(byte[] handshakeMessage, byte[] swfHash, in /** * Returns the DH offset from an array of bytes. - * + * * @param algorithm * validation algorithm * @param handshake @@ -441,7 +441,7 @@ public int getDHOffset(int algorithm, byte[] handshake, int bufferOffset) { /** * Returns the DH byte offset. - * + * * @param handshake * handshake sequence * @param bufferOffset @@ -466,7 +466,7 @@ protected int getDHOffset1(byte[] handshake, int bufferOffset) { /** * Returns the DH byte offset. - * + * * @param handshake * handshake sequence * @param bufferOffset @@ -491,7 +491,7 @@ protected int getDHOffset2(byte[] handshake, int bufferOffset) { /** * Returns the digest offset using current validation scheme. - * + * * @param algorithm * validation algorithm * @param handshake @@ -512,7 +512,7 @@ public int getDigestOffset(int algorithm, byte[] handshake, int bufferOffset) { /** * Returns a digest byte offset. - * + * * @param handshake * handshake sequence * @param bufferOffset @@ -537,7 +537,7 @@ protected int getDigestOffset1(byte[] handshake, int bufferOffset) { /** * Returns a digest byte offset. - * + * * @param handshake * handshake sequence * @param bufferOffset @@ -562,7 +562,7 @@ protected int getDigestOffset2(byte[] handshake, int bufferOffset) { /** * RTMPE type 8 uses XTEA on the regular signature http://en.wikipedia.org/wiki/XTEA - * + * * @param array * array to get signature * @param offset @@ -593,7 +593,7 @@ public void getXteaSignature(byte[] array, int offset, int keyId) { /** * RTMPE type 9 uses Blowfish on the regular signature http://en.wikipedia.org/wiki/Blowfish_(cipher) - * + * * @param array * array to get signature * @param offset @@ -612,7 +612,7 @@ public void getBlowfishSignature(byte[] array, int offset, int keyId) { /** * Returns whether or not a given handshake type is valid. - * + * * @param handshakeType * the type of handshake * @return true if valid and supported, false otherwise @@ -631,7 +631,7 @@ public final static boolean validHandshakeType(byte handshakeType) { /** * Whether or not encryptions is in use. - * + * * @return true if handshake type is an encrypted type, false otherwise */ public boolean useEncryption() { @@ -646,7 +646,7 @@ public boolean useEncryption() { /** * Sets the handshake type. Currently only two types are supported, plain and encrypted. - * + * * @param handshakeType * handshake type */ @@ -663,7 +663,7 @@ public void setHandshakeType(byte handshakeType) { /** * Returns the handshake type. - * + * * @return handshakeType */ public byte getHandshakeType() { @@ -672,7 +672,7 @@ public byte getHandshakeType() { /** * Gets the DH offset in the handshake bytes array based on validation scheme Generates DH keypair Adds public key to handshake bytes - * + * * @return cipher */ public Cipher getCipherOut() { @@ -681,7 +681,7 @@ public Cipher getCipherOut() { /** * Returns the contained handshake bytes. These are just random bytes if the player is using an non-versioned player. - * + * * @return cipher */ public Cipher getCipherIn() { @@ -690,7 +690,7 @@ public Cipher getCipherIn() { /** * Returns the SWF verification bytes. - * + * * @return swf verification bytes */ public byte[] getSwfVerificationBytes() { diff --git a/common/src/main/java/org/red5/server/net/rtmp/RTMPMinaConnection.java b/common/src/main/java/org/red5/server/net/rtmp/RTMPMinaConnection.java index 74cda653e..e4cf30171 100644 --- a/common/src/main/java/org/red5/server/net/rtmp/RTMPMinaConnection.java +++ b/common/src/main/java/org/red5/server/net/rtmp/RTMPMinaConnection.java @@ -40,9 +40,9 @@ /** * Represents an RTMP connection using Mina. - * + * * @see "http://mina.apache.org/report/trunk/apidocs/org/apache/mina/core/session/IoSession.html" - * + * * @author Paul Gregoire */ @ManagedResource @@ -148,7 +148,7 @@ public void operationComplete(CloseFuture future) { /** * Return MINA I/O session. - * + * * @return MINA O/I session, connection between two end-points */ @Override @@ -300,7 +300,7 @@ protected void onInactive() { /** * Setter for MINA I/O session (connection). - * + * * @param protocolSession * Protocol session */ @@ -334,7 +334,7 @@ public void write(Packet out) { boolean acquired = false; try { acquired = lock.tryAcquire(10, TimeUnit.MILLISECONDS); - if (acquired) { // attempt write if not closing + if (acquired) { // attempt write if not closing if (!ioSession.isClosing()) { if (log.isTraceEnabled()) { log.trace("Writing message"); @@ -347,11 +347,11 @@ public void write(Packet out) { } catch (InterruptedException e) { log.warn("Interrupted while waiting for write lock. State: {}", RTMP.states[state.getState()], e); if (log.isInfoEnabled()) { - // further debugging to assist with possible connection problems + // further debugging to assist with possible connection problems log.info("Session id: {} in queue size: {} pending msgs: {} last ping/pong: {}", getSessionId(), currentQueueSize(), getPendingMessages(), getLastPingSentAndLastPongReceivedInterval()); log.info("Available permits - decoder: {} encoder: {}", decoderLock.availablePermits(), encoderLock.availablePermits()); } - String exMsg = e.getMessage(); // if the exception cause is null break out of here to prevent looping until closed + String exMsg = e.getMessage(); // if the exception cause is null break out of here to prevent looping until closed if (exMsg == null || exMsg.indexOf("null") >= 0) { log.debug("Exception writing to connection: {}", this); break; diff --git a/common/src/main/java/org/red5/server/net/rtmp/RTMPType.java b/common/src/main/java/org/red5/server/net/rtmp/RTMPType.java index 35fae4b0f..731fd403d 100644 --- a/common/src/main/java/org/red5/server/net/rtmp/RTMPType.java +++ b/common/src/main/java/org/red5/server/net/rtmp/RTMPType.java @@ -9,16 +9,16 @@ /** * Enum for RTMP types. - * + * * @author Paul Gregoire (mondain@gmail.com) */ public enum RTMPType { /** * The specification refers to the following types by different names: 0x03 = Acknowledgement 0x04 = User control message 0x05 = Window Acknowledgement Size 0x06 = Set Peer Bandwidth 0x0f = AMF3 Data message 0x10 = AMF3 Shared object message 0x11 = AMF3 Command message 0x12 = AMF0 Data message 0x13 = AMF0 Shared object message 0x14 = AMF0 Command message - * + * * ------------------------------------------------------------------- RTMFP related (here for reference) - * + * * 0x30 Initiator hello 0x70 Responder hello 0x38 Initiator initial keying 0x78 Responder initial keying 0x0f Forwarded initiator hello 0x71 Forwarded hello response 0x10 Normal user data 0x11 Next user data 0x0c Session failed on client side 0x4c Session died 0x01 Causes response with 0x41, reset keep alive 0x41 Reset times keep alive 0x5e Negative ack 0x51 Some ack */ TYPE_CHUNK_SIZE(0x01), TYPE_ABORT(0x02), TYPE_BYTES_READ(0x03), TYPE_PING(0x04), TYPE_SERVER_BANDWIDTH(0x05), TYPE_CLIENT_BANDWIDTH(0x06), TYPE_EDGE_ORIGIN(0x07), TYPE_AUDIO_DATA(0x08), TYPE_VIDEO_DATA(0x09), TYPE_UNK1(0x0a), TYPE_UNK2(0x0b), TYPE_UNK3(0x0c), TYPE_UNK4(0x0d), TYPE_UNK5(0x0e), TYPE_FLEX_STREAM_SEND(0x0f), TYPE_FLEX_SHARED_OBJECT(0x10), TYPE_FLEX_MESSAGE(0x11), TYPE_NOTIFY( diff --git a/common/src/main/java/org/red5/server/net/rtmp/RTMPUtils.java b/common/src/main/java/org/red5/server/net/rtmp/RTMPUtils.java index 2549371bf..006101b8e 100644 --- a/common/src/main/java/org/red5/server/net/rtmp/RTMPUtils.java +++ b/common/src/main/java/org/red5/server/net/rtmp/RTMPUtils.java @@ -49,7 +49,7 @@ public static void writeMediumInt(IoBuffer out, int value) { /** * Read unsigned 24 bit integer. - * + * * @param in input * @return unsigned int */ @@ -105,7 +105,7 @@ public static int readReverseInt(IoBuffer in) { /** * Encodes header size marker and channel id into header marker. - * + * * @param out output buffer * @param headerSize Header size marker * @param channelId Channel used @@ -184,7 +184,7 @@ public static int getHeaderLength(byte headerSize) { /** * Compares two RTMP time stamps, accounting for time stamp wrapping. - * + * * @param a * First time stamp * @param b @@ -198,7 +198,7 @@ public static int compareTimestamps(final int a, final int b) { /** * Calculates the delta between two time stamps, adjusting for time stamp wrapping. - * + * * @param a * First time stamp * @param b diff --git a/common/src/main/java/org/red5/server/net/rtmp/ReadBuffer.java b/common/src/main/java/org/red5/server/net/rtmp/ReadBuffer.java index 4325873cd..2dba71157 100644 --- a/common/src/main/java/org/red5/server/net/rtmp/ReadBuffer.java +++ b/common/src/main/java/org/red5/server/net/rtmp/ReadBuffer.java @@ -16,7 +16,7 @@ /** * Buffer for incoming data. - * + * * @author Paul Gregoire (mondain@gmail.com) * */ @@ -29,7 +29,7 @@ public class ReadBuffer { /** * Returns the buffer size. - * + * * @return buffer remaining */ public int getBufferSize() { @@ -38,7 +38,7 @@ public int getBufferSize() { /** * Add a byte array to the buffer. - * + * * @param in * incoming bytes */ @@ -49,7 +49,7 @@ public void addBuffer(byte[] in) { /** * Add a IoBuffer to the buffer. - * + * * @param in * incoming IoBuffer */ @@ -64,7 +64,7 @@ public void addBuffer(IoBuffer in) { /** * Returns buffered IoBuffer itself. - * + * * @return IoBuffer */ public IoBuffer getBufferAsIoBuffer() { @@ -75,7 +75,7 @@ public IoBuffer getBufferAsIoBuffer() { /** * Returns buffered byte array. - * + * * @return bytes */ public byte[] getBuffer() { @@ -86,7 +86,7 @@ public byte[] getBuffer() { /** * Returns buffered byte array. - * + * * @param length size of the array to return * @return bytes */ diff --git a/common/src/main/java/org/red5/server/net/rtmp/ReceivedMessageTask.java b/common/src/main/java/org/red5/server/net/rtmp/ReceivedMessageTask.java index 0897d7e53..385fbd87f 100644 --- a/common/src/main/java/org/red5/server/net/rtmp/ReceivedMessageTask.java +++ b/common/src/main/java/org/red5/server/net/rtmp/ReceivedMessageTask.java @@ -21,7 +21,7 @@ /** * Wraps processing of incoming messages. - * + * * @author Paul Gregoire (mondain@gmail.com) */ public final class ReceivedMessageTask implements Callable { diff --git a/common/src/main/java/org/red5/server/net/rtmp/codec/IEventDecoder.java b/common/src/main/java/org/red5/server/net/rtmp/codec/IEventDecoder.java index b991b81a9..1cf455676 100644 --- a/common/src/main/java/org/red5/server/net/rtmp/codec/IEventDecoder.java +++ b/common/src/main/java/org/red5/server/net/rtmp/codec/IEventDecoder.java @@ -25,7 +25,7 @@ public interface IEventDecoder { /** * Decodes event of Unknown type. - * + * * @param dataType * Data type * @param in @@ -36,7 +36,7 @@ public interface IEventDecoder { /** * Decodes chunk size event. - * + * * @param in * Byte buffer to decode * @return ChunkSize event @@ -45,7 +45,7 @@ public interface IEventDecoder { /** * Decodes shared object message event. - * + * * @param in * Byte buffer to decode * @return ISharedObjectMessage event @@ -54,7 +54,7 @@ public interface IEventDecoder { /** * Decodes shared object message event from AMF3 encoding. - * + * * @param in * Byte buffer to decode * @return ISharedObjectMessage event @@ -63,7 +63,7 @@ public interface IEventDecoder { /** * Decodes ping event. - * + * * @param in * Byte buffer to decode * @return Ping event @@ -72,7 +72,7 @@ public interface IEventDecoder { /** * Decodes BytesRead event. - * + * * @param in * Byte buffer to decode * @return BytesRead event @@ -81,7 +81,7 @@ public interface IEventDecoder { /** * Decodes the aggregated data. - * + * * @param in * Byte buffer to decode * @return Aggregate event @@ -90,7 +90,7 @@ public interface IEventDecoder { /** * Decodes audio data event. - * + * * @param in * Byte buffer to decode * @return AudioData event @@ -99,7 +99,7 @@ public interface IEventDecoder { /** * Decodes video data event. - * + * * @param in * Byte buffer to decode * @return VideoData event @@ -108,7 +108,7 @@ public interface IEventDecoder { /** * Decodes Flex message event. - * + * * @param in * Byte buffer to decode * @return FlexMessage event diff --git a/common/src/main/java/org/red5/server/net/rtmp/codec/RTMP.java b/common/src/main/java/org/red5/server/net/rtmp/codec/RTMP.java index 5fd6f677e..4d6f5e0bb 100644 --- a/common/src/main/java/org/red5/server/net/rtmp/codec/RTMP.java +++ b/common/src/main/java/org/red5/server/net/rtmp/codec/RTMP.java @@ -104,7 +104,7 @@ public RTMP() { /** * Returns channel information for a given channel id. - * + * * @param channelId * @return channel info */ @@ -317,7 +317,7 @@ public void setWriteChunkSize(int writeChunkSize) { /** * Getter for encoding version. - * + * * @return Encoding version */ public Encoding getEncoding() { @@ -326,7 +326,7 @@ public Encoding getEncoding() { /** * Setter for encoding version. - * + * * @param encoding * Encoding version */ @@ -344,7 +344,7 @@ public int getLastFullTimestampWritten(int channelId) { /** * Sets the last "read" packet header for the given channel. - * + * * @param channelId channel id * @param header header */ @@ -354,7 +354,7 @@ public void setLastReadPacketHeader(int channelId, Header header) { /** * Returns the last "read" packet header for the given channel. - * + * * @param channelId channel id * @return Header */ diff --git a/common/src/main/java/org/red5/server/net/rtmp/codec/RTMPCodecFactory.java b/common/src/main/java/org/red5/server/net/rtmp/codec/RTMPCodecFactory.java index cf562c7d6..e12db7344 100644 --- a/common/src/main/java/org/red5/server/net/rtmp/codec/RTMPCodecFactory.java +++ b/common/src/main/java/org/red5/server/net/rtmp/codec/RTMPCodecFactory.java @@ -47,7 +47,7 @@ public ProtocolEncoder getEncoder(IoSession session) { /** * Returns the RTMP decoder. - * + * * @return decoder */ public RTMPProtocolDecoder getRTMPDecoder() { @@ -56,7 +56,7 @@ public RTMPProtocolDecoder getRTMPDecoder() { /** * Returns the RTMP encoder. - * + * * @return encoder */ public RTMPProtocolEncoder getRTMPEncoder() { diff --git a/common/src/main/java/org/red5/server/net/rtmp/codec/RTMPMinaProtocolDecoder.java b/common/src/main/java/org/red5/server/net/rtmp/codec/RTMPMinaProtocolDecoder.java index 141a52f76..989b4d4c1 100644 --- a/common/src/main/java/org/red5/server/net/rtmp/codec/RTMPMinaProtocolDecoder.java +++ b/common/src/main/java/org/red5/server/net/rtmp/codec/RTMPMinaProtocolDecoder.java @@ -105,7 +105,7 @@ public void decode(IoSession session, IoBuffer in, ProtocolDecoderOutput out) th /** * Sets the RTMP protocol decoder. - * + * * @param decoder * RTMP decoder */ @@ -115,7 +115,7 @@ public void setDecoder(RTMPProtocolDecoder decoder) { /** * Returns an RTMP decoder. - * + * * @return RTMP decoder */ public RTMPProtocolDecoder getDecoder() { diff --git a/common/src/main/java/org/red5/server/net/rtmp/codec/RTMPMinaProtocolEncoder.java b/common/src/main/java/org/red5/server/net/rtmp/codec/RTMPMinaProtocolEncoder.java index 86f03772b..2cbe82ba1 100644 --- a/common/src/main/java/org/red5/server/net/rtmp/codec/RTMPMinaProtocolEncoder.java +++ b/common/src/main/java/org/red5/server/net/rtmp/codec/RTMPMinaProtocolEncoder.java @@ -93,7 +93,7 @@ public void encode(IoSession session, Object message, ProtocolEncoderOutput out) /** * Sets an RTMP protocol encoder - * + * * @param encoder * the RTMP encoder */ @@ -103,7 +103,7 @@ public void setEncoder(RTMPProtocolEncoder encoder) { /** * Returns an RTMP encoder - * + * * @return RTMP encoder */ public RTMPProtocolEncoder getEncoder() { @@ -112,7 +112,7 @@ public RTMPProtocolEncoder getEncoder() { /** * Setter for baseTolerance - * + * * @param baseTolerance * base tolerance */ @@ -122,7 +122,7 @@ public void setBaseTolerance(long baseTolerance) { /** * Setter for dropLiveFuture - * + * * @param dropLiveFuture * drop live future */ diff --git a/common/src/main/java/org/red5/server/net/rtmp/codec/RTMPProtocolDecoder.java b/common/src/main/java/org/red5/server/net/rtmp/codec/RTMPProtocolDecoder.java index 97963e464..0f1def81d 100644 --- a/common/src/main/java/org/red5/server/net/rtmp/codec/RTMPProtocolDecoder.java +++ b/common/src/main/java/org/red5/server/net/rtmp/codec/RTMPProtocolDecoder.java @@ -81,7 +81,7 @@ public RTMPProtocolDecoder() { /** * Decode all available objects in buffer. - * + * * @param conn * RTMP connection * @param buffer @@ -153,7 +153,7 @@ public List decodeBuffer(RTMPConnection conn, IoBuffer buffer) { /** * Decodes the buffer data. - * + * * @param conn * RTMP connection * @param state @@ -161,10 +161,10 @@ public List decodeBuffer(RTMPConnection conn, IoBuffer buffer) { * @param in * IoBuffer of data to be decoded * @return one of three possible values: - * + * *
-     * 1. null : the object could not be decoded, or some data was skipped, just continue 
-     * 2. ProtocolState : the decoder was unable to decode the whole object, refer to the protocol state 
+     * 1. null : the object could not be decoded, or some data was skipped, just continue
+     * 2. ProtocolState : the decoder was unable to decode the whole object, refer to the protocol state
      * 3. Object : something was decoded, continue
      * 
* @throws ProtocolException @@ -202,7 +202,7 @@ public Object decode(RTMPConnection conn, RTMPDecodeState state, IoBuffer in) th /** * Decodes an IoBuffer into a Packet. - * + * * @param conn * Connection * @param state @@ -306,7 +306,7 @@ public Packet decodePacket(RTMPConnection conn, RTMPDecodeState state, IoBuffer // store the last ts in thread local for debugging //lastTimestamp.set(header.getTimerBase()); final IRTMPEvent message = decodeMessage(conn, packet.getHeader(), buf); - // flash will send an earlier time stamp when resetting a video stream with a new key frame. To avoid dropping it, we give it the + // flash will send an earlier time stamp when resetting a video stream with a new key frame. To avoid dropping it, we give it the // minimal increment since the last message. To avoid relative time stamps being mis-computed, we don't reset the header we stored. message.setTimestamp(timestamp); if (log.isTraceEnabled()) { @@ -339,7 +339,7 @@ public Packet decodePacket(RTMPConnection conn, RTMPDecodeState state, IoBuffer /** * Decodes packet header. - * + * * @param chh * chunk header * @param state @@ -473,7 +473,7 @@ public Header decodeHeader(ChunkHeader chh, RTMPDecodeState state, IoBuffer in, /** * Decodes RTMP message event. - * + * * @param conn * RTMP connection * @param header @@ -562,7 +562,7 @@ public IRTMPEvent decodeAbort(IoBuffer in) { /** * Decodes server bandwidth. - * + * * @param in * IoBuffer * @return RTMP event @@ -573,7 +573,7 @@ private IRTMPEvent decodeServerBW(IoBuffer in) { /** * Decodes client bandwidth. - * + * * @param in * Byte buffer * @return RTMP event @@ -644,7 +644,7 @@ public ISharedObjectMessage decodeSharedObject(IoBuffer in) { /** * Perform the actual decoding of the shared object contents. - * + * * @param so * Shared object message * @param in @@ -726,7 +726,7 @@ protected void doDecodeSharedObject(SharedObjectMessage so, IoBuffer in, Input i /** * Decode the 'action' for a supplied an Invoke. - * + * * @param encoding * AMF encoding * @param in @@ -788,7 +788,7 @@ private int readTransactionId(Input input) { /** * Decodes ping event. - * + * * @param in * IoBuffer * @return Ping event @@ -842,7 +842,7 @@ public VideoData decodeVideoData(IoBuffer in) { /** * Decodes stream data, to include onMetaData, onCuePoint, and onFI. - * + * * @param in * input buffer * @return Notify @@ -979,7 +979,7 @@ public Notify decodeStreamData(IoBuffer in) { /** * Decodes FlexMessage event. - * + * * @param in * IoBuffer * @return FlexMessage event @@ -1049,7 +1049,7 @@ public FlexMessage decodeFlexMessage(IoBuffer in) { /** * Sets whether or not a header error on any channel should result in a closed connection. - * + * * @param closeOnHeaderError * true to close on header decode errors */ @@ -1059,7 +1059,7 @@ public void setCloseOnHeaderError(boolean closeOnHeaderError) { /** * Checks if the passed action is a reserved stream method. - * + * * @param action * Action to check * @return true if passed action is a reserved stream method, false otherwise @@ -1088,7 +1088,7 @@ private boolean isStreamCommand(String action) { /** * Sets incoming connection parameters and / or returns encoded parameters for use in a call. - * + * * @param in * @param notify * @param input @@ -1122,7 +1122,7 @@ private Object[] handleParameters(IoBuffer in, Notify notify, Input input) { /** * Set the maximum allowed packet size. Default is 3 Mb. - * + * * @param maxPacketSize maximum allowed size for a packet */ public static void setMaxPacketSize(int maxPacketSize) { diff --git a/common/src/main/java/org/red5/server/net/rtmp/codec/RTMPProtocolEncoder.java b/common/src/main/java/org/red5/server/net/rtmp/codec/RTMPProtocolEncoder.java index 6e6f09283..e5f6d84fb 100755 --- a/common/src/main/java/org/red5/server/net/rtmp/codec/RTMPProtocolEncoder.java +++ b/common/src/main/java/org/red5/server/net/rtmp/codec/RTMPProtocolEncoder.java @@ -87,7 +87,7 @@ public class RTMPProtocolEncoder implements Constants, IEventEncoder { /** * Encodes object with given protocol state to byte buffer - * + * * @param message * Object to encode * @return IoBuffer with encoded data @@ -191,12 +191,12 @@ public IoBuffer encodePacket(Packet packet) { /** * Determine if this message should be dropped. If the traffic from server to client is congested, then drop LIVE messages to help alleviate congestion. - * + * * - determine latency between server and client using ping * - ping timestamp is unsigned int (4 bytes) and is set from value on sender - * + * * 1st drop disposable frames - lowest mark 2nd drop interframes - middle 3rd drop key frames - high mark - * + * * @param channelId * the channel ID * @param message @@ -337,7 +337,7 @@ protected boolean dropMessage(int channelId, IRTMPEvent message) { /** * Determine type of header to use. - * + * * @param header RTMP message header * @param lastHeader Previous header * @return Header type to use @@ -360,7 +360,7 @@ private byte getHeaderType(final Header header, final Header lastHeader) { /** * Calculate number of bytes necessary to encode the header. - * + * * @param header * RTMP message header * @param lastHeader @@ -381,7 +381,7 @@ private int calculateHeaderSize(final Header header, final Header lastHeader) { /** * Encode RTMP header. - * + * * @param header * RTMP message header * @param lastHeader @@ -422,7 +422,7 @@ public void encodeHeader(Header header, Header lastHeader, IoBuffer buf) { switch (headerType) { case HEADER_NEW: // type 0 - 11 bytes timeBase = header.getTimerBase(); - // absolute time - unsigned 24-bit (3 bytes) (chop at max 24bit time) + // absolute time - unsigned 24-bit (3 bytes) (chop at max 24bit time) RTMPUtils.writeMediumInt(buf, Math.min(timeBase, MEDIUM_INT_MAX)); // header size 24-bit (3 bytes) RTMPUtils.writeMediumInt(buf, headerSize); @@ -953,7 +953,7 @@ public IoBuffer encodeStreamMetadata(Notify metaData) { /** * Generate error object to return for given exception. - * + * * @param code * call * @param error @@ -1025,7 +1025,7 @@ public void setBaseTolerance(long baseTolerance) { /** * Setter for dropLiveFuture - * + * * @param dropLiveFuture * drop live data with future times */ diff --git a/common/src/main/java/org/red5/server/net/rtmp/event/Abort.java b/common/src/main/java/org/red5/server/net/rtmp/event/Abort.java index 8320ab6a9..593bbc8c8 100644 --- a/common/src/main/java/org/red5/server/net/rtmp/event/Abort.java +++ b/common/src/main/java/org/red5/server/net/rtmp/event/Abort.java @@ -13,7 +13,7 @@ /** * RTMP Abort event. - * + * * @author aclarke@xuggle.com */ public class Abort extends BaseEvent { diff --git a/common/src/main/java/org/red5/server/net/rtmp/event/Aggregate.java b/common/src/main/java/org/red5/server/net/rtmp/event/Aggregate.java index 21e36fa87..3bc41c01b 100644 --- a/common/src/main/java/org/red5/server/net/rtmp/event/Aggregate.java +++ b/common/src/main/java/org/red5/server/net/rtmp/event/Aggregate.java @@ -51,7 +51,7 @@ public Aggregate() { /** * Create aggregate data event with given data buffer. - * + * * @param data * data */ @@ -62,7 +62,7 @@ public Aggregate(IoBuffer data) { /** * Create aggregate data event with given data buffer. - * + * * @param data * aggregate data * @param copy @@ -107,7 +107,7 @@ public void setData(byte[] data) { /** * Breaks-up the aggregate into its individual parts and returns them as a list. The parts are returned based on the ordering of the aggregate itself. - * + * * @return list of IRTMPEvent objects */ public LinkedList getParts() { @@ -239,7 +239,7 @@ public void writeExternal(ObjectOutput out) throws IOException { /** * Duplicate this message / event. - * + * * @return duplicated event */ public Aggregate duplicate() throws IOException, ClassNotFoundException { diff --git a/common/src/main/java/org/red5/server/net/rtmp/event/AllocationDebugger.java b/common/src/main/java/org/red5/server/net/rtmp/event/AllocationDebugger.java index b8323cbf8..1ff9fb02d 100644 --- a/common/src/main/java/org/red5/server/net/rtmp/event/AllocationDebugger.java +++ b/common/src/main/java/org/red5/server/net/rtmp/event/AllocationDebugger.java @@ -17,7 +17,7 @@ /** * Simple allocation debugger for Event reference counting. - * + * * @author The Red5 Project * @author Steven Gong (steven.gong@gmail.com) on behalf of (ce@publishing-etc.de) * @author Paul Gregoire (mondain@gmail.com) @@ -56,7 +56,7 @@ public Info() { /** * Getter for instance - * + * * @return Allocation debugger instance */ public static AllocationDebugger getInstance() { @@ -71,7 +71,7 @@ private AllocationDebugger() { /** * Add event to map - * + * * @param event * Event */ @@ -81,7 +81,7 @@ protected void create(BaseEvent event) { /** * Retain event - * + * * @param event * Event */ @@ -96,7 +96,7 @@ protected void retain(BaseEvent event) { /** * Release event if there's no more references to it - * + * * @param event * Event */ diff --git a/common/src/main/java/org/red5/server/net/rtmp/event/AudioData.java b/common/src/main/java/org/red5/server/net/rtmp/event/AudioData.java index 5dc203f09..97fd92a0b 100644 --- a/common/src/main/java/org/red5/server/net/rtmp/event/AudioData.java +++ b/common/src/main/java/org/red5/server/net/rtmp/event/AudioData.java @@ -54,7 +54,7 @@ public AudioData(IoBuffer data) { /** * Create audio data event with given data buffer - * + * * @param data * Audio data * @param copy @@ -151,7 +151,7 @@ public void writeExternal(ObjectOutput out) throws IOException { /** * Duplicate this message / event. - * + * * @return duplicated event */ public AudioData duplicate() throws IOException, ClassNotFoundException { diff --git a/common/src/main/java/org/red5/server/net/rtmp/event/BaseEvent.java b/common/src/main/java/org/red5/server/net/rtmp/event/BaseEvent.java index 7e00c1b34..664132f3b 100644 --- a/common/src/main/java/org/red5/server/net/rtmp/event/BaseEvent.java +++ b/common/src/main/java/org/red5/server/net/rtmp/event/BaseEvent.java @@ -73,7 +73,7 @@ public BaseEvent() { /** * Create new event of given type - * + * * @param type * Event type */ @@ -83,7 +83,7 @@ public BaseEvent(Type type) { /** * Create new event of given type - * + * * @param type * Event type * @param source diff --git a/common/src/main/java/org/red5/server/net/rtmp/event/BytesRead.java b/common/src/main/java/org/red5/server/net/rtmp/event/BytesRead.java index a86539210..0b7d7370a 100644 --- a/common/src/main/java/org/red5/server/net/rtmp/event/BytesRead.java +++ b/common/src/main/java/org/red5/server/net/rtmp/event/BytesRead.java @@ -29,7 +29,7 @@ public BytesRead() { /** * Creates new event with given bytes number - * + * * @param bytesRead * Number of bytes read */ diff --git a/common/src/main/java/org/red5/server/net/rtmp/event/CachedEvent.java b/common/src/main/java/org/red5/server/net/rtmp/event/CachedEvent.java index c3bb3cfdd..42f17ad2c 100644 --- a/common/src/main/java/org/red5/server/net/rtmp/event/CachedEvent.java +++ b/common/src/main/java/org/red5/server/net/rtmp/event/CachedEvent.java @@ -12,7 +12,7 @@ /** * Provides a means for storage of RTMP events. - * + * * @author Paul Gregoire (mondain@gmail.com) */ public class CachedEvent implements IStreamPacket { diff --git a/common/src/main/java/org/red5/server/net/rtmp/event/ChunkSize.java b/common/src/main/java/org/red5/server/net/rtmp/event/ChunkSize.java index 877259574..005f2cd9c 100644 --- a/common/src/main/java/org/red5/server/net/rtmp/event/ChunkSize.java +++ b/common/src/main/java/org/red5/server/net/rtmp/event/ChunkSize.java @@ -29,7 +29,7 @@ public ChunkSize() { /** * Create chunk size event with given size - * + * * @param size * Chunk size */ diff --git a/common/src/main/java/org/red5/server/net/rtmp/event/ClientBW.java b/common/src/main/java/org/red5/server/net/rtmp/event/ClientBW.java index 947a08cd1..d073a8f4e 100644 --- a/common/src/main/java/org/red5/server/net/rtmp/event/ClientBW.java +++ b/common/src/main/java/org/red5/server/net/rtmp/event/ClientBW.java @@ -25,7 +25,7 @@ public class ClientBW extends BaseEvent { /** * Enforcement level or limit type of the bandwidth value based on three values. - * + * *
      * TYPE_HARD 0
      * TYPE_SOFT 1
diff --git a/common/src/main/java/org/red5/server/net/rtmp/event/ClientInvokeEvent.java b/common/src/main/java/org/red5/server/net/rtmp/event/ClientInvokeEvent.java
index 2fd9b2439..f07c9051c 100644
--- a/common/src/main/java/org/red5/server/net/rtmp/event/ClientInvokeEvent.java
+++ b/common/src/main/java/org/red5/server/net/rtmp/event/ClientInvokeEvent.java
@@ -6,7 +6,7 @@
 
 /**
  * Represents an invoke to be executed on a connected client.
- * 
+ *
  * @author Paul Gregoire (mondain@gmail.com)
  */
 public class ClientInvokeEvent extends BaseEvent {
diff --git a/common/src/main/java/org/red5/server/net/rtmp/event/ClientNotifyEvent.java b/common/src/main/java/org/red5/server/net/rtmp/event/ClientNotifyEvent.java
index 0a2e56412..b7aede4be 100644
--- a/common/src/main/java/org/red5/server/net/rtmp/event/ClientNotifyEvent.java
+++ b/common/src/main/java/org/red5/server/net/rtmp/event/ClientNotifyEvent.java
@@ -4,7 +4,7 @@
 
 /**
  * Represents an notify to be executed on a connected client.
- * 
+ *
  * @author Paul Gregoire (mondain@gmail.com)
  */
 public class ClientNotifyEvent extends BaseEvent {
diff --git a/common/src/main/java/org/red5/server/net/rtmp/event/FlexStreamSend.java b/common/src/main/java/org/red5/server/net/rtmp/event/FlexStreamSend.java
index 2542c7604..60ba8031c 100644
--- a/common/src/main/java/org/red5/server/net/rtmp/event/FlexStreamSend.java
+++ b/common/src/main/java/org/red5/server/net/rtmp/event/FlexStreamSend.java
@@ -11,7 +11,7 @@
 
 /**
  * AMF3 stream send message.
- * 
+ *
  * @author The Red5 Project
  * @author Joachim Bauch (jojo@struktur.de)
  */
@@ -26,7 +26,7 @@ public FlexStreamSend() {
 
     /**
      * Create new stream send object.
-     * 
+     *
      * @param data
      *            data
      */
diff --git a/common/src/main/java/org/red5/server/net/rtmp/event/Invoke.java b/common/src/main/java/org/red5/server/net/rtmp/event/Invoke.java
index 94f62a7ba..4e4e70b25 100644
--- a/common/src/main/java/org/red5/server/net/rtmp/event/Invoke.java
+++ b/common/src/main/java/org/red5/server/net/rtmp/event/Invoke.java
@@ -31,7 +31,7 @@ public Invoke() {
 
     /**
      * Create new invocation event with given data
-     * 
+     *
      * @param data
      *            Event data
      */
@@ -42,7 +42,7 @@ public Invoke(IoBuffer data) {
 
     /**
      * Create new invocation event with given pending service call
-     * 
+     *
      * @param call
      *            Pending call
      */
@@ -53,7 +53,7 @@ public Invoke(IPendingServiceCall call) {
 
     /**
      * Setter for transaction id
-     * 
+     *
      * @param transactionId
      *            the transactionId to set
      */
@@ -87,7 +87,7 @@ public boolean equals(Object obj) {
 
     /**
      * Duplicate this Invoke message to future injection. Serialize to memory and deserialize, safe way.
-     * 
+     *
      * @return duplicated Invoke event
      */
     @Override
diff --git a/common/src/main/java/org/red5/server/net/rtmp/event/Notify.java b/common/src/main/java/org/red5/server/net/rtmp/event/Notify.java
index c91577929..ffbabcac3 100644
--- a/common/src/main/java/org/red5/server/net/rtmp/event/Notify.java
+++ b/common/src/main/java/org/red5/server/net/rtmp/event/Notify.java
@@ -63,7 +63,7 @@ public Notify() {
 
     /**
      * Create new notification event with given byte buffer
-     * 
+     *
      * @param data
      *            Byte buffer
      */
@@ -74,7 +74,7 @@ public Notify(IoBuffer data) {
 
     /**
      * Create new notification event with given byte buffer and action.
-     * 
+     *
      * @param data Byte buffer
      * @param action Action / method
      */
@@ -86,7 +86,7 @@ public Notify(IoBuffer data, String action) {
 
     /**
      * Create new notification event with given service call
-     * 
+     *
      * @param call
      *            Service call
      */
@@ -262,7 +262,7 @@ public void writeExternal(ObjectOutput out) throws IOException {
 
     /**
      * Duplicate this Notify message to future injection Serialize to memory and deserialize, safe way.
-     * 
+     *
      * @return duplicated Notify event
      */
     public Notify duplicate() throws IOException, ClassNotFoundException {
diff --git a/common/src/main/java/org/red5/server/net/rtmp/event/Ping.java b/common/src/main/java/org/red5/server/net/rtmp/event/Ping.java
index bc3622594..258ee6021 100644
--- a/common/src/main/java/org/red5/server/net/rtmp/event/Ping.java
+++ b/common/src/main/java/org/red5/server/net/rtmp/event/Ping.java
@@ -175,7 +175,7 @@ public byte getDataType() {
 
     /**
      * Returns the events sub-type
-     * 
+     *
      * @return the event type
      */
     public short getEventType() {
@@ -184,7 +184,7 @@ public short getEventType() {
 
     /**
      * Sets the events sub-type
-     * 
+     *
      * @param eventType
      *            event type
      */
diff --git a/common/src/main/java/org/red5/server/net/rtmp/event/SWFResponse.java b/common/src/main/java/org/red5/server/net/rtmp/event/SWFResponse.java
index b9823028c..f9fb0faba 100644
--- a/common/src/main/java/org/red5/server/net/rtmp/event/SWFResponse.java
+++ b/common/src/main/java/org/red5/server/net/rtmp/event/SWFResponse.java
@@ -7,7 +7,7 @@
 
 /**
  * Control message used in response to a SWF verification request.
- * 
+ *
  * @author Paul Gregoire (mondain@gmail.com)
  */
 public class SWFResponse extends Ping {
diff --git a/common/src/main/java/org/red5/server/net/rtmp/event/ServerBW.java b/common/src/main/java/org/red5/server/net/rtmp/event/ServerBW.java
index c3b223806..c88a88149 100644
--- a/common/src/main/java/org/red5/server/net/rtmp/event/ServerBW.java
+++ b/common/src/main/java/org/red5/server/net/rtmp/event/ServerBW.java
@@ -28,7 +28,7 @@ public ServerBW() {
 
     /**
      * Server bandwidth event
-     * 
+     *
      * @param bandwidth
      *            Bandwidth
      */
diff --git a/common/src/main/java/org/red5/server/net/rtmp/event/SetBuffer.java b/common/src/main/java/org/red5/server/net/rtmp/event/SetBuffer.java
index af094b5d0..cb1c7ab7e 100644
--- a/common/src/main/java/org/red5/server/net/rtmp/event/SetBuffer.java
+++ b/common/src/main/java/org/red5/server/net/rtmp/event/SetBuffer.java
@@ -6,7 +6,7 @@
 
 /**
  * Control message used to set a buffer.
- * 
+ *
  * @author Paul Gregoire (mondain@gmail.com)
  */
 public class SetBuffer extends Ping {
diff --git a/common/src/main/java/org/red5/server/net/rtmp/event/StreamActionEvent.java b/common/src/main/java/org/red5/server/net/rtmp/event/StreamActionEvent.java
index ff49f1766..842a4315b 100644
--- a/common/src/main/java/org/red5/server/net/rtmp/event/StreamActionEvent.java
+++ b/common/src/main/java/org/red5/server/net/rtmp/event/StreamActionEvent.java
@@ -6,7 +6,7 @@
 
 /**
  * Represents a stream action occurring on a connection or stream. This event is used to notify an IEventHandler; it is not meant to be sent over the wire to clients.
- * 
+ *
  * @author Paul Gregoire (mondain@gmail.com)
  */
 public class StreamActionEvent implements IEvent {
diff --git a/common/src/main/java/org/red5/server/net/rtmp/event/Unknown.java b/common/src/main/java/org/red5/server/net/rtmp/event/Unknown.java
index 5278e33ac..ae7a5c1a6 100644
--- a/common/src/main/java/org/red5/server/net/rtmp/event/Unknown.java
+++ b/common/src/main/java/org/red5/server/net/rtmp/event/Unknown.java
@@ -35,7 +35,7 @@ public Unknown() {
 
     /**
      * Create new unknown event with given data and data type
-     * 
+     *
      * @param dataType
      *            Data type
      * @param data
diff --git a/common/src/main/java/org/red5/server/net/rtmp/event/VideoData.java b/common/src/main/java/org/red5/server/net/rtmp/event/VideoData.java
index 54676fa20..c20129a98 100644
--- a/common/src/main/java/org/red5/server/net/rtmp/event/VideoData.java
+++ b/common/src/main/java/org/red5/server/net/rtmp/event/VideoData.java
@@ -73,7 +73,7 @@ public VideoData() {
 
     /**
      * Create video data event with given data buffer
-     * 
+     *
      * @param data
      *            Video data
      */
@@ -84,7 +84,7 @@ public VideoData(IoBuffer data) {
 
     /**
      * Create video data event with given data buffer
-     * 
+     *
      * @param data
      *            Video data
      * @param copy
@@ -213,7 +213,7 @@ public void writeExternal(ObjectOutput out) throws IOException {
 
     /**
      * Duplicate this message / event.
-     * 
+     *
      * @return duplicated event
      */
     public VideoData duplicate() throws IOException, ClassNotFoundException {
diff --git a/common/src/main/java/org/red5/server/net/rtmp/message/ChunkHeader.java b/common/src/main/java/org/red5/server/net/rtmp/message/ChunkHeader.java
index dcf8a22bd..e9539ed9f 100644
--- a/common/src/main/java/org/red5/server/net/rtmp/message/ChunkHeader.java
+++ b/common/src/main/java/org/red5/server/net/rtmp/message/ChunkHeader.java
@@ -19,7 +19,7 @@
 
 /**
  * RTMP chunk header
- * 
+ *
  * 
  * rtmp_specification_1.0.pdf (5.3.1.1 page 12)
  * 
@@ -102,7 +102,7 @@ public void setSize(byte size) { /** * Read chunk header from the buffer. - * + * * @param in * buffer * @return ChunkHeader instance diff --git a/common/src/main/java/org/red5/server/net/rtmp/message/Constants.java b/common/src/main/java/org/red5/server/net/rtmp/message/Constants.java index 62bc5bbcc..9f7357911 100644 --- a/common/src/main/java/org/red5/server/net/rtmp/message/Constants.java +++ b/common/src/main/java/org/red5/server/net/rtmp/message/Constants.java @@ -210,7 +210,7 @@ static enum DataType { TYPE_PING, // 4 Ping / control TYPE_SERVER_BANDWIDTH, // 5 Window Acknowledgement Size TYPE_CLIENT_BANDWIDTH, // 6 Set Peer Bandwidth - TYPE_EDGE_ORIGIN, // 7 + TYPE_EDGE_ORIGIN, // 7 TYPE_AUDIO_DATA, // 8 Audio TYPE_VIDEO_DATA, // 9 Video TYPE_UNK_0A, // 0x0a 10 diff --git a/common/src/main/java/org/red5/server/net/rtmp/message/Packet.java b/common/src/main/java/org/red5/server/net/rtmp/message/Packet.java index fbb117085..e19413631 100644 --- a/common/src/main/java/org/red5/server/net/rtmp/message/Packet.java +++ b/common/src/main/java/org/red5/server/net/rtmp/message/Packet.java @@ -60,7 +60,7 @@ public Packet() { /** * Create packet with given header. - * + * * @param header * Packet header */ @@ -74,7 +74,7 @@ public Packet(Header header) { /** * Create packet with given header and event context. - * + * * @param header * RTMP header * @param event @@ -154,7 +154,7 @@ public IoBuffer getData() { /** * Returns whether or not the packet has a data buffer. - * + * * @return true if data buffer exists and false otherwise */ public boolean hasData() { @@ -174,7 +174,7 @@ public void clearData() { /** * Return the expiration time. - * + * * @return expirationTime */ public long getExpirationTime() { @@ -183,7 +183,7 @@ public long getExpirationTime() { /** * Set the expiration time. - * + * * @param expirationTime new expiration time to set */ public void setExpirationTime(long expirationTime) { @@ -192,7 +192,7 @@ public void setExpirationTime(long expirationTime) { /** * Returns true if expiration time has been reached and false otherwise. - * + * * @return expired or not */ public boolean isExpired() { @@ -202,7 +202,7 @@ public boolean isExpired() { /** * Sets the processed flag. - * + * * @param isProcessed * true if processed and false otherwise */ @@ -212,7 +212,7 @@ public void setProcessed(boolean isProcessed) { /** * Gets the processed flag. - * + * * @return true if processed and false otherwise */ public boolean isProcessed() { diff --git a/common/src/main/java/org/red5/server/net/rtmp/message/SharedObjectTypeMapping.java b/common/src/main/java/org/red5/server/net/rtmp/message/SharedObjectTypeMapping.java index 9e432f39f..3f22c0080 100644 --- a/common/src/main/java/org/red5/server/net/rtmp/message/SharedObjectTypeMapping.java +++ b/common/src/main/java/org/red5/server/net/rtmp/message/SharedObjectTypeMapping.java @@ -24,7 +24,7 @@ public class SharedObjectTypeMapping { public static final Type[] typeMap = new Type[] { null, Type.SERVER_CONNECT, // 01 Type.SERVER_DISCONNECT, // 02 Type.SERVER_SET_ATTRIBUTE, // 03 - Type.CLIENT_UPDATE_DATA, // 04 + Type.CLIENT_UPDATE_DATA, // 04 Type.CLIENT_UPDATE_ATTRIBUTE, // 05 Type.SERVER_SEND_MESSAGE, // 06 Type.CLIENT_STATUS, // 07 @@ -36,7 +36,7 @@ public class SharedObjectTypeMapping { /** * Convert byte value of RTMP marker to event type - * + * * @param rtmpType * RTMP marker value * @return Corresponding Shared Object event type @@ -47,7 +47,7 @@ public static Type toType(byte rtmpType) { /** * Convert SO event type to byte representation that RTMP uses - * + * * @param type * Event type * @return Byte representation of given event type @@ -86,7 +86,7 @@ public static byte toByte(Type type) { /** * String representation of type - * + * * @param type * Type * @return String representation of type diff --git a/common/src/main/java/org/red5/server/net/rtmp/status/RuntimeStatusObject.java b/common/src/main/java/org/red5/server/net/rtmp/status/RuntimeStatusObject.java index 3751cd188..cc3b229e6 100644 --- a/common/src/main/java/org/red5/server/net/rtmp/status/RuntimeStatusObject.java +++ b/common/src/main/java/org/red5/server/net/rtmp/status/RuntimeStatusObject.java @@ -38,7 +38,7 @@ public RuntimeStatusObject() { /** * Create runtime status object with given code, level and description - * + * * @param code * Status code * @param level @@ -52,7 +52,7 @@ public RuntimeStatusObject(String code, String level, String description) { /** * Create runtime status object with given code, level, description, details and client id - * + * * @param code * Status code * @param level diff --git a/common/src/main/java/org/red5/server/net/rtmp/status/Status.java b/common/src/main/java/org/red5/server/net/rtmp/status/Status.java index 10a43a0ea..0efcacd6b 100644 --- a/common/src/main/java/org/red5/server/net/rtmp/status/Status.java +++ b/common/src/main/java/org/red5/server/net/rtmp/status/Status.java @@ -70,7 +70,7 @@ public Status() { /** * Creates status object with given status code - * + * * @param code * Status code */ @@ -81,7 +81,7 @@ public Status(String code) { /** * Creates status object with given level, description and status code - * + * * @param code * Status code * @param level diff --git a/common/src/main/java/org/red5/server/net/rtmp/status/StatusCodes.java b/common/src/main/java/org/red5/server/net/rtmp/status/StatusCodes.java index 25cd67d87..2ca7b0fa5 100644 --- a/common/src/main/java/org/red5/server/net/rtmp/status/StatusCodes.java +++ b/common/src/main/java/org/red5/server/net/rtmp/status/StatusCodes.java @@ -168,7 +168,7 @@ public interface StatusCodes { /** * Transition to another stream has been forced. - * + * * If streams that are being switched do not have aligned content/timelines, or if the keyframes are not aligned between the two streams, it is possible that the server will have to force a hard transition. This can also happen with broadcast (live) dynamic streaming if the server cannot find a synchronization point within the two streams. This is set as the "reason" property of the NetStatusEvent. */ public static final String NS_TRANSITION_FORCED = "NetStream.Transition.Forced"; @@ -217,7 +217,7 @@ public interface StatusCodes { /** * The ActionScript engine has encountered a runtime warning. In addition to the standard infoObject properties, the following properties are set: - * + * * filename: name of the offending ASC file. lineno: line number where the error occurred. linebuf: source code of the offending line */ public static final String APP_SCRIPT_WARNING = "Application.Script.Warning"; diff --git a/common/src/main/java/org/red5/server/net/rtmp/status/StatusObject.java b/common/src/main/java/org/red5/server/net/rtmp/status/StatusObject.java index 7f7c137ba..7eef01df9 100644 --- a/common/src/main/java/org/red5/server/net/rtmp/status/StatusObject.java +++ b/common/src/main/java/org/red5/server/net/rtmp/status/StatusObject.java @@ -22,7 +22,7 @@ /** * Status object that is sent to client with every status event - * + * * @author The Red5 Project * @author Luke Hubbard, Codegent Ltd (luke@codegent.com) */ @@ -147,7 +147,7 @@ public String toString() { /** * Generate Status object that can be returned through a RTMP channel. - * + * * @return status */ public Status asStatus() { diff --git a/common/src/main/java/org/red5/server/net/rtmp/status/StatusObjectService.java b/common/src/main/java/org/red5/server/net/rtmp/status/StatusObjectService.java index 28dbfdb0b..3c81cf2de 100644 --- a/common/src/main/java/org/red5/server/net/rtmp/status/StatusObjectService.java +++ b/common/src/main/java/org/red5/server/net/rtmp/status/StatusObjectService.java @@ -138,7 +138,7 @@ public void cacheStatusObjects() { /** * Serializes status object - * + * * @param out * Byte buffer for output object * @param statusObject @@ -152,7 +152,7 @@ public void serializeStatusObject(IoBuffer out, StatusObject statusObject) { /** * Return status object by code - * + * * @param statusCode * Status object code * @return Status object with given code @@ -163,7 +163,7 @@ public StatusObject getStatusObject(String statusCode) { /** * Return status object by code as byte array - * + * * @param statusCode * Status object code * @return Status object with given code as byte array diff --git a/common/src/main/java/org/red5/server/net/rtmpe/EncryptedWriteRequest.java b/common/src/main/java/org/red5/server/net/rtmpe/EncryptedWriteRequest.java index 8169fdfe7..fb92507dc 100644 --- a/common/src/main/java/org/red5/server/net/rtmpe/EncryptedWriteRequest.java +++ b/common/src/main/java/org/red5/server/net/rtmpe/EncryptedWriteRequest.java @@ -6,7 +6,7 @@ /** * Used to parcel encrypted content for RTMPE. - * + * * @author Paul Gregoire */ public class EncryptedWriteRequest extends WriteRequestWrapper { diff --git a/common/src/main/java/org/red5/server/net/rtmpt/RTMPTHandler.java b/common/src/main/java/org/red5/server/net/rtmpt/RTMPTHandler.java index 4eec6ff67..8925cdf7c 100644 --- a/common/src/main/java/org/red5/server/net/rtmpt/RTMPTHandler.java +++ b/common/src/main/java/org/red5/server/net/rtmpt/RTMPTHandler.java @@ -14,7 +14,7 @@ /** * Handler for RTMPT messages. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) * @author Paul Gregoire (mondain@gmail.com) @@ -49,7 +49,7 @@ public RTMPTCodecFactory getCodecFactory() { /** * Return hostname for URL. - * + * * @param url * URL * @return Hostname from that URL diff --git a/common/src/main/java/org/red5/server/net/servlet/ServletUtils.java b/common/src/main/java/org/red5/server/net/servlet/ServletUtils.java index 2b4fb1126..c9aa3e921 100644 --- a/common/src/main/java/org/red5/server/net/servlet/ServletUtils.java +++ b/common/src/main/java/org/red5/server/net/servlet/ServletUtils.java @@ -31,12 +31,12 @@ public class ServletUtils { /** * Copies information from the input stream to the output stream using a default buffer size of 2048 bytes. - * + * * @param input * input * @param output * output - * + * * @throws java.io.IOException * on error */ @@ -46,7 +46,7 @@ public static void copy(InputStream input, OutputStream output) throws IOExcepti /** * Copies information from the input stream to the output stream using the specified buffer size - * + * * @param input * input * @param bufferSize @@ -88,7 +88,7 @@ public static void copy(InputStream input, OutputStream output, int bufferSize) /** * Copies information from the http request to the output stream using the specified content length. - * + * * @param req * Request * @param output @@ -116,7 +116,7 @@ public static void copy(HttpServletRequest req, OutputStream output) throws IOEx /** * Copies information between specified streams and then closes both of the streams. - * + * * @param output * output * @param input @@ -146,7 +146,7 @@ public static byte[] getBytes(InputStream input) throws IOException { /** * Return all remote addresses that were involved in the passed request. - * + * * @param request * request * @return remote addresses @@ -155,7 +155,7 @@ public static List getRemoteAddresses(HttpServletRequest request) { List addresses = new ArrayList(); addresses.add(request.getRemoteHost()); if (!request.getRemoteAddr().equals(request.getRemoteHost())) { - // Store both remote host and remote address + // Store both remote host and remote address addresses.add(request.getRemoteAddr()); } final String forwardedFor = request.getHeader("X-Forwarded-For"); diff --git a/common/src/main/java/org/red5/server/persistence/RamPersistence.java b/common/src/main/java/org/red5/server/persistence/RamPersistence.java index 988df31d7..1777921e6 100644 --- a/common/src/main/java/org/red5/server/persistence/RamPersistence.java +++ b/common/src/main/java/org/red5/server/persistence/RamPersistence.java @@ -20,7 +20,7 @@ /** * Persistence implementation that stores the objects in memory. This serves as default persistence if nothing has been configured. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) * @author Michael Klishin (michael@novemberain.com) @@ -29,7 +29,7 @@ public class RamPersistence implements IPersistenceStore { /** * This is used in the id for objects that have a name of - * + * *
      * null
      * 
@@ -48,7 +48,7 @@ public class RamPersistence implements IPersistenceStore { /** * Creates RAM persistence object from resource pattern resolvers - * + * * @param resources * Resource pattern resolver and loader */ @@ -58,7 +58,7 @@ public RamPersistence(ResourcePatternResolver resources) { /** * Creates RAM persistence object from scope - * + * * @param scope * Scope */ @@ -68,11 +68,11 @@ public RamPersistence(IScope scope) { /** * Get resource name from path. The format of the object id is - * + * *
      * type / path / objectName
      * 
- * + * * @param id * object id * @return resource name @@ -88,11 +88,11 @@ protected String getObjectName(String id) { /** * Get object path for given id and name. The format of the object id is - * + * *
      * type / path / objectName
      * 
- * + * * @param id * object id * @param name @@ -113,7 +113,7 @@ protected String getObjectPath(String id, String name) { /** * Get object id - * + * * @param object * Persistable object whose id is asked for * @return Given persistable object id diff --git a/common/src/main/java/org/red5/server/plugin/PluginDescriptor.java b/common/src/main/java/org/red5/server/plugin/PluginDescriptor.java index 3c8c22dc8..64819fdc0 100644 --- a/common/src/main/java/org/red5/server/plugin/PluginDescriptor.java +++ b/common/src/main/java/org/red5/server/plugin/PluginDescriptor.java @@ -11,7 +11,7 @@ /** * Simple descriptor for plug-ins. - * + * * @author Paul Gregoire */ public final class PluginDescriptor { diff --git a/common/src/main/java/org/red5/server/plugin/PluginLauncher.java b/common/src/main/java/org/red5/server/plugin/PluginLauncher.java index 74d8aebb0..24fece292 100644 --- a/common/src/main/java/org/red5/server/plugin/PluginLauncher.java +++ b/common/src/main/java/org/red5/server/plugin/PluginLauncher.java @@ -25,7 +25,7 @@ /** * Creates the plug-in environment and cleans up on shutdown. - * + * * @author Paul Gregoire (mondain@gmail.com) */ public class PluginLauncher implements ApplicationContextAware, InitializingBean { diff --git a/common/src/main/java/org/red5/server/plugin/PluginRegistry.java b/common/src/main/java/org/red5/server/plugin/PluginRegistry.java index 25912ef39..7ecd67ab4 100644 --- a/common/src/main/java/org/red5/server/plugin/PluginRegistry.java +++ b/common/src/main/java/org/red5/server/plugin/PluginRegistry.java @@ -20,7 +20,7 @@ /** * Central registry for Red5 plug-ins. - * + * * @author Paul Gregoire */ public class PluginRegistry { @@ -44,7 +44,7 @@ public class PluginRegistry { /** * Registers a plug-in. - * + * * @param plugin * plugin */ @@ -77,7 +77,7 @@ public static void register(IRed5Plugin plugin) { /** * Unregisters a plug-in. - * + * * @param plugin * plugin */ @@ -112,7 +112,7 @@ public static void unregister(IRed5Plugin plugin) { /** * Returns a plug-in. - * + * * @param pluginName * plugin name * @return requested plug-in matching the name given or null if not found @@ -130,7 +130,7 @@ public static IRed5Plugin getPlugin(String pluginName) { /** * Shuts down the registry and stops any plug-ins that are found. - * + * * @throws Exception * on exception */ diff --git a/common/src/main/java/org/red5/server/plugin/Red5Plugin.java b/common/src/main/java/org/red5/server/plugin/Red5Plugin.java index bb4baa947..53c5ce579 100644 --- a/common/src/main/java/org/red5/server/plugin/Red5Plugin.java +++ b/common/src/main/java/org/red5/server/plugin/Red5Plugin.java @@ -14,7 +14,7 @@ /** * Provides more features to the plug-in system. - * + * * @author Paul Gregoire (mondain@gmail.com) */ public abstract class Red5Plugin implements IRed5Plugin { @@ -49,7 +49,7 @@ public void setApplicationContext(ApplicationContext context) { /** * Return the server reference. - * + * * @return server */ public Server getServer() { @@ -63,7 +63,7 @@ public void setServer(Server server) { /** * Set the application making use of this plug-in. - * + * * @param application * application */ diff --git a/common/src/main/java/org/red5/server/scheduling/JDKSchedulingServiceJob.java b/common/src/main/java/org/red5/server/scheduling/JDKSchedulingServiceJob.java index b706b2a5e..f39171a16 100644 --- a/common/src/main/java/org/red5/server/scheduling/JDKSchedulingServiceJob.java +++ b/common/src/main/java/org/red5/server/scheduling/JDKSchedulingServiceJob.java @@ -16,7 +16,7 @@ /** * Scheduled job that is registered in the Quartz scheduler. - * + * * @author The Red5 Project * @author Paul Gregoire (mondain@gmail.com) */ diff --git a/common/src/main/java/org/red5/server/scope/BasicScope.java b/common/src/main/java/org/red5/server/scope/BasicScope.java index d00502acc..ecf74b5fb 100644 --- a/common/src/main/java/org/red5/server/scope/BasicScope.java +++ b/common/src/main/java/org/red5/server/scope/BasicScope.java @@ -182,7 +182,7 @@ public String getPath() { /** * Sets the amount of time to keep the scope available after the last disconnect. - * + * * @param keepDelay delay */ public void setKeepDelay(int keepDelay) { @@ -191,7 +191,7 @@ public void setKeepDelay(int keepDelay) { /** * Validates a scope based on its name and type - * + * * @return true if both name and type are valid, false otherwise */ public boolean isValid() { @@ -264,7 +264,7 @@ public void setSecurityHandlers(Set handlers) { /** * Add event listener to list of notified objects - * + * * @param listener Listening object * @return true if listener is added and false otherwise */ @@ -275,7 +275,7 @@ public boolean addEventListener(IEventListener listener) { /** * Remove event listener from list of listeners - * + * * @param listener * Listener to remove * @return true if listener is removed and false otherwise @@ -315,7 +315,7 @@ public Set getEventListeners() { /** * Returns true if there are event listeners attached to this scope. - * + * * @return true if it has listeners; else false. */ public boolean hasEventListeners() { @@ -334,7 +334,7 @@ public boolean handleEvent(IEvent event) { /** * Notifies listeners on event. Current implementation is empty. To be implemented in subclass realization - * + * * @param event Event to broadcast */ public void notifyEvent(IEvent event) { @@ -356,7 +356,7 @@ public void dispatchEvent(IEvent event) { /** * Hash code is based on the scope's name and type - * + * * @return hash code */ public int hashCode() { @@ -369,7 +369,7 @@ public int hashCode() { /** * Equality is based on the scope's name and type. - * + * * @param obj * object */ diff --git a/common/src/main/java/org/red5/server/scope/Scope.java b/common/src/main/java/org/red5/server/scope/Scope.java index ddd829dba..b1d18f98f 100644 --- a/common/src/main/java/org/red5/server/scope/Scope.java +++ b/common/src/main/java/org/red5/server/scope/Scope.java @@ -60,7 +60,7 @@ * 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
@@ -68,7 +68,7 @@
  *              /Shared object scope - Contains shared object
  *              /Broadcast stream scope - Contains a broadcast stream
  * 
- * + * * @author The Red5 Project * @author Paul Gregoire (mondain@gmail.com) * @author Nathan Smith (nathgs@gmail.com) @@ -169,7 +169,7 @@ public Scope() { /** * Creates scope via parameters. - * + * * @param parent scope parent * @param type scope type * @param name scope name @@ -183,7 +183,7 @@ public Scope(IScope parent, ScopeType type, String name, boolean persistent) { /** * 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 @@ -220,7 +220,7 @@ public boolean addChildScope(IBasicScope scope) { /** * Connect to scope - * + * * @param conn * Connection object * @return true on success, false otherwise @@ -232,7 +232,7 @@ public boolean connect(IConnection conn) { /** * 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 @@ -289,7 +289,7 @@ public boolean connect(IConnection conn, Object[] params) { /** * Create child scope of room type, with the given name. - * + * * @param name * child scope name * @return true on success, false otherwise @@ -307,7 +307,7 @@ public boolean createChildScope(String name) { /** * Destroys scope - * + * * @throws Exception * on error */ @@ -331,7 +331,7 @@ public void destroy() throws Exception { /** * Disconnect connection from scope - * + * * @param conn * Connection object */ @@ -440,7 +440,7 @@ public int getActiveSubscopes() { /** * Return the broadcast scope for a given name. - * + * * @param name * name * @return broadcast scope or null if not found @@ -451,7 +451,7 @@ public IBroadcastScope getBroadcastScope(String name) { /** * Return base scope with given name. - * + * * @param name * Scope name * @return Basic scope object @@ -462,7 +462,7 @@ public IBasicScope getBasicScope(String name) { /** * Return base scope of given type with given name. - * + * * @param type * Scope type * @param name @@ -475,7 +475,7 @@ public IBasicScope getBasicScope(ScopeType type, String name) { /** * Return basic scope names matching given type. - * + * * @param type * Scope type * @return set of scope names @@ -513,7 +513,7 @@ public Set getBasicScopeNames(ScopeType type) { /** * Return current thread context classloader. - * + * * @return Classloader for thread context */ public ClassLoader getClassLoader() { @@ -522,7 +522,7 @@ public ClassLoader getClassLoader() { /** * Return set of clients. - * + * * @return Set of clients bound to scope */ public Set getClients() { @@ -589,7 +589,7 @@ public IConnection lookupConnection(IClient client) { /** * 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() { @@ -604,7 +604,7 @@ public IContext getContext() { /** * Return scope context path - * + * * @return Scope context path */ public String getContextPath() { @@ -624,7 +624,7 @@ public long getCreationTime() { /** * return scope depth - * + * * @return Scope depth */ @Override @@ -641,7 +641,7 @@ public int getDepth() { /** * 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() { @@ -672,7 +672,7 @@ public int getMaxSubscopes() { /** * Return parent scope - * + * * @return Parent scope */ @Override @@ -682,7 +682,7 @@ public IScope getParent() { /** * Return scope path calculated from parent path and parent scope name - * + * * @return Scope path */ @Override @@ -696,7 +696,7 @@ public String getPath() { /** * Return resource located at given path - * + * * @param path * Resource path * @return Resource @@ -710,7 +710,7 @@ public Resource getResource(String path) { /** * Return array of resources from path string, usually used with pattern path - * + * * @param path * Resources path * @return Resources @@ -726,7 +726,7 @@ public Resource[] getResources(String path) throws IOException { /** * Return child scope by name - * + * * @param name * Scope name * @return Child scope with given name @@ -745,7 +745,7 @@ public IScope getScope(String name) { /** * Return child scope names iterator - * + * * @return Child scope names iterator */ public Set getScopeNames() { @@ -755,7 +755,7 @@ public Set getScopeNames() { /** * Return service handler by name - * + * * @param name * Handler name * @return Service handler with given name @@ -770,7 +770,7 @@ public Object getServiceHandler(String 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") @@ -784,7 +784,7 @@ public Set getServiceHandlerNames() { /** * Return map of service handlers. The map is created if it doesn't exist yet. - * + * * @return Map of service handlers */ protected Map getServiceHandlers() { @@ -793,7 +793,7 @@ protected Map getServiceHandlers() { /** * 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 @@ -830,7 +830,7 @@ public int getTotalSubscopes() { /** * Handles event. To be implemented in subclasses. - * + * * @param event * Event to handle * @return true on success, false otherwise @@ -842,7 +842,7 @@ public boolean handleEvent(IEvent event) { /** * 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 @@ -854,7 +854,7 @@ public boolean hasChildScope(String name) { /** * Check whether scope has child scope with given name and type - * + * * @param type * Child scope type * @param name @@ -868,7 +868,7 @@ public boolean hasChildScope(ScopeType type, String name) { /** * Check if scope has a context - * + * * @return true if scope has context, false otherwise */ public boolean hasContext() { @@ -877,7 +877,7 @@ public boolean hasContext() { /** * 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() { @@ -886,7 +886,7 @@ public boolean hasHandler() { /** * Check if scope has parent scope - * + * * @return true if scope has parent scope, false otherwise` */ @Override @@ -940,7 +940,7 @@ public void uninit() { /** * Check if scope is enabled - * + * * @return true if scope is enabled, false otherwise */ public boolean isEnabled() { @@ -956,7 +956,7 @@ public boolean getEnabled() { /** * Check if scope is in running state - * + * * @return true if scope is in running state, false otherwise */ public boolean isRunning() { @@ -972,7 +972,7 @@ public boolean getRunning() { /** * Register service handler by name - * + * * @param name * Service handler name * @param handler @@ -985,7 +985,7 @@ public void registerServiceHandler(String name, Object handler) { /** * Removes child scope - * + * * @param scope * Child scope to remove */ @@ -1009,7 +1009,7 @@ public void removeChildren() { /** * Setter for autostart flag - * + * * @param autoStart * Autostart flag value */ @@ -1019,7 +1019,7 @@ public void setAutoStart(boolean autoStart) { /** * Setter for child load path. Should be implemented in subclasses? - * + * * @param pattern * Load path pattern */ @@ -1029,7 +1029,7 @@ public void setChildLoadPath(String pattern) { /** * Setter for context - * + * * @param context * Context object */ @@ -1040,7 +1040,7 @@ public void setContext(IContext context) { /** * Set scope depth - * + * * @param depth * Scope depth */ @@ -1050,7 +1050,7 @@ public void setDepth(int depth) { /** * Enable or disable scope by setting enable flag - * + * * @param enabled * Enable flag value */ @@ -1060,7 +1060,7 @@ public void setEnabled(boolean enabled) { /** * Setter for scope event handler - * + * * @param handler * Event handler */ @@ -1074,7 +1074,7 @@ public void setHandler(IScopeHandler handler) { /** * Setter for scope name - * + * * @param name * Scope name */ @@ -1097,7 +1097,7 @@ public final void setName(String name) { /** * Setter for parent scope - * + * * @param parent * Parent scope */ @@ -1108,7 +1108,7 @@ public void setParent(IScope parent) { /** * Set scope persistence class - * + * * @param persistenceClass * Scope's persistence class * @throws Exception @@ -1123,7 +1123,7 @@ public void setPersistenceClass(String persistenceClass) throws Exception { /** * Starts scope - * + * * @return true if scope has handler and it's start method returned true, false otherwise */ public boolean start() { @@ -1189,7 +1189,7 @@ public String toString() { /** * Unregisters service handler by name - * + * * @param name * Service handler name */ @@ -1202,7 +1202,7 @@ public void unregisterServiceHandler(String name) { /** * Return the server instance connected to this scope. - * + * * @return the server instance */ public IServer getServer() { @@ -1271,7 +1271,7 @@ protected void unregisterJMX() { /** * Allows for reconstruction via CompositeData. - * + * * @param cd * composite data * @return Scope class instance @@ -1334,7 +1334,7 @@ public boolean add(IBasicScope scope) { if (!contains(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 + // 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)) { @@ -1402,7 +1402,7 @@ public boolean remove(Object scope) { /** * Returns the scope names. - * + * * @return names */ public Set getNames() { @@ -1413,7 +1413,7 @@ public Set getNames() { /** * Returns whether or not a named scope exists. - * + * * @return true if a matching scope is found, false otherwise */ public boolean hasName(String name) { @@ -1430,7 +1430,7 @@ public boolean hasName(String name) { /** * Returns a child scope for a given name and type. - * + * * @param type * Scope type * @param name diff --git a/common/src/main/java/org/red5/server/scope/ScopeSecurityHandler.java b/common/src/main/java/org/red5/server/scope/ScopeSecurityHandler.java index 05723c5fe..f41accc20 100644 --- a/common/src/main/java/org/red5/server/scope/ScopeSecurityHandler.java +++ b/common/src/main/java/org/red5/server/scope/ScopeSecurityHandler.java @@ -15,7 +15,7 @@ /** * Scope security handler providing positive results to any allow request. - * + * * @author Paul Gregoire (mondain@gmail.com) */ public class ScopeSecurityHandler implements IScopeSecurityHandler { diff --git a/common/src/main/java/org/red5/server/service/Call.java b/common/src/main/java/org/red5/server/service/Call.java index 7fddd26f0..4073cd38f 100644 --- a/common/src/main/java/org/red5/server/service/Call.java +++ b/common/src/main/java/org/red5/server/service/Call.java @@ -120,7 +120,7 @@ public Call() { /** * Creates call from method name - * + * * @param method * Method name */ @@ -130,7 +130,7 @@ public Call(String method) { /** * Creates call from method name and array of call parameters - * + * * @param method * Method name * @param args @@ -143,7 +143,7 @@ public Call(String method, Object[] args) { /** * Creates call from given service name, method name and array of call parameters - * + * * @param name * Service name * @param method diff --git a/common/src/main/java/org/red5/server/service/IServiceResolver.java b/common/src/main/java/org/red5/server/service/IServiceResolver.java index c7ab1cde1..5133e57a6 100644 --- a/common/src/main/java/org/red5/server/service/IServiceResolver.java +++ b/common/src/main/java/org/red5/server/service/IServiceResolver.java @@ -11,9 +11,9 @@ /** * Interface for objects that resolve service names to services. - * + * * This is used by the ServiceInvoker to lookup the service to invoke a method on. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ @@ -21,17 +21,17 @@ public interface IServiceResolver { /** * Search for a service with the given name in the scope. - * + * * @param scope * the scope to search in * @param serviceName * the name of the service * @return the object implementing the service or - * + * *
      * null
      * 
- * + * * if service doesn't exist */ public Object resolveService(IScope scope, String serviceName); diff --git a/common/src/main/java/org/red5/server/service/MethodNotFoundException.java b/common/src/main/java/org/red5/server/service/MethodNotFoundException.java index 68822aac5..e57c7c6f0 100644 --- a/common/src/main/java/org/red5/server/service/MethodNotFoundException.java +++ b/common/src/main/java/org/red5/server/service/MethodNotFoundException.java @@ -18,13 +18,13 @@ public class MethodNotFoundException extends RuntimeException { /** - * + * */ private static final long serialVersionUID = 7559230924102506068L; /** * Creates exception with given method name - * + * * @param methodName * Service method name that can't be found */ @@ -34,7 +34,7 @@ public MethodNotFoundException(String methodName) { /** * Creates exception with given method name and arguments - * + * * @param methodName * Service method name that can't be found * @param args diff --git a/common/src/main/java/org/red5/server/service/NotAllowedException.java b/common/src/main/java/org/red5/server/service/NotAllowedException.java index 69d0a6199..819198017 100644 --- a/common/src/main/java/org/red5/server/service/NotAllowedException.java +++ b/common/src/main/java/org/red5/server/service/NotAllowedException.java @@ -9,14 +9,14 @@ /** * Thrown when a client is not allowed to execute a method. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ public class NotAllowedException extends RuntimeException { /** - * + * */ private static final long serialVersionUID = -7552833324276839926L; diff --git a/common/src/main/java/org/red5/server/service/PendingCall.java b/common/src/main/java/org/red5/server/service/PendingCall.java index c66bec1c5..05d7c4189 100644 --- a/common/src/main/java/org/red5/server/service/PendingCall.java +++ b/common/src/main/java/org/red5/server/service/PendingCall.java @@ -38,7 +38,7 @@ public PendingCall() { /** * Creates pending call with given method name - * + * * @param method * Method name */ @@ -48,7 +48,7 @@ public PendingCall(String method) { /** * Creates pending call with given method name and array of parameters - * + * * @param method * Method name * @param args diff --git a/common/src/main/java/org/red5/server/service/ReflectionUtils.java b/common/src/main/java/org/red5/server/service/ReflectionUtils.java index 7e6d89201..c765906a7 100644 --- a/common/src/main/java/org/red5/server/service/ReflectionUtils.java +++ b/common/src/main/java/org/red5/server/service/ReflectionUtils.java @@ -28,7 +28,7 @@ public class ReflectionUtils { /** * Returns (method, params) for the given service or (null, null) if no method was found. - * + * * @param service * Service * @param methodName @@ -48,7 +48,7 @@ public static Object[] findMethodWithExactParameters(Object service, String meth /** * Returns (method, params) for the given service or (null, null) if not method was found. XXX use ranking for method matching rather * than exact type matching plus type conversion. - * + * * @param service * Service * @param methodName @@ -119,7 +119,7 @@ public static Object[] findMethodWithExactParameters(Object service, String meth /** * Returns (method, params) for the given service or (null, null) if no method was found. - * + * * @param service * Service * @param methodName @@ -138,7 +138,7 @@ public static Object[] findMethodWithListParameters(Object service, String metho /** * Returns (method, params) for the given service or (null, null) if not method was found. - * + * * @param service * Service * @param methodName diff --git a/common/src/main/java/org/red5/server/service/ServiceInvoker.java b/common/src/main/java/org/red5/server/service/ServiceInvoker.java index 40f684ec7..df14ac4a8 100644 --- a/common/src/main/java/org/red5/server/service/ServiceInvoker.java +++ b/common/src/main/java/org/red5/server/service/ServiceInvoker.java @@ -28,7 +28,7 @@ /** * Makes remote calls, invoking services, resolves service handlers - * + * * @author The Red5 Project * @author Luke Hubbard, Codegent Ltd (luke@codegent.com) */ @@ -48,7 +48,7 @@ public class ServiceInvoker implements IServiceInvoker { /** * Setter for service resolvers. - * + * * @param resolvers * Service resolvers */ @@ -58,7 +58,7 @@ public void setServiceResolvers(Set resolvers) { /** * Lookup a handler for the passed service name in the given scope. - * + * * @param scope * Scope * @param serviceName diff --git a/common/src/main/java/org/red5/server/service/ServiceNotFoundException.java b/common/src/main/java/org/red5/server/service/ServiceNotFoundException.java index a3c5f7441..b49f1436f 100644 --- a/common/src/main/java/org/red5/server/service/ServiceNotFoundException.java +++ b/common/src/main/java/org/red5/server/service/ServiceNotFoundException.java @@ -16,7 +16,7 @@ public class ServiceNotFoundException extends RuntimeException { /** - * + * */ private static final long serialVersionUID = 7543755414829244027L; @@ -25,7 +25,7 @@ public class ServiceNotFoundException extends RuntimeException { /** * Creates new exception with service name - * + * * @param serviceName * Name of service that couldn't been found */ @@ -36,7 +36,7 @@ public ServiceNotFoundException(String serviceName) { /** * Get the name of the service that doesn't exist. - * + * * @return name of the service */ public String getServiceName() { diff --git a/common/src/main/java/org/red5/server/so/ClientSharedObject.java b/common/src/main/java/org/red5/server/so/ClientSharedObject.java index 1e56cbc94..0f79e287e 100644 --- a/common/src/main/java/org/red5/server/so/ClientSharedObject.java +++ b/common/src/main/java/org/red5/server/so/ClientSharedObject.java @@ -52,7 +52,7 @@ public class ClientSharedObject extends SharedObject implements IClientSharedObj /** * Create new client SO with - * + * * @param name * Shared Object name * @param persistent @@ -66,7 +66,7 @@ public ClientSharedObject(String name, boolean persistent) { /** * Connect the shared object using the passed connection. - * + * * @param conn * Attach SO to given connection */ @@ -184,7 +184,7 @@ protected void notifyDisconnect() { /** * Notify listeners on update - * + * * @param key * Updated attribute key * @param value @@ -198,7 +198,7 @@ protected void notifyUpdate(String key, Object value) { /** * Notify listeners on map attribute update - * + * * @param key * Updated attribute key * @param value @@ -217,7 +217,7 @@ protected void notifyUpdate(String key, Map value) { /** * Notify listeners on attribute delete - * + * * @param key * Attribute name */ @@ -238,7 +238,7 @@ protected void notifyClear() { /** * Broadcast send event to listeners - * + * * @param method * Method name * @param params diff --git a/common/src/main/java/org/red5/server/so/ISharedObjectEvent.java b/common/src/main/java/org/red5/server/so/ISharedObjectEvent.java index c4a134461..ac2b64981 100644 --- a/common/src/main/java/org/red5/server/so/ISharedObjectEvent.java +++ b/common/src/main/java/org/red5/server/so/ISharedObjectEvent.java @@ -18,14 +18,14 @@ enum Type { /** * Returns the type of the event. - * + * * @return the type of the event */ public Type getType(); /** * Returns the key of the event. - * + * * Depending on the type this contains: *
    *
  • the attribute name to set for SET_ATTRIBUTE
  • @@ -33,21 +33,21 @@ enum Type { *
  • the handler name to call for SEND_MESSAGE
  • *
* In all other cases the key is null - * + * * @return the key of the event */ public String getKey(); /** * Returns the value of the event. - * + * * Depending on the type this contains: *
    *
  • the attribute value to set for SET_ATTRIBUTE
  • *
  • a list of parameters to pass to the handler for SEND_MESSAGE
  • *
* In all other cases the value is null - * + * * @return the value of the event */ public Object getValue(); diff --git a/common/src/main/java/org/red5/server/so/ISharedObjectMessage.java b/common/src/main/java/org/red5/server/so/ISharedObjectMessage.java index 27407d43e..dc1b8815b 100644 --- a/common/src/main/java/org/red5/server/so/ISharedObjectMessage.java +++ b/common/src/main/java/org/red5/server/so/ISharedObjectMessage.java @@ -18,35 +18,35 @@ public interface ISharedObjectMessage extends IRTMPEvent { /** * Returns the name of the shared object this message belongs to. - * + * * @return name of the shared object */ public String getName(); /** * Returns the version to modify. - * + * * @return version to modify */ public int getVersion(); /** * Does the message affect a persistent shared object? - * + * * @return true if a persistent shared object should be updated otherwise false */ public boolean isPersistent(); /** * Returns a set of ISharedObjectEvent objects containing informations what to change. - * + * * @return set of ISharedObjectEvents */ public Set getEvents(); /** * Addition event handler - * + * * @param type Event type * @param key Handler key * @param value Event value (like arguments) @@ -56,7 +56,7 @@ public interface ISharedObjectMessage extends IRTMPEvent { /** * Add event handler - * + * * @param event SO event * @return true if event is added and false if it is not added */ diff --git a/common/src/main/java/org/red5/server/so/SharedObject.java b/common/src/main/java/org/red5/server/so/SharedObject.java index e3ee73f14..a98a52380 100644 --- a/common/src/main/java/org/red5/server/so/SharedObject.java +++ b/common/src/main/java/org/red5/server/so/SharedObject.java @@ -161,7 +161,7 @@ public SharedObject() { /** * Constructs new SO from Input object - * + * * @param input * Input source * @throws IOException @@ -195,7 +195,7 @@ public SharedObject(String name, String path, boolean persistent) { /** * Creates new SO from given data map, name, path, storage object and persistence option - * + * * @param name * SO name * @param path @@ -229,7 +229,7 @@ public SharedObject(Map data, String name, String path, boolean /** * Creates new SO from given data map, name, path, storage object and persistence option - * + * * @param data * Data * @param name @@ -332,7 +332,7 @@ protected synchronized void sendUpdates() { if (log.isTraceEnabled()) { log.trace("Listeners: {}", listeners); } - // get all current sync events + // get all current sync events final TreeSet events = new TreeSet<>(syncEvents); syncEvents.removeAll(events); // updates all registered clients of this shared object @@ -378,7 +378,7 @@ protected void notifyModified() { /** * Return an error message to the client. - * + * * @param message * message */ @@ -549,7 +549,7 @@ public void removeAttributes() { /** * Broadcast event to event handler - * + * * @param handler * Event handler * @param arguments @@ -586,7 +586,7 @@ public int getVersion() { /** * Register event listener - * + * * @param listener * Event listener * @return true if listener was added @@ -612,7 +612,7 @@ protected boolean register(IEventListener listener) { /** * Unregister event listener - * + * * @param listener * Event listener */ @@ -657,7 +657,7 @@ public void beginUpdate() { /** * Begin update of this Shared Object and setting listener - * + * * @param listener * Update with listener */ @@ -721,7 +721,7 @@ public IPersistenceStore getStore() { /** * Deletes all the attributes and sends a clear event to all listeners. The persistent data object is also removed from a persistent * shared object. - * + * * @return true on success, false otherwise */ protected boolean clear() { @@ -759,7 +759,7 @@ public void acquire() { /** * Check if shared object currently is acquired. - * + * * @return true if the SO is acquired, false otherwise */ public boolean isAcquired() { diff --git a/common/src/main/java/org/red5/server/so/SharedObjectEvent.java b/common/src/main/java/org/red5/server/so/SharedObjectEvent.java index 4bf3d0a18..97ba8e16b 100644 --- a/common/src/main/java/org/red5/server/so/SharedObjectEvent.java +++ b/common/src/main/java/org/red5/server/so/SharedObjectEvent.java @@ -40,7 +40,7 @@ public SharedObjectEvent() { } /** - * + * * @param type * type * @param key diff --git a/common/src/main/java/org/red5/server/so/SharedObjectMessage.java b/common/src/main/java/org/red5/server/so/SharedObjectMessage.java index 80bce2fe1..54797a8ac 100644 --- a/common/src/main/java/org/red5/server/so/SharedObjectMessage.java +++ b/common/src/main/java/org/red5/server/so/SharedObjectMessage.java @@ -54,7 +54,7 @@ public SharedObjectMessage() { /** * Creates Shared Object event with given name, version and persistence flag - * + * * @param name * Event name * @param version @@ -68,7 +68,7 @@ public SharedObjectMessage(String name, int version, boolean persistent) { /** * Creates Shared Object event with given listener, name, SO version and persistence flag - * + * * @param source * Event listener * @param name @@ -106,7 +106,7 @@ public int getVersion() { /** * Setter for version - * + * * @param version * New version */ @@ -121,7 +121,7 @@ public String getName() { /** * Setter for name - * + * * @param name * Event name */ @@ -136,7 +136,7 @@ public boolean isPersistent() { /** * Setter for persistence flag - * + * * @param persistent * Persistence flag */ diff --git a/common/src/main/java/org/red5/server/so/SharedObjectScope.java b/common/src/main/java/org/red5/server/so/SharedObjectScope.java index 0ba3b5c3a..78e572c4f 100644 --- a/common/src/main/java/org/red5/server/so/SharedObjectScope.java +++ b/common/src/main/java/org/red5/server/so/SharedObjectScope.java @@ -79,7 +79,7 @@ public class SharedObjectScope extends BasicScope implements ISharedObject, Stat /** * Creates shared object with given parent scope, name, persistence flag state and store object - * + * * @param parent * Parent scope * @param name @@ -134,7 +134,7 @@ public void release() { /** * This is no longer supported and is only here to prevent issues at runtime for those * implementing the call. - * + * * @return false */ @Deprecated @@ -477,13 +477,13 @@ public Map getData() { /** * Return security handlers for this shared object or - * + * *
      * null
      * 
- * + * * if none are found. - * + * * @return set of security handlers */ private Set getSecurityHandlers() { @@ -496,7 +496,7 @@ private Set getSecurityHandlers() { /** * Call handlers and check if connection to the existing SO is allowed. - * + * * @return is connection allowed */ protected boolean isConnectionAllowed() { @@ -521,7 +521,7 @@ protected boolean isConnectionAllowed() { /** * Call handlers and check if writing to the SO is allowed. - * + * * @param key * key * @param value @@ -550,7 +550,7 @@ protected boolean isWriteAllowed(String key, Object value) { /** * Call handlers and check if deleting a property from the SO is allowed. - * + * * @param key * key * @return is delete allowed @@ -577,7 +577,7 @@ protected boolean isDeleteAllowed(String key) { /** * Call handlers and check if sending a message to the clients connected to the SO is allowed. - * + * * @param message * message * @param arguments diff --git a/common/src/main/java/org/red5/server/so/SharedObjectService.java b/common/src/main/java/org/red5/server/so/SharedObjectService.java index ef3d61c00..118335bb9 100644 --- a/common/src/main/java/org/red5/server/so/SharedObjectService.java +++ b/common/src/main/java/org/red5/server/so/SharedObjectService.java @@ -50,7 +50,7 @@ public class SharedObjectService implements ISharedObjectService { /** * Pushes a task to the scheduler for single execution. - * + * * @param task * runnable */ @@ -68,7 +68,7 @@ public void setMaximumEventsPerUpdate(int maximumEventsPerUpdate) { /** * Setter for persistence class name. - * + * * @param name * Setter for persistence class name */ @@ -86,7 +86,7 @@ public static void setScheduler(ThreadPoolTaskScheduler scheduler) { /** * Return scope store - * + * * @param scope * Scope * @param persistent @@ -166,7 +166,7 @@ public boolean clearSharedObjects(IScope scope, String name) { if (hasSharedObject(scope, name)) { // '/' clears all local and persistent shared objects associated with the instance // /foo/bar clears the shared object /foo/bar; if bar is a directory name, no shared objects are deleted. - // /foo/bar/* clears all shared objects stored under the instance directory /foo/bar. + // /foo/bar/* clears all shared objects stored under the instance directory /foo/bar. // The bar directory is also deleted if no persistent shared objects are in use within this namespace. // /foo/bar/XX?? clears all shared objects that begin with XX, followed by any two characters. If a directory name matches // this specification, all the shared objects within this directory are cleared. diff --git a/common/src/main/java/org/red5/server/stream/AbstractClientStream.java b/common/src/main/java/org/red5/server/stream/AbstractClientStream.java index 2a237b266..f43282e54 100644 --- a/common/src/main/java/org/red5/server/stream/AbstractClientStream.java +++ b/common/src/main/java/org/red5/server/stream/AbstractClientStream.java @@ -39,7 +39,7 @@ public abstract class AbstractClientStream extends AbstractStream implements ICl /** * Setter for stream id - * + * * @param streamId * Stream id */ @@ -49,7 +49,7 @@ public void setStreamId(Number streamId) { /** * Return stream id - * + * * @return Stream id */ public Number getStreamId() { @@ -58,7 +58,7 @@ public Number getStreamId() { /** * Setter for stream capable connection - * + * * @param conn * IStreamCapableConnection object */ @@ -68,7 +68,7 @@ public void setConnection(IStreamCapableConnection conn) { /** * Return connection associated with stream - * + * * @return Stream capable connection object */ public IStreamCapableConnection getConnection() { @@ -91,7 +91,7 @@ public int getClientBufferDuration() { /** * Sets the broadcasting streams name. - * + * * @param broadcastStreamPublishName * name of the broadcasting stream */ diff --git a/common/src/main/java/org/red5/server/stream/AbstractStream.java b/common/src/main/java/org/red5/server/stream/AbstractStream.java index 4018379d1..60ea6964e 100644 --- a/common/src/main/java/org/red5/server/stream/AbstractStream.java +++ b/common/src/main/java/org/red5/server/stream/AbstractStream.java @@ -106,7 +106,7 @@ public void removeStateChangeListener(PropertyChangeListener listener) { /** * Return stream name. - * + * * @return Stream name */ public String getName() { @@ -115,7 +115,7 @@ public String getName() { /** * Return codec information. - * + * * @return Stream codec information */ public IStreamCodecInfo getCodecInfo() { @@ -124,7 +124,7 @@ public IStreamCodecInfo getCodecInfo() { /** * Returns a copy of the metadata for the associated stream, if it exists. - * + * * @return stream meta data */ public Notify getMetaData() { @@ -140,7 +140,7 @@ public Notify getMetaData() { /** * Set the metadata. - * + * * @param metaData * stream meta data */ @@ -150,7 +150,7 @@ public void setMetaData(Notify metaData) { /** * Return scope. - * + * * @return Scope */ public IScope getScope() { @@ -159,7 +159,7 @@ public IScope getScope() { /** * Returns timestamp at which the stream was created. - * + * * @return creation timestamp */ public long getCreationTime() { @@ -168,7 +168,7 @@ public long getCreationTime() { /** * Returns timestamp at which the stream was started. - * + * * @return started timestamp */ public long getStartTime() { @@ -177,7 +177,7 @@ public long getStartTime() { /** * Setter for name. - * + * * @param name * Stream name */ @@ -187,7 +187,7 @@ public void setName(String name) { /** * Setter for codec info. - * + * * @param codecInfo * Codec info */ @@ -197,7 +197,7 @@ public void setCodecInfo(IStreamCodecInfo codecInfo) { /** * Setter for scope. - * + * * @param scope * Scope */ @@ -207,7 +207,7 @@ public void setScope(IScope scope) { /** * Return stream state. - * + * * @return StreamState */ public StreamState getState() { @@ -216,7 +216,7 @@ public StreamState getState() { /** * Sets the stream state. - * + * * @param newState stream state */ public void setState(StreamState newState) { @@ -228,7 +228,7 @@ public void setState(StreamState newState) { /** * Return stream aware scope handler or null if scope is null. - * + * * @return IStreamAwareScopeHandler implementation */ protected IStreamAwareScopeHandler getStreamAwareHandler() { diff --git a/common/src/main/java/org/red5/server/stream/AudioCodecFactory.java b/common/src/main/java/org/red5/server/stream/AudioCodecFactory.java index 871063b86..f9547bed8 100644 --- a/common/src/main/java/org/red5/server/stream/AudioCodecFactory.java +++ b/common/src/main/java/org/red5/server/stream/AudioCodecFactory.java @@ -17,7 +17,7 @@ /** * Factory for audio codecs. Creates and returns audio codecs - * + * * @author The Red5 Project * @author Vladimir Hmelyoff (vlhm@splitmedialabs.com) */ @@ -49,7 +49,7 @@ public void setCodecs(List codecs) { /** * Create and return new audio codec applicable for byte buffer data - * + * * @param data * Byte buffer data * @return audio codec @@ -60,7 +60,7 @@ public static IAudioStreamCodec getAudioCodec(IoBuffer data) { //get the codec identifying byte int codecId = (data.get() & 0xf0) >> 4; switch (codecId) { - case 10: //aac + case 10: //aac result = (IAudioStreamCodec) Class.forName("org.red5.codec.AACAudio").getDeclaredConstructor().newInstance(); break; case 11: diff --git a/common/src/main/java/org/red5/server/stream/ClientBroadcastStream.java b/common/src/main/java/org/red5/server/stream/ClientBroadcastStream.java index a35bb9bc2..928b71279 100644 --- a/common/src/main/java/org/red5/server/stream/ClientBroadcastStream.java +++ b/common/src/main/java/org/red5/server/stream/ClientBroadcastStream.java @@ -86,7 +86,7 @@ * Note that recorded streams are recorded as FLV files. * * This type of stream uses two different pipes for live streaming and recording. - * + * * @author The Red5 Project * @author Steven Gong * @author Paul Gregoire (mondain@gmail.com) @@ -196,7 +196,7 @@ public class ClientBroadcastStream extends AbstractClientStream implements IClie /** * Check and send notification if necessary - * + * * @param event * Event */ @@ -253,7 +253,7 @@ public void close() { /** * Dispatches event - * + * * @param event * Event to dispatch */ @@ -417,7 +417,7 @@ public int getMaxSubscribers() { /** * Getter for provider - * + * * @return Provider */ public IProvider getProvider() { @@ -426,7 +426,7 @@ public IProvider getProvider() { /** * Setter for stream published name - * + * * @param name * Name that used for publishing. Set at client side when begin to broadcast with NetStream#publish. */ @@ -441,7 +441,7 @@ public void setPublishedName(String name) { /** * Getter for published name - * + * * @return Stream published name */ public String getPublishedName() { @@ -607,7 +607,7 @@ public void onOOBControlMessage(IMessageComponent source, IPipe pipe, OOBControl /** * Pipe connection event handler - * + * * @param event * Pipe connection event */ @@ -816,7 +816,7 @@ protected void sendRecordStopNotify() { /** * Pushes a message out to a consumer. - * + * * @param msg * StatusMessage */ @@ -956,7 +956,7 @@ public void removeStreamListener(IStreamListener listener) { /** * Get the file we'd be recording to based on scope and given name. - * + * * @param scope * scope * @param name diff --git a/common/src/main/java/org/red5/server/stream/DefaultStreamFilenameGenerator.java b/common/src/main/java/org/red5/server/stream/DefaultStreamFilenameGenerator.java index 48ac177d4..6f44490aa 100644 --- a/common/src/main/java/org/red5/server/stream/DefaultStreamFilenameGenerator.java +++ b/common/src/main/java/org/red5/server/stream/DefaultStreamFilenameGenerator.java @@ -13,7 +13,7 @@ /** * Default filename generator for streams. The files will be stored in a directory "streams" in the application folder. Option for changing directory streams are saved to is investigated as of 0.6RC1. - * + * * @author The Red5 Project * @author Joachim Bauch (bauch@struktur.de) */ @@ -21,25 +21,25 @@ public class DefaultStreamFilenameGenerator implements IStreamFilenameGenerator /** * Generate stream directory based on relative scope path. The base directory is - * + * *
      * streams
      * 
- * + * * , e.g. a scope - * + * *
      * /application/one/two/
      * 
- * + * * will generate a directory - * + * *
      * /streams/one/two/
      * 
- * + * * inside the application. - * + * * @param scope * Scope * @return Directory based on relative scope path @@ -76,15 +76,15 @@ public String generateFilename(IScope scope, String name, String extension, Gene /** * The default filenames are relative to the scope path, so always return - * + * *
      * false
      * 
- * + * * . - * + * * @return always - * + * *
      * false
      * 
diff --git a/common/src/main/java/org/red5/server/stream/IFrameDropper.java b/common/src/main/java/org/red5/server/stream/IFrameDropper.java index 0b4a19686..ecfbe10a3 100644 --- a/common/src/main/java/org/red5/server/stream/IFrameDropper.java +++ b/common/src/main/java/org/red5/server/stream/IFrameDropper.java @@ -11,7 +11,7 @@ /** * Interface for classes that implement logic to drop frames. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ @@ -31,7 +31,7 @@ public interface IFrameDropper { /** * Checks if a message may be sent to the subscriber. - * + * * @param message * the message to check * @param pending @@ -39,9 +39,9 @@ public interface IFrameDropper { * @return
      * true
      * 
- * + * * if the packet may be sent, otherwise - * + * *
      * false
      * 
@@ -50,7 +50,7 @@ public interface IFrameDropper { /** * Notify that a packet has been dropped. - * + * * @param message * the message that was dropped */ @@ -58,7 +58,7 @@ public interface IFrameDropper { /** * Notify that a message has been sent. - * + * * @param message * the message that was sent */ @@ -69,7 +69,7 @@ public interface IFrameDropper { /** * Reset the frame dropper to a given state. - * + * * @param state * the state to reset the frame dropper to */ diff --git a/common/src/main/java/org/red5/server/stream/IProviderService.java b/common/src/main/java/org/red5/server/stream/IProviderService.java index d09ec8b2c..cf30b807c 100644 --- a/common/src/main/java/org/red5/server/stream/IProviderService.java +++ b/common/src/main/java/org/red5/server/stream/IProviderService.java @@ -29,7 +29,7 @@ enum INPUT_TYPE { /** * Returns the input type for a named provider if a source of input exists. Live is checked first and VOD second. If the VOD * file is not located, a LIVE_WAIT is returned if legacy live-wait support is enabled. - * + * * @param scope * Scope of provider * @param name @@ -42,7 +42,7 @@ enum INPUT_TYPE { /** * Get a named provider as the source of input. Live stream first, VOD stream second. - * + * * @param scope * Scope of provider * @param name @@ -53,7 +53,7 @@ enum INPUT_TYPE { /** * Get a named Live provider as the source of input. - * + * * @param scope * Scope of provider * @param name @@ -66,7 +66,7 @@ enum INPUT_TYPE { /** * Get a named VOD provider as the source of input. - * + * * @param scope * Scope of provider * @param name @@ -77,7 +77,7 @@ enum INPUT_TYPE { /** * Get a named VOD source file. - * + * * @param scope * Scope of provider * @param name @@ -88,7 +88,7 @@ enum INPUT_TYPE { /** * Register a broadcast stream to a scope. - * + * * @param scope * Scope * @param name @@ -101,7 +101,7 @@ enum INPUT_TYPE { /** * Get names of existing broadcast streams in a scope. - * + * * @param scope * Scope to get stream names from * @return List of stream names @@ -110,7 +110,7 @@ enum INPUT_TYPE { /** * Unregister a broadcast stream of a specific name from a scope. - * + * * @param scope * Scope * @param name @@ -121,7 +121,7 @@ enum INPUT_TYPE { /** * Unregister a broadcast stream of a specific name from a scope. - * + * * @param scope * Scope * @param name @@ -134,14 +134,14 @@ enum INPUT_TYPE { /** * Whether or not legacy live-wait support is enabled. - * + * * @return true if enabled and false otherwise */ boolean isLiveWaitSupport(); /** * Sets live-wait support. - * + * * @param liveWaitSupport use live-wait or not */ void setLiveWaitSupport(boolean liveWaitSupport); diff --git a/common/src/main/java/org/red5/server/stream/IRecordingListener.java b/common/src/main/java/org/red5/server/stream/IRecordingListener.java index 9fe1b86e8..9e02879ca 100644 --- a/common/src/main/java/org/red5/server/stream/IRecordingListener.java +++ b/common/src/main/java/org/red5/server/stream/IRecordingListener.java @@ -9,14 +9,14 @@ /** * Recording listener interface. - * + * * @author Paul Gregoire (mondain@gmail.com) */ public interface IRecordingListener extends IStreamListener { /** * Initialize the listener. - * + * * @param conn * Stream source connection * @param name @@ -29,7 +29,7 @@ public interface IRecordingListener extends IStreamListener { /** * Initialize the listener. - * + * * @param scope * Stream source scope * @param name diff --git a/common/src/main/java/org/red5/server/stream/ISeekableProvider.java b/common/src/main/java/org/red5/server/stream/ISeekableProvider.java index 342df973e..7eb8f5a29 100644 --- a/common/src/main/java/org/red5/server/stream/ISeekableProvider.java +++ b/common/src/main/java/org/red5/server/stream/ISeekableProvider.java @@ -17,7 +17,7 @@ public interface ISeekableProvider extends IProvider { /** * Seek the provider to timestamp ts (in milliseconds). - * + * * @param ts * Timestamp to seek to * @return Actual timestamp seeked to diff --git a/common/src/main/java/org/red5/server/stream/IStreamData.java b/common/src/main/java/org/red5/server/stream/IStreamData.java index 6cbf50b0c..2e1c17b25 100644 --- a/common/src/main/java/org/red5/server/stream/IStreamData.java +++ b/common/src/main/java/org/red5/server/stream/IStreamData.java @@ -25,7 +25,7 @@ public interface IStreamData { /** * Creates a byte accurate copy. - * + * * @return duplicate of the current data item * @throws IOException * on error diff --git a/common/src/main/java/org/red5/server/stream/IStreamTypeAwareProvider.java b/common/src/main/java/org/red5/server/stream/IStreamTypeAwareProvider.java index e0589b402..293aedc58 100644 --- a/common/src/main/java/org/red5/server/stream/IStreamTypeAwareProvider.java +++ b/common/src/main/java/org/red5/server/stream/IStreamTypeAwareProvider.java @@ -11,7 +11,7 @@ /** * Interface for providers that know if they contain video frames. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) * @@ -22,7 +22,7 @@ public interface IStreamTypeAwareProvider extends IProvider { /** * Check if the provider contains video tags. - * + * * @return provider has video */ public boolean hasVideo(); diff --git a/common/src/main/java/org/red5/server/stream/PlayEngine.java b/common/src/main/java/org/red5/server/stream/PlayEngine.java index 73fe52068..21998e3ee 100755 --- a/common/src/main/java/org/red5/server/stream/PlayEngine.java +++ b/common/src/main/java/org/red5/server/stream/PlayEngine.java @@ -71,7 +71,7 @@ /** * A play engine for playing a IPlayItem. - * + * * @author The Red5 Project * @author Steven Gong * @author Paul Gregoire (mondain@gmail.com) @@ -305,7 +305,7 @@ public void start() { /** * Play stream - * + * * @param item * Playlist item * @throws StreamNotFoundException @@ -321,9 +321,9 @@ public void play(IPlayItem item) throws StreamNotFoundException, IllegalStateExc /** * Play stream - * + * * See: https://www.adobe.com/devnet/adobe-media-server/articles/dynstream_actionscript.html - * + * * @param item * Playlist item * @param withReset @@ -351,10 +351,10 @@ public void play(IPlayItem item, boolean withReset) throws StreamNotFoundExcepti } // Play type determination // https://help.adobe.com/en_US/FlashPlatform/reference/actionscript/3/flash/net/NetStream.html#play() - // The start time, in seconds. Allowed values are -2, -1, 0, or a positive number. - // The default value is -2, which looks for a live stream, then a recorded stream, - // and if it finds neither, opens a live stream. - // If -1, plays only a live stream. + // The start time, in seconds. Allowed values are -2, -1, 0, or a positive number. + // The default value is -2, which looks for a live stream, then a recorded stream, + // and if it finds neither, opens a live stream. + // If -1, plays only a live stream. // If 0 or a positive number, plays a recorded stream, beginning start seconds in. // // -2: live then recorded, -1: live, >=0: recorded @@ -520,7 +520,7 @@ public void execute(ISchedulingService service) { *
  • Decoder configurations (ie. AVC codec)
  • *
  • Most recent keyframe
  • * - * + * * @throws IOException */ private final void playLive() throws IOException { @@ -596,7 +596,7 @@ private final void playLive() throws IOException { /** * Performs the processes needed for VOD / pre-recorded streams. - * + * * @param withReset * whether or not to perform reset on the stream * @param itemLength @@ -646,7 +646,7 @@ private final IMessage playVOD(boolean withReset, long itemLength) throws IOExce /** * Connects to the data provider. - * + * * @param itemName * name of the item to play */ @@ -678,7 +678,7 @@ private final void connectToProvider(String itemName) { /** * Pause at position - * + * * @param position * Position in file * @throws IllegalStateException @@ -702,7 +702,7 @@ public void pause(int position) throws IllegalStateException { /** * Resume playback - * + * * @param position * Resumes playback * @throws IllegalStateException @@ -738,7 +738,7 @@ public void resume(int position) throws IllegalStateException { /** * Seek to a given position - * + * * @param position * Position * @throws IllegalStateException @@ -755,7 +755,7 @@ public void seek(int position) throws IllegalStateException, OperationNotSupport /** * Stop playback - * + * * @throws IllegalStateException * If stream is in stopped state */ @@ -846,7 +846,7 @@ public void close() { /** * Check if it's okay to send the client more data. This takes the configured bandwidth as well as the requested client buffer into * account. - * + * * @param message * @return true if it is ok to send more, false otherwise */ @@ -885,7 +885,7 @@ private boolean okayToSendMessage(IRTMPEvent message) { /** * Estimate client buffer fill. - * + * * @param now * The current timestamp being used. * @return True if it appears that the client buffer is full, otherwise false. @@ -953,7 +953,7 @@ private void clearWaitJobs() { /** * Sends a status message. - * + * * @param status */ private void doPushMessage(Status status) { @@ -964,7 +964,7 @@ private void doPushMessage(Status status) { /** * Send message to output stream and handle exceptions. - * + * * @param message * The message to send. */ @@ -996,7 +996,7 @@ private void doPushMessage(AbstractMessage message) { /** * Send an RTMP message - * + * * @param messageIn * incoming RTMP message */ @@ -1071,7 +1071,7 @@ private void sendClearPing() { Ping eof = new Ping(); eof.setEventType(Ping.STREAM_PLAYBUFFER_CLEAR); eof.setValue2(streamId); - // eos + // eos RTMPMessage eofMsg = RTMPMessage.build(eof); doPushMessage(eofMsg); } @@ -1084,14 +1084,14 @@ private void sendReset() { Ping recorded = new Ping(); recorded.setEventType(Ping.RECORDED_STREAM); recorded.setValue2(streamId); - // recorded + // recorded RTMPMessage recordedMsg = RTMPMessage.build(recorded); doPushMessage(recordedMsg); } Ping begin = new Ping(); begin.setEventType(Ping.STREAM_BEGIN); begin.setValue2(streamId); - // begin + // begin RTMPMessage beginMsg = RTMPMessage.build(begin); doPushMessage(beginMsg); // reset @@ -1101,7 +1101,7 @@ private void sendReset() { /** * Send reset status for item - * + * * @param item * Playlist item */ @@ -1116,7 +1116,7 @@ private void sendResetStatus(IPlayItem item) { /** * Send playback start status notification - * + * * @param item * Playlist item */ @@ -1131,7 +1131,7 @@ private void sendStartStatus(IPlayItem item) { /** * Send playback stoppage status notification - * + * * @param item * Playlist item */ @@ -1146,9 +1146,9 @@ private void sendStopStatus(IPlayItem item) { /** * Sends an onPlayStatus message. - * + * * http://help.adobe.com/en_US/FlashPlatform/reference/actionscript/3/flash/events/NetDataEvent.html - * + * * @param code * @param duration * @param bytes @@ -1216,7 +1216,7 @@ private void sendCompleteStatus() { /** * Send seek status notification - * + * * @param item * Playlist item * @param position @@ -1233,7 +1233,7 @@ private void sendSeekStatus(IPlayItem item, int position) { /** * Send pause status notification - * + * * @param item * Playlist item */ @@ -1247,7 +1247,7 @@ private void sendPauseStatus(IPlayItem item) { /** * Send resume status notification - * + * * @param item * Playlist item */ @@ -1261,7 +1261,7 @@ private void sendResumeStatus(IPlayItem item) { /** * Send published status notification - * + * * @param item * Playlist item */ @@ -1275,7 +1275,7 @@ private void sendPublishedStatus(IPlayItem item) { /** * Send unpublished status notification - * + * * @param item * Playlist item */ @@ -1289,7 +1289,7 @@ private void sendUnpublishedStatus(IPlayItem item) { /** * Stream not found status notification - * + * * @param item * Playlist item */ @@ -1304,7 +1304,7 @@ private void sendStreamNotFoundStatus(IPlayItem item) { /** * Insufficient bandwidth notification - * + * * @param item * Playlist item */ @@ -1320,7 +1320,7 @@ private void sendInsufficientBandwidthStatus(IPlayItem item) { /** * Send VOD init control message - * + * * @param item * Playlist item */ @@ -1336,7 +1336,7 @@ private void sendVODInitCM(IPlayItem item) { /** * Send VOD seek control message - * + * * @param msgIn * Message input * @param position @@ -1360,7 +1360,7 @@ private int sendVODSeekCM(int position) { /** * Send VOD check video control message - * + * * @return result of oob control message */ private boolean sendCheckVideoCM() { @@ -1452,7 +1452,7 @@ public void pushMessage(IPipe pipe, IMessage message) throws IOException { IRTMPEvent body = rtmpMessage.getBody(); if (body instanceof IStreamData) { final String subscribedStreamName = subscriberStream.getBroadcastStreamPublishName(); - // the subscriber paused + // the subscriber paused if (subscriberStream.getState() == StreamState.PAUSED) { if (log.isInfoEnabled() && shouldLogPacketDrop()) { log.info("Dropping packet because we are paused. sessionId={} stream={} count={}", sessionId, subscribedStreamName, droppedPacketsCount); @@ -1561,7 +1561,7 @@ public void pushMessage(IPipe pipe, IMessage message) throws IOException { /** * Get number of pending video messages - * + * * @return Number of pending video messages */ private long pendingVideoMessages() { @@ -1580,7 +1580,7 @@ private long pendingVideoMessages() { /** * Get number of pending messages to be sent - * + * * @return Number of pending messages */ private long pendingMessages() { @@ -1597,7 +1597,7 @@ public boolean isPaused() { /** * Returns the timestamp of the last message sent. - * + * * @return last message timestamp */ public int getLastMessageTimestamp() { @@ -1614,7 +1614,7 @@ public void sendBlankAudio(boolean sendBlankAudio) { /** * Returns true if the engine currently receives audio. - * + * * @return receive audio */ public boolean receiveAudio() { @@ -1623,7 +1623,7 @@ public boolean receiveAudio() { /** * Returns true if the engine currently receives audio and sets the new value. - * + * * @param receive * new value * @return old value @@ -1639,7 +1639,7 @@ public boolean receiveAudio(boolean receive) { /** * Returns true if the engine currently receives video. - * + * * @return receive video */ public boolean receiveVideo() { @@ -1648,7 +1648,7 @@ public boolean receiveVideo() { /** * Returns true if the engine currently receives video and sets the new value. - * + * * @param receive * new value * @return old value @@ -1677,7 +1677,7 @@ private void releasePendingMessage() { /** * Check if sending the given message was enabled by the client. - * + * * @param message * the message to check * @return true if the message should be sent, false otherwise (and the message is discarded) @@ -1718,7 +1718,7 @@ private void runDeferredStop() { // Schedule deferred stop executor. log.trace("Ran deferred stop"); if (deferredStop == null) { - // set deferred stop if we get a job name returned + // set deferred stop if we get a job name returned deferredStop = subscriberStream.scheduleWithFixedDelay(new DeferredStopRunnable(), 100); } } @@ -1886,7 +1886,7 @@ public void execute(ISchedulingService svc) { Runnable worker = null; while (!pendingOperations.isEmpty()) { log.debug("Pending operations: {}", pendingOperations.size()); - // remove the first operation and execute it + // remove the first operation and execute it worker = pendingOperations.remove(); log.debug("Worker: {}", worker); // if the operation is seek, ensure it is the last request in the set diff --git a/common/src/main/java/org/red5/server/stream/PlaylistSubscriberStream.java b/common/src/main/java/org/red5/server/stream/PlaylistSubscriberStream.java index 686e98c50..11d06608c 100644 --- a/common/src/main/java/org/red5/server/stream/PlaylistSubscriberStream.java +++ b/common/src/main/java/org/red5/server/stream/PlaylistSubscriberStream.java @@ -91,11 +91,11 @@ public class PlaylistSubscriberStream extends AbstractClientStream implements IP /** * Number of pending messages at which a - * + * *
          * NetStream.Play.InsufficientBW
          * 
    - * + * * message is generated for VOD streams. */ protected int underrunTrigger = 10; @@ -139,7 +139,7 @@ PlayEngine createEngine(ISchedulingService schedulingService, IConsumerService c /** * Set interval to check for buffer underruns. Set to 0 to disable. - * + * * @param bufferCheckInterval * interval in ms */ @@ -149,13 +149,13 @@ public void setBufferCheckInterval(int bufferCheckInterval) { /** * Set maximum number of pending messages at which a - * + * *
          * NetStream.Play.InsufficientBW
          * 
    - * + * * message will be generated for VOD streams - * + * * @param underrunTrigger * the maximum number of pending messages */ @@ -520,7 +520,7 @@ public void receiveAudio(boolean receive) { // send a blank audio packet to reset the player engine.sendBlankAudio(true); } else if (!receiveAudio && receive) { - // do a seek + // do a seek seekToCurrentPlayback(); } } else { diff --git a/common/src/main/java/org/red5/server/stream/SingleItemSubscriberStream.java b/common/src/main/java/org/red5/server/stream/SingleItemSubscriberStream.java index b233f73cf..aac9da808 100644 --- a/common/src/main/java/org/red5/server/stream/SingleItemSubscriberStream.java +++ b/common/src/main/java/org/red5/server/stream/SingleItemSubscriberStream.java @@ -27,7 +27,7 @@ /** * Stream of a single play item for a subscriber - * + * * @author Paul Gregoire (mondain@gmail.com) */ public class SingleItemSubscriberStream extends AbstractClientStream implements ISingleItemSubscriberStream { @@ -51,11 +51,11 @@ public class SingleItemSubscriberStream extends AbstractClientStream implements /** * Number of pending messages at which a - * + * *
          * NetStream.Play.InsufficientBW
          * 
    - * + * * message is generated for VOD streams. */ protected int underrunTrigger = 10; @@ -141,7 +141,7 @@ public void receiveAudio(boolean receive) { //send a blank audio packet to reset the player engine.sendBlankAudio(true); } else if (!receiveAudio && receive) { - //do a seek + //do a seek seekToCurrentPlayback(); } } @@ -156,13 +156,13 @@ PlayEngine createEngine(ISchedulingService schedulingService, IConsumerService c /** * Set interval to check for buffer underruns. Set to - * + * *
          * 0
          * 
    - * + * * to disable. - * + * * @param bufferCheckInterval * interval in ms */ @@ -172,13 +172,13 @@ public void setBufferCheckInterval(int bufferCheckInterval) { /** * Set maximum number of pending messages at which a - * + * *
          * NetStream.Play.InsufficientBW
          * 
    - * + * * message will be generated for VOD streams - * + * * @param underrunTrigger * the maximum number of pending messages */ diff --git a/common/src/main/java/org/red5/server/stream/StreamService.java b/common/src/main/java/org/red5/server/stream/StreamService.java index 793883979..404d2dc5c 100644 --- a/common/src/main/java/org/red5/server/stream/StreamService.java +++ b/common/src/main/java/org/red5/server/stream/StreamService.java @@ -152,9 +152,9 @@ public void closeStream() { * Close stream. This method can close both IClientBroadcastStream (coming from Flash Player to Red5) and ISubscriberStream (from Red5 * to Flash Player). Corresponding application handlers (streamSubscriberClose, etc.) are called as if close was initiated by Flash * Player. - * + * * It is recommended to remember stream id in application handlers, ex.: - * + * *
          * public void streamBroadcastStart(IBroadcastStream stream) {
          *     super.streamBroadcastStart(stream);
    @@ -164,17 +164,17 @@ public void closeStream() {
          *     }
          * }
          * 
    - * + * *
          * public void streamPlaylistItemPlay(IPlaylistSubscriberStream stream, IPlayItem item, boolean isLive) {
          *     super.streamPlaylistItemPlay(stream, item, isLive);
          *     Red5.getConnectionLocal().setAttribute(WATCHED_STREAM_ID_ATTRIBUTE, stream.getStreamId());
          * }
          * 
    - * + * * When stream is closed, corresponding NetStream status will be sent to stream provider / consumers. Implementation is based on Red5's * StreamService.close() - * + * * @param conn * client connection * @param streamId @@ -246,7 +246,7 @@ public void pauseRaw(Boolean pausePlayback, int position) { /** * Pause at given position. Required as "pausePlayback" can be "null" if no flag is passed by the client - * + * * @param pausePlayback * Pause playback or not * @param position @@ -275,7 +275,7 @@ public void pause(Boolean pausePlayback, int position) { /** * Plays back a stream based on the supplied name, from the specified position for the given length of time. - * + * * @param name * - The name of a recorded file, or the identifier for live data. If * @param start @@ -473,7 +473,7 @@ public void play(Boolean dontStop) { /** * Dynamic streaming play method. This is a convenience method. - * + * * @param oldStreamName * old * @param start @@ -499,7 +499,7 @@ public void play2(String oldStreamName, int start, String transition, int length /** * Dynamic streaming play method. This is a convenience method. - * + * * @param params * play parameters */ @@ -517,15 +517,15 @@ public void play2(ObjectMap params) { /** * Dynamic streaming play method. - * + * * The following properties are supported on the play options: - * + * *
          * streamName: String. The name of the stream to play or the new stream to switch to.
    -     * oldStreamName: String. The name of the initial stream that needs to be switched out. This is not needed and ignored 
    +     * oldStreamName: String. The name of the initial stream that needs to be switched out. This is not needed and ignored
          *                 when play2 is used for just playing the stream and not switching to a new stream.
    -     * start: Number. The start time of the new stream to play, just as supported by the existing play API. and it has the 
    -     *                same defaults. This is ignored when the method is called for switching (in other words, the transition 
    +     * start: Number. The start time of the new stream to play, just as supported by the existing play API. and it has the
    +     *                same defaults. This is ignored when the method is called for switching (in other words, the transition
          *                is either NetStreamPlayTransition.SWITCH or NetStreamPlayTransitions.SWAP)
          * len: Number. The duration of the playback, just as supported by the existing play API and has the same defaults.
          * transition: String. The transition mode for the playback command. It could be one of the following:
    @@ -534,7 +534,7 @@ public void play2(ObjectMap params) {
          *      NetStreamPlayTransitions.SWITCH
          *      NetStreamPlayTransitions.SWAP
          * 
    - * + * * NetStreamPlayTransitions: *
          *      APPEND : String = "append" - Adds the stream to a playlist and begins playback with the first stream.
    @@ -545,7 +545,7 @@ public void play2(ObjectMap params) {
          *      SWAP : String = "swap" - Replaces a content stream with a different content stream and maintains the rest of the playlist.
          *      SWITCH : String = "switch" - Switches from playing one stream to another stream, typically with streams of the same content.
          * 
    - * + * * @see ActionScript guide to dynamic * streaming * @see Dynamic streaming in Flash Media @@ -708,7 +708,7 @@ public void publish(String name, String mode) { } IBroadcastScope bsScope = getBroadcastScope(scope, name); if (bsScope != null && !bsScope.getProviders().isEmpty()) { - // another stream with that name is already published + // another stream with that name is already published sendNSFailed(streamConn, StatusCodes.NS_PUBLISH_BADNAME, name, name, streamId); log.error("Bad name {}", name); return; @@ -838,7 +838,7 @@ public void receiveAudio(boolean receive) { /** * Return broadcast scope object for given scope and child scope name. - * + * * @param scope * Scope object * @param name @@ -851,7 +851,7 @@ public IBroadcastScope getBroadcastScope(IScope scope, String name) { /** * Send NetStream.Play.Failed to the client. - * + * * @param conn * @param errorCode * @param description @@ -864,7 +864,7 @@ private void sendNSFailed(IConnection conn, String errorCode, String description /** * Send NetStream.Status to the client. - * + * * @param conn * @param statusCode * see StatusCodes class @@ -878,7 +878,7 @@ private void sendNSStatus(IConnection conn, String statusCode, String descriptio /** * Send NetStream.Status to the client. - * + * * @param conn * connection * @param statusCode diff --git a/common/src/main/java/org/red5/server/stream/StreamableFileFactory.java b/common/src/main/java/org/red5/server/stream/StreamableFileFactory.java index e322efc6d..a5d749292 100644 --- a/common/src/main/java/org/red5/server/stream/StreamableFileFactory.java +++ b/common/src/main/java/org/red5/server/stream/StreamableFileFactory.java @@ -28,7 +28,7 @@ public class StreamableFileFactory implements IStreamableFileFactory { /** * Setter for services - * + * * @param services * Set of streamable file services */ diff --git a/common/src/main/java/org/red5/server/stream/VideoCodecFactory.java b/common/src/main/java/org/red5/server/stream/VideoCodecFactory.java index ba76726f3..588a2ea71 100644 --- a/common/src/main/java/org/red5/server/stream/VideoCodecFactory.java +++ b/common/src/main/java/org/red5/server/stream/VideoCodecFactory.java @@ -17,7 +17,7 @@ /** * Factory for video codecs. Creates and returns video codecs - * + * * @author The Red5 Project * @author Paul Gregoire (mondain@gmail.com) */ @@ -49,7 +49,7 @@ public void setCodecs(List codecs) { /** * Create and return new video codec applicable for byte buffer data - * + * * @param data * Byte buffer data * @return Video codec @@ -60,7 +60,7 @@ public static IVideoStreamCodec getVideoCodec(IoBuffer data) { int codecId = data.get() & 0x0f; try { switch (codecId) { - case 2: // sorenson + case 2: // sorenson result = (IVideoStreamCodec) Class.forName("org.red5.codec.SorensonVideo").getDeclaredConstructor().newInstance(); break; case 3: // screen video @@ -118,7 +118,7 @@ public static IVideoStreamCodec getVideoCodec(IoBuffer data) { // boolean result = ((first & 0x0f) == 3); // return result; // } - // + // // private boolean isSorenson(byte first) { // log.debug("Trying Sorenson"); // boolean result = ((first & 0x0f) == 2); diff --git a/common/src/main/java/org/red5/server/stream/bandwidth/ClientServerDetection.java b/common/src/main/java/org/red5/server/stream/bandwidth/ClientServerDetection.java index 525fa42ec..c08323f2c 100644 --- a/common/src/main/java/org/red5/server/stream/bandwidth/ClientServerDetection.java +++ b/common/src/main/java/org/red5/server/stream/bandwidth/ClientServerDetection.java @@ -20,7 +20,7 @@ import org.slf4j.LoggerFactory; /** - * + * * @author The Red5 Project * @author Dan Rossi */ diff --git a/common/src/main/java/org/red5/server/stream/bandwidth/IBandwidthDetection.java b/common/src/main/java/org/red5/server/stream/bandwidth/IBandwidthDetection.java index dce6d64ee..b953b9a1a 100644 --- a/common/src/main/java/org/red5/server/stream/bandwidth/IBandwidthDetection.java +++ b/common/src/main/java/org/red5/server/stream/bandwidth/IBandwidthDetection.java @@ -10,7 +10,7 @@ import org.red5.server.api.IConnection; /** - * + * * @author The Red5 Project * @author Dan Rossi */ diff --git a/common/src/main/java/org/red5/server/stream/bandwidth/ServerClientDetection.java b/common/src/main/java/org/red5/server/stream/bandwidth/ServerClientDetection.java index b5dfff2c4..cd2e75523 100644 --- a/common/src/main/java/org/red5/server/stream/bandwidth/ServerClientDetection.java +++ b/common/src/main/java/org/red5/server/stream/bandwidth/ServerClientDetection.java @@ -23,9 +23,9 @@ /** * Calculates the bandwidth between the client and server. The checks originate from the server. - * + * * @see FMS 3.5 Bandwidth Doc - * + * * @author The Red5 Project * @author Dan Rossi * @author Paul Gregoire @@ -58,7 +58,7 @@ public class ServerClientDetection implements IPendingServiceCallback, IBandwidt // start time using nanos private long startTime; - // time passed overall + // time passed overall private long timePassed; private AtomicInteger packetsSent = new AtomicInteger(0); @@ -111,7 +111,7 @@ public void resultReceived(IPendingServiceCall call) { // We now have a latency figure so can start sending test data. // Second call. 1st packet sent log.debug("Sending first payload at {} ns", now); - callBWCheck(payload); // 1k + callBWCheck(payload); // 1k break; case 2: log.debug("Sending second payload at {} ns", now); diff --git a/common/src/main/java/org/red5/server/stream/consumer/ConnectionConsumer.java b/common/src/main/java/org/red5/server/stream/consumer/ConnectionConsumer.java index a4d614e02..5492b75b8 100644 --- a/common/src/main/java/org/red5/server/stream/consumer/ConnectionConsumer.java +++ b/common/src/main/java/org/red5/server/stream/consumer/ConnectionConsumer.java @@ -86,7 +86,7 @@ public class ConnectionConsumer implements IPushableConsumer, IPipeConnectionLis /** * Create RTMP connection consumer for given connection and channels. - * + * * @param conn * RTMP connection * @param videoChannel @@ -106,7 +106,7 @@ public ConnectionConsumer(RTMPConnection conn, Channel videoChannel, Channel aud /** * Create connection consumer without an RTMP connection. - * + * * @param videoChannel * video channel * @param audioChannel @@ -156,8 +156,8 @@ public void pushMessage(IPipe pipe, IMessage message) { } // create a new header for the consumer if the message.body doesnt already have one final Header header = Optional.ofNullable(msg.getHeader()).orElse(new Header()); - // XXX sets the timerbase, but should we do this if there's already a timerbase? - header.setTimerBase(eventTime); + //reset header times. + header.setTimer(eventTime); // data buffer IoBuffer buf = null; switch (dataType) { @@ -272,16 +272,16 @@ public void onOOBControlMessage(IMessageComponent source, IPipe pipe, OOBControl if ("pendingCount".equals(serviceName)) { oobCtrlMsg.setResult(conn.getPendingMessages()); } else if ("pendingVideoCount".equals(serviceName)) { - /* + /* * This section relies on the messageSent call-back from Mina to update the pending counter * the logic does not work if RTMPE is used due to the marshalling. For now we will simply return 0 * and the caller sending the oob will proceed. The pending video check was implemented to handle * flash player connections on slow links and is most likely irrelevant at this point. - * + * IClientStream stream = conn.getStreamByChannelId(video.getId()); log.trace("pending video count for video id: {} stream: {}", video.getId(), stream); - if (stream != null) { - oobCtrlMsg.setResult(conn.getPendingVideoMessages(stream.getStreamId())); + if (stream != null) { + oobCtrlMsg.setResult(conn.getPendingVideoMessages(stream.getStreamId())); } else { oobCtrlMsg.setResult(0L); } diff --git a/common/src/main/java/org/red5/server/stream/consumer/ImmutableTag.java b/common/src/main/java/org/red5/server/stream/consumer/ImmutableTag.java index 767f68006..f4f87e087 100644 --- a/common/src/main/java/org/red5/server/stream/consumer/ImmutableTag.java +++ b/common/src/main/java/org/red5/server/stream/consumer/ImmutableTag.java @@ -5,7 +5,7 @@ /** * An ImmutableTag represents immutable encapsulation of flash media data. The timestamp is the only mutable field. - * + * * @author Paul Gregoire (mondain@gmail.com) */ public class ImmutableTag implements ITag { @@ -32,7 +32,7 @@ public class ImmutableTag implements ITag { /** * ImmutableTag Constructor - * + * * @param dataType * Tag data type * @param timestamp @@ -49,7 +49,7 @@ private ImmutableTag(byte dataType, int timestamp, byte[] data) { /** * ImmutableTag Constructor - * + * * @param dataType * Tag data type * @param timestamp @@ -68,7 +68,7 @@ private ImmutableTag(byte dataType, int timestamp, byte[] data, int previousTagS /** * Get the data type - * + * * @return Tag data type */ public byte getDataType() { @@ -77,7 +77,7 @@ public byte getDataType() { /** * Return the timestamp - * + * * @return Tag timestamp */ public int getTimestamp() { @@ -96,7 +96,7 @@ public IoBuffer getData() { /** * Return the body IoBuffer - * + * * @return Tag body */ public IoBuffer getBody() { @@ -105,7 +105,7 @@ public IoBuffer getBody() { /** * Return the size of the body - * + * * @return Tag body size */ public int getBodySize() { @@ -114,7 +114,7 @@ public int getBodySize() { /** * Return previous tag size - * + * * @return Previous tag size */ public int getPreviousTagSize() { @@ -139,7 +139,7 @@ public void setPreviousTagSize(int size) { /** * Prints out the contents of the tag - * + * * @return Tag contents */ @Override diff --git a/common/src/main/java/org/red5/server/stream/consumer/QueuedMediaDataComparator.java b/common/src/main/java/org/red5/server/stream/consumer/QueuedMediaDataComparator.java index 7b0525ba8..2acb03923 100644 --- a/common/src/main/java/org/red5/server/stream/consumer/QueuedMediaDataComparator.java +++ b/common/src/main/java/org/red5/server/stream/consumer/QueuedMediaDataComparator.java @@ -8,7 +8,7 @@ /** * Comparator for queued media data in file consumers. - * + * * @author mondain */ public class QueuedMediaDataComparator implements Comparator { diff --git a/common/src/main/java/org/red5/server/stream/consumer/SlicedFileConsumer.java b/common/src/main/java/org/red5/server/stream/consumer/SlicedFileConsumer.java index 7baddc055..52d22e814 100644 --- a/common/src/main/java/org/red5/server/stream/consumer/SlicedFileConsumer.java +++ b/common/src/main/java/org/red5/server/stream/consumer/SlicedFileConsumer.java @@ -58,7 +58,7 @@ /** * Consumer that pushes messages to file. Used when recording live streams. - * + * * @author The Red5 Project * @author Paul Gregoire (mondain@gmail.com) * @author Vladimir Hmelyoff (vlhm@splitmedialabs.com) @@ -170,7 +170,7 @@ public SlicedFileConsumer() { /** * Creates file consumer - * + * * @param scope * Scope of consumer * @param file @@ -184,7 +184,7 @@ public SlicedFileConsumer(IScope scope, File file) { /** * Creates file consumer - * + * * @param scope * Scope of consumer * @param fileName @@ -201,7 +201,7 @@ public SlicedFileConsumer(IScope scope, String fileName, String mode) { /** * Push message through pipe - * + * * @param pipe * Pipe * @param message @@ -358,7 +358,7 @@ private QueuedMediaData[] createTimestampLimitedSlice(int timestamp) { /** * Get the WriteFuture with a timeout based on the length of the slice to write. - * + * * @param sliceLength * @return true if successful and false otherwise */ @@ -385,7 +385,7 @@ private boolean acquireWriteFuture(int sliceLength) { /** * Out-of-band control message handler - * + * * @param source * Source of message * @param pipe @@ -398,7 +398,7 @@ public void onOOBControlMessage(IMessageComponent source, IPipe pipe, OOBControl /** * Pipe connection event handler - * + * * @param event * Pipe connection event */ @@ -418,7 +418,7 @@ public void onPipeConnectionEvent(PipeConnectionEvent event) { /** * Initialization - * + * * @throws IOException * I/O exception */ @@ -536,7 +536,7 @@ public final void doWrites() { /** * Write a slice of the queued items to the writer. - * + * * @param slice * set of queued data */ @@ -567,7 +567,7 @@ public final void doWrites(QueuedMediaData[] slice) { /** * Write incoming data to the file. - * + * * @param timestamp * adjusted timestamp * @param msg @@ -613,7 +613,7 @@ public final void doWrites(QueuedMediaData[] slice) { /** * Adjust timestamp and write to the file. - * + * * @param queued * queued data for write */ @@ -691,7 +691,7 @@ public void setupOutputPath(String name) { /** * Sets a video decoder configuration; some codecs require this, such as AVC. - * + * * @param decoderConfig * video codec configuration */ @@ -704,7 +704,7 @@ public void setVideoDecoderConfiguration(IRTMPEvent decoderConfig) { /** * Sets a audio decoder configuration; some codecs require this, such as AAC. - * + * * @param decoderConfig * audio codec configuration */ @@ -717,7 +717,7 @@ public void setAudioDecoderConfiguration(IRTMPEvent decoderConfig) { /** * Sets the scope for this consumer. - * + * * @param scope * scope */ @@ -727,7 +727,7 @@ public void setScope(IScope scope) { /** * Sets the file we're writing to. - * + * * @param file * file */ @@ -737,7 +737,7 @@ public void setFile(File file) { /** * Returns the file. - * + * * @return file */ public File getFile() { @@ -746,7 +746,7 @@ public File getFile() { /** * Sets the threshold for the queue. When the threshold is met a worker is spawned to empty the sorted queue to the writer. - * + * * @param queueThreshold * number of items to queue before spawning worker */ @@ -756,7 +756,7 @@ public void setQueueThreshold(int queueThreshold) { /** * Returns the size of the delayed writing queue. - * + * * @return queue length */ public int getQueueThreshold() { @@ -765,7 +765,7 @@ public int getQueueThreshold() { /** * Whether or not the queue should be utilized. - * + * * @return true if using the queue, false if sending directly to the writer */ @Deprecated @@ -775,7 +775,7 @@ public boolean isDelayWrite() { /** * Sets whether or not to use the queue. - * + * * @param delayWrite * true to use the queue, false if not */ @@ -785,7 +785,7 @@ public void setDelayWrite(boolean delayWrite) { /** * Whether or not to wait for the first keyframe before processing video frames. - * + * * @param waitForVideoKeyframe wait for a key frame or not */ public void setWaitForVideoKeyframe(boolean waitForVideoKeyframe) { @@ -810,7 +810,7 @@ public void setSchedulerThreadSize(int schedulerThreadSize) { /** * Sets the recording mode. - * + * * @param mode * either "record" or "append" depending on the type of action to perform */ diff --git a/common/src/main/java/org/red5/server/stream/message/RTMPMessage.java b/common/src/main/java/org/red5/server/stream/message/RTMPMessage.java index 805b7be0f..fe5559a39 100644 --- a/common/src/main/java/org/red5/server/stream/message/RTMPMessage.java +++ b/common/src/main/java/org/red5/server/stream/message/RTMPMessage.java @@ -20,7 +20,7 @@ public class RTMPMessage extends AbstractMessage { /** * Creates a new rtmp message. - * + * * @param body * value to set for property 'body' */ @@ -32,7 +32,7 @@ private RTMPMessage(IRTMPEvent body) { /** * Creates a new rtmp message. - * + * * @param body * value to set for property 'body' * @param eventTime @@ -56,7 +56,7 @@ public IRTMPEvent getBody() { /** * Builder for RTMPMessage. - * + * * @param body * event data * @return Immutable RTMPMessage @@ -67,7 +67,7 @@ public final static RTMPMessage build(IRTMPEvent body) { /** * Builder for RTMPMessage. - * + * * @param body * event data * @param eventTime diff --git a/common/src/main/java/org/red5/server/stream/message/ResetMessage.java b/common/src/main/java/org/red5/server/stream/message/ResetMessage.java index dd9423c13..5f8e14503 100644 --- a/common/src/main/java/org/red5/server/stream/message/ResetMessage.java +++ b/common/src/main/java/org/red5/server/stream/message/ResetMessage.java @@ -11,7 +11,7 @@ /** * To notify the client to reset the playing state. - * + * * @author The Red5 Project * @author Steven Gong (steven.gong@gmail.com) */ diff --git a/common/src/main/java/org/red5/server/util/FileUtil.java b/common/src/main/java/org/red5/server/util/FileUtil.java index 270529d43..d0b351a8b 100644 --- a/common/src/main/java/org/red5/server/util/FileUtil.java +++ b/common/src/main/java/org/red5/server/util/FileUtil.java @@ -29,7 +29,7 @@ /** * Generic file utility containing useful file or directory manipulation functions. - * + * * @author Paul Gregoire (mondain@gmail.com) * @author Dominick Accattato (daccattato@gmail.com) */ @@ -96,7 +96,7 @@ public static void moveFile(String source, String dest) throws IOException { /** * Deletes a directory and its contents. This will fail if there are any file locks or if the directory cannot be emptied. - * + * * @param directory * directory to delete * @throws IOException @@ -109,7 +109,7 @@ public static boolean deleteDirectory(String directory) throws IOException { /** * Deletes a directory and its contents. This will fail if there are any file locks or if the directory cannot be emptied. - * + * * @param directory * directory to delete * @param useOSNativeDelete @@ -152,7 +152,7 @@ public static boolean deleteDirectory(String directory, boolean useOSNativeDelet //we are windows p = runTime.exec("CMD /D /C \"RMDIR /Q /S " + directory.replace('/', '\\') + "\""); } else { - //we are unix variant + //we are unix variant p = runTime.exec("rm -rf " + directory.replace('\\', File.separatorChar)); } // observe std out @@ -182,7 +182,7 @@ public static boolean deleteDirectory(String directory, boolean useOSNativeDelet /** * Rename a file natively; using REN on Windows and mv on *nix. - * + * * @param from * old name * @param to @@ -198,7 +198,7 @@ public static void rename(String from, String to) { /** * Special method for capture of StdOut. - * + * * @return stdOut thread */ private final static Thread stdOut(final Process p) { @@ -232,7 +232,7 @@ public void run() { /** * Create a directory. - * + * * @param directory * directory to make * @return whether a new directory was made @@ -245,7 +245,7 @@ public static boolean makeDirectory(String directory) throws IOException { /** * Create a directory. The parent directories will be created if createParents is passed as true. - * + * * @param directory * directory * @param createParents @@ -253,7 +253,7 @@ public static boolean makeDirectory(String directory) throws IOException { * @return true if directory was created; false if it already existed * @throws IOException * if we cannot create directory - * + * */ public static boolean makeDirectory(String directory, boolean createParents) throws IOException { boolean created = false; @@ -279,7 +279,7 @@ public static boolean makeDirectory(String directory, boolean createParents) thr /** * Unzips a war file to an application located under the webapps directory - * + * * @param compressedFileName * The String name of the war file * @param destinationDir @@ -288,7 +288,7 @@ public static boolean makeDirectory(String directory, boolean createParents) thr public static void unzip(String compressedFileName, String destinationDir) { //strip everything except the applications name String dirName = null; - // checks to see if there is a dash "-" in the filename of the war. + // checks to see if there is a dash "-" in the filename of the war. String applicationName = compressedFileName.substring(compressedFileName.lastIndexOf("/")); int dashIndex = applicationName.indexOf('-'); if (dashIndex != -1) { @@ -374,7 +374,7 @@ public static void copy(InputStream in, OutputStream out) throws IOException { /** * Quick-n-dirty directory formatting to support launching in windows, specifically from ant. - * + * * @param absWebappsPath * abs webapps path * @param contextDirName @@ -425,7 +425,7 @@ public static String formatPath(String absWebappsPath, String contextDirName) { /** * Generates a custom name containing numbers and an underscore ex. 282818_00023. The name contains current seconds and a random number component. - * + * * @return custom name */ public static String generateCustomName() { @@ -449,7 +449,7 @@ public static String generateCustomName() { /** * Reads all the bytes of a given file into an array. If the file size exceeds Integer.MAX_VALUE, it will be truncated. - * + * * @param localSwfFile * swf file * @return file bytes diff --git a/common/src/main/java/org/red5/server/util/HttpConnectionUtil.java b/common/src/main/java/org/red5/server/util/HttpConnectionUtil.java index 92e40724a..5b3b7e83d 100644 --- a/common/src/main/java/org/red5/server/util/HttpConnectionUtil.java +++ b/common/src/main/java/org/red5/server/util/HttpConnectionUtil.java @@ -25,7 +25,7 @@ /** * Utility for using HTTP connections. - * + * * @author The Red5 Project * @author Paul Gregoire (mondain@gmail.com) */ @@ -49,7 +49,7 @@ public class HttpConnectionUtil { /** * Returns a client with all our selected properties / params. - * + * * @return client */ public static final HttpClient getClient() { @@ -58,7 +58,7 @@ public static final HttpClient getClient() { /** * Returns a client with all our selected properties / params. - * + * * @param timeout * - socket timeout to set * @return client @@ -86,7 +86,7 @@ public static final HttpClient getClient(int timeout) { /** * Returns a client with all our selected properties / params and SSL enabled. - * + * * @return client */ public static final HttpClient getSecureClient() { @@ -109,7 +109,7 @@ public static final HttpClient getSecureClient() { /** * Logs details about the request error. - * + * * @param response * http response * @throws IOException diff --git a/common/src/main/java/org/red5/server/util/PropertyConverter.java b/common/src/main/java/org/red5/server/util/PropertyConverter.java index 4ef769bc7..f58789806 100644 --- a/common/src/main/java/org/red5/server/util/PropertyConverter.java +++ b/common/src/main/java/org/red5/server/util/PropertyConverter.java @@ -12,14 +12,14 @@ /** * Converter for properties originating from properties files. Predetermined string formats are converted into other usable types such as timestamps. - * + * * @author Paul Gregoire (mondain@gmail.com) */ public class PropertyConverter { /** * Converts a string denoting an amount of time into milliseconds and adds it to the current date. Strings are expected to follow this form where # equals a digit: #M The following are permitted for denoting time: H = hours, M = minutes, S = seconds - * + * * @param time * time * @return time in milliseconds @@ -38,7 +38,7 @@ public static long convertStringToFutureTimeMillis(String time) { /** * Converts a string denoting an amount of time into seconds. Strings are expected to follow this form where # equals a digit: #M The following are permitted for denoting time: H = hours, M = minutes, S = seconds - * + * * @param time * time * @return time in seconds @@ -60,7 +60,7 @@ public static int convertStringToTimeSeconds(String time) { /** * Converts a string denoting an amount of time into milliseconds. Strings are expected to follow this form where # equals a digit: #M The following are permitted for denoting time: H = hours, M = minutes, S = seconds - * + * * @param time * time * @return time in milliseconds @@ -82,7 +82,7 @@ public static long convertStringToTimeMillis(String time) { /** * Converts a string denoting an amount of bytes into an integer value. Strings are expected to follow this form where # equals a digit: #M The following are permitted for denoting binary size: K = kilobytes, M = megabytes, G = gigabytes - * + * * @param memSize * memory * @return size as an integer @@ -101,7 +101,7 @@ public static int convertStringToMemorySizeInt(String memSize) { /** * Converts a string denoting an amount of bytes into an long value. Strings are expected to follow this form where # equals a digit: #M The following are permitted for denoting binary size: K = kilobytes, M = megabytes, G = gigabytes - * + * * @param memSize * memory size * @return size as an long @@ -120,7 +120,7 @@ public static long convertStringToMemorySizeLong(String memSize) { /** * Quick time converter to keep our timestamps compatible with PHP's time() (seconds) - * + * * @return time in seconds */ public static Integer getCurrentTimeSeconds() { @@ -129,7 +129,7 @@ public static Integer getCurrentTimeSeconds() { /** * Quick time converter to keep our timestamps compatible with PHP's time() (seconds) - * + * * @param millis * milliseconds * @return seconds diff --git a/common/src/main/java/org/red5/server/util/ScopeUtils.java b/common/src/main/java/org/red5/server/util/ScopeUtils.java index 0901f1520..55bfe1215 100644 --- a/common/src/main/java/org/red5/server/util/ScopeUtils.java +++ b/common/src/main/java/org/red5/server/util/ScopeUtils.java @@ -99,11 +99,11 @@ public static IScope findRoot(IScope from) { * Returns the application scope for specified scope. Application scope has depth of 1 and has no parent. * * See - * + * *
          * isApp
          * 
    - * + * * method for details. * * @param from @@ -126,17 +126,17 @@ public static IScope findApplication(IScope from) { * @param ancestor * Scope to check * @return - * + * *
          *         true
          *         
    - * + * * if ancestor scope is really an ancestor of scope passed as from parameter, - * + * *
          *         false
          *         
    - * + * * otherwise. */ public static boolean isAncestor(IBasicScope from, IBasicScope ancestor) { @@ -156,17 +156,17 @@ public static boolean isAncestor(IBasicScope from, IBasicScope ancestor) { * @param scope * Scope to check * @return - * + * *
          *         true
          *         
    - * + * * if scope is root scope (top level scope), - * + * *
          *         false
          *         
    - * + * * otherwise. */ public static boolean isRoot(IBasicScope scope) { @@ -182,17 +182,17 @@ public static boolean isRoot(IBasicScope scope) { * @param scope * Scope to check * @return - * + * *
          *         true
          *         
    - * + * * if scope is the global scope, - * + * *
          *         false
          *         
    - * + * * otherwise. */ public static boolean isGlobal(IBasicScope scope) { @@ -205,17 +205,17 @@ public static boolean isGlobal(IBasicScope scope) { * @param scope * Scope to check * @return - * + * *
          *         true
          *         
    - * + * * if scope is an application scope, - * + * *
          *         false
          *         
    - * + * * otherwise. */ public static boolean isApp(IBasicScope scope) { @@ -228,17 +228,17 @@ public static boolean isApp(IBasicScope scope) { * @param scope * Scope to check * @return - * + * *
          *         true
          *         
    - * + * * if scope is a room scope, - * + * *
          *         false
          *         
    - * + * * otherwise. */ public static boolean isRoom(IBasicScope scope) { diff --git a/common/src/test/java/org/red5/server/net/rtmp/TestRTMPConnection.java b/common/src/test/java/org/red5/server/net/rtmp/TestRTMPConnection.java index cd5a97fe8..51344c8d0 100644 --- a/common/src/test/java/org/red5/server/net/rtmp/TestRTMPConnection.java +++ b/common/src/test/java/org/red5/server/net/rtmp/TestRTMPConnection.java @@ -42,12 +42,12 @@ public void tearDown() throws Exception { // public void testNewPlaylistSubscriberStream() { // System.out.println("\n testNewPlaylistSubscriberStream"); // RTMPConnection conn = new RTMPMinaConnection(); - // + // // Number streamId = 0; - // + // // IPlaylistSubscriberStream stream = conn.newPlaylistSubscriberStream(streamId); // System.out.printf("PlaylistSubscriberStream for stream id 0: %s\n", stream); - // + // // } // // @Test @@ -64,13 +64,13 @@ public void tearDown() throws Exception { // public void testGetStreamById() { // System.out.println("\n testGetStreamById"); // RTMPConnection conn = new RTMPMinaConnection(); - // + // // IClientStream stream = conn.getStreamById(0); // System.out.printf("Stream for stream id 0: %s\n", stream); // assertNull(stream); // stream = conn.getStreamById(1); // System.out.printf("Stream for stream id 1: %s\n", stream); - // + // // } @Test @@ -98,7 +98,7 @@ public void testGetStreamIdForChannelId() { // System.out.println("\n testGetStreamByChannelId"); // RTMPConnection conn = new RTMPMinaConnection(); // // any channel less than 4 should be null - // assertNull(conn.getStreamByChannelId(3)); + // assertNull(conn.getStreamByChannelId(3)); // // stream id 0 // assertNotNull(conn.getStreamByChannelId(4)); // assertNotNull(conn.getStreamByChannelId(5)); diff --git a/common/src/test/java/org/red5/server/net/rtmp/codec/TestRTMPProtocolDecoder.java b/common/src/test/java/org/red5/server/net/rtmp/codec/TestRTMPProtocolDecoder.java index acdb20788..32f937293 100644 --- a/common/src/test/java/org/red5/server/net/rtmp/codec/TestRTMPProtocolDecoder.java +++ b/common/src/test/java/org/red5/server/net/rtmp/codec/TestRTMPProtocolDecoder.java @@ -237,7 +237,7 @@ public void decodeRTMPCamData() throws Exception { RTMPConnection conn = new RTMPMinaConnection(); conn.getState().setState(RTMP.STATE_CONNECTED); conn.setHandler(this); - // RTMPProtocolDecoder - Failed to decodeBuffer: pos 0, limit 4644, chunk size 1360, buffer + // RTMPProtocolDecoder - Failed to decodeBuffer: pos 0, limit 4644, chunk size 1360, buffer IoBuffer p00 = IoBuffer.wrap(IOUtils.hexStringToByteArray( "1703030578d9f863f2cef8b8cd9d2f9edb11f37f4ecf6ae63eadc21ac2c2e81b83951537ebefad8b4b734ca81b51f0a057c6ea0a2807831178ef5a5ac0fb6a7ac37bdd9ab8116f614d925876f8f3ea6318f8305d51b8a2f1e258147428cdb8d56262169922b3532d701a6b4d4eae86553a54fe5bc590d9d8b0c2ecaa910186ab2d2a5b7508078e87705da88c7b7acc9fcba57b84e0d02f032e8f50d2f04db3e358d87175734af810e75db5f38ed86e39ab9843f3c21bb6526f0c6a37c6cfc51db57bf3bff10fc836851e27e54e8fa6fe8e58a7059e5fe102ff5798d8f6078a87d80674b98192674a194665a220c1fb39625d5128ba27fd5d632815c92d0be4eecbef2c358f31a028452a56233e9124e62b7eadeb126a4f29b13104cfbed3d5af691716928822f0e822b3530f5ccf9262f8241a5a1df94fa48366870b3e34010a0d4e192b69bb5c12f968f36db07654f36c405a202e751c108b1ea5c965e10d6f66501f25e7fa70f771cf4eab3eb42526cf77c8d8a9e657f9c565e41d19402dfe3fac5d8ba0b9ec59800c0250275e0dbd6ea744554c698a2c72102b549b14c8e649f01b6c750193b4d62c157b899e9be1ffd212694958bab73365beb7b4c14104f692a6f3c085cde4eed89fd6d9546372a29930085097088388f0a75bf089ac5eb3fb74fac0bbe783230a39f2c326394f2f9c28b4c683a40205cf8fa97ec8980f430e6e73f6b4b6cbdc632f8027c3a0c1d438b065f25842b7997c092fd39505d940d4605179f89952e28a2fce9e5cca32e28e24c49ff4273d04535cf791b6bb2bba3735e79ee941fff414248bec8c574eeecf21d313b8615345bc031b1c4fe47315c63debbf16c106141e34b874baa23d6da4e47e1df9740e710d59216fcb2d002660d4f3d4a2ecc26c2044cd1ff3ad240292d8696b09dc23c84051d56e8fd931e5bb3396f6f40c9e37cf16630cfc9e158c7fb1892de3812f3dceb9cd27d32d9c384a8d0a1cbe93136d6d0e521bf4a9a1c73ab2a2e7e88a13e14c4df185094095545dfb09213c5af298541c1c6ae787dd2114aa3c760485aa22c4de9de105808a4ad74b6b30c349de2721456c5ac62fa4dd7feffb609045c6d930cec2e4f9dd7117d8365feb3781c83bcc1ba5b835d77530c2a7e2e643c6cb4a81ddae92d6cfceda38efbbdf5bbe196e3a8e41989c8ded0dc577034ffadc88f6bddd922ed185c454544007e73856dfd5edf140dfca105cec29d7b9100a1664f428264d8cacf6f365156be76a58c4c4520180ae54e1b4dde9dfa02775aa2caaa789cdbbc0077872361de9e046694533d4dd6ad7ec9a18dff5532d90117e12abe4876c2906febf4e2d07bcc4e04e4cd35f6ad9669c14f47fbe80d169fbd2aa9423574d3dd5a2812e8132c50a4e54672437868587e7c5d5785621b24b9ecb2280a6713655eb7e3aac5ff510271510b4d67e282157d3122e28819f43dd3f39fee369451acedc157164235af1c3b749d3d773b322c8dac7765246ee9973ae85ef6d862a99f780a89cf66faa6d03af74de83234ee1de624f3c6fe607a5605d015ba9838e11b8a4786ccf2586a530a775d3f047a7ffe6afcba4be1dfd26077fa5220fc317d2b2243a194fa89b545d91fda964cd6a86d04c0c0b40509bc919b1bb0bda282765aec2afb67b33d209cd54e1a866de6d2ed585c17113edfe86026094e6a045fe2667e296d4bb68d93f976449c8cf11c5242dbe7be2c9af1c7c71a102fd5496a81c5acbc28748cd9c87f0dd14a1934db77f06294d093f8b4db07ad248b9fe4d2c6832889bab08cdc7e9184207a1918a72a81930c2c9592d370ad94e52c4d4b2babe9078a9a124f493cdbce67fe403c0be4cf8cdee0f7f0863bccabda37935505247b0146617c8eca7a50e227815bcc0e4271f9d2bc77423db7b3464bf81b6eb729e4cc7351e747b3857dc6782ba9da7b809d07013a5bb3036214191cde474116bb8dceb170303056dd9f863f2cef8b8ce6cb78cb4d4cc92575d9cef7ce92d75f0f63a4cbc74822af2427fde24dd5c58407920a0af7e1fd4ea5e437d8e1310d5868fe70269d248176c750ab33e4a1c3cffce67059c30b6d5383d3b666a282c56da1ea7a6df1ed3d4e49b1f5fd4c1b18cf40f3cc470d9e1da61064449e8883d91b8ea0223f0fe065818818b53bbacde35b3866e27a4ceb2df2143a885257628e174726d6a3c790753a5b9cc07f6a23bdb86a208f3ccd296f3cc17aad4a55c0477276d02002ff863303fea3e095c011db2876a6133c1371677dab8e106df9c458b60914a83688835c06de210dde2c16c84a7eb3e8dbf44a84e98eec975e68d154f30562a3295f838b6c287a8e53f55de3c0168c68a5e6f88ae2e63c7b0cb4c54a6881a44edc09f9b75d414bb7bfa35b2aac940a7146865c7466de063c8bf9e1ad3f49435bc62c70c53a0f824328e1436385fb972df500ad0f9ff6a900234b4921b3701291782d6427f1513db70281f13df0ef95083c3fca91d0ae706e57d4bafc2f9527fde9d089fc10bab5880cc2853c7d89557a282c2abc88dc423a8a5d8d09e4e4274c1da77894782e75957aa06ba3869c1f0997a732969e1564f02a396e1547302049c008bc49f6b0571def0b8c5bb74c2c08b7a53eb8471e1097f2d29fc31842b96f2cea8aba9a63f1e24da07552340ce6d242675ab2f91a99041295bcfe23f938ecf1d7c3ebf9f4c9ca0ace8288abd2a22756faa7a42ce0d1e70a4a21537d3a52db8f72df5dd8fa47bb69e22df66efe1be4994654c75cc352266da5b8e4788b7a0b604f33a077c0d18be1b669a8123c696dbee53f2befd05df517fcf3523d1c3437c51089e49e14797da8527b797d17cebe17226741464c3b7b12893b32968a3f0c7f67e2969900b877b97ab14ab64fbbd9c20ad47bdcc82dadc56422933f37cb8fb07853bcdd5dc031e8041abad41ffc6745fbf670dd1bba909d6be1bf41b1b0773950fe79c3c4e66550a64214e534a07ae5c0176a98c119c449b6c29fb60660f19301fdac3673751d0ebad842b8d1454bd148188d57e22c7fe5762e97aa720de2ba2d32e8f5aacbf693c58e0d3544e5e2189419a352f6ce6c9740b4ddddf5044f2f680285286100cdd3424701b7ab952e5fabe1bae62ce0e9d8a199290c1cd9f6dbc1ec02441152de5a6bcc4a4ff8b6c16e0d98f7b302278cb0f2141eaed732ecd0cc5de0e5de137f7338b01a6e8c3e140547a597c809bc58834ac930ea220ccccce6df83bf25c45b490f4424fcc7705800b97417bb11bb0bf06e680e88ce0e58cc210a09b921b5882d389307c9ce0bfe56e286d367b78c7c3f02d9131bca76f3039cb3d8c43c3e7c8a5e859829d377718e995d7473d66ce0d572476b60dc921fa895dfe5e834d9a0afb36239e572582442ed770a0f0ce409cd77a777550856b3cc342924aee8a709bd2dc6685b5333b3362405e1744ad9c1c041173da63f49ab5cdf2154046aafc2b972750faebbba3c95c39a87bd5736fcdf3c67bc5aead9b84f21c46047253224bb5961325658448fc912800255d2ece8b8e323a479272c0889305d73a1f7e126cef5948e18f822519974835ca865fd9a5aa4350c238df7a1c317afa4a2a52d7b528767520f51fa6db36e21d9771e444c65d9137fe9294f544e4c6fe2c6759c663faac616b9ece8375f6c12d00f4624a31c050100a51561de49725be9fffac8f70937cc27550fcaad06ee1935714ed479be588891dc0f88ab395cd550ee2e4635e866b060ef5c1922e585f912b3df94c414e19cde1d62461e1cd98e474b5552594571e31a2b722bc7a6f8bd2b3a89e8f462cf2d6ddd05489333fe5917be0629e138180c7760497b8f18633e4b0c1bff99a4242f53b7ea7aa1f28c22aec72834088e93c6779ff9ea43bb2de2c8d34135c435ea3ceb99dc7faf7804efef04be5df5eb7a2018caf3ccc5b667f170303056dd9f863f2cef8b8cfa070d31e174fa8c12dacea9fc8247fd41f4664f89e1ffba5e365e27cb173d54d9109ee798d40e2f3acff4300d1a5e74ec0a5a368cc35f2244911392bc0842d9152c2320621faca6209318a11d7b4afb2d91c180705a70eb111feac0ddaf57cacc5973a257c5154c1a5e2097e98fcce73b7c71e74aa09cba1a8577b60f4a796e64debf39753a207ea21eed98ef2358cc3189014145ae3adf0278a2f0e4887599d84a681155e677aa6906d2ff225d50b70ae040739232d0c91d9b602110ad604ea8ea31859040e9744a9eb99bfd02a31ad120b9b3b15a4e7aec8816a3780d6980f9a9b2f6a86ffa6f188f3e1acd51fb61a045bcd060972cb42bd7b4b6a2576e82153834807d4d9af241cb6f7e0a268ac9d219ee5eea7be0251b8ede2a44681ad59f26d47d0ec29d0d2e73a754493d4edbbc0f986afdef3f56c8abb34971d0449ee579feffa2f4cb64a67f875670b617db0358e67e5ff93d887c17f4f4b286c95cb25c63dafb4719b2c6c21a5a68d76bff6e40c62fa4f895b16020b901add813f427448f407df4139d07c42489a73daadb859e7bcac0e4f3e87aa9cc0eee4ae8bc5181a4b71f739d412aa36d14ba5c5c939e4285cd132e8b39c5e3c363b65cba66929c4631fe3ebf6b30bba3ebfc75a742c5eb4f6b534e1ba5abc4444bcb8527f84a8f26aaf2fb23eea7e93dab52ee4664fdafed1ed8563842e19a337a11dc08e610b9d07c8b738ec0cae64352d5a63be25aa70596e45a59c81534fa78f7af0075257362800792f07fd629bef0ff1927c0ecb0060cd9b0887b9c984fbe54443091995778cb49d8ac801258b2fb88717b6e7775e885d3fc493251b8d6b72cfab76ab889e0e1402e62273e943b8d440fbfb90c11ded9553396a1123f981e61d040d29e4590a86bece98a34a74df597cb804af8c7df5b4ada503e74af75f783252f5c4109ea63f57a10c70c0764122831c9d48b57acdf22aabef7cc66279f8ae2da24d484e1b7bf00bb0e6672405f603ea6406a51a7a1511a9c5af26de386e111967ca2d3948ad91259c12dfe5e27cf9e4dbc2a713a6153f27c78c6768213ad13f06661b1e8209623f81fffd94b6dfa621fc13f45dcdc69fba5fba92859e7dbd6542a2c90fd754df24f553f5a46b2d464efc4ccec6457581c68415d7aa65157a87011ef87543d4ac02b0511c73742d4321274ab2aa056d0c129807f8ed28f2c71f23fe4d00b915db2401525358e2bd279cf97d30057d2b15203ca9393df1b28c2d99fe16ea38f77214cf07356668dc687f593157c77572510e6180182cf135a29c03dee1474489aa655e2e735466ef0bae1ccf0691ad3d9aa2033944353809f97ac72cfda3b24cd20b897da07ca8b073484d9a3e16d61654b0be8d5a2fd75ec27cbbb3cd88ee8d5f628d67ca490338850ffade9b61a1e8dadf07a0a9612c2085511b450db6efccabd2d1ad59810725cb8143296433f3891f3b7a58fd7e4d0811b5be7da3bd45986aeec10ec215f91d22c10fe983c266f03a5f0d260c8d286bf47d51549f9491b274fd57265b5734cd9f01cb8d9cf081e18a2931b32e8fb9ac5bd82e72cd285cb59949883baf87fa062e7dcda5e3756adbdf0e6261204d13194433bd12a9447bab021e5128ae0cdad0a6f26e578397ef1beb42e6a0349866553d03988427d5b3d060703b76759b67961748a5ff5ed37f773844373c7c739f21b12c224611b04a673ec401eef0bebdf78aadf97cfb8eb97cda2c260df87631b72c49fa9392d1669d401062d45a326c15e3d2bf4f6b72e56f0e9ac937014aca03b5c144481d8de8824ba2a2d8da99e93ac116300d83199ee9482db38be778edd18ccd4f205503a23132c97dfdabda124f75bacf456f86b3d1e146bceaed29b095cb0d2b6a3293f55b3a466225215ef05ea5491e73b2807ea6b75ed96377f778c594b57109a38cc67ed817030301bed9f863f2cef8b8d08439800bf2649cbeae6c33bac8b31cf2a02a40f1d651a3884d5ca1f366f4a0f4d9b48a8457c0f9070530496e0588c7f653ce83ffc6a55ba01937d1a487030e0ccf2b1d1570b0e5a3d3b56db2f9c25b698588f833a8697d48a0b457b5cb98e5e9a59284c1aacaf2f6dde685a8d84791342d8680ef3210cc3822a14f1d04b00ddb10291b992501541261cbb34e71532a3124fc92a21005fd692ad499f5b2c1556dfa9097f4c3afda48582cedd341adff827e8d2e346f05aaf8fd7880cedc3cf6105a0c367f15d9a72579b10a83211761d197aa8c15f26053e01a7b57afc92900b0b5d60d87f2eb9fbe972fa911d70873122723275531f76fbf5cbbaf07764f41a2b5a7b4fd9927cb736c4a8d7d31e594e7923bbd6ae373339fc8245abae7d63f78e0cd8aa2a39f08b7488245263d5c5cee554e18b91470226bbe9cbd7ac7c1e4263349c3ac782546a0190e68f5674e1e0ceeeb52d6743a43a2783ce9ae4a5e9b835df402cd080fec041e0a6a9bafa391d9fb9e4fb384b632b684172202ac76c1d70439c9758ab2605fb1b52601513e15eaaac576a3497cf0a2672f828f7d860178d79baafcac9637bf895086fc509f4f5e25378397bde2")); objs = dec.decodeBuffer(conn, p00); diff --git a/common/src/test/java/org/red5/test/selftest/EchoApplication.java b/common/src/test/java/org/red5/test/selftest/EchoApplication.java index 702f64424..00067083c 100644 --- a/common/src/test/java/org/red5/test/selftest/EchoApplication.java +++ b/common/src/test/java/org/red5/test/selftest/EchoApplication.java @@ -11,7 +11,7 @@ /** * Echo sample application. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ @@ -19,7 +19,7 @@ public class EchoApplication extends MultiThreadedApplicationAdapter { /** * Return passed parameter back to client. - * + * * @param param Parameter to return. * @return Passed parameter. */ diff --git a/io/pom.xml b/io/pom.xml index 4ba452ac3..bd36c4f08 100644 --- a/io/pom.xml +++ b/io/pom.xml @@ -3,7 +3,7 @@ org.red5 red5-parent - 1.2.24 + 1.2.31 4.0.0 red5-io diff --git a/io/src/main/java/org/red5/annotations/Anonymous.java b/io/src/main/java/org/red5/annotations/Anonymous.java index 16f7c39cb..732bac800 100644 --- a/io/src/main/java/org/red5/annotations/Anonymous.java +++ b/io/src/main/java/org/red5/annotations/Anonymous.java @@ -14,9 +14,9 @@ /** * Annotation for classes that should be serialized without their class name. - * + * * This should only be used if you know what you're doing and currently is only added to Red5 internal classes. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ diff --git a/io/src/main/java/org/red5/annotations/DeclarePrivate.java b/io/src/main/java/org/red5/annotations/DeclarePrivate.java index 98254a965..80175e5bf 100644 --- a/io/src/main/java/org/red5/annotations/DeclarePrivate.java +++ b/io/src/main/java/org/red5/annotations/DeclarePrivate.java @@ -14,7 +14,7 @@ /** * Annotation for public methods that should not be callable through RTMP, RTMPT or Remoting. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ diff --git a/io/src/main/java/org/red5/annotations/DeclareProtected.java b/io/src/main/java/org/red5/annotations/DeclareProtected.java index b0e850ec5..a41dbaf10 100644 --- a/io/src/main/java/org/red5/annotations/DeclareProtected.java +++ b/io/src/main/java/org/red5/annotations/DeclareProtected.java @@ -14,7 +14,7 @@ /** * Annotation for public methods that should be protected by a named permission when called through RTMP, RTMPT or Remoting. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ @@ -24,7 +24,7 @@ /** * Permission required to execute method. - * + * * @return permission required */ String permission(); diff --git a/io/src/main/java/org/red5/annotations/DontSerialize.java b/io/src/main/java/org/red5/annotations/DontSerialize.java index 61f381f08..21127b563 100644 --- a/io/src/main/java/org/red5/annotations/DontSerialize.java +++ b/io/src/main/java/org/red5/annotations/DontSerialize.java @@ -14,7 +14,7 @@ /** * Annotation for fields that should not be serialized when sending objects to a client. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ diff --git a/io/src/main/java/org/red5/cache/ICacheStore.java b/io/src/main/java/org/red5/cache/ICacheStore.java index f4f7ff1db..92df9dd95 100644 --- a/io/src/main/java/org/red5/cache/ICacheStore.java +++ b/io/src/main/java/org/red5/cache/ICacheStore.java @@ -12,12 +12,12 @@ /** * Storage for cacheable objects. Selected cache engines must implement this interface. - * + * * @see Soft references provide for quick-and-dirty caching * @see Reference Objects and Garbage Collection * @see Top Ten New Things You Can Do with NIO * @see Proxy Cache Solution - * + * * @author The Red5 Project * @author Paul Gregoire (mondain@gmail.com) */ @@ -25,7 +25,7 @@ public interface ICacheStore { /** * Offer an object to the cache with an associated key. If the named object exists in cache, it will not be accepted. - * + * * @param name * string name representing the object * @param obj @@ -36,7 +36,7 @@ public interface ICacheStore { /** * Puts an object in the cache with the associated key. - * + * * @param name * string name representing the object * @param obj @@ -46,7 +46,7 @@ public interface ICacheStore { /** * Return a cached object with the given name. - * + * * @param name * the name of the object to return * @return the object or null if no such object was found @@ -55,7 +55,7 @@ public interface ICacheStore { /** * Delete the passed cached object. - * + * * @param obj * the object to delete * @return true if was removed; false it wasn't in cache to begin with @@ -64,7 +64,7 @@ public interface ICacheStore { /** * Delete the cached object with the given name. - * + * * @param name * the name of the object to delete * @return true if was removed; false it wasn't in cache to begin with @@ -73,21 +73,21 @@ public interface ICacheStore { /** * Return iterator over the names of all already loaded objects in the storage. - * + * * @return iterator over all objects names */ public Iterator getObjectNames(); /** * Return iterator over the already loaded objects in the storage. - * + * * @return iterator over all objects */ public Iterator> getObjects(); /** * Sets the maximum number of entries for the cache. - * + * * @param max * upper-limit of the cache */ diff --git a/io/src/main/java/org/red5/cache/ICacheable.java b/io/src/main/java/org/red5/cache/ICacheable.java index c6fedc4d0..8e560681e 100644 --- a/io/src/main/java/org/red5/cache/ICacheable.java +++ b/io/src/main/java/org/red5/cache/ICacheable.java @@ -13,9 +13,9 @@ /** * Base interface for objects that can be made cacheable. - * + * * @see ICacheStore - * + * * @author The Red5 Project * @author Paul Gregoire (mondain@gmail.com) */ @@ -23,14 +23,14 @@ public interface ICacheable extends Serializable { /** * Returns true if the object is cached, false otherwise. - * + * * @return true if object is cached, false otherwise */ public boolean isCached(); /** * Sets a flag to represent the cached status of a cacheable object. - * + * * @param cached * true if object is cached, false otherwise */ @@ -38,14 +38,14 @@ public interface ICacheable extends Serializable { /** * Returns the name of the cached object. - * + * * @return Object name */ public String getName(); /** * Set the name of the cached object. - * + * * @param name * New object name */ @@ -53,14 +53,14 @@ public interface ICacheable extends Serializable { /** * Returns the object contained within the cacheable reference. - * + * * @return Cached representation of object */ public byte[] getBytes(); /** * Returns a readonly byte buffer. - * + * * @return Read-only IoBuffer with cached data */ public IoBuffer getByteBuffer(); diff --git a/io/src/main/java/org/red5/cache/impl/CacheImpl.java b/io/src/main/java/org/red5/cache/impl/CacheImpl.java index 61fefe06f..420fac859 100644 --- a/io/src/main/java/org/red5/cache/impl/CacheImpl.java +++ b/io/src/main/java/org/red5/cache/impl/CacheImpl.java @@ -24,7 +24,7 @@ /** * Provides an implementation of an object cache. - * + * * @author The Red5 Project * @author Paul Gregoire (mondain@gmail.com) */ @@ -83,7 +83,7 @@ public static ApplicationContext getApplicationContext() { /** * Returns the instance of this class. - * + * * @return instance of this class */ public static CacheImpl getInstance() { diff --git a/io/src/main/java/org/red5/cache/impl/CacheableImpl.java b/io/src/main/java/org/red5/cache/impl/CacheableImpl.java index 3c92570ca..c4c059ade 100644 --- a/io/src/main/java/org/red5/cache/impl/CacheableImpl.java +++ b/io/src/main/java/org/red5/cache/impl/CacheableImpl.java @@ -14,7 +14,7 @@ /** * Provides an implementation of a cacheable object. - * + * * @author The Red5 Project * @author Paul Gregoire (mondain@gmail.com) */ diff --git a/io/src/main/java/org/red5/cache/impl/EhCacheImpl.java b/io/src/main/java/org/red5/cache/impl/EhCacheImpl.java index 59a105374..ad6d142cc 100644 --- a/io/src/main/java/org/red5/cache/impl/EhCacheImpl.java +++ b/io/src/main/java/org/red5/cache/impl/EhCacheImpl.java @@ -31,9 +31,9 @@ /** * Provides an implementation of an object cache using EhCache. - * + * * @see ehcache homepage - * + * * @author The Red5 Project * @author Paul Gregoire (mondain@gmail.com) */ diff --git a/io/src/main/java/org/red5/cache/impl/NoCacheImpl.java b/io/src/main/java/org/red5/cache/impl/NoCacheImpl.java index 88b18a46f..5370b41c3 100644 --- a/io/src/main/java/org/red5/cache/impl/NoCacheImpl.java +++ b/io/src/main/java/org/red5/cache/impl/NoCacheImpl.java @@ -21,7 +21,7 @@ /** * Provides an implementation of an object cache which actually does not provide a cache. - * + * * @author The Red5 Project * @author Paul Gregoire (mondain@gmail.com) */ @@ -40,7 +40,7 @@ private NoCacheImpl() { /** * Returns the instance of this class. - * + * * @return class instance */ public static NoCacheImpl getInstance() { diff --git a/io/src/main/java/org/red5/codec/AACAudio.java b/io/src/main/java/org/red5/codec/AACAudio.java index db1e678a8..351cd0911 100644 --- a/io/src/main/java/org/red5/codec/AACAudio.java +++ b/io/src/main/java/org/red5/codec/AACAudio.java @@ -15,7 +15,7 @@ * Red5 audio codec for the AAC audio format. * * Stores the decoder configuration - * + * * @author Paul Gregoire (mondain@gmail.com) * @author Wittawas Nakkasem (vittee@hotmail.com) * @author Vladimir Hmelyoff (vlhm@splitmedialabs.com) @@ -109,12 +109,12 @@ private static long sample2TC(long time, int sampleRate) { return (time * 1000L / sampleRate); } - //private final byte[] getAACSpecificConfig() { - // byte[] b = new byte[] { + //private final byte[] getAACSpecificConfig() { + // byte[] b = new byte[] { // (byte) (0x10 | /*((profile > 2) ? 2 : profile << 3) | */((sampleRateIndex >> 1) & 0x03)), // (byte) (((sampleRateIndex & 0x01) << 7) | ((channels & 0x0F) << 3)) // }; // log.debug("SpecificAudioConfig {}", HexDump.toHexString(b)); - // return b; - //} + // return b; + //} } diff --git a/io/src/main/java/org/red5/codec/AudioCodec.java b/io/src/main/java/org/red5/codec/AudioCodec.java index 6c8fbe155..21f6024fb 100644 --- a/io/src/main/java/org/red5/codec/AudioCodec.java +++ b/io/src/main/java/org/red5/codec/AudioCodec.java @@ -13,7 +13,7 @@ /** * Audio codecs that Red5 supports. - * + * * @author Art Clarke * @author Paul Gregoire (mondain@gmail.com) */ @@ -42,7 +42,7 @@ private AudioCodec(byte id) { /** * Returns back a numeric id for this codec, that happens to correspond to the numeric identifier that FLV will use for this codec. - * + * * @return the codec id */ public byte getId() { diff --git a/io/src/main/java/org/red5/codec/IAudioStreamCodec.java b/io/src/main/java/org/red5/codec/IAudioStreamCodec.java index 706f11331..5f0c27d73 100644 --- a/io/src/main/java/org/red5/codec/IAudioStreamCodec.java +++ b/io/src/main/java/org/red5/codec/IAudioStreamCodec.java @@ -11,7 +11,7 @@ /** * Represents an Audio codec and its associated decoder configuration. - * + * * @author Paul Gregoire (mondain@gmail.com) */ public interface IAudioStreamCodec { @@ -28,7 +28,7 @@ public interface IAudioStreamCodec { /** * Returns true if the codec knows how to handle the passed stream data. - * + * * @param data * some sample data to see if this codec can handle it. * @return can this code handle the data. @@ -37,7 +37,7 @@ public interface IAudioStreamCodec { /** * Update the state of the codec with the passed data. - * + * * @param data * data to tell the codec we're adding * @return true for success. false for error. @@ -46,7 +46,7 @@ public interface IAudioStreamCodec { /** * Add audio data with a time stamp and a flag identifying the content as AMF or not. - * + * * @param data * @param timestamp * @param amf if true, data is in AMF format otherwise its most likely from non-AMF source like RTP @@ -56,7 +56,7 @@ public interface IAudioStreamCodec { /** * Returns information used to configure the decoder. - * + * * @return the data for decoder setup. */ public IoBuffer getDecoderConfiguration(); diff --git a/io/src/main/java/org/red5/codec/IStreamCodecInfo.java b/io/src/main/java/org/red5/codec/IStreamCodecInfo.java index 6658c7d26..c30222846 100644 --- a/io/src/main/java/org/red5/codec/IStreamCodecInfo.java +++ b/io/src/main/java/org/red5/codec/IStreamCodecInfo.java @@ -13,14 +13,14 @@ public interface IStreamCodecInfo { /** * Has audio support? - * + * * @return true if stream codec has audio support, false otherwise */ boolean hasAudio(); /** * Has video support? - * + * * @return true if stream codec has video support, false otherwise */ boolean hasVideo(); diff --git a/io/src/main/java/org/red5/codec/IVideoStreamCodec.java b/io/src/main/java/org/red5/codec/IVideoStreamCodec.java index ff134ddfe..cc7160908 100644 --- a/io/src/main/java/org/red5/codec/IVideoStreamCodec.java +++ b/io/src/main/java/org/red5/codec/IVideoStreamCodec.java @@ -31,14 +31,14 @@ public interface IVideoStreamCodec { /** * Check if the codec supports frame dropping. - * + * * @return if the codec supports frame dropping. */ public boolean canDropFrames(); /** * Returns true if the codec knows how to handle the passed stream data. - * + * * @param data * some sample data to see if this codec can handle it * @return can this code handle the data. @@ -47,7 +47,7 @@ public interface IVideoStreamCodec { /** * Update the state of the codec with the passed data. - * + * * @param data * data to tell the codec we're adding * @return true for success. false for error @@ -56,7 +56,7 @@ public interface IVideoStreamCodec { /** * Update the state of the codec with the passed data. - * + * * @param data * data to tell the codec we're adding * @param timestamp time associated with the data @@ -66,7 +66,7 @@ public interface IVideoStreamCodec { /** * Add video data with a time stamp and a flag identifying the content as AMF or not. - * + * * @param data * @param timestamp * @param amf if true, data is in AMF format otherwise its most likely from non-AMF source like RTP @@ -76,28 +76,28 @@ public interface IVideoStreamCodec { /** * Returns keyframe data. - * + * * @return the data for a keyframe */ public IoBuffer getKeyframe(); /** * Returns all the keyframe data. - * + * * @return array of keyframe data */ public FrameData[] getKeyframes(); /** * Returns information used to configure the decoder. - * + * * @return the data for decoder setup */ public IoBuffer getDecoderConfiguration(); /** * Returns the number of interframes collected from last keyframe. - * + * * @return number of interframes */ public int getNumInterframes(); @@ -127,7 +127,7 @@ public FrameData(IoBuffer data) { /** * Makes a copy of the incoming bytes and places them in an IoBuffer. No flip or rewind is performed on the source data. - * + * * @param data * data */ diff --git a/io/src/main/java/org/red5/codec/MP3Audio.java b/io/src/main/java/org/red5/codec/MP3Audio.java index 9c473d079..6912fffb6 100644 --- a/io/src/main/java/org/red5/codec/MP3Audio.java +++ b/io/src/main/java/org/red5/codec/MP3Audio.java @@ -12,7 +12,7 @@ * Red5 audio codec for the MP3 audio format. * * Stores the decoder configuration - * + * * @author Paul Gregoire (mondain@gmail.com) */ public class MP3Audio extends AbstractAudio { diff --git a/io/src/main/java/org/red5/codec/OpusAudio.java b/io/src/main/java/org/red5/codec/OpusAudio.java index 2ec4440aa..a93d2913b 100644 --- a/io/src/main/java/org/red5/codec/OpusAudio.java +++ b/io/src/main/java/org/red5/codec/OpusAudio.java @@ -14,7 +14,7 @@ * Red5 audio codec for the Opus audio format. * * Opus has no decoder configuration; its all in-band. - * + * * @author Paul Gregoire (mondain@gmail.com) */ public class OpusAudio extends AbstractAudio { @@ -22,7 +22,7 @@ public class OpusAudio extends AbstractAudio { private static Logger log = LoggerFactory.getLogger(OpusAudio.class); /** - * Sample rates: + * Sample rates:
             Abbreviation            Audio bandwidth     Effective sample rate
             NB (narrowband)         4 kHz               8 kHz
    diff --git a/io/src/main/java/org/red5/codec/ScreenVideo.java b/io/src/main/java/org/red5/codec/ScreenVideo.java
    index eed201f17..43c10afd0 100644
    --- a/io/src/main/java/org/red5/codec/ScreenVideo.java
    +++ b/io/src/main/java/org/red5/codec/ScreenVideo.java
    @@ -13,7 +13,7 @@
     
     /**
      * Red5 video codec for the screen capture format.
    - * 
    + *
      * @author The Red5 Project
      * @author Joachim Bauch (jojo@struktur.de)
      * @author Paul Gregoire (mondain@gmail.com)
    @@ -127,7 +127,7 @@ private static int maxCompressedSize(int size) {
     
         /**
          * Update total block size
    -     * 
    +     *
          * @param data
          *            Byte buffer
          */
    diff --git a/io/src/main/java/org/red5/codec/ScreenVideo2.java b/io/src/main/java/org/red5/codec/ScreenVideo2.java
    index 64c132832..d13098d31 100644
    --- a/io/src/main/java/org/red5/codec/ScreenVideo2.java
    +++ b/io/src/main/java/org/red5/codec/ScreenVideo2.java
    @@ -13,7 +13,7 @@
     
     /**
      * Red5 video codec for the screen capture format.
    - * 
    + *
      * @author The Red5 Project
      * @author Joachim Bauch (jojo@struktur.de)
      * @author Paul Gregoire (mondain@gmail.com)
    @@ -137,7 +137,7 @@ private static int maxCompressedSize(int size) {
     
         /**
          * Update total block size
    -     * 
    +     *
          * @param data
          *            Byte buffer
          */
    diff --git a/io/src/main/java/org/red5/codec/SpeexAudio.java b/io/src/main/java/org/red5/codec/SpeexAudio.java
    index 99dbeeba4..54f34d8be 100644
    --- a/io/src/main/java/org/red5/codec/SpeexAudio.java
    +++ b/io/src/main/java/org/red5/codec/SpeexAudio.java
    @@ -12,7 +12,7 @@
      * Red5 audio codec for the Speex audio format.
      *
      * Stores the decoder configuration
    - * 
    + *
      * @author Paul Gregoire (mondain@gmail.com)
      */
     public class SpeexAudio extends AbstractAudio {
    diff --git a/io/src/main/java/org/red5/codec/ULAWAudio.java b/io/src/main/java/org/red5/codec/ULAWAudio.java
    index 72a871381..9152f8dba 100644
    --- a/io/src/main/java/org/red5/codec/ULAWAudio.java
    +++ b/io/src/main/java/org/red5/codec/ULAWAudio.java
    @@ -12,7 +12,7 @@
      * Red5 audio codec for the PCM uLaw audio format.
      *
      * Stores the decoder configuration
    - * 
    + *
      * @author Paul Gregoire (mondain@gmail.com)
      */
     public class ULAWAudio extends AbstractAudio {
    diff --git a/io/src/main/java/org/red5/codec/VideoCodec.java b/io/src/main/java/org/red5/codec/VideoCodec.java
    index 383f8d908..bbfbcbacb 100644
    --- a/io/src/main/java/org/red5/codec/VideoCodec.java
    +++ b/io/src/main/java/org/red5/codec/VideoCodec.java
    @@ -13,7 +13,7 @@
     
     /**
      * Video codecs that Red5 supports.
    - * 
    + *
      * @author Art Clarke
      * @author Paul Gregoire (mondain@gmail.com)
      */
    @@ -42,7 +42,7 @@ private VideoCodec(byte id) {
     
         /**
          * Returns back a numeric id for this codec, that happens to correspond to the numeric identifier that FLV will use for this codec.
    -     * 
    +     *
          * @return the codec id
          */
         public byte getId() {
    diff --git a/io/src/main/java/org/red5/compatibility/flex/data/messages/DataMessage.java b/io/src/main/java/org/red5/compatibility/flex/data/messages/DataMessage.java
    index 698efb7ec..8cff12e83 100644
    --- a/io/src/main/java/org/red5/compatibility/flex/data/messages/DataMessage.java
    +++ b/io/src/main/java/org/red5/compatibility/flex/data/messages/DataMessage.java
    @@ -11,7 +11,7 @@
     
     /**
      * Message containing data update requests.
    - * 
    + *
      * @author The Red5 Project
      * @author Joachim Bauch (jojo@struktur.de)
      */
    diff --git a/io/src/main/java/org/red5/compatibility/flex/data/messages/SequencedMessage.java b/io/src/main/java/org/red5/compatibility/flex/data/messages/SequencedMessage.java
    index 569981a88..58f3ab360 100644
    --- a/io/src/main/java/org/red5/compatibility/flex/data/messages/SequencedMessage.java
    +++ b/io/src/main/java/org/red5/compatibility/flex/data/messages/SequencedMessage.java
    @@ -11,9 +11,9 @@
     
     /**
      * Response to DataMessage requests.
    - * 
    + *
      * @see DataMessage
    - * 
    + *
      * @author The Red5 Project
      * @author Joachim Bauch (jojo@struktur.de)
      */
    diff --git a/io/src/main/java/org/red5/compatibility/flex/messaging/io/ArrayCollection.java b/io/src/main/java/org/red5/compatibility/flex/messaging/io/ArrayCollection.java
    index e198e66e1..e6e53237e 100644
    --- a/io/src/main/java/org/red5/compatibility/flex/messaging/io/ArrayCollection.java
    +++ b/io/src/main/java/org/red5/compatibility/flex/messaging/io/ArrayCollection.java
    @@ -22,9 +22,9 @@
     
     /**
      * Flex ArrayCollection compatibility class.
    - * 
    + *
      * @see ArrayCollection
    - * 
    + *
      * @author The Red5 Project
      * @author Joachim Bauch (jojo@struktur.de)
      * @author Paul Gregoire (mondain@gmail.com)
    diff --git a/io/src/main/java/org/red5/compatibility/flex/messaging/io/ObjectProxy.java b/io/src/main/java/org/red5/compatibility/flex/messaging/io/ObjectProxy.java
    index 950e91a55..847fcb3ff 100644
    --- a/io/src/main/java/org/red5/compatibility/flex/messaging/io/ObjectProxy.java
    +++ b/io/src/main/java/org/red5/compatibility/flex/messaging/io/ObjectProxy.java
    @@ -19,7 +19,7 @@
     
     /**
      * Flex ObjectProxy compatibility class.
    - * 
    + *
      * @see ObjectProxy
      * @author The Red5 Project
      * @author Joachim Bauch (jojo@struktur.de)
    @@ -44,7 +44,7 @@ public ObjectProxy() {
     
         /**
          * Create proxy for given object.
    -     * 
    +     *
          * @param item
          *            object to proxy
          */
    @@ -67,7 +67,7 @@ public void writeExternal(IDataOutput output) {
     
         /**
          * Return string representation of the proxied object.
    -     * 
    +     *
          * @return string
          */
         @Override
    @@ -82,7 +82,7 @@ public void clear() {
     
         /**
          * Check if proxied object has a given property.
    -     * 
    +     *
          * @param name
          *            name
          * @return boolean
    @@ -104,7 +104,7 @@ public Set> entrySet() {
     
         /**
          * Return the value of a property.
    -     * 
    +     *
          * @param name
          *            name
          * @return value
    @@ -126,7 +126,7 @@ public Set keySet() {
     
         /**
          * Change a property of the proxied object.
    -     * 
    +     *
          * @param name
          *            name
          * @param value
    @@ -146,7 +146,7 @@ public void putAll(Map values) {
     
         /**
          * Remove a property from the proxied object.
    -     * 
    +     *
          * @param name
          *            name
          * @return old value
    diff --git a/io/src/main/java/org/red5/compatibility/flex/messaging/messages/AbstractMessage.java b/io/src/main/java/org/red5/compatibility/flex/messaging/messages/AbstractMessage.java
    index 64bb5e782..815514994 100644
    --- a/io/src/main/java/org/red5/compatibility/flex/messaging/messages/AbstractMessage.java
    +++ b/io/src/main/java/org/red5/compatibility/flex/messaging/messages/AbstractMessage.java
    @@ -21,7 +21,7 @@
     
     /**
      * Base class for all Flex compatibility messages.
    - * 
    + *
      * @author The Red5 Project
      * @author Joachim Bauch (jojo@struktur.de)
      */
    @@ -58,7 +58,7 @@ public AbstractMessage() {
     
         /**
          * Add message properties to string.
    -     * 
    +     *
          * @param result
          *            StringBuilder to add properties to
          */
    @@ -169,7 +169,7 @@ public void setTimeToLive(long value) {
     
         /**
          * Return string representation of the message.
    -     * 
    +     *
          * @return value
          */
         @Override
    diff --git a/io/src/main/java/org/red5/compatibility/flex/messaging/messages/AcknowledgeMessage.java b/io/src/main/java/org/red5/compatibility/flex/messaging/messages/AcknowledgeMessage.java
    index 345b2a5e4..74654defb 100644
    --- a/io/src/main/java/org/red5/compatibility/flex/messaging/messages/AcknowledgeMessage.java
    +++ b/io/src/main/java/org/red5/compatibility/flex/messaging/messages/AcknowledgeMessage.java
    @@ -16,7 +16,7 @@
     
     /**
      * Flex compatibility message that is returned to the client.
    - * 
    + *
      * @author The Red5 Project
      * @author Joachim Bauch (jojo@struktur.de)
      * @author Paul Gregoire (mondain@gmail.com)
    diff --git a/io/src/main/java/org/red5/compatibility/flex/messaging/messages/AcknowledgeMessageExt.java b/io/src/main/java/org/red5/compatibility/flex/messaging/messages/AcknowledgeMessageExt.java
    index 9643e554a..49a62f836 100644
    --- a/io/src/main/java/org/red5/compatibility/flex/messaging/messages/AcknowledgeMessageExt.java
    +++ b/io/src/main/java/org/red5/compatibility/flex/messaging/messages/AcknowledgeMessageExt.java
    @@ -12,7 +12,7 @@
     
     /**
      * An externalizable version of a given AcknowledgeMessage. The class alias for this class within flex is "DSK".
    - * 
    + *
      * @author Paul Gregoire (mondain@gmail.com)
      */
     public class AcknowledgeMessageExt extends AcknowledgeMessage implements IExternalizable {
    diff --git a/io/src/main/java/org/red5/compatibility/flex/messaging/messages/AsyncMessage.java b/io/src/main/java/org/red5/compatibility/flex/messaging/messages/AsyncMessage.java
    index e6efce7dd..68bb18733 100644
    --- a/io/src/main/java/org/red5/compatibility/flex/messaging/messages/AsyncMessage.java
    +++ b/io/src/main/java/org/red5/compatibility/flex/messaging/messages/AsyncMessage.java
    @@ -16,7 +16,7 @@
     
     /**
      * Base class for for asynchronous Flex compatibility messages.
    - * 
    + *
      * @author The Red5 Project
      * @author Joachim Bauch (jojo@struktur.de)
      * @author Paul Gregoire (mondain@gmail.com)
    diff --git a/io/src/main/java/org/red5/compatibility/flex/messaging/messages/AsyncMessageExt.java b/io/src/main/java/org/red5/compatibility/flex/messaging/messages/AsyncMessageExt.java
    index d309dd6a5..aa3146a44 100644
    --- a/io/src/main/java/org/red5/compatibility/flex/messaging/messages/AsyncMessageExt.java
    +++ b/io/src/main/java/org/red5/compatibility/flex/messaging/messages/AsyncMessageExt.java
    @@ -12,7 +12,7 @@
     
     /**
      * An externalizable version of a given AsyncMessage. The class alias for this class within flex is "DSA".
    - * 
    + *
      * @author Paul Gregoire (mondain@gmail.com)
      */
     public class AsyncMessageExt extends AsyncMessage implements IExternalizable {
    diff --git a/io/src/main/java/org/red5/compatibility/flex/messaging/messages/AuthenticationMessage.java b/io/src/main/java/org/red5/compatibility/flex/messaging/messages/AuthenticationMessage.java
    index eade11dba..81e881fbb 100644
    --- a/io/src/main/java/org/red5/compatibility/flex/messaging/messages/AuthenticationMessage.java
    +++ b/io/src/main/java/org/red5/compatibility/flex/messaging/messages/AuthenticationMessage.java
    @@ -9,7 +9,7 @@
     
     /**
      * Added to support flex.messaging.messages.AuthenticationMessage as noted in http://jira.red5.org/browse/APPSERVER-176
    - * 
    + *
      * @author The Red5 Project
      * @author Paul Gregoire (mondain@gmail.com)
      */
    diff --git a/io/src/main/java/org/red5/compatibility/flex/messaging/messages/CommandMessage.java b/io/src/main/java/org/red5/compatibility/flex/messaging/messages/CommandMessage.java
    index d639229e1..492e68ab6 100644
    --- a/io/src/main/java/org/red5/compatibility/flex/messaging/messages/CommandMessage.java
    +++ b/io/src/main/java/org/red5/compatibility/flex/messaging/messages/CommandMessage.java
    @@ -18,7 +18,7 @@
     
     /**
      * Command message as sent by the mx:RemoteObject tag.
    - * 
    + *
      * @see Action Message Format
      * @see Apache Flex
      *
    diff --git a/io/src/main/java/org/red5/compatibility/flex/messaging/messages/CommandMessageExt.java b/io/src/main/java/org/red5/compatibility/flex/messaging/messages/CommandMessageExt.java
    index 17eb77a3d..0cdeffce8 100644
    --- a/io/src/main/java/org/red5/compatibility/flex/messaging/messages/CommandMessageExt.java
    +++ b/io/src/main/java/org/red5/compatibility/flex/messaging/messages/CommandMessageExt.java
    @@ -12,7 +12,7 @@
     
     /**
      * An externalizable version of a given CommandMessage. The class alias for this class within flex is "DSC".
    - * 
    + *
      * @author Paul Gregoire (mondain@gmail.com)
      */
     public class CommandMessageExt extends CommandMessage implements IExternalizable {
    diff --git a/io/src/main/java/org/red5/compatibility/flex/messaging/messages/Constants.java b/io/src/main/java/org/red5/compatibility/flex/messaging/messages/Constants.java
    index e59c9e26b..931310e06 100644
    --- a/io/src/main/java/org/red5/compatibility/flex/messaging/messages/Constants.java
    +++ b/io/src/main/java/org/red5/compatibility/flex/messaging/messages/Constants.java
    @@ -9,7 +9,7 @@
     
     /**
      * Constants for the flex compatibility messages.
    - * 
    + *
      * @author The Red5 Project
      * @author Joachim Bauch (jojo@struktur.de)
      */
    diff --git a/io/src/main/java/org/red5/compatibility/flex/messaging/messages/ErrorMessage.java b/io/src/main/java/org/red5/compatibility/flex/messaging/messages/ErrorMessage.java
    index 2c5ba107d..3195ef288 100644
    --- a/io/src/main/java/org/red5/compatibility/flex/messaging/messages/ErrorMessage.java
    +++ b/io/src/main/java/org/red5/compatibility/flex/messaging/messages/ErrorMessage.java
    @@ -9,7 +9,7 @@
     
     /**
      * Compatibility flex error message to be returned to the client.
    - * 
    + *
      * @author The Red5 Project
      * @author Joachim Bauch (jojo@struktur.de)
      */
    diff --git a/io/src/main/java/org/red5/compatibility/flex/messaging/messages/Message.java b/io/src/main/java/org/red5/compatibility/flex/messaging/messages/Message.java
    index a19636b62..beecb6468 100644
    --- a/io/src/main/java/org/red5/compatibility/flex/messaging/messages/Message.java
    +++ b/io/src/main/java/org/red5/compatibility/flex/messaging/messages/Message.java
    @@ -39,28 +39,28 @@ public interface Message {
     
         /**
          * Returns the body of the message.
    -     * 
    +     *
          * @return message body
          */
         Object getBody();
     
         /**
          * Returns the client id indicating the client that sent the message.
    -     * 
    +     *
          * @return client id
          */
         String getClientId();
     
         /**
          * Returns the destination that the message targets.
    -     * 
    +     *
          * @return destination
          */
         String getDestination();
     
         /**
          * Returns a header value corresponding to the passed header name.
    -     * 
    +     *
          * @param name
          *            header name
          * @return header value
    @@ -69,35 +69,35 @@ public interface Message {
     
         /**
          * Returns the headers for the message.
    -     * 
    +     *
          * @return headers
          */
         Map getHeaders();
     
         /**
          * Returns the unique message id.
    -     * 
    +     *
          * @return message id
          */
         String getMessageId();
     
         /**
          * Returns the timestamp for the message.
    -     * 
    +     *
          * @return timestamp
          */
         long getTimestamp();
     
         /**
          * Returns the time to live for the message.
    -     * 
    +     *
          * @return time to live
          */
         long getTimeToLive();
     
         /**
          * Tests whether a header with the passed name exists.
    -     * 
    +     *
          * @param name
          *            header name
          * @return true if header exists, false otherwise
    @@ -106,7 +106,7 @@ public interface Message {
     
         /**
          * Sets the body of the message.
    -     * 
    +     *
          * @param value
          *            body
          */
    @@ -114,7 +114,7 @@ public interface Message {
     
         /**
          * Sets the client id indicating the client that sent the message.
    -     * 
    +     *
          * @param value
          *            client id
          */
    @@ -122,7 +122,7 @@ public interface Message {
     
         /**
          * Sets the destination that the message targets.
    -     * 
    +     *
          * @param value
          *            destination
          */
    @@ -130,7 +130,7 @@ public interface Message {
     
         /**
          * Sets a header on the message.
    -     * 
    +     *
          * @param name
          *            header name
          * @param value
    @@ -140,7 +140,7 @@ public interface Message {
     
         /**
          * Sets the headers for the message.
    -     * 
    +     *
          * @param values
          *            header values
          */
    @@ -148,7 +148,7 @@ public interface Message {
     
         /**
          * Sets the unique message id.
    -     * 
    +     *
          * @param value
          *            message id
          */
    @@ -156,7 +156,7 @@ public interface Message {
     
         /**
          * Sets the timestamp for the message.
    -     * 
    +     *
          * @param value
          *            timestamp
          */
    @@ -164,7 +164,7 @@ public interface Message {
     
         /**
          * Sets the time to live for the message.
    -     * 
    +     *
          * @param value
          *            ttl
          */
    diff --git a/io/src/main/java/org/red5/compatibility/flex/messaging/messages/RemotingMessage.java b/io/src/main/java/org/red5/compatibility/flex/messaging/messages/RemotingMessage.java
    index 022bf48a6..d3392c49b 100644
    --- a/io/src/main/java/org/red5/compatibility/flex/messaging/messages/RemotingMessage.java
    +++ b/io/src/main/java/org/red5/compatibility/flex/messaging/messages/RemotingMessage.java
    @@ -9,10 +9,10 @@
     
     /**
      * Flex compatibility message that is sent by the mx:RemoteObject mxml tag.
    - * 
    + *
      * @see Action Message Format
      * @see Apache Flex
    - * 
    + *
      * @author The Red5 Project
      * @author Joachim Bauch (jojo@struktur.de)
      */
    diff --git a/io/src/main/java/org/red5/io/ITagWriter.java b/io/src/main/java/org/red5/io/ITagWriter.java
    index a0ab88b79..fa8075e0f 100644
    --- a/io/src/main/java/org/red5/io/ITagWriter.java
    +++ b/io/src/main/java/org/red5/io/ITagWriter.java
    @@ -86,7 +86,7 @@ public interface ITagWriter {
     
         /**
          * Adds a post-process for execution once the instance completes.
    -     * 
    +     *
          * @param postProcessor an implementation instance of IPostProcessor
          */
         public void addPostProcessor(IPostProcessor postProcessor);
    diff --git a/io/src/main/java/org/red5/io/amf/AMF.java b/io/src/main/java/org/red5/io/amf/AMF.java
    index 5c513d7bf..b8ed9306d 100644
    --- a/io/src/main/java/org/red5/io/amf/AMF.java
    +++ b/io/src/main/java/org/red5/io/amf/AMF.java
    @@ -11,11 +11,11 @@
     
     /**
      * These are the core AMF data types supported by Red5.
    - * 
    + *
      * For detailed specification please see the link below.
    - * 
    + *
      * @see Action Message Format
    - * 
    + *
      * @author The Red5 Project
      * @author Luke Hubbard, Codegent Ltd (luke@codegent.com)
      */
    diff --git a/io/src/main/java/org/red5/io/amf/Input.java b/io/src/main/java/org/red5/io/amf/Input.java
    index 01775d2f4..de924cc54 100644
    --- a/io/src/main/java/org/red5/io/amf/Input.java
    +++ b/io/src/main/java/org/red5/io/amf/Input.java
    @@ -180,7 +180,7 @@ public Number readNumber() {
     
         /**
          * Reads string from buffer
    -     * 
    +     *
          * @return String
          */
         @Override
    @@ -230,7 +230,7 @@ public String readString() {
     
         /**
          * Converts the bytes into a string.
    -     * 
    +     *
          * @param str
          *            string bytes
          * @return decoded String
    @@ -305,7 +305,7 @@ public Map readKeyValues() {
     
         /**
          * Read key - value pairs into Map object
    -     * 
    +     *
          * @param result
          *            Map to put resulting pair to
          */
    diff --git a/io/src/main/java/org/red5/io/amf/Output.java b/io/src/main/java/org/red5/io/amf/Output.java
    index f4b55bab2..d4480ebe2 100644
    --- a/io/src/main/java/org/red5/io/amf/Output.java
    +++ b/io/src/main/java/org/red5/io/amf/Output.java
    @@ -68,7 +68,7 @@ private static CacheManager getCacheManager() {
                         cacheManager = constructDefault();
                     }
                 } else {
    -                // not a server, maybe running tests? 
    +                // not a server, maybe running tests?
                     cacheManager = constructDefault();
                 }
             }
    @@ -91,7 +91,7 @@ private static CacheManager constructDefault() {
     
         /**
          * Creates output with given byte buffer
    -     * 
    +     *
          * @param buf
          *            Byte buffer
          */
    @@ -526,7 +526,7 @@ protected static byte[] encodeString(String string) {
     
         /**
          * Write out string
    -     * 
    +     *
          * @param buf
          *            Byte buffer to write to
          * @param string
    @@ -559,7 +559,7 @@ public void writeXML(Document xml) {
     
         /**
          * Convenience method to allow XML text to be used, instead of requiring an XML Document.
    -     * 
    +     *
          * @param xml
          *            xml to write
          */
    @@ -570,7 +570,7 @@ public void writeXML(String xml) {
     
         /**
          * Return buffer of this Output object
    -     * 
    +     *
          * @return Byte buffer of this Output object
          */
         public IoBuffer buf() {
    diff --git a/io/src/main/java/org/red5/io/amf3/AMF3.java b/io/src/main/java/org/red5/io/amf3/AMF3.java
    index 634b74487..deabb7884 100644
    --- a/io/src/main/java/org/red5/io/amf3/AMF3.java
    +++ b/io/src/main/java/org/red5/io/amf3/AMF3.java
    @@ -11,10 +11,10 @@
      * AMF3 data type definitions.
      *
      * For detailed specification please see the link below.
    - * 
    + *
      * @see Action Message Format
      * @see Official Adobe AMF3 Specification
    - * 
    + *
      * @author The Red5 Project
      * @author Luke Hubbard, Codegent Ltd (luke@codegent.com)
      * @author Joachim Bauch (jojo@struktur.de)
    @@ -131,21 +131,21 @@ public class AMF3 {
     
         /**
          * Property list encoding.
    -     * 
    +     *
          * The remaining integer-data represents the number of class members that exist. The property names are read as string-data. The values are then read as AMF3-data.
          */
         public static final byte TYPE_OBJECT_PROPERTY = 0x00;
     
         /**
          * Externalizable object.
    -     * 
    +     *
          * What follows is the value of the "inner" object, including type code. This value appears for objects that implement IExternalizable, such as ArrayCollection and ObjectProxy.
          */
         public static final byte TYPE_OBJECT_EXTERNALIZABLE = 0x01;
     
         /**
          * Name-value encoding.
    -     * 
    +     *
          * The property names and values are encoded as string-data followed by AMF3-data until there is an empty string property name. If there is a class-def reference there are no property names and the number of values is equal to the number of properties in the class-def.
          */
         public static final byte TYPE_OBJECT_VALUE = 0x02;
    diff --git a/io/src/main/java/org/red5/io/amf3/ByteArray.java b/io/src/main/java/org/red5/io/amf3/ByteArray.java
    index bf1b0ac16..f371f038e 100644
    --- a/io/src/main/java/org/red5/io/amf3/ByteArray.java
    +++ b/io/src/main/java/org/red5/io/amf3/ByteArray.java
    @@ -17,7 +17,7 @@
     
     /**
      * Red5 version of the Flex ByteArray class.
    - * 
    + *
      * @author The Red5 Project
      * @author Joachim Bauch (jojo@struktur.de)
      */
    @@ -34,7 +34,7 @@ public class ByteArray implements IDataInput, IDataOutput {
     
         /**
          * Internal constructor used to create ByteArray during deserialization.
    -     * 
    +     *
          * @param buffer
          *            io buffer
          * @param length
    @@ -74,7 +74,7 @@ protected void prepareIO() {
     
         /**
          * Get internal data.
    -     * 
    +     *
          * @return byte buffer
          */
         protected IoBuffer getData() {
    @@ -83,7 +83,7 @@ protected IoBuffer getData() {
     
         /**
          * Get the current position in the data.
    -     * 
    +     *
          * @return current position
          */
         public int position() {
    @@ -92,7 +92,7 @@ public int position() {
     
         /**
          * Set the current position in the data.
    -     * 
    +     *
          * @param position
          *            position to set
          */
    @@ -102,7 +102,7 @@ public void position(int position) {
     
         /**
          * Return number of bytes available for reading.
    -     * 
    +     *
          * @return bytes available
          */
         public int bytesAvailable() {
    @@ -111,7 +111,7 @@ public int bytesAvailable() {
     
         /**
          * Return total number of bytes in array.
    -     * 
    +     *
          * @return number of bytes in array
          */
         public int length() {
    @@ -232,7 +232,7 @@ public String readMultiByte(int length, String charSet) {
         @Override
         public Object readObject() {
             // according to AMF3 spec, each object should have its own "reference" tables,
    -        // so we must recreate Input object before reading each object 
    +        // so we must recreate Input object before reading each object
             prepareIO();
             return dataInput.readObject();
         }
    @@ -338,7 +338,7 @@ public void writeMultiByte(String value, String encoding) {
         @Override
         public void writeObject(Object value) {
             // according to AMF3 spec, each object should have its own "reference" tables,
    -        // so we must recreate Input object before writing each object 
    +        // so we must recreate Input object before writing each object
             prepareIO();
             dataOutput.writeObject(value);
         }
    @@ -400,7 +400,7 @@ public boolean equals(Object obj) {
     
         /**
          * Return string representation of the array's contents.
    -     * 
    +     *
          * @return string representation of array's contents.
          */
         @Override
    diff --git a/io/src/main/java/org/red5/io/amf3/DataInput.java b/io/src/main/java/org/red5/io/amf3/DataInput.java
    index 1e3cd8889..86ecd19e6 100644
    --- a/io/src/main/java/org/red5/io/amf3/DataInput.java
    +++ b/io/src/main/java/org/red5/io/amf3/DataInput.java
    @@ -17,10 +17,10 @@
     
     /**
      * Implementation of the IDataInput interface. Can be used to load an IExternalizable object.
    - * 
    + *
      * @author The Red5 Project
      * @author Joachim Bauch (jojo@struktur.de)
    - * 
    + *
      */
     public class DataInput implements IDataInput {
     
    @@ -32,7 +32,7 @@ public class DataInput implements IDataInput {
     
         /**
          * Create a new DataInput.
    -     * 
    +     *
          * @param input
          *            input to use
          */
    diff --git a/io/src/main/java/org/red5/io/amf3/DataOutput.java b/io/src/main/java/org/red5/io/amf3/DataOutput.java
    index e8fff1500..0ff5062fd 100644
    --- a/io/src/main/java/org/red5/io/amf3/DataOutput.java
    +++ b/io/src/main/java/org/red5/io/amf3/DataOutput.java
    @@ -18,10 +18,10 @@
     
     /**
      * Implementation of the IDataOutput interface. Can be used to store an IExternalizable object.
    - * 
    + *
      * @author The Red5 Project
      * @author Joachim Bauch (jojo@struktur.de)
    - * 
    + *
      */
     public class DataOutput implements IDataOutput {
     
    @@ -33,7 +33,7 @@ public class DataOutput implements IDataOutput {
     
         /**
          * Create a new DataOutput.
    -     * 
    +     *
          * @param output
          *            destination to write to
          */
    diff --git a/io/src/main/java/org/red5/io/amf3/IDataInput.java b/io/src/main/java/org/red5/io/amf3/IDataInput.java
    index 8b1fcc9bd..1213f5f8f 100644
    --- a/io/src/main/java/org/red5/io/amf3/IDataInput.java
    +++ b/io/src/main/java/org/red5/io/amf3/IDataInput.java
    @@ -11,7 +11,7 @@
     
     /**
      * Interface implemented by classes that provide a way to load custom objects.
    - * 
    + *
      * @see IExternalizable#readExternal(IDataInput)
      * @see Adobe Livedocs (external)
      */
    @@ -19,14 +19,14 @@ public interface IDataInput {
     
         /**
          * Return the byteorder used when loading values.
    -     * 
    +     *
          * @return the byteorder
          */
         public ByteOrder getEndian();
     
         /**
          * Set the byteorder to use when loading values.
    -     * 
    +     *
          * @param endian
          *            the byteorder to use
          */
    @@ -34,21 +34,21 @@ public interface IDataInput {
     
         /**
          * Read boolean value.
    -     * 
    +     *
          * @return the value
          */
         public boolean readBoolean();
     
         /**
          * Read signed single byte value.
    -     * 
    +     *
          * @return the value
          */
         public byte readByte();
     
         /**
          * Read list of bytes.
    -     * 
    +     *
          * @param bytes
          *            destination for read bytes
          */
    @@ -56,7 +56,7 @@ public interface IDataInput {
     
         /**
          * Read list of bytes to given offset.
    -     * 
    +     *
          * @param bytes
          *            destination for read bytes
          * @param offset
    @@ -66,7 +66,7 @@ public interface IDataInput {
     
         /**
          * Read given number of bytes to given offset.
    -     * 
    +     *
          * @param bytes
          *            destination for read bytes
          * @param offset
    @@ -78,28 +78,28 @@ public interface IDataInput {
     
         /**
          * Read double-precision floating point value.
    -     * 
    +     *
          * @return the value
          */
         public double readDouble();
     
         /**
          * Read single-precision floating point value.
    -     * 
    +     *
          * @return the value
          */
         public float readFloat();
     
         /**
          * Read signed integer value.
    -     * 
    +     *
          * @return the value
          */
         public int readInt();
     
         /**
          * Read multibyte string.
    -     * 
    +     *
          * @param length
          *            length of string to read
          * @param charSet
    @@ -110,49 +110,49 @@ public interface IDataInput {
     
         /**
          * Read arbitrary object.
    -     * 
    +     *
          * @return the object
          */
         public Object readObject();
     
         /**
          * Read signed short value.
    -     * 
    +     *
          * @return the value
          */
         public short readShort();
     
         /**
          * Read unsigned single byte value.
    -     * 
    +     *
          * @return the value
          */
         public int readUnsignedByte();
     
         /**
          * Read unsigned integer value.
    -     * 
    +     *
          * @return the value
          */
         public long readUnsignedInt();
     
         /**
          * Read unsigned short value.
    -     * 
    +     *
          * @return the value
          */
         public int readUnsignedShort();
     
         /**
          * Read UTF-8 encoded string.
    -     * 
    +     *
          * @return the string
          */
         public String readUTF();
     
         /**
          * Read UTF-8 encoded string with given length.
    -     * 
    +     *
          * @param length
          *            the length of the string
          * @return the string
    diff --git a/io/src/main/java/org/red5/io/amf3/IDataOutput.java b/io/src/main/java/org/red5/io/amf3/IDataOutput.java
    index f02d0a0c4..ea7b0e691 100644
    --- a/io/src/main/java/org/red5/io/amf3/IDataOutput.java
    +++ b/io/src/main/java/org/red5/io/amf3/IDataOutput.java
    @@ -11,7 +11,7 @@
     
     /**
      * Interface implemented by classes that provide a way to store custom objects.
    - * 
    + *
      * @see IExternalizable#writeExternal(IDataOutput)
      * @see Adobe Livedocs (external)
      */
    @@ -19,14 +19,14 @@ public interface IDataOutput {
     
         /**
          * Return the byteorder used when storing values.
    -     * 
    +     *
          * @return the byteorder
          */
         public ByteOrder getEndian();
     
         /**
          * Set the byteorder to use when storing values.
    -     * 
    +     *
          * @param endian
          *            the byteorder to use
          */
    @@ -34,7 +34,7 @@ public interface IDataOutput {
     
         /**
          * Write boolean value.
    -     * 
    +     *
          * @param value
          *            the value
          */
    @@ -42,7 +42,7 @@ public interface IDataOutput {
     
         /**
          * Write signed byte value.
    -     * 
    +     *
          * @param value
          *            the value
          */
    @@ -50,7 +50,7 @@ public interface IDataOutput {
     
         /**
          * Write multiple bytes.
    -     * 
    +     *
          * @param bytes
          *            the bytes
          */
    @@ -58,7 +58,7 @@ public interface IDataOutput {
     
         /**
          * Write multiple bytes from given offset.
    -     * 
    +     *
          * @param bytes
          *            the bytes
          * @param offset
    @@ -68,7 +68,7 @@ public interface IDataOutput {
     
         /**
          * Write given number of bytes from given offset.
    -     * 
    +     *
          * @param bytes
          *            the bytes
          * @param offset
    @@ -80,7 +80,7 @@ public interface IDataOutput {
     
         /**
          * Write double-precision floating point value.
    -     * 
    +     *
          * @param value
          *            the value
          */
    @@ -88,7 +88,7 @@ public interface IDataOutput {
     
         /**
          * Write single-precision floating point value.
    -     * 
    +     *
          * @param value
          *            the value
          */
    @@ -96,7 +96,7 @@ public interface IDataOutput {
     
         /**
          * Write signed integer value.
    -     * 
    +     *
          * @param value
          *            the value
          */
    @@ -104,7 +104,7 @@ public interface IDataOutput {
     
         /**
          * Write string in given character set.
    -     * 
    +     *
          * @param value
          *            the string
          * @param encoding
    @@ -114,7 +114,7 @@ public interface IDataOutput {
     
         /**
          * Write arbitrary object.
    -     * 
    +     *
          * @param value
          *            the object
          */
    @@ -122,7 +122,7 @@ public interface IDataOutput {
     
         /**
          * Write signed short value.
    -     * 
    +     *
          * @param value
          *            the value
          */
    @@ -130,7 +130,7 @@ public interface IDataOutput {
     
         /**
          * Write unsigned integer value.
    -     * 
    +     *
          * @param value
          *            the value
          */
    @@ -138,7 +138,7 @@ public interface IDataOutput {
     
         /**
          * Write UTF-8 encoded string.
    -     * 
    +     *
          * @param value
          *            the string
          */
    @@ -146,7 +146,7 @@ public interface IDataOutput {
     
         /**
          * Write UTF-8 encoded string as byte array. This string is stored without informations about its length, so {@link IDataInput#readUTFBytes(int)} must be used to load it.
    -     * 
    +     *
          * @param value
          *            the string
          */
    diff --git a/io/src/main/java/org/red5/io/amf3/IExternalizable.java b/io/src/main/java/org/red5/io/amf3/IExternalizable.java
    index 543734265..b162c0463 100644
    --- a/io/src/main/java/org/red5/io/amf3/IExternalizable.java
    +++ b/io/src/main/java/org/red5/io/amf3/IExternalizable.java
    @@ -9,14 +9,14 @@
     
     /**
      * Interface that needs to be implemented by classes that serialize / deserialize themselves.
    - * 
    + *
      * @see Adobe Livedocs (external)
      */
     public interface IExternalizable {
     
         /**
          * Load custom object from stream.
    -     * 
    +     *
          * @param input
          *            object to be used for data loading
          */
    @@ -24,7 +24,7 @@ public interface IExternalizable {
     
         /**
          * Store custom object to stream.
    -     * 
    +     *
          * @param output
          *            object to be used for data storing
          */
    diff --git a/io/src/main/java/org/red5/io/amf3/Input.java b/io/src/main/java/org/red5/io/amf3/Input.java
    index b2db4bef0..baf670c12 100644
    --- a/io/src/main/java/org/red5/io/amf3/Input.java
    +++ b/io/src/main/java/org/red5/io/amf3/Input.java
    @@ -71,7 +71,7 @@ protected static class ClassReference {
     
             /**
              * Create new information about a class.
    -         * 
    +         *
              * @param className
              *            class name
              * @param type
    @@ -175,7 +175,7 @@ public static class RefStorage {
     
         /**
          * Creates Input object for AMF3 from byte buffer
    -     * 
    +     *
          * @param buf
          *            Byte buffer
          */
    @@ -185,7 +185,7 @@ public Input(IoBuffer buf) {
     
         /**
          * Creates Input object for AMF3 from byte buffer and initializes references from passed RefStorage
    -     * 
    +     *
          * @param buf
          *            buffer
          * @param refStorage
    @@ -206,7 +206,7 @@ public void enforceAMF3() {
     
         /**
          * Provide access to raw data.
    -     * 
    +     *
          * @return IoBuffer
          */
         protected IoBuffer getBuffer() {
    @@ -215,7 +215,7 @@ protected IoBuffer getBuffer() {
     
         /**
          * Reads the data type
    -     * 
    +     *
          * @return byte Data type
          */
         @Override
    @@ -329,7 +329,7 @@ public byte readDataType() {
     
         /**
          * Reads a null (value)
    -     * 
    +     *
          * @return Object null
          */
         @Override
    @@ -339,7 +339,7 @@ public Object readNull() {
     
         /**
          * Reads a boolean
    -     * 
    +     *
          * @return boolean Boolean value
          */
         @Override
    @@ -349,7 +349,7 @@ public Boolean readBoolean() {
     
         /**
          * Reads a Number
    -     * 
    +     *
          * @return Number Number
          */
         @Override
    @@ -383,7 +383,7 @@ public Number readNumber() {
     
         /**
          * Reads a string
    -     * 
    +     *
          * @return String String
          */
         @Override
    @@ -427,7 +427,7 @@ public String readString() {
     
         /**
          * Reads a string of a set length. This does not use the string reference table.
    -     * 
    +     *
          * @param length the length of the string
          * @return String
          */
    @@ -458,7 +458,7 @@ public String getString() {
     
         /**
          * Returns a date
    -     * 
    +     *
          * @return Date Date object
          */
         @Override
    @@ -478,7 +478,7 @@ public Date readDate() {
     
         /**
          * Returns an array
    -     * 
    +     *
          * @return int Length of array
          */
         @SuppressWarnings({ "unchecked", "rawtypes" })
    @@ -1014,7 +1014,7 @@ public Vector readVectorObject() {
     
         /**
          * Reads Custom
    -     * 
    +     *
          * @return Object Custom type object
          */
         @Override
    @@ -1031,7 +1031,7 @@ public Object readReference() {
     
         /**
          * Parser of AMF3 "compressed" integer data type
    -     * 
    +     *
          * @return a converted integer value
          */
         private int readInteger() {
    diff --git a/io/src/main/java/org/red5/io/amf3/Output.java b/io/src/main/java/org/red5/io/amf3/Output.java
    index d3d964f61..268f55f21 100644
    --- a/io/src/main/java/org/red5/io/amf3/Output.java
    +++ b/io/src/main/java/org/red5/io/amf3/Output.java
    @@ -566,7 +566,7 @@ public void writeByteArray(ByteArray array) {
     
         /**
          * Write a Vector<int>.
    -     * 
    +     *
          * @param vector
          *            vector
          */
    @@ -598,7 +598,7 @@ public void writeVectorInt(Vector vector) {
     
         /**
          * Write a Vector<uint>.
    -     * 
    +     *
          * @param vector
          *            vector
          */
    @@ -624,7 +624,7 @@ public void writeVectorUInt(Vector vector) {
     
         /**
          * Write a Vector<Number>.
    -     * 
    +     *
          * @param vector
          *            vector
          */
    @@ -647,7 +647,7 @@ public void writeVectorNumber(Vector vector) {
     
         /**
          * Write a Vector<Object>.
    -     * 
    +     *
          * @param vector
          *            vector
          */
    diff --git a/io/src/main/java/org/red5/io/flv/IFLV.java b/io/src/main/java/org/red5/io/flv/IFLV.java
    index 1079471e3..d11cb3bb5 100644
    --- a/io/src/main/java/org/red5/io/flv/IFLV.java
    +++ b/io/src/main/java/org/red5/io/flv/IFLV.java
    @@ -25,14 +25,14 @@ public interface IFLV extends IStreamableFile {
     
         /**
          * Returns a boolean stating whether the flv has metadata
    -     * 
    +     *
          * @return boolean true if file has injected metadata, false otherwise
          */
         public boolean hasMetaData();
     
         /**
          * Sets the metadata
    -     * 
    +     *
          * @param metadata
          *            Metadata object
          * @throws FileNotFoundException
    @@ -45,7 +45,7 @@ public interface IFLV extends IStreamableFile {
     
         /**
          * Sets the MetaService through Spring
    -     * 
    +     *
          * @param service
          *            Metadata service
          */
    @@ -53,7 +53,7 @@ public interface IFLV extends IStreamableFile {
     
         /**
          * Returns a map of the metadata
    -     * 
    +     *
          * @return metadata File metadata
          * @throws FileNotFoundException
          *             File not found
    @@ -63,14 +63,14 @@ public interface IFLV extends IStreamableFile {
     
         /**
          * Returns a boolean stating whether a flv has keyframedata
    -     * 
    +     *
          * @return boolean true if file has keyframe metadata, false otherwise
          */
         public boolean hasKeyFrameData();
     
         /**
          * Sets the keyframe data of a flv file
    -     * 
    +     *
          * @param keyframedata
          *            Keyframe metadata
          */
    @@ -79,7 +79,7 @@ public interface IFLV extends IStreamableFile {
     
         /**
          * Gets the keyframe data
    -     * 
    +     *
          * @return keyframedata Keyframe metadata
          */
         @SuppressWarnings({ "rawtypes" })
    @@ -87,7 +87,7 @@ public interface IFLV extends IStreamableFile {
     
         /**
          * Refreshes the headers. Usually used after data is added to the flv file
    -     * 
    +     *
          * @throws IOException
          *             Any I/O exception
          */
    @@ -95,7 +95,7 @@ public interface IFLV extends IStreamableFile {
     
         /**
          * Flushes Header
    -     * 
    +     *
          * @throws IOException
          *             Any I/O exception
          */
    @@ -103,7 +103,7 @@ public interface IFLV extends IStreamableFile {
     
         /**
          * Returns a Reader closest to the nearest keyframe
    -     * 
    +     *
          * @param seekPoint
          *            Point in file we are seeking around
          * @return reader Tag reader closest to that point
    @@ -112,7 +112,7 @@ public interface IFLV extends IStreamableFile {
     
         /**
          * Returns a Writer based on the nearest key frame
    -     * 
    +     *
          * @param seekPoint
          *            Point in file we are seeking around
          * @return writer Tag writer closest to that point
    @@ -121,7 +121,7 @@ public interface IFLV extends IStreamableFile {
     
         /**
          * Sets the caching implemenation
    -     * 
    +     *
          * @param cache
          *            cache
          */
    diff --git a/io/src/main/java/org/red5/io/flv/impl/FLV.java b/io/src/main/java/org/red5/io/flv/impl/FLV.java
    index 4bdc5a19b..93023f5be 100644
    --- a/io/src/main/java/org/red5/io/flv/impl/FLV.java
    +++ b/io/src/main/java/org/red5/io/flv/impl/FLV.java
    @@ -34,7 +34,7 @@
     
     /**
      * A FLVImpl implements the FLV api
    - * 
    + *
      * @author The Red5 Project
      * @author Dominick Accattato (daccattato@gmail.com)
      * @author Luke Hubbard, Codegent Ltd (luke@codegent.com)
    @@ -73,7 +73,7 @@ public FLV() {
     
         /**
          * Create FLV from given file source
    -     * 
    +     *
          * @param file
          *            File source
          */
    @@ -83,7 +83,7 @@ public FLV(File file) {
     
         /**
          * Create FLV from given file source and with specified metadata generation option
    -     * 
    +     *
          * @param file
          *            File source
          * @param generateMetadata
    @@ -115,7 +115,7 @@ public FLV(File file, boolean generateMetadata) {
     
         /**
          * Sets the cache implementation to be used.
    -     * 
    +     *
          * @param cache
          *            Cache store
          */
    @@ -126,7 +126,7 @@ public void setCache(ICacheStore cache) {
     
         /**
          * Sets a writer post processor.
    -     * 
    +     *
          * @param writerPostProcessor IPostProcess implementation class name
          */
         @SuppressWarnings("unchecked")
    @@ -143,7 +143,7 @@ public void setWriterPostProcessor(String writerPostProcessor) {
     
         /**
          * Sets a group of writer post processors.
    -     * 
    +     *
          * @param writerPostProcessors IPostProcess implementation class names
          */
         @SuppressWarnings("unchecked")
    diff --git a/io/src/main/java/org/red5/io/flv/impl/FLVReader.java b/io/src/main/java/org/red5/io/flv/impl/FLVReader.java
    index db25b3f44..029806be4 100644
    --- a/io/src/main/java/org/red5/io/flv/impl/FLVReader.java
    +++ b/io/src/main/java/org/red5/io/flv/impl/FLVReader.java
    @@ -462,7 +462,7 @@ public static void setBufferSize(int bufferSize) {
     
         /**
          * Returns the file buffer.
    -     * 
    +     *
          * @return File contents as byte buffer
          */
         public IoBuffer getFileData() {
    @@ -923,7 +923,7 @@ private ITag readTagHeader() throws UnsupportedDataTypeException {
     
         /**
          * Returns the last tag's timestamp as the files duration.
    -     * 
    +     *
          * @param flvFile
          *            FLV file
          * @return duration
    diff --git a/io/src/main/java/org/red5/io/flv/impl/FLVWriter.java b/io/src/main/java/org/red5/io/flv/impl/FLVWriter.java
    index 764a2b0b7..3ba2ea924 100644
    --- a/io/src/main/java/org/red5/io/flv/impl/FLVWriter.java
    +++ b/io/src/main/java/org/red5/io/flv/impl/FLVWriter.java
    @@ -190,7 +190,7 @@ public class FLVWriter implements ITagWriter {
     
         /**
          * Creates writer implementation with for a given file
    -     * 
    +     *
          * @param filePath
          *            path to existing file
          */
    @@ -394,7 +394,7 @@ public boolean writeTag(ITag tag) throws IOException {
                     }
                     // get the data type
                     byte dataType = tag.getDataType();
    -                // when tag is ImmutableTag which is in red5-server-common.jar, tag.getBody().reset() will throw InvalidMarkException because 
    +                // when tag is ImmutableTag which is in red5-server-common.jar, tag.getBody().reset() will throw InvalidMarkException because
                     // ImmutableTag.getBody() returns a new IoBuffer instance everytime.
                     IoBuffer tagBody = tag.getBody();
                     // set a var holding the entire tag size including the previous tag length
    @@ -541,8 +541,8 @@ public boolean writeTag(ITag tag) throws IOException {
                     }
                     // Data Type
                     IOUtils.writeUnsignedByte(tagBuffer, dataType); //1
    -                // Body Size - Length of the message. Number of bytes after StreamID to end of tag 
    -                // (Equal to length of the tag - 11) 
    +                // Body Size - Length of the message. Number of bytes after StreamID to end of tag
    +                // (Equal to length of the tag - 11)
                     IOUtils.writeMediumInt(tagBuffer, bodySize); //3
                     // Timestamp
                     IOUtils.writeExtendedMediumInt(tagBuffer, timestamp); //4
    @@ -625,8 +625,8 @@ public boolean writeTag(byte dataType, IoBuffer data) throws IOException {
                     ByteBuffer tagBuffer = ByteBuffer.allocate(totalTagSize);
                     // Data Type
                     IOUtils.writeUnsignedByte(tagBuffer, dataType); //1
    -                // Body Size - Length of the message. Number of bytes after StreamID to end of tag 
    -                // (Equal to length of the tag - 11) 
    +                // Body Size - Length of the message. Number of bytes after StreamID to end of tag
    +                // (Equal to length of the tag - 11)
                     IOUtils.writeMediumInt(tagBuffer, bodySize); //3
                     // Timestamp
                     int timestamp = (int) (System.currentTimeMillis() - timeOffset);
    @@ -695,7 +695,7 @@ public boolean writeStream(byte[] b) {
     
         /**
          * Create the stream output file; the flv itself.
    -     * 
    +     *
          * @throws IOException
          */
         private void createOutputFile() throws IOException {
    @@ -704,7 +704,7 @@ private void createOutputFile() throws IOException {
     
         /**
          * Create the stream data file.
    -     * 
    +     *
          * @throws IOException
          */
         private void createDataFile() throws IOException {
    @@ -782,7 +782,7 @@ private void writeMetadataTag(double duration, int videoCodecId, int audioCodecI
                 }
                 params.put("stereo", soundType);
                 if (audioDataSize > 0) {
    -                params.put("audiodatarate", 8 * audioDataSize / 1024 / duration); //from bytes to kilobits		
    +                params.put("audiodatarate", 8 * audioDataSize / 1024 / duration); //from bytes to kilobits
                 }
             } else {
                 // place holder
    @@ -806,8 +806,8 @@ private void writeMetadataTag(double duration, int videoCodecId, int audioCodecI
             buf.get(bodyBuf);
             // Data Type
             IOUtils.writeUnsignedByte(tagBuffer, ITag.TYPE_METADATA); //1
    -        // Body Size - Length of the message. Number of bytes after StreamID to end of tag 
    -        // (Equal to length of the tag - 11) 
    +        // Body Size - Length of the message. Number of bytes after StreamID to end of tag
    +        // (Equal to length of the tag - 11)
             IOUtils.writeMediumInt(tagBuffer, bodySize); //3
             // Timestamp
             IOUtils.writeExtendedMediumInt(tagBuffer, timestamp); //4
    @@ -843,7 +843,7 @@ private void writeMetadataTag(double duration, int videoCodecId, int audioCodecI
     
         /**
          * Finalizes the FLV file.
    -     * 
    +     *
          * @return bytes transferred
          */
         private long finalizeFlv() {
    @@ -931,7 +931,7 @@ private long finalizeFlv() {
                     // get starting position of the channel where latest stream data was written
                     long pos = dataChannel.position();
                     log.trace("Data available: {} bytes", pos);
    -                // set the data file the beginning 
    +                // set the data file the beginning
                     dataChannel.position(0L);
                     // transfer / write data file into final flv
                     int read = -1, wrote;
    @@ -1005,7 +1005,7 @@ private long finalizeFlv() {
     
         /**
          * Read flv file information from pre-finalization file.
    -     * 
    +     *
          * @param tmpFile
          * @return array containing audio codec id, video codec id, and duration
          */
    @@ -1186,7 +1186,7 @@ public void run() {
     
         /**
          * Allows repair of flv files if .info and .ser files still exist.
    -     * 
    +     *
          * @param path
          *            path to .ser file
          * @param audioId
    @@ -1253,7 +1253,7 @@ public static boolean repair(String path, Integer audioId, Integer videoId) thro
     
         /**
          * Submits a finalizer internally.
    -     * 
    +     *
          * @param flvFinalizer
          * @return Future representing task
          */
    @@ -1266,7 +1266,7 @@ private Future submit(FLVFinalizer flvFinalizer) {
     
         /**
          * Exposed to allow repair of flv files if .info and .ser files still exist.
    -     * 
    +     *
          * @param args
          *            0: path to .ser file 1: audio codec id 2: video codec id
          * @throws InterruptedException
    diff --git a/io/src/main/java/org/red5/io/flv/impl/Tag.java b/io/src/main/java/org/red5/io/flv/impl/Tag.java
    index 622e6b6e5..9e50b1a44 100644
    --- a/io/src/main/java/org/red5/io/flv/impl/Tag.java
    +++ b/io/src/main/java/org/red5/io/flv/impl/Tag.java
    @@ -12,7 +12,7 @@
     
     /**
      * A Tag represents the contents or payload of a FLV file.
    - * 
    + *
      * @see FLV Tag
      *
      * @author The Red5 Project
    @@ -58,7 +58,7 @@ public class Tag implements ITag {
     
         /**
          * TagImpl Constructor
    -     * 
    +     *
          * @param dataType
          *            Tag data type
          * @param timestamp
    @@ -112,7 +112,7 @@ public IoBuffer getData() {
     
         /**
          * Return the body IoBuffer
    -     * 
    +     *
          * @return Tag body
          */
         @Override
    @@ -122,7 +122,7 @@ public IoBuffer getBody() {
     
         /**
          * Return the size of the body
    -     * 
    +     *
          * @return Tag body size
          */
         @Override
    @@ -132,7 +132,7 @@ public int getBodySize() {
     
         /**
          * Get the data type
    -     * 
    +     *
          * @return Tag data type
          */
         @Override
    @@ -142,7 +142,7 @@ public byte getDataType() {
     
         /**
          * Return the timestamp
    -     * 
    +     *
          * @return Tag timestamp
          */
         @Override
    @@ -152,7 +152,7 @@ public int getTimestamp() {
     
         /**
          * Return previous tag size
    -     * 
    +     *
          * @return Previous tag size
          */
         @Override
    @@ -162,7 +162,7 @@ public int getPreviousTagSize() {
     
         /**
          * Prints out the contents of the tag
    -     * 
    +     *
          * @return Tag contents
          */
         @Override
    diff --git a/io/src/main/java/org/red5/io/flv/meta/IMeta.java b/io/src/main/java/org/red5/io/flv/meta/IMeta.java
    index 7ea143669..1e8097ab0 100644
    --- a/io/src/main/java/org/red5/io/flv/meta/IMeta.java
    +++ b/io/src/main/java/org/red5/io/flv/meta/IMeta.java
    @@ -11,7 +11,7 @@
     
     /**
      * IMeta is a Marker Interface CuePoint and MetaData both implement this interface
    - * 
    + *
      * @author The Red5 Project
      * @author daccattato(daccattato@gmail.com)
      */
    diff --git a/io/src/main/java/org/red5/io/flv/meta/IMetaCue.java b/io/src/main/java/org/red5/io/flv/meta/IMetaCue.java
    index 287f8fdce..ddd525ef8 100644
    --- a/io/src/main/java/org/red5/io/flv/meta/IMetaCue.java
    +++ b/io/src/main/java/org/red5/io/flv/meta/IMetaCue.java
    @@ -9,7 +9,7 @@
     
     /**
      * ICuePoint defines contract methods for use with cuepoints
    - * 
    + *
      * @author The Red5 Project
      * @author Dominick Accattato (daccattato@gmail.com)
      */
    @@ -17,24 +17,24 @@ public interface IMetaCue extends IMeta, Comparable {
     
         /**
          * Sets the name
    -     * 
    +     *
          * @param name
          *            Cue point name
    -     * 
    +     *
          */
         public void setName(String name);
     
         /**
          * Gets the name
    -     * 
    +     *
          * @return name Cue point name
    -     * 
    +     *
          */
         public String getName();
     
         /**
          * Sets the type type can be "event" or "navigation"
    -     * 
    +     *
          * @param type
          *            Cue point type
          *
    @@ -43,7 +43,7 @@ public interface IMetaCue extends IMeta, Comparable {
     
         /**
          * Gets the type
    -     * 
    +     *
          * @return type Cue point type
          *
          */
    @@ -51,7 +51,7 @@ public interface IMetaCue extends IMeta, Comparable {
     
         /**
          * Sets the time
    -     * 
    +     *
          * @param d
          *            Timestamp
          *
    @@ -60,7 +60,7 @@ public interface IMetaCue extends IMeta, Comparable {
     
         /**
          * Gets the time
    -     * 
    +     *
          * @return time Timestamp
          *
          */
    diff --git a/io/src/main/java/org/red5/io/flv/meta/IMetaData.java b/io/src/main/java/org/red5/io/flv/meta/IMetaData.java
    index 991a6cde4..0fa8d1054 100644
    --- a/io/src/main/java/org/red5/io/flv/meta/IMetaData.java
    +++ b/io/src/main/java/org/red5/io/flv/meta/IMetaData.java
    @@ -9,10 +9,10 @@
     
     /**
      * FLV MetaData interface
    - * 
    + *
      * @author The Red5 Project
      * @author Dominick Accattato (daccattato@gmail.com)
    - * 
    + *
      *         Sample Data: private boolean canSeekToEnd = true; private int videocodecid = 4; private int framerate = 15; private int videodatarate = 400; private int height = 215; private int width = 320; private int duration = 7.347;
      * @param 
      *            key type
    @@ -23,14 +23,14 @@ public interface IMetaData extends IMeta {
     
         /**
          * Returns a boolean depending on whether the video can seek to end
    -     * 
    +     *
          * @return true if file is seekable to the end, false otherwise
          */
         public boolean getCanSeekToEnd();
     
         /**
          * Sets whether a video can seek to end
    -     * 
    +     *
          * @param b
          *            true if file is seekable to the end, false otherwise
          */
    @@ -38,14 +38,14 @@ public interface IMetaData extends IMeta {
     
         /**
          * Returns the video codec id
    -     * 
    +     *
          * @return Video codec id
          */
         public int getVideoCodecId();
     
         /**
          * Sets the video codec id
    -     * 
    +     *
          * @param id
          *            Video codec id
          */
    @@ -57,14 +57,14 @@ public interface IMetaData extends IMeta {
     
         /**
          * Returns the framerate.
    -     * 
    +     *
          * @return FLV framerate in frames per second
          */
         public double getFrameRate();
     
         /**
          * Sets the framerate.
    -     * 
    +     *
          * @param rate
          *            FLV framerate in frames per second
          */
    @@ -72,14 +72,14 @@ public interface IMetaData extends IMeta {
     
         /**
          * Returns the videodatarate
    -     * 
    +     *
          * @return Video data rate
          */
         public int getVideoDataRate();
     
         /**
          * Sets the videodatarate
    -     * 
    +     *
          * @param rate
          *            Video data rate
          */
    @@ -87,14 +87,14 @@ public interface IMetaData extends IMeta {
     
         /**
          * Returns the height
    -     * 
    +     *
          * @return height Video height
          */
         public int getHeight();
     
         /**
          * Sets the height
    -     * 
    +     *
          * @param h
          *            Video height
          */
    @@ -102,14 +102,14 @@ public interface IMetaData extends IMeta {
     
         /**
          * Returns the width Video width
    -     * 
    +     *
          * @return width
          */
         public int getWidth();
     
         /**
          * Sets the width
    -     * 
    +     *
          * @param w
          *            Video width
          */
    @@ -117,14 +117,14 @@ public interface IMetaData extends IMeta {
     
         /**
          * Returns the duration.
    -     * 
    +     *
          * @return duration Video duration in seconds
          */
         public double getDuration();
     
         /**
          * Sets the duration.
    -     * 
    +     *
          * @param d
          *            Video duration in seconds
          */
    @@ -132,7 +132,7 @@ public interface IMetaData extends IMeta {
     
         /**
          * Sets the cue points
    -     * 
    +     *
          * @param metaCue
          *            Cue points
          */
    @@ -140,7 +140,7 @@ public interface IMetaData extends IMeta {
     
         /**
          * Gets the cue points
    -     * 
    +     *
          * @return Cue points
          */
         public IMetaCue[] getMetaCue();
    diff --git a/io/src/main/java/org/red5/io/flv/meta/IMetaService.java b/io/src/main/java/org/red5/io/flv/meta/IMetaService.java
    index 69bce547c..8ff035228 100644
    --- a/io/src/main/java/org/red5/io/flv/meta/IMetaService.java
    +++ b/io/src/main/java/org/red5/io/flv/meta/IMetaService.java
    @@ -14,7 +14,7 @@
     
     /**
      * IMetaService Defines the MetaData Service API
    - * 
    + *
      * @author The Red5 Project
      * @author Dominick Accattato (daccattato@gmail.com)
      * @author Luke Hubbard, Codegent Ltd (luke@codegent.com)
    @@ -22,7 +22,7 @@
     public interface IMetaService {
     
         // Get FLV from FLVService
    -    // grab a reader from FLV	
    +    // grab a reader from FLV
         // Set up CuePoints
         // Set up MetaData
         // Pass CuePoint array into MetaData
    @@ -37,7 +37,7 @@ public interface IMetaService {
     
         /**
          * Initiates writing of the MetaData
    -     * 
    +     *
          * @param meta
          *            Metadata
          * @throws IOException
    @@ -47,7 +47,7 @@ public interface IMetaService {
     
         /**
          * Writes the MetaData
    -     * 
    +     *
          * @param metaData
          *            Metadata
          */
    @@ -60,7 +60,7 @@ public interface IMetaService {
     
         /**
          * Read the MetaData
    -     * 
    +     *
          * @return metaData Metadata
          * @param buffer
          *            IoBuffer source
    @@ -69,14 +69,14 @@ public interface IMetaService {
     
         /**
          * Read the Meta Cue Points
    -     * 
    +     *
          * @return Meta cue points
          */
         public IMetaCue[] readMetaCue();
     
         /**
          * Media file to be accessed
    -     * 
    +     *
          * @param file
          *            file
          */
    @@ -84,7 +84,7 @@ public interface IMetaService {
     
         /**
          * Returns the file being accessed
    -     * 
    +     *
          * @return file
          */
         public File getFile();
    diff --git a/io/src/main/java/org/red5/io/flv/meta/MetaCue.java b/io/src/main/java/org/red5/io/flv/meta/MetaCue.java
    index 22d0a049b..fd2d51364 100644
    --- a/io/src/main/java/org/red5/io/flv/meta/MetaCue.java
    +++ b/io/src/main/java/org/red5/io/flv/meta/MetaCue.java
    @@ -11,7 +11,7 @@
     import java.util.Map;
     
     /**
    - * Cue point is metadata marker used to control and accompany video playback with client-side application events. 
    + * Cue point is metadata marker used to control and accompany video playback with client-side application events.
      * Each cue point have at least one attribute, timestamp. Timestamp specifies position of cue point in FLV file.
      * 
    * Cue points are usually used as event triggers down video flow or navigation points in a file. Cue points are of two types: @@ -21,7 +21,7 @@ * *
    * To add cue point trigger event listener at client-side in Flex/Flash application, use NetStream.onCuePoint event handler. - * + * * @author The Red5 Project * @author Dominick Accattato (daccattato@gmail.com) * @author Luke Hubbard, Codegent Ltd (luke@codegent.com) diff --git a/io/src/main/java/org/red5/io/flv/meta/MetaService.java b/io/src/main/java/org/red5/io/flv/meta/MetaService.java index 9c3ae3c5c..2e2ced9d8 100644 --- a/io/src/main/java/org/red5/io/flv/meta/MetaService.java +++ b/io/src/main/java/org/red5/io/flv/meta/MetaService.java @@ -30,7 +30,7 @@ /** * MetaService represents a MetaData service in Spring - * + * * @author The Red5 Project * @author Dominick Accattato (daccattato@gmail.com) * @author Luke Hubbard, Codegent Ltd (luke@codegent.com) @@ -129,7 +129,7 @@ public void write(IMetaData meta) throws IOException { /** * Merges the two Meta objects - * + * * @param metaData1 * First metadata object * @param metaData2 @@ -190,7 +190,7 @@ public static IMeta mergeMeta(IMetaData metaData1, IMetaData metaDat /** * Injects metadata (other than Cue points) into a tag - * + * * @param meta * Metadata * @param tag @@ -211,7 +211,7 @@ private static ITag injectMetaData(IMetaData meta, ITag tag) { /** * Injects metadata (Cue Points) into a tag - * + * * @param meta * Metadata (cue points) * @param tag @@ -234,7 +234,7 @@ private static ITag injectMetaCue(IMetaCue meta, ITag tag) { /** * Returns a timestamp of cue point in milliseconds - * + * * @param metaCue * Cue point * @return int time Timestamp of given cue point (in milliseconds) diff --git a/io/src/main/java/org/red5/io/m4a/IM4A.java b/io/src/main/java/org/red5/io/m4a/IM4A.java index 1c3593dad..32980aeb7 100644 --- a/io/src/main/java/org/red5/io/m4a/IM4A.java +++ b/io/src/main/java/org/red5/io/m4a/IM4A.java @@ -11,7 +11,7 @@ /** * Represents M4A / AAC file - * + * * @author Paul Gregoire (mondain@gmail.com) */ public interface IM4A extends IStreamableFile { diff --git a/io/src/main/java/org/red5/io/m4a/impl/M4A.java b/io/src/main/java/org/red5/io/m4a/impl/M4A.java index 41e82f61a..9afa18b5b 100644 --- a/io/src/main/java/org/red5/io/m4a/impl/M4A.java +++ b/io/src/main/java/org/red5/io/m4a/impl/M4A.java @@ -18,7 +18,7 @@ /** * A M4AImpl implements the M4A api - * + * * @author The Red5 Project * @author Paul Gregoire, (mondain@gmail.com) */ @@ -36,7 +36,7 @@ public M4A() { /** * Create M4A from given file source - * + * * @param file * File source */ diff --git a/io/src/main/java/org/red5/io/m4a/impl/M4AReader.java b/io/src/main/java/org/red5/io/m4a/impl/M4AReader.java index 8330473b2..88717e4e0 100644 --- a/io/src/main/java/org/red5/io/m4a/impl/M4AReader.java +++ b/io/src/main/java/org/red5/io/m4a/impl/M4AReader.java @@ -69,7 +69,7 @@ /** * A Reader is used to read the contents of a M4A file. NOTE: This class is not implemented as threading-safe. The caller should make sure * the threading-safety. - * + * * @author The Red5 Project * @author Paul Gregoire, (mondain@gmail.com) */ @@ -113,7 +113,7 @@ public class M4AReader implements IoConstants, ITagReader { //samples to chunk mappings private List audioSamplesToChunks; - //samples + //samples private long[] audioSamples; private long audioSampleSize; @@ -295,7 +295,7 @@ public void decodeHeader() { /** * Process the audio information contained in the atoms. - * + * * @param stbl * @param ase * AudioSampleEntry @@ -488,7 +488,7 @@ public boolean hasVideo() { /** * Returns the file buffer. - * + * * @return File contents as byte buffer */ public IoBuffer getFileData() { @@ -574,12 +574,12 @@ ITag createFileMeta() { /** * Tag sequence MetaData, Audio config, remaining audio - * + * * Packet prefixes: af 00 ... 06 = Audio extra data (first audio packet) af 01 = Audio frame - * + * * Audio extra data(s): af 00 = Prefix 11 90 4f 14 = AAC Main = aottype 0 12 10 = AAC LC = aottype 1 13 90 56 e5 a5 48 00 = HE-AAC SBR = * aottype 2 06 = Suffix - * + * * Still not absolutely certain about this order or the bytes - need to verify later */ private void createPreStreamingTags() { @@ -679,7 +679,7 @@ public void analyzeFrames() { int sample = 1; // position Long pos = null; - //add the audio frames / samples / chunks + //add the audio frames / samples / chunks for (int i = 0; i < audioSamplesToChunks.size(); i++) { SampleToChunkBox.Entry record = audioSamplesToChunks.get(i); long firstChunk = record.getFirstChunk(); @@ -698,7 +698,7 @@ public void analyzeFrames() { int size = 0; // if we have no samples, skip size check as its probably not aac if (audioSamples.length > 0) { - //update sample size + //update sample size size = (int) audioSamples[sample - 1]; // skip empty AAC data which is 6 bytes long log.trace("Audio sample - size: {} pos: {}", size, pos); @@ -777,7 +777,7 @@ public void position(long pos) { /** * Search through the frames by offset / position to find the sample. - * + * * @param pos * @return frame index */ diff --git a/io/src/main/java/org/red5/io/matroska/ConverterException.java b/io/src/main/java/org/red5/io/matroska/ConverterException.java index f226498e2..775572672 100644 --- a/io/src/main/java/org/red5/io/matroska/ConverterException.java +++ b/io/src/main/java/org/red5/io/matroska/ConverterException.java @@ -23,7 +23,7 @@ public ConverterException() { /** * @see Exception#Exception(String) - * + * * @param message * - string message for this exception */ diff --git a/io/src/main/java/org/red5/io/matroska/ParserUtils.java b/io/src/main/java/org/red5/io/matroska/ParserUtils.java index 705cc2eb7..40f5a80d7 100644 --- a/io/src/main/java/org/red5/io/matroska/ParserUtils.java +++ b/io/src/main/java/org/red5/io/matroska/ParserUtils.java @@ -30,7 +30,7 @@ public class ParserUtils { /** * method used to parse : int, uint and date - * + * * @param inputStream * - stream to get value * @param size @@ -54,7 +54,7 @@ public static long parseInteger(InputStream inputStream, final int size) throws /** * method used to parse string - * + * * @param inputStream * - stream to get value * @param size @@ -77,7 +77,7 @@ public static String parseString(InputStream inputStream, final int size) throws /** * method used to parse float and double - * + * * @param inputStream * - stream to get value * @param size @@ -101,7 +101,7 @@ public static double parseFloat(InputStream inputStream, final int size) throws /** * method used to parse subelements of {@link CompoundTag} - * + * * @param inputStream * - stream to get value * @param size @@ -128,7 +128,7 @@ public static ArrayList parseMasterElement(InputStream inputStream, final i /** * method to parse byte array - * + * * @param inputStream * - stream to get value * @param size @@ -149,7 +149,7 @@ public static byte[] parseBinary(InputStream inputStream, final int size) throws /** * method to parse {@link VINT} - * + * * @param inputStream * - stream to get value * @return - parsed value @@ -201,9 +201,9 @@ public static VINT readVINT(InputStream inputStream) throws IOException { /** * parsing tag by matroska specification matroska spec - * + * * tag = VINT id, VINT size, data - * + * * @param inputStream * - stream to get value * @return tag, without parsing tag data, because it delegate to an tag itself @@ -221,7 +221,7 @@ public static Tag parseTag(InputStream inputStream) throws IOException, Converte /** * method to encode long as byte array of given size - * + * * @param val * - value to encode * @param size @@ -240,7 +240,7 @@ public static byte[] getBytes(long val, long size) { /** * method to skip given amount of bytes in stream - * + * * @param size * - size to skip * @param input diff --git a/io/src/main/java/org/red5/io/matroska/VINT.java b/io/src/main/java/org/red5/io/matroska/VINT.java index 34573a2b9..c13865b8f 100644 --- a/io/src/main/java/org/red5/io/matroska/VINT.java +++ b/io/src/main/java/org/red5/io/matroska/VINT.java @@ -34,7 +34,7 @@ public class VINT { /** * Constructor - * + * * @param binary * - binary value of this {@link VINT}, calculated from value if not specified * @param length @@ -56,7 +56,7 @@ public VINT(long binary, byte length, long value) { /** * getter for length - * + * * @return - length */ public byte getLength() { @@ -65,7 +65,7 @@ public byte getLength() { /** * getter for binary - * + * * @return - binary */ public long getBinary() { @@ -74,7 +74,7 @@ public long getBinary() { /** * getter for value - * + * * @return - value */ public long getValue() { @@ -83,7 +83,7 @@ public long getValue() { /** * method to encode {@link VINT} as sequence of bytes - * + * * @return - encoded {@link VINT} */ public byte[] encode() { @@ -100,7 +100,7 @@ public String toString() { /** * method to construct {@link VINT} based on its binary representation - * + * * @param binary * - binary value of {@link VINT} * @return {@link VINT} corresponding to this binary @@ -125,7 +125,7 @@ public static VINT fromBinary(long binary) { /** * method to construct {@link VINT} based on its value - * + * * @param value * - value of {@link VINT} * @return {@link VINT} corresponding to this value diff --git a/io/src/main/java/org/red5/io/matroska/dtd/BinaryTag.java b/io/src/main/java/org/red5/io/matroska/dtd/BinaryTag.java index 1a91f9b43..ed737a39c 100644 --- a/io/src/main/java/org/red5/io/matroska/dtd/BinaryTag.java +++ b/io/src/main/java/org/red5/io/matroska/dtd/BinaryTag.java @@ -25,7 +25,7 @@ public class BinaryTag extends Tag { /** * Constructor - * + * * @see Tag#Tag(String, VINT) * * @param name @@ -41,9 +41,9 @@ public BinaryTag(String name, VINT id) throws IOException { /** * Constructor - * + * * @see Tag#Tag(String, VINT, VINT, InputStream) - * + * * @param name * - the name of tag to be created * @param id @@ -77,7 +77,7 @@ protected void putValue(ByteBuffer bb) throws IOException { /** * getter for value - * + * * @return - byte array stored by this binary tag */ public byte[] getValue() { @@ -86,7 +86,7 @@ public byte[] getValue() { /** * setter for value, updates the size of this tag - * + * * @param value * - value to be set * @return - this for chaining @@ -107,7 +107,7 @@ public String toString() { /** * Utility helper method to get string representation of given byte array - * + * * @param bytes * - bytes to be printed * @return - String representation of byte array diff --git a/io/src/main/java/org/red5/io/matroska/dtd/CompoundTag.java b/io/src/main/java/org/red5/io/matroska/dtd/CompoundTag.java index 4a00dbab2..e46830713 100644 --- a/io/src/main/java/org/red5/io/matroska/dtd/CompoundTag.java +++ b/io/src/main/java/org/red5/io/matroska/dtd/CompoundTag.java @@ -24,7 +24,7 @@ public class CompoundTag extends Tag { /** * Constructor - * + * * @see Tag#Tag(String, VINT) * * @param name @@ -40,9 +40,9 @@ public CompoundTag(String name, VINT id) throws IOException { /** * Constructor - * + * * @see Tag#Tag(String, VINT, VINT, InputStream) - * + * * @param name * - the name of tag to be created * @param id @@ -60,7 +60,7 @@ public CompoundTag(String name, VINT id, VINT size, InputStream inputStream) thr /** * @see Tag#readData(InputStream) - * + * * @param inputStream * - stream to read tag data from * @throws IOException @@ -99,7 +99,7 @@ protected void putValue(ByteBuffer bb) throws IOException { /** * method to add child tag to this {@link CompoundTag}, updates the size on add - * + * * @param ch * - child {@link Tag} to be added * @return - this for chaining diff --git a/io/src/main/java/org/red5/io/matroska/dtd/DateTag.java b/io/src/main/java/org/red5/io/matroska/dtd/DateTag.java index f75a48cb7..ec74e249d 100644 --- a/io/src/main/java/org/red5/io/matroska/dtd/DateTag.java +++ b/io/src/main/java/org/red5/io/matroska/dtd/DateTag.java @@ -10,7 +10,7 @@ /** * http://matroska.org/technical/specs/index.html Date - signed 8 octets integer in nanoseconds with 0 indicating the precise beginning of the millennium (at 2001-01-01T00:00:00,000000000 UTC) - * + * */ public class DateTag extends UnsignedIntegerTag { public static final long NANO_MULTIPLIER = 1000; @@ -21,7 +21,7 @@ public class DateTag extends UnsignedIntegerTag { /** * Constructor - * + * * @see Tag#Tag(String, VINT) * * @param name @@ -37,9 +37,9 @@ public DateTag(String name, VINT id) throws IOException { /** * Constructor - * + * * @see Tag#Tag(String, VINT, VINT, InputStream) - * + * * @param name * - the name of tag to be created * @param id @@ -76,7 +76,7 @@ protected void putValue(ByteBuffer bb) throws IOException { /** * setter for value, updates the size of this tag - * + * * @param value * - value to be set * @return - this for chaining @@ -89,7 +89,7 @@ public DateTag setValue(final Date value) { /** * getter for value as {@link Date} - * + * * @return - value as {@link Date} */ public Date getDate() { diff --git a/io/src/main/java/org/red5/io/matroska/dtd/FloatTag.java b/io/src/main/java/org/red5/io/matroska/dtd/FloatTag.java index f5b52400c..ed15b869c 100644 --- a/io/src/main/java/org/red5/io/matroska/dtd/FloatTag.java +++ b/io/src/main/java/org/red5/io/matroska/dtd/FloatTag.java @@ -16,16 +16,16 @@ /** * http://matroska.org/technical/specs/index.html - * + * * Float tag is class able to store 4 byte float or 8 byte double, stores double by default - * + * */ public class FloatTag extends Tag { private double value; /** * Constructor - * + * * @see Tag#Tag(String, VINT) * * @param name @@ -41,9 +41,9 @@ public FloatTag(String name, VINT id) throws IOException { /** * Constructor - * + * * @see Tag#Tag(String, VINT, VINT, InputStream) - * + * * @param name * - the name of tag to be created * @param id @@ -81,7 +81,7 @@ protected void putValue(ByteBuffer bb) throws IOException { /** * getter for value as double - * + * * @return - value as double */ public double getValue() { @@ -90,7 +90,7 @@ public double getValue() { /** * setter for value, updates the size of this tag - * + * * @param value * - value to be set * @return - this for chaining diff --git a/io/src/main/java/org/red5/io/matroska/dtd/SimpleBlock.java b/io/src/main/java/org/red5/io/matroska/dtd/SimpleBlock.java index 8c70348fe..4b638eeec 100644 --- a/io/src/main/java/org/red5/io/matroska/dtd/SimpleBlock.java +++ b/io/src/main/java/org/red5/io/matroska/dtd/SimpleBlock.java @@ -30,7 +30,7 @@ public class SimpleBlock extends Tag { /** * Constructor - * + * * @see Tag#Tag(String, VINT) * * @param name @@ -46,9 +46,9 @@ public SimpleBlock(String name, VINT id) throws IOException { /** * Constructor - * + * * @see Tag#Tag(String, VINT, VINT, InputStream) - * + * * @param name * - the name of tag to be created * @param id @@ -88,7 +88,7 @@ protected void putValue(ByteBuffer bb) throws IOException { /** * getter for binary - * + * * @return - binary */ public byte[] getBinary() { @@ -97,7 +97,7 @@ public byte[] getBinary() { /** * getter for time code - * + * * @return - time code */ public long getTimeCode() { @@ -106,7 +106,7 @@ public long getTimeCode() { /** * getter for track number - * + * * @return - track number */ public int getTrackNumber() { @@ -115,7 +115,7 @@ public int getTrackNumber() { /** * getter for key frame - * + * * @return - key frame */ public boolean isKeyFrame() { diff --git a/io/src/main/java/org/red5/io/matroska/dtd/StringTag.java b/io/src/main/java/org/red5/io/matroska/dtd/StringTag.java index be788629d..c57803780 100644 --- a/io/src/main/java/org/red5/io/matroska/dtd/StringTag.java +++ b/io/src/main/java/org/red5/io/matroska/dtd/StringTag.java @@ -17,16 +17,16 @@ /** * http://matroska.org/technical/specs/index.html - * + * * String tag is class able to store strings - * + * */ public class StringTag extends Tag { private String value = ""; /** * Constructor - * + * * @see Tag#Tag(String, VINT) * * @param name @@ -42,9 +42,9 @@ public StringTag(String name, VINT id) throws IOException { /** * Constructor - * + * * @see Tag#Tag(String, VINT, VINT, InputStream) - * + * * @param name * - the name of tag to be created * @param id @@ -78,7 +78,7 @@ protected void putValue(ByteBuffer bb) throws IOException { /** * getter for value - * + * * @return - value */ public String getValue() { @@ -87,7 +87,7 @@ public String getValue() { /** * setter for value, updates the size of this tag - * + * * @param value * - value to be set * @return - this for chaining diff --git a/io/src/main/java/org/red5/io/matroska/dtd/Tag.java b/io/src/main/java/org/red5/io/matroska/dtd/Tag.java index c28acb047..388e06145 100644 --- a/io/src/main/java/org/red5/io/matroska/dtd/Tag.java +++ b/io/src/main/java/org/red5/io/matroska/dtd/Tag.java @@ -35,7 +35,7 @@ public abstract class Tag { /** * Constructor, internally calls {@link Tag#Tag(String, VINT, VINT, InputStream)} to create tag with 0 size - * + * * @param name * - the name of tag to be created * @param id @@ -49,7 +49,7 @@ public Tag(String name, VINT id) throws IOException { /** * Constructor - * + * * @param name * - the name of tag to be created * @param id @@ -70,7 +70,7 @@ public Tag(String name, VINT id, VINT size, InputStream inputStream) throws IOEx /** * method to read and to parse tag from inputStream given - * + * * @param inputStream * - stream to parse tag data from * @throws IOException @@ -82,7 +82,7 @@ public Tag(String name, VINT id, VINT size, InputStream inputStream) throws IOEx /** * method to parse tag from inner bytes array - data - * + * * @throws IOException * - in case of any IO errors * @throws ConverterException @@ -94,7 +94,7 @@ public void parse() throws IOException, ConverterException { /** * method to read tag data from inputStream given - * + * * @param inputStream InputStream * @throws IOException * - in case of any IO errors @@ -109,7 +109,7 @@ public void readData(InputStream inputStream) throws IOException { /** * method to store tag value to {@link ByteBuffer} given - * + * * @param bb * - {@link ByteBuffer} to store value * @throws IOException @@ -119,7 +119,7 @@ public void readData(InputStream inputStream) throws IOException { /** * getter for name - * + * * @return name of this {@link Tag} */ public String getName() { @@ -128,7 +128,7 @@ public String getName() { /** * getter for id - * + * * @return id of this {@link Tag} as binary value of correspondent {@link VINT} */ public long getId() { @@ -137,7 +137,7 @@ public long getId() { /** * getter for size - * + * * @return size of this {@link Tag} as value of correspondent {@link VINT} */ public long getSize() { @@ -146,7 +146,7 @@ public long getSize() { /** * method to get total size of this tag: "header" + "contents" - * + * * @return - total size as int */ public int totalSize() { @@ -155,7 +155,7 @@ public int totalSize() { /** * method to encode {@link Tag} as sequence of bytes - * + * * @return - encoded {@link Tag} * @throws IOException * - in case of any IO errors diff --git a/io/src/main/java/org/red5/io/matroska/dtd/UnsignedIntegerTag.java b/io/src/main/java/org/red5/io/matroska/dtd/UnsignedIntegerTag.java index e2402cebb..d721333ea 100644 --- a/io/src/main/java/org/red5/io/matroska/dtd/UnsignedIntegerTag.java +++ b/io/src/main/java/org/red5/io/matroska/dtd/UnsignedIntegerTag.java @@ -18,16 +18,16 @@ /** * http://matroska.org/technical/specs/index.html - * + * * UnsignedInteger tag is class able to store long - * + * */ public class UnsignedIntegerTag extends Tag { private long value; /** * Constructor - * + * * @see Tag#Tag(String, VINT) * * @param name @@ -43,9 +43,9 @@ public UnsignedIntegerTag(String name, VINT id) throws IOException { /** * Constructor - * + * * @see Tag#Tag(String, VINT, VINT, InputStream) - * + * * @param name * - the name of tag to be created * @param id @@ -79,7 +79,7 @@ protected void putValue(ByteBuffer bb) throws IOException { /** * getter for value - * + * * @return - value */ public long getValue() { @@ -88,7 +88,7 @@ public long getValue() { /** * setter for value, updates the size of this tag - * + * * @param value * - value to be set * @return - this for chaining diff --git a/io/src/main/java/org/red5/io/matroska/parser/TagCrawler.java b/io/src/main/java/org/red5/io/matroska/parser/TagCrawler.java index 2fc66a9ec..aa1057ff3 100644 --- a/io/src/main/java/org/red5/io/matroska/parser/TagCrawler.java +++ b/io/src/main/java/org/red5/io/matroska/parser/TagCrawler.java @@ -31,7 +31,7 @@ public class TagCrawler { /** * Constructor - * + * */ public TagCrawler() { skipHandler = createSkipHandler(); @@ -39,7 +39,7 @@ public TagCrawler() { /** * Method to add {@link TagHandler} - * + * * @param name * - unique name of tag handler * @param handler @@ -53,7 +53,7 @@ public TagCrawler addHandler(String name, TagHandler handler) { /** * Method to remove {@link TagHandler} - * + * * @param name * - unique name of tag handler * @return - this for chaining @@ -67,7 +67,7 @@ public TagCrawler removeHandler(String name) { /** * Method to get {@link TagHandler} by tag, can be overridden to change the logic of handler searching - * + * * @param tag * - tag to be handled * @return - this for chaining @@ -81,7 +81,7 @@ public TagHandler getHandler(Tag tag) { /** * Method to create "default" handler (the one will be used if none other handlers were found) can be overridden to change the logic - * + * * @return - this for chaining */ public TagHandler createSkipHandler() { @@ -99,7 +99,7 @@ public void handle(Tag tag, InputStream input) throws IOException, ConverterExce /** * Method to process the input stream given, will stop as soon as input stream will be empty - * + * * @param input * - input stream to process * @throws IOException diff --git a/io/src/main/java/org/red5/io/mp3/IMP3.java b/io/src/main/java/org/red5/io/mp3/IMP3.java index 630e36c07..eb31b2dd8 100644 --- a/io/src/main/java/org/red5/io/mp3/IMP3.java +++ b/io/src/main/java/org/red5/io/mp3/IMP3.java @@ -11,7 +11,7 @@ /** * Informations about a MP3 file. Marker interface by now. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ diff --git a/io/src/main/java/org/red5/io/mp3/impl/MP3.java b/io/src/main/java/org/red5/io/mp3/impl/MP3.java index b6e8355b0..58f67107f 100644 --- a/io/src/main/java/org/red5/io/mp3/impl/MP3.java +++ b/io/src/main/java/org/red5/io/mp3/impl/MP3.java @@ -25,7 +25,7 @@ public class MP3 implements IMP3 { /** * Creates MP3 object using given file - * + * * @param file * File object to use */ diff --git a/io/src/main/java/org/red5/io/mp3/impl/MP3Header.java b/io/src/main/java/org/red5/io/mp3/impl/MP3Header.java index 3412585c4..f35f6f293 100644 --- a/io/src/main/java/org/red5/io/mp3/impl/MP3Header.java +++ b/io/src/main/java/org/red5/io/mp3/impl/MP3Header.java @@ -9,7 +9,7 @@ /** * Header of a MP3 frame. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) * @see File format @@ -76,7 +76,7 @@ public class MP3Header { /** * Creates MP3 header from frame sync value - * + * * @param data * Frame sync data * @throws Exception @@ -185,7 +185,7 @@ public int getSampleRate() { /** * Calculate the size of a MP3 frame for this header. - * + * * @return size of the frame including the header */ public int frameSize() { @@ -211,7 +211,7 @@ public int frameSize() { /** * Return the duration of the frame for this header. - * + * * @return The duration in milliseconds */ public double frameDuration() { diff --git a/io/src/main/java/org/red5/io/mp3/impl/MP3Reader.java b/io/src/main/java/org/red5/io/mp3/impl/MP3Reader.java index 9970548a4..75b0d00bc 100644 --- a/io/src/main/java/org/red5/io/mp3/impl/MP3Reader.java +++ b/io/src/main/java/org/red5/io/mp3/impl/MP3Reader.java @@ -118,7 +118,7 @@ public class MP3Reader implements ITagReader, IKeyFrameDataAnalyzer { /** * Creates reader from file input stream - * + * * @param file * file input * @throws IOException @@ -193,7 +193,7 @@ public MP3Reader(File file) throws IOException { /** * A MP3 stream never has video. - * + * * @return always returns false */ @Override @@ -224,7 +224,7 @@ private void checkValidHeader() { /** * Creates file metadata object - * + * * @return Tag */ private ITag createFileMeta() { @@ -329,7 +329,7 @@ public long getDuration() { /** * Get the total readable bytes in a file or ByteBuffer. - * + * * @return Total readable bytes */ @Override diff --git a/io/src/main/java/org/red5/io/mp3/impl/MP3Stream.java b/io/src/main/java/org/red5/io/mp3/impl/MP3Stream.java index 781f18e90..c6e0afce6 100644 --- a/io/src/main/java/org/red5/io/mp3/impl/MP3Stream.java +++ b/io/src/main/java/org/red5/io/mp3/impl/MP3Stream.java @@ -20,7 +20,7 @@ *

    * Instances of this class are constructed with an underlying stream which should point to an audio file. Read operations are possible in the usual way. However, there are special methods for searching and extracting headers of MPEG frames. Some meta information of frames can be queried. *

    - * + * * This class was copied from Apache Tika and modified for Red5. */ public class MP3Stream extends PushbackInputStream { @@ -72,7 +72,7 @@ public class MP3Stream extends PushbackInputStream { /** * Creates a new instance of {@code MpegStream} and initializes it with the underlying stream. - * + * * @param in * the underlying audio stream */ @@ -87,7 +87,7 @@ public boolean eos() { /** * Searches for the next MPEG frame header from the current stream position on. This method advances the underlying input stream until it finds a valid frame header or the end of the stream is reached. In the former case a corresponding {@code AudioFrame} object is created. In the latter case there are no more headers, so the end of the stream is probably reached. - * + * * @return the next {@code AudioFrame} or null * @throws IOException * if an IO error occurs @@ -114,7 +114,7 @@ public AudioFrame nextFrame() throws IOException { /** * Skips the current MPEG frame. This method can be called after a valid MPEG header has been retrieved using {@code nextFrame()}. In this case the underlying stream is advanced to the end of the associated MPEG frame. Otherwise, this method has no effect. The return value indicates whether a frame could be skipped. - * + * * @return true if a frame could be skipped, false otherwise * @throws IOException * if an IO error occurs @@ -130,7 +130,7 @@ public boolean skipFrame() throws IOException { /** * Advances the underlying stream until the first byte of frame sync is found. - * + * * @throws IOException * if an error occurs */ @@ -145,7 +145,7 @@ private void findFrameSyncByte() throws IOException { /** * Creates a bit field for the MPEG frame header. - * + * * @return the bit field * @throws IOException * if an error occurs @@ -160,7 +160,7 @@ private HeaderBitField createHeaderField() throws IOException { /** * Creates an {@code AudioFrame} object based on the given header field. If the header field contains invalid values, result is null. - * + * * @param bits * the header bit field * @return the {@code AudioFrame} @@ -188,7 +188,7 @@ private static AudioFrame createHeader(HeaderBitField bits) { /** * Reads the next byte. - * + * * @return the next byte * @throws IOException * if an error occurs @@ -206,7 +206,7 @@ private int nextByte() throws IOException { /** * Pushes the given header field back in the stream so that the bytes are read again. This method is called if an invalid header was detected. Then search has to continue at the next byte after the frame sync byte. - * + * * @param field * the header bit field with the invalid frame header * @throws IOException @@ -218,7 +218,7 @@ private void pushBack(HeaderBitField field) throws IOException { /** * Skips the given number of bytes from the specified input stream. - * + * * @param in * the input stream * @param count @@ -239,7 +239,7 @@ private static void skipStream(InputStream in, long count) throws IOException { /** * Calculates the bit rate based on the given parameters. - * + * * @param mpegVer * the MPEG version * @param layer @@ -274,7 +274,7 @@ private static int calculateBitRate(int mpegVer, int layer, int code) { /** * Calculates the sample rate based on the given parameters. - * + * * @param mpegVer * the MPEG version * @param code @@ -287,7 +287,7 @@ private static int calculateSampleRate(int mpegVer, int code) { /** * Calculates the length of an MPEG frame based on the given parameters. - * + * * @param layer * the layer * @param bitRate @@ -308,7 +308,7 @@ private static int calculateFrameLength(int layer, int bitRate, int sampleRate, /** * Calculates the duration of a MPEG frame based on the given parameters. - * + * * @param layer * the layer * @param sampleRate @@ -322,7 +322,7 @@ private static float calculateDuration(int layer, int sampleRate) { /** * Calculates the number of channels based on the given parameters. - * + * * @param chan * the code for the channels * @return the number of channels @@ -333,7 +333,7 @@ private static int calculateChannels(int chan) { /** * Creates the complete array for the sample rate mapping. - * + * * @return the table for the sample rates */ private static int[][] createSampleRateTable() { @@ -353,7 +353,7 @@ private static class HeaderBitField { /** * Adds a byte to this field. - * + * * @param b * the byte to be added */ @@ -364,7 +364,7 @@ public void add(int b) { /** * Returns the value of the bit group from the given start and end index. E.g. ''from'' = 0, ''to'' = 3 will return the value of the first 4 bits. - * + * * @param the * from index * @param to @@ -379,7 +379,7 @@ public int get(int from, int to) { /** * Returns the value of the bit with the given index. The bit index is 0-based. Result is either 0 or 1, depending on the value of this bit. - * + * * @param bit * the bit index * @return the value of this bit @@ -390,7 +390,7 @@ public int get(int bit) { /** * Returns the internal value of this field as an array. The array contains 3 bytes. - * + * * @return the internal value of this field as int array */ public byte[] toArray() { diff --git a/io/src/main/java/org/red5/io/mp4/IMP4.java b/io/src/main/java/org/red5/io/mp4/IMP4.java index d62a270ee..9e7c1827c 100644 --- a/io/src/main/java/org/red5/io/mp4/IMP4.java +++ b/io/src/main/java/org/red5/io/mp4/IMP4.java @@ -19,21 +19,21 @@ /** * Represents MP4 file - * + * * @author Paul Gregoire (mondain@gmail.com) */ public interface IMP4 extends IStreamableFile { /** * Returns a boolean stating whether the mp4 has metadata - * + * * @return boolean true if file has injected metadata, false otherwise */ public boolean hasMetaData(); /** * Sets the metadata - * + * * @param metadata * Metadata object * @throws FileNotFoundException @@ -45,7 +45,7 @@ public interface IMP4 extends IStreamableFile { /** * Sets the MetaService through Spring - * + * * @param service * Metadata service */ @@ -53,7 +53,7 @@ public interface IMP4 extends IStreamableFile { /** * Returns a map of the metadata - * + * * @return metadata File metadata * @throws FileNotFoundException * File not found @@ -62,14 +62,14 @@ public interface IMP4 extends IStreamableFile { /** * Returns a boolean stating whether a mp4 has keyframedata - * + * * @return boolean true if file has keyframe metadata, false otherwise */ public boolean hasKeyFrameData(); /** * Sets the keyframe data of a mp4 file - * + * * @param keyframedata * Keyframe metadata */ @@ -77,14 +77,14 @@ public interface IMP4 extends IStreamableFile { /** * Gets the keyframe data - * + * * @return keyframedata Keyframe metadata */ public Map getKeyFrameData(); /** * Refreshes the headers. Usually used after data is added to the mp4 file - * + * * @throws IOException * Any I/O exception */ @@ -92,7 +92,7 @@ public interface IMP4 extends IStreamableFile { /** * Flushes Header - * + * * @throws IOException * Any I/O exception */ @@ -100,7 +100,7 @@ public interface IMP4 extends IStreamableFile { /** * Returns a Reader closest to the nearest keyframe - * + * * @param seekPoint * Point in file we are seeking around * @return reader Tag reader closest to that point @@ -109,7 +109,7 @@ public interface IMP4 extends IStreamableFile { /** * Returns a Writer based on the nearest key frame - * + * * @param seekPoint * Point in file we are seeking around * @return writer Tag writer closest to that point diff --git a/io/src/main/java/org/red5/io/mp4/MP4Frame.java b/io/src/main/java/org/red5/io/mp4/MP4Frame.java index d2e7332b7..752ed63d9 100644 --- a/io/src/main/java/org/red5/io/mp4/MP4Frame.java +++ b/io/src/main/java/org/red5/io/mp4/MP4Frame.java @@ -9,7 +9,7 @@ /** * Represents an MP4 frame / chunk sample - * + * * @author Paul Gregoire (mondain@gmail.com) */ public class MP4Frame implements Comparable { @@ -29,7 +29,7 @@ public class MP4Frame implements Comparable { /** * Returns the data type, being audio or video. - * + * * @return the data type */ public byte getType() { @@ -42,7 +42,7 @@ public void setType(byte type) { /** * Returns the offset of the data chunk in the media source. - * + * * @return the offset in bytes */ public long getOffset() { @@ -55,7 +55,7 @@ public void setOffset(long offset) { /** * Returns the size of the data chunk. - * + * * @return the size in bytes */ public int getSize() { @@ -68,7 +68,7 @@ public void setSize(int size) { /** * Returns the timestamp. - * + * * @return the timestamp */ public double getTime() { @@ -96,7 +96,7 @@ public void setTimeOffset(int timeOffset) { /** * Returns whether or not this chunk represents a key frame. - * + * * @return true if a key frame */ public boolean isKeyFrame() { diff --git a/io/src/main/java/org/red5/io/mp4/impl/MP4.java b/io/src/main/java/org/red5/io/mp4/impl/MP4.java index 453cd7959..6cfc7f9b9 100644 --- a/io/src/main/java/org/red5/io/mp4/impl/MP4.java +++ b/io/src/main/java/org/red5/io/mp4/impl/MP4.java @@ -24,7 +24,7 @@ /** * A MP4Impl implements the MP4 api - * + * * @author The Red5 Project * @author Paul Gregoire, (mondain@gmail.com) */ @@ -46,7 +46,7 @@ public MP4() { /** * Create MP4 from given file source. - * + * * @param file * File source */ diff --git a/io/src/main/java/org/red5/io/mp4/impl/MP4Reader.java b/io/src/main/java/org/red5/io/mp4/impl/MP4Reader.java index 138ded4e9..5ff30f8be 100644 --- a/io/src/main/java/org/red5/io/mp4/impl/MP4Reader.java +++ b/io/src/main/java/org/red5/io/mp4/impl/MP4Reader.java @@ -96,7 +96,7 @@ *
  • NetStream.Play.NoSupportedTrackFound: This event is sent if the player does not detect any supported tracks. If there aren't any * supported video, audio or data tracks found, Flash Player does not play the file.
  • * - * + * * @author The Red5 Project * @author Paul Gregoire (mondain@gmail.com) */ @@ -143,10 +143,10 @@ public class MP4Reader implements IoConstants, ITagReader, IKeyFrameDataAnalyzer /** Whether or not the clip contains an audio track */ private boolean hasAudio = false; - //default video codec + //default video codec private String videoCodecId = "avc1"; - //default audio codec + //default audio codec private String audioCodecId = "mp4a"; //decoder bytes / configs @@ -192,7 +192,7 @@ public class MP4Reader implements IoConstants, ITagReader, IKeyFrameDataAnalyzer //keyframe - sample numbers private long[] syncSamples; - //samples + //samples private long[] videoSamples; private long[] audioSamples; @@ -511,7 +511,7 @@ public void decodeHeader() { /** * Dumps the children of a container box. - * + * * @param box * mp4 box */ @@ -524,7 +524,7 @@ public static void dumpBox(Container box) { /** * Process the video information contained in the atoms. - * + * * @param stbl * @param vse * VisualSampleEntry @@ -582,7 +582,7 @@ private void processVideoBox(SampleTableBox stbl, VisualSampleEntry vse, long sc /** * Process the video information contained in the atoms. - * + * * @param stbl * @param scale * timescale @@ -605,7 +605,7 @@ private void processVideoBox(SampleTableBox stbl, long scale) { /** * Process an stbl atom with containing video information. - * + * * @param stbl * @param scale */ @@ -703,7 +703,7 @@ private void processVideoStbl(SampleTableBox stbl, long scale) { /** * Process the audio information contained in the atoms. - * + * * @param stbl * @param ase * AudioSampleEntry @@ -809,7 +809,7 @@ private void processAudioBox(SampleTableBox stbl, AudioSampleEntry ase, long sca /** * Process the audio information contained in the atoms. - * + * * @param stbl * @param scale * timescale @@ -916,7 +916,7 @@ public boolean hasVideo() { /** * Returns the file buffer. - * + * * @return File contents as byte buffer */ public IoBuffer getFileData() { @@ -981,7 +981,7 @@ public boolean hasMoreTags() { * Create tag for metadata event. * * Information mostly from http://www.kaourantin.net/2007/08/what-just-happened-to-video-on-web_20.html - * + * *
          * 		width: Display width in pixels.
          * 		height: Display height in pixels.
    @@ -1002,18 +1002,18 @@ public boolean hasMoreTags() {
          * 	    	trackinfo[1].timescale: 44100
          * 	    	trackinfo[1].sampledescription.sampletype: mp4a
          * 	    	trackinfo[1].language: und
    -     * 	    
    +     *
          * 	    chapters: As mentioned above information about chapters in audiobooks.
    -     * 		seekpoints: Array that lists the available keyframes in a file as time stamps in milliseconds. 
    -     * 				This is optional as the MP4 file might not contain this information. Generally speaking, 
    +     * 		seekpoints: Array that lists the available keyframes in a file as time stamps in milliseconds.
    +     * 				This is optional as the MP4 file might not contain this information. Generally speaking,
          * 				most MP4 files will include this by default. You can directly feed the values into NetStream.seek();
    -     * 	    videoframerate: The frame rate of the video if a monotone frame rate is used. 
    +     * 	    videoframerate: The frame rate of the video if a monotone frame rate is used.
          * 	    		Most videos will have a monotone frame rate.
          * 	    audiosamplerate: The original sampling rate of the audio track.
          * 	    audiochannels: The original number of channels of the audio track.
    -     * 		progressivedownloadinfo: Object that provides information from the "pdin" atom. This is optional 
    +     * 		progressivedownloadinfo: Object that provides information from the "pdin" atom. This is optional
          * 				and many files will not have this field.
    -     * 		tags: Array of key value pairs representing the information present in the "ilst" atom, which is 
    +     * 		tags: Array of key value pairs representing the information present in the "ilst" atom, which is
          * 				the equivalent of ID3 tags for MP4 files. These tags are mostly used by iTunes.
          * 
    * @@ -1106,13 +1106,13 @@ ITag createFileMeta() { /** * Tag sequence MetaData, Video config, Audio config, remaining audio and video - * + * * Packet prefixes: 17 00 00 00 00 = Video extra data (first video packet) 17 01 00 00 00 = Video keyframe 27 01 00 00 00 = Video * interframe af 00 ... 06 = Audio extra data (first audio packet) af 01 = Audio frame - * + * * Audio extra data(s): af 00 = Prefix 11 90 4f 14 = AAC Main = aottype 0 // 11 90 12 10 = AAC LC = aottype 1 13 90 56 e5 a5 48 00 = * HE-AAC SBR = aottype 2 06 = Suffix - * + * * Still not absolutely certain about this order or the bytes - need to verify later */ private void createPreStreamingTags(int timestamp, boolean clear) { @@ -1141,7 +1141,7 @@ private void createPreStreamingTags(int timestamp, boolean clear) { firstTags.add(tag); } // TODO: Handle other mp4 container audio codecs like mp3 - // mp3 header magic number ((int & 0xffe00000) == 0xffe00000) + // mp3 header magic number ((int & 0xffe00000) == 0xffe00000) if (hasAudio) { //audio tag #1 if (audioDecoderBytes != null) { @@ -1360,7 +1360,7 @@ public void analyzeFrames() { } // if video-only, skip this if (audioSamplesToChunks != null) { - //add the audio frames / samples / chunks + //add the audio frames / samples / chunks sample = 1; for (int i = 0; i < audioSamplesToChunks.size(); i++) { SampleToChunkBox.Entry record = audioSamplesToChunks.get(i); @@ -1380,7 +1380,7 @@ public void analyzeFrames() { int size = 0; // if we have no samples, skip size check as its probably not aac if (audioSamples.length > 0) { - //update sample size + //update sample size size = (int) audioSamples[sample - 1]; // skip empty AAC data which is 6 bytes long log.trace("Audio sample - size: {} pos: {}", size, pos); @@ -1467,7 +1467,7 @@ public void position(long pos) { for (int f = 0; f < len; f++) { frame = frames.get(f); long offset = frame.getOffset(); - //look for pos to match frame offset or grab the first keyframe + //look for pos to match frame offset or grab the first keyframe //beyond the offset if (pos == offset || (offset > pos && frame.isKeyFrame())) { //ensure that it is a keyframe diff --git a/io/src/main/java/org/red5/io/object/BaseInput.java b/io/src/main/java/org/red5/io/object/BaseInput.java index 6fcd05240..3422ceb18 100644 --- a/io/src/main/java/org/red5/io/object/BaseInput.java +++ b/io/src/main/java/org/red5/io/object/BaseInput.java @@ -13,7 +13,7 @@ /** * BaseInput represents a way to map input to a HashMap. This class is meant to be extended. - * + * * @author The Red5 Project * @author Luke Hubbard, Codegent Ltd (luke@codegent.com) */ @@ -33,7 +33,7 @@ public class BaseInput { /** * Store an object into a map. - * + * * @param obj * Object to store * @return reference id @@ -47,7 +47,7 @@ protected int storeReference(Object obj) { /** * Replace a referenced object with another one. This is used by the AMF3 deserializer to handle circular references. - * + * * @param refId * reference id * @param newRef @@ -67,7 +67,7 @@ public void clearReferences() { /** * Returns the object with the parameters id - * + * * @param id * Object reference id * @return Object Object reference with given id @@ -78,7 +78,7 @@ protected Object getReference(int id) { /** * Checks the deserializer to see if a given class is blacklisted or not. - * + * * @param className class name/package * @return true if not blacklisted and false if it is blacklisted */ diff --git a/io/src/main/java/org/red5/io/object/BaseOutput.java b/io/src/main/java/org/red5/io/object/BaseOutput.java index 44db6aa62..3017b2806 100644 --- a/io/src/main/java/org/red5/io/object/BaseOutput.java +++ b/io/src/main/java/org/red5/io/object/BaseOutput.java @@ -12,7 +12,7 @@ /** * BaseOutput represents a way to map input to a HashMap. This class is meant to be extended. - * + * * @author The Red5 Project * @author Luke Hubbard, Codegent Ltd (luke@codegent.com) */ @@ -26,7 +26,7 @@ static class IdentityWrapper { /** * Creates wrapper for object - * + * * @param object * Object to wrap */ @@ -71,7 +71,7 @@ protected BaseOutput() { /** * Store an object into a map - * + * * @param obj * Object to store */ @@ -81,7 +81,7 @@ protected void storeReference(Object obj) { /** * Returns a boolean stating whether the map contains an object with that key - * + * * @param obj * Object * @return boolean true if it does contain it, false otherwise @@ -100,7 +100,7 @@ public void clearReferences() { /** * Returns the reference id based on the parameter obj - * + * * @param obj * Object * @return short Reference id diff --git a/io/src/main/java/org/red5/io/object/Deserializer.java b/io/src/main/java/org/red5/io/object/Deserializer.java index f8af95625..f65b99f82 100644 --- a/io/src/main/java/org/red5/io/object/Deserializer.java +++ b/io/src/main/java/org/red5/io/object/Deserializer.java @@ -48,7 +48,7 @@ public synchronized static void loadBlackList() throws IOException { /** * Deserializes the input parameter and returns an Object which must then be cast to a core data type - * + * * @param * type * @param in @@ -144,7 +144,7 @@ public static T deserialize(Input in, Type target) { /** * Checks to see if a given class is blacklisted or not. - * + * * @param className class name/package * @return true if not blacklisted and false if it is blacklisted */ diff --git a/io/src/main/java/org/red5/io/object/ICustomSerializable.java b/io/src/main/java/org/red5/io/object/ICustomSerializable.java index 0e2d6da5d..6c55d324b 100644 --- a/io/src/main/java/org/red5/io/object/ICustomSerializable.java +++ b/io/src/main/java/org/red5/io/object/ICustomSerializable.java @@ -9,9 +9,9 @@ /** * Interface for objects that know how to serialize their contents. - * + * * NOTE: This is only used for AMF0 encoding and you should not need to implement this in your own objects. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ @@ -19,7 +19,7 @@ public interface ICustomSerializable { /** * Serialize this object to the given output stream. - * + * * @param output * output */ diff --git a/io/src/main/java/org/red5/io/object/Input.java b/io/src/main/java/org/red5/io/object/Input.java index e2442bc65..e3a3b4f5a 100644 --- a/io/src/main/java/org/red5/io/object/Input.java +++ b/io/src/main/java/org/red5/io/object/Input.java @@ -16,9 +16,9 @@ import org.w3c.dom.Document; /** - * Interface for Input which defines the contract methods which are to be implemented. Input object provides ways to read primitives, + * Interface for Input which defines the contract methods which are to be implemented. Input object provides ways to read primitives, * complex object and object references from byte buffer. - * + * * @author The Red5 Project * @author Luke Hubbard, Codegent Ltd (luke@codegent.com) */ @@ -26,56 +26,56 @@ public interface Input { /** * Read type of data - * + * * @return Type of data as byte */ byte readDataType(); /** * Read a string without the string type header. - * + * * @return String */ String getString(); /** * Read Null data type - * + * * @return Null datatype (AS) */ Object readNull(); /** * Read Boolean value - * + * * @return Boolean */ Boolean readBoolean(); /** * Read Number object - * + * * @return Number */ Number readNumber(); /** * Read String object - * + * * @return String */ String readString(); /** * Read date object - * + * * @return Date */ Date readDate(); /** * Read an array. This can result in a List or Map being deserialized depending on the array type found. - * + * * @param target * target type * @return array @@ -84,42 +84,42 @@ public interface Input { /** * Read a map containing key - value pairs. This can result in a List or Map being deserialized depending on the map type found. - * + * * @return Map */ Object readMap(); /** * Read an object. - * + * * @return object */ Object readObject(); /** * Read XML document - * + * * @return XML DOM document */ Document readXML(); /** * Read custom object - * + * * @return Custom object */ Object readCustom(); /** * Read ByteArray object. - * + * * @return ByteArray object */ ByteArray readByteArray(); /** * Read reference to Complex Data Type. Objects that are collaborators (properties) of other objects must be stored as references in map of id-reference pairs. - * + * * @return object */ Object readReference(); @@ -131,35 +131,35 @@ public interface Input { /** * Read key - value pairs. This is required for the RecordSet deserializer. - * + * * @return key-value pairs */ Map readKeyValues(); /** * Read Vector<int> object. - * + * * @return Vector<Integer> */ Vector readVectorInt(); /** * Read Vector<uint> object. - * + * * @return Vector<Long> */ Vector readVectorUInt(); /** * Read Vector<Number> object. - * + * * @return Vector<Double> */ Vector readVectorNumber(); /** * Read Vector<Object> object. - * + * * @return Vector<Object> */ Vector readVectorObject(); diff --git a/io/src/main/java/org/red5/io/object/Output.java b/io/src/main/java/org/red5/io/object/Output.java index ab3f080c0..a1ea85feb 100644 --- a/io/src/main/java/org/red5/io/object/Output.java +++ b/io/src/main/java/org/red5/io/object/Output.java @@ -28,7 +28,7 @@ public interface Output { // Basic Data Types /** * Write number - * + * * @param num * Number */ @@ -36,7 +36,7 @@ public interface Output { /** * Write boolean - * + * * @param bol * Boolean */ @@ -44,7 +44,7 @@ public interface Output { /** * Write string - * + * * @param string * String */ @@ -52,7 +52,7 @@ public interface Output { /** * Write date - * + * * @param date * Date */ @@ -62,7 +62,7 @@ public interface Output { /** * Write array. - * + * * @param array * Array to write */ @@ -70,7 +70,7 @@ public interface Output { /** * Write array. - * + * * @param array * Array to write */ @@ -78,7 +78,7 @@ public interface Output { /** * Write primitive array. - * + * * @param array * Array to write */ @@ -126,7 +126,7 @@ public interface Output { /** * Write XML object - * + * * @param xml * XML document */ @@ -134,7 +134,7 @@ public interface Output { /** * Write ByteArray object (AMF3 only). - * + * * @param array * object to write */ @@ -142,7 +142,7 @@ public interface Output { /** * Write a Vector<int>. - * + * * @param vector * vector */ @@ -150,7 +150,7 @@ public interface Output { /** * Write a Vector<uint>. - * + * * @param vector * vector */ @@ -158,7 +158,7 @@ public interface Output { /** * Write a Vector<Number>. - * + * * @param vector * vector */ @@ -166,7 +166,7 @@ public interface Output { /** * Write a Vector<Object>. - * + * * @param vector * vector */ @@ -174,7 +174,7 @@ public interface Output { /** * Write reference to complex data type - * + * * @param obj * Referenced object */ @@ -191,7 +191,7 @@ public interface Output { /** * Write custom (user) object - * + * * @param custom * Custom data type object */ diff --git a/io/src/main/java/org/red5/io/object/RecordSet.java b/io/src/main/java/org/red5/io/object/RecordSet.java index b7b9e3458..d85003dde 100644 --- a/io/src/main/java/org/red5/io/object/RecordSet.java +++ b/io/src/main/java/org/red5/io/object/RecordSet.java @@ -27,7 +27,7 @@ *

    * For last mode, use page size property to specify maximum number of rows on one page *

    - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ @@ -99,7 +99,7 @@ public class RecordSet { /** * Creates recordset from Input object - * + * * @param input * input */ @@ -131,7 +131,7 @@ public RecordSet(Input input) { /** * Set the remoting client to use for retrieving of paged results. - * + * * @param client * Remoting client that works with this Recordset */ @@ -141,7 +141,7 @@ public void setRemotingClient(IRemotingClient client) { /** * Set the mode for fetching paged results. - * + * * @param mode * Mode for fetching of results */ @@ -151,7 +151,7 @@ public void setDeliveryMode(String mode) { /** * Set the mode for fetching paged results with given max page size. - * + * * @param mode * Mode for fetching of results * @param pageSize @@ -163,7 +163,7 @@ public void setDeliveryMode(String mode, int pageSize) { /** * Set the mode for fetching paged results with given max page size and number of prefetched pages. - * + * * @param mode * Mode for fetching of results * @param pageSize @@ -178,7 +178,7 @@ public void setDeliveryMode(String mode, int pageSize, int prefetchCount) { /** * Return a list containing the names of the columns in the recordset. - * + * * @return Column names set */ public List getColumnNames() { @@ -187,7 +187,7 @@ public List getColumnNames() { /** * Make sure the passed item has been fetched from the server. - * + * * @param index * Item index */ @@ -245,7 +245,7 @@ private void ensureAvailable(int index) { /** * Return a specified item from the recordset. If the item is not available yet, it will be received from the server. - * + * * @param index * Item index * @return Item from recordset @@ -262,7 +262,7 @@ public List getItemAt(int index) { /** * Get the total number of items. - * + * * @return Number of items */ public int getLength() { @@ -271,7 +271,7 @@ public int getLength() { /** * Get the number of items already received from the server. - * + * * @return Nsumber of received items */ public int getNumberAvailable() { @@ -286,7 +286,7 @@ public int getNumberAvailable() { /** * Check if all items are available on the client. - * + * * @return number of available items */ public boolean isFullyPopulated() { @@ -295,7 +295,7 @@ public boolean isFullyPopulated() { /** * Return Map that can be serialized as result. - * + * * @return serializable informations */ public Map serialize() { diff --git a/io/src/main/java/org/red5/io/object/RecordSetPage.java b/io/src/main/java/org/red5/io/object/RecordSetPage.java index 0072ae480..21029a871 100644 --- a/io/src/main/java/org/red5/io/object/RecordSetPage.java +++ b/io/src/main/java/org/red5/io/object/RecordSetPage.java @@ -30,7 +30,7 @@ public class RecordSetPage { /** * Creates recordset page from Input object - * + * * @param input * Input object to use as source for data that has to be deserialized */ diff --git a/io/src/main/java/org/red5/io/object/Serializer.java b/io/src/main/java/org/red5/io/object/Serializer.java index a2ad08cdf..431ec6ef8 100644 --- a/io/src/main/java/org/red5/io/object/Serializer.java +++ b/io/src/main/java/org/red5/io/object/Serializer.java @@ -30,7 +30,7 @@ /** * The Serializer class writes data output and handles the data according to the core data types - * + * * @author The Red5 Project * @author Luke Hubbard, Codegent Ltd (luke@codegent.com) * @author Harald Radi (harald.radi@nme.at) @@ -45,7 +45,7 @@ private Serializer() { /** * Serializes output to a core data type object - * + * * @param out * Output writer * @param any @@ -57,7 +57,7 @@ public static void serialize(Output out, Object any) { /** * Serializes output to a core data type object - * + * * @param out * Output writer * @param field @@ -124,7 +124,7 @@ public static void serialize(Output out, Field field, Method getter, Object obje /** * Writes a primitive out as an object - * + * * @param out * Output writer * @param basic @@ -153,7 +153,7 @@ protected static boolean writeBasic(Output out, Object basic) { /** * Writes a complex type object out - * + * * @param out * Output writer * @param complex @@ -179,7 +179,7 @@ public static boolean writeComplex(Output out, Object complex) { /** * Writes Lists out as a data type - * + * * @param out * Output write * @param listType @@ -198,7 +198,7 @@ protected static boolean writeListType(Output out, Object listType) { /** * Writes a List out as an Object - * + * * @param out * Output writer * @param list @@ -232,7 +232,7 @@ protected static void writeList(Output out, List list) { /** * Writes array (or collection) out as output Arrays, Collections, etc - * + * * @param out * Output object * @param arrType @@ -258,7 +258,7 @@ protected static boolean writeArrayType(Output out, Object arrType) { /** * Writes an iterator out to the output - * + * * @param out * Output writer * @param it @@ -277,7 +277,7 @@ protected static void writeIterator(Output out, Iterator it) { /** * Writes an xml type out to the output - * + * * @param out * Output writer * @param xml @@ -297,7 +297,7 @@ protected static boolean writeXMLType(Output out, Object xml) { /** * Writes a document to the output - * + * * @param out * Output writer * @param doc @@ -309,7 +309,7 @@ protected static void writeDocument(Output out, Document doc) { /** * Write typed object to the output - * + * * @param out * Output writer * @param obj @@ -332,7 +332,7 @@ protected static boolean writeObjectType(Output out, Object obj) { /** * Writes a custom data to the output - * + * * @param out * Output writer * @param obj @@ -351,7 +351,7 @@ protected static boolean writeCustomType(Output out, Object obj) { /** * Checks whether the field should be serialized or not - * + * * @param keyName * key name * @param field @@ -385,7 +385,7 @@ public static boolean serializeField(String keyName, Field field, Method getter) /** * Handles classes by name, also provides "shortened" class aliases where appropriate. - * + * * @param objectClass * class * @return class name for given object diff --git a/io/src/main/java/org/red5/io/object/StreamAction.java b/io/src/main/java/org/red5/io/object/StreamAction.java index 17356cbb1..d9b055c79 100644 --- a/io/src/main/java/org/red5/io/object/StreamAction.java +++ b/io/src/main/java/org/red5/io/object/StreamAction.java @@ -13,7 +13,7 @@ /** * Represents all the actions which may be permitted on a stream. Some actions are called by client implementations other than a Flash Player itself; ex "getStreamLength". * If an action is not specified here, the "CUSTOM" enum will be returned. - * + * * @author Paul Gregoire */ public enum StreamAction { diff --git a/io/src/main/java/org/red5/io/object/UnsignedByte.java b/io/src/main/java/org/red5/io/object/UnsignedByte.java index 71f081ca7..9750b5530 100644 --- a/io/src/main/java/org/red5/io/object/UnsignedByte.java +++ b/io/src/main/java/org/red5/io/object/UnsignedByte.java @@ -9,7 +9,7 @@ /** * The UnsignedByte class wraps a value of and unsigned 8 bits number. - * + * * @author Matteo Merli (matteo.merli@gmail.com) */ public final class UnsignedByte extends UnsignedNumber { diff --git a/io/src/main/java/org/red5/io/object/UnsignedInt.java b/io/src/main/java/org/red5/io/object/UnsignedInt.java index 68e051df5..50ce745dc 100644 --- a/io/src/main/java/org/red5/io/object/UnsignedInt.java +++ b/io/src/main/java/org/red5/io/object/UnsignedInt.java @@ -9,7 +9,7 @@ /** * The UnsignedInt class wraps a value of an unsigned 32 bits number. - * + * * @author Matteo Merli (matteo.merli@gmail.com) */ public final class UnsignedInt extends UnsignedNumber { diff --git a/io/src/main/java/org/red5/io/object/UnsignedLong.java b/io/src/main/java/org/red5/io/object/UnsignedLong.java index 3f407b6a5..7d2257aeb 100644 --- a/io/src/main/java/org/red5/io/object/UnsignedLong.java +++ b/io/src/main/java/org/red5/io/object/UnsignedLong.java @@ -13,7 +13,7 @@ /** * The UnsignedLong class wraps a value of an unsigned 64 bits number. - * + * * @author Matteo Merli (matteo.merli@gmail.com) */ public final class UnsignedLong extends UnsignedNumber { @@ -54,7 +54,7 @@ public UnsignedLong(long c) { /** * Construct a new random UnsignedLong. - * + * * @param random * a Random handler */ diff --git a/io/src/main/java/org/red5/io/object/UnsignedNumber.java b/io/src/main/java/org/red5/io/object/UnsignedNumber.java index ae831493f..be21faf94 100644 --- a/io/src/main/java/org/red5/io/object/UnsignedNumber.java +++ b/io/src/main/java/org/red5/io/object/UnsignedNumber.java @@ -16,14 +16,14 @@ public abstract class UnsignedNumber extends Number { /** * Get a byte array representation of the number. The order will be MSB first (Big Endian). - * + * * @return the serialized number */ public abstract byte[] getBytes(); /** * Perform a bit right shift of the value. - * + * * @param nBits * the number of positions to shift */ @@ -31,7 +31,7 @@ public abstract class UnsignedNumber extends Number { /** * Perform a bit left shift of the value. - * + * * @param nBits * the number of positions to shift */ diff --git a/io/src/main/java/org/red5/io/object/UnsignedShort.java b/io/src/main/java/org/red5/io/object/UnsignedShort.java index c08050bc2..923ddc426 100644 --- a/io/src/main/java/org/red5/io/object/UnsignedShort.java +++ b/io/src/main/java/org/red5/io/object/UnsignedShort.java @@ -11,7 +11,7 @@ /** * The UnsignedByte class wraps a value of an unsigned 16 bits number. - * + * * @author Matteo Merli (matteo.merli@gmail.com) */ public final class UnsignedShort extends UnsignedNumber { diff --git a/io/src/main/java/org/red5/io/sctp/SctpException.java b/io/src/main/java/org/red5/io/sctp/SctpException.java index 77ea38d9f..de340de39 100644 --- a/io/src/main/java/org/red5/io/sctp/SctpException.java +++ b/io/src/main/java/org/red5/io/sctp/SctpException.java @@ -10,7 +10,7 @@ public class SctpException extends Exception { /** - * + * */ private static final long serialVersionUID = 1L; diff --git a/io/src/main/java/org/red5/io/sctp/SctpServerChanneOverUDP.java b/io/src/main/java/org/red5/io/sctp/SctpServerChanneOverUDP.java index 6f95f2caa..a12d170d8 100644 --- a/io/src/main/java/org/red5/io/sctp/SctpServerChanneOverUDP.java +++ b/io/src/main/java/org/red5/io/sctp/SctpServerChanneOverUDP.java @@ -157,7 +157,7 @@ protected void implCloseSelectableChannel() throws IOException { @Override protected void implConfigureBlocking(boolean block) throws IOException { - // TODO Auto-generated method stub + // TODO Auto-generated method stub } @Override diff --git a/io/src/main/java/org/red5/io/sctp/packet/chunks/Init.java b/io/src/main/java/org/red5/io/sctp/packet/chunks/Init.java index d130c1fb9..d2c05e209 100644 --- a/io/src/main/java/org/red5/io/sctp/packet/chunks/Init.java +++ b/io/src/main/java/org/red5/io/sctp/packet/chunks/Init.java @@ -20,7 +20,7 @@ public class Init extends Chunk { - // initiateTag(4 byte) + advertisedReceiverWindowCredit(4 byte) + numberOfOutboundStreams(2 byte) + numberOfInboundStreams(2 byte) + TSN(4 byte) + // initiateTag(4 byte) + advertisedReceiverWindowCredit(4 byte) + numberOfOutboundStreams(2 byte) + numberOfInboundStreams(2 byte) + TSN(4 byte) private static final int MANDATORY_FIELD_SIZE = 16; private int initiateTag; diff --git a/io/src/main/java/org/red5/io/utils/BufferUtils.java b/io/src/main/java/org/red5/io/utils/BufferUtils.java index 6c80755c3..8bc5a17d5 100644 --- a/io/src/main/java/org/red5/io/utils/BufferUtils.java +++ b/io/src/main/java/org/red5/io/utils/BufferUtils.java @@ -13,7 +13,7 @@ /** * Buffer Utility class which reads/writes integers to the input/output buffer - * + * * @author The Red5 Project * @author Luke Hubbard, Codegent Ltd (luke@codegent.com) * @author Andy Shaules (bowljoman@hotmail.com) @@ -24,7 +24,7 @@ public class BufferUtils { /** * Writes a Medium Int to the output buffer - * + * * @param out * Container to write to * @param value @@ -40,7 +40,7 @@ public static void writeMediumInt(IoBuffer out, int value) { /** * Reads an unsigned Medium Int from the in buffer - * + * * @param in * Source * @return int Integer value @@ -57,7 +57,7 @@ public static int readUnsignedMediumInt(IoBuffer in) { /** * Reads a Medium Int to the in buffer - * + * * @param in * Source * @return int Medium int @@ -77,7 +77,7 @@ public static int readMediumInt(IoBuffer in) { /** * Puts an input buffer in an output buffer and returns number of bytes written. - * + * * @param out * Output buffer * @param in @@ -107,7 +107,7 @@ public final static int put(IoBuffer out, IoBuffer in, int numBytesMax) { /** * Consumes bytes from an input buffer and returns them in an output buffer. - * + * * @param in * Input byte array * @param numBytesMax diff --git a/io/src/main/java/org/red5/io/utils/ConversionUtils.java b/io/src/main/java/org/red5/io/utils/ConversionUtils.java index e611196cb..a35654e66 100644 --- a/io/src/main/java/org/red5/io/utils/ConversionUtils.java +++ b/io/src/main/java/org/red5/io/utils/ConversionUtils.java @@ -29,7 +29,7 @@ /** * Misc utils for conversions - * + * * @author The Red5 Project * @author Luke Hubbard, Codegent Ltd (luke@codegent.com) * @author Paul Gregoire (mondain@gmail.com) @@ -76,7 +76,7 @@ public class ConversionUtils { /** * Returns true for base types or arrays of base type. - * + * * @param obj Object * @return true if base-type or array and false otherwise */ @@ -92,7 +92,7 @@ public static boolean isBaseTypeOrArray(Object obj) { /** * Convert source to given class - * + * * @param source * Source object * @param target @@ -157,7 +157,7 @@ public static Object convert(Object source, Class target) throws ConversionEx /** * Convert to array - * + * * @param source * Source object * @param target @@ -200,7 +200,7 @@ public static List convertMapToList(Map map) { /** * Convert to wrapped primitive - * + * * @param source * Source object * @param wrapper @@ -233,7 +233,7 @@ public static Object convertToWrappedPrimitive(Object source, Class wrapper) /** * Convert string to primitive wrapper like Boolean or Float - * + * * @param str * String to convert * @param wrapper @@ -264,7 +264,7 @@ public static Object convertStringToWrapper(String str, Class wrapper) { /** * Convert number to primitive wrapper like Boolean or Float - * + * * @param num * Number to conver * @param wrapper @@ -295,7 +295,7 @@ public static Object convertNumberToWrapper(Number num, Class wrapper) { /** * Find method by name and number of parameters - * + * * @param object * Object to find method on * @param method @@ -337,7 +337,7 @@ public static List findMethodsByNameAndNumParams(Object object, String m /** * Convert parameters using methods of this utility class - * + * * @param source * Array of source object * @param target @@ -356,7 +356,7 @@ public static Object[] convertParams(Object[] source, Class[] target) throws /** * Convert parameters using methods of this utility class. Special handling is afforded to classes that implement IConnection. - * + * * @param source * Array of source object * @return Array of converted objects @@ -405,7 +405,7 @@ public static List convertArrayToList(Object[] source) throws ConversionExcep /** * Convert map to bean - * + * * @param source * Source map * @param target @@ -433,7 +433,7 @@ public static Object convertMapToBean(Map source, Clas /** * Convert bean to map - * + * * @param source * Source bean * @return Converted map @@ -444,7 +444,7 @@ public static Object convertMapToBean(Map source, Clas /** * Convert array to set, removing duplicates - * + * * @param source * Source array * @return Set @@ -459,7 +459,7 @@ public static Set convertArrayToSet(Object[] source) { /** * Create new class instance - * + * * @param className * Class name; may not be loaded by JVM yet * @return Instance of given class @@ -479,7 +479,7 @@ protected static Object newInstance(String className) { /** * Create new class instance - * + * * @param clazz * Class; may not be loaded by JVM yet * @return Instance of given class diff --git a/io/src/main/java/org/red5/io/utils/DOM2Writer.java b/io/src/main/java/org/red5/io/utils/DOM2Writer.java index 44bf4077c..2bba0bd36 100644 --- a/io/src/main/java/org/red5/io/utils/DOM2Writer.java +++ b/io/src/main/java/org/red5/io/utils/DOM2Writer.java @@ -19,7 +19,7 @@ /** * This class is a utility to serialize a DOM node as XML. This class uses the DOM Level 2 APIs. The main difference between this class and DOMWriter is that this class generates and prints out namespace declarations. - * + * * @author Matthew J. Duftler (duftler@us.ibm.com) * @author Joseph Kesselman */ @@ -29,7 +29,7 @@ public class DOM2Writer { /** * Serialize this node into the writer as XML. - * + * * @param writer * Writer object * @param node @@ -43,7 +43,7 @@ public static void serializeAsXML(Node node, Writer writer) { /** * Dumps DOM node - * + * * @param node * Node to dump * @param out diff --git a/io/src/main/java/org/red5/io/utils/HexCharset.java b/io/src/main/java/org/red5/io/utils/HexCharset.java index c48cf3c18..42d2658a4 100644 --- a/io/src/main/java/org/red5/io/utils/HexCharset.java +++ b/io/src/main/java/org/red5/io/utils/HexCharset.java @@ -25,7 +25,7 @@ *

    * hex:nn used as a charset name inserts \n after every nnth character. *

    - * + * * @author Malcolm McMahon */ public class HexCharset extends Charset { @@ -40,7 +40,7 @@ public class HexCharset extends Charset { /** * Creates a new instance of HexCharset - * + * * @param caps * true for A-F, false for a-f */ @@ -51,7 +51,7 @@ public HexCharset(boolean caps) { /** * Construct the charset - * + * * @param caps * true for A-F, false for a-f * @param measure @@ -65,7 +65,7 @@ public HexCharset(boolean caps, int measure) { /** * Constructs a new encoder for this charset. - * + * * @return A new encoder for this charset */ @Override @@ -75,7 +75,7 @@ public CharsetEncoder newEncoder() { /** * Constructs a new decoder for this charset. - * + * * @return A new decoder for this charset */ @Override @@ -85,19 +85,19 @@ public CharsetDecoder newDecoder() { /** * Tells whether or not this charset contains the given charset. - * + * *

    * A charset C is said to contain a charset D if, and only if, every character representable in D is also representable in C. If this relationship holds then it is guaranteed that every string that can be encoded in D can also be encoded in C without performing any replacements. - * + * *

    * That C contains D does not imply that each character representable in C by a particular byte sequence is represented in D by the same byte sequence, although sometimes this is the case. - * + * *

    * Every charset contains itself. - * + * *

    * This method computes an approximation of the containment relation: If it returns true then the given charset is known to be contained by this charset; if it returns false, however, then it is not necessarily the case that the given charset is not contained in this charset. - * + * * @return true if, and only if, the given charset is contained in this charset */ @Override @@ -116,14 +116,14 @@ private Encoder() { /** * Flushes this encoder. - * + * *

    * The default implementation of this method does nothing, and always returns {@link CoderResult#UNDERFLOW}. This method should be overridden by encoders that may need to write final bytes to the output buffer once the entire input sequence has been read. *

    - * + * * @param out * The output byte buffer - * + * * @return A coder-result object, either {@link CoderResult#UNDERFLOW} or {@link CoderResult#OVERFLOW} */ @Override @@ -137,27 +137,27 @@ protected java.nio.charset.CoderResult implFlush(java.nio.ByteBuffer out) { /** * Encodes one or more characters into one or more bytes. - * + * *

    * This method encapsulates the basic encoding loop, encoding as many characters as possible until it either runs out of input, runs out of room in the output buffer, or encounters an encoding error. This method is invoked by the {@link #encode encode} method, which handles result interpretation and error recovery. - * + * *

    * The buffers are read from, and written to, starting at their current positions. At most {@link Buffer#remaining in.remaining()} characters will be read, and at most {@link Buffer#remaining out.remaining()} bytes will be written. The buffers' positions will be advanced to reflect the characters read and the bytes written, but their marks and limits will not be modified. - * + * *

    * This method returns a {@link CoderResult} object to describe its reason for termination, in the same manner as the {@link #encode encode} method. Most implementations of this method will handle encoding errors by returning an appropriate result object for interpretation by the {@link #encode encode} method. An optimized implementation may instead examine the relevant error action and implement that action * itself. - * + * *

    * An implementation of this method may perform arbitrary lookahead by returning {@link CoderResult#UNDERFLOW} until it receives sufficient input. *

    - * + * * @param in * The input character buffer - * + * * @param out * The output byte buffer - * + * * @return A coder-result object describing the reason for termination */ @Override @@ -201,27 +201,27 @@ private Decoder() { /** * Decodes one or more bytes into one or more characters. - * + * *

    * This method encapsulates the basic decoding loop, decoding as many bytes as possible until it either runs out of input, runs out of room in the output buffer, or encounters a decoding error. This method is invoked by the {@link #decode decode} method, which handles result interpretation and error recovery. - * + * *

    * The buffers are read from, and written to, starting at their current positions. At most {@link Buffer#remaining in.remaining()} bytes will be read, and at most {@link Buffer#remaining out.remaining()} characters will be written. The buffers' positions will be advanced to reflect the bytes read and the characters written, but their marks and limits will not be modified. - * + * *

    * This method returns a {@link CoderResult} object to describe its reason for termination, in the same manner as the {@link #decode decode} method. Most implementations of this method will handle decoding errors by returning an appropriate result object for interpretation by the {@link #decode decode} method. An optimized implementation may instead examine the relevant error action and implement that action * itself. - * + * *

    * An implementation of this method may perform arbitrary lookahead by returning {@link CoderResult#UNDERFLOW} until it receives sufficient input. *

    - * + * * @param in * The input byte buffer - * + * * @param out * The output character buffer - * + * * @return A coder-result object describing the reason for termination */ @Override @@ -245,7 +245,7 @@ public java.nio.charset.CoderResult decodeLoop(java.nio.ByteBuffer in, java.nio. /** * Resets this decoder, clearing any charset-specific internal state. - * + * *

    * The default implementation of this method does nothing. This method should be overridden by decoders that maintain internal state. *

    diff --git a/io/src/main/java/org/red5/io/utils/HexDump.java b/io/src/main/java/org/red5/io/utils/HexDump.java index 7c73632ea..5a321a388 100644 --- a/io/src/main/java/org/red5/io/utils/HexDump.java +++ b/io/src/main/java/org/red5/io/utils/HexDump.java @@ -13,15 +13,15 @@ /** * Hexadecimal byte dumper - * + * * @author Niko Schweitzer */ public class HexDump { /** * Method prettyPrintHex - * - * + * + * * @param bbToConvert * ByteBuffer to encode * @return Hexdump string @@ -32,8 +32,8 @@ public static String prettyPrintHex(ByteBuffer bbToConvert) { /** * Method prettyPrintHex - * - * + * + * * @param baToConvert * Array of bytes to encode * @return Hexdump string @@ -50,8 +50,8 @@ public static String prettyPrintHex(byte[] baToConvert) { /** * Method prettyPrintHex - * - * + * + * * @param sToConvert * string to convert * @return hexdump string @@ -68,7 +68,7 @@ public static String prettyPrintHex(String sToConvert) { /** * Dumps a byte array as hex. - * + * * @param sb * string builder * @param b @@ -114,7 +114,7 @@ public static void dumpHex(StringBuilder sb, byte[] b) { /** * Sets the WithByteSeparator attribute of the Convert class - * + * * @param bs * The new WithByteSeparator value */ @@ -124,7 +124,7 @@ public static void setWithByteSeparator(boolean bs) { /** * Sets the ByteSeparator attribute of the Convert class - * + * * @param bs * The new ByteSeparator value */ @@ -134,7 +134,7 @@ public static void setByteSeparator(char bs) { /** * Sets the BitDigits attribute of the Convert class - * + * * @param bd * The new BitDigits value * @exception Exception @@ -151,7 +151,7 @@ public static void setBitDigits(char[] bd) throws Exception { /** * Method setBitDigits - * + * * @param zeroBit * zero bit * @param oneBit @@ -168,7 +168,7 @@ public static void setBitDigits(char zeroBit, char oneBit) { /** * Description of the Method - * + * * @param block * Description of Parameter * @return Description of the Returned Value @@ -193,7 +193,7 @@ public static String byteArrayToBinaryString(byte[] block) { /** * Method toBinaryString - * + * * @param ba * binary array * @return the binary representation of the byte array @@ -204,7 +204,7 @@ public static String toBinaryString(byte[] ba) { /** * Method toBinaryString - * + * * @param b * byte array * @return the binary representation of the byte @@ -217,7 +217,7 @@ public static String toBinaryString(byte b) { /** * Method toBinaryString - * + * * @param s * short * @return the binary representation of the short @@ -228,7 +228,7 @@ public static String toBinaryString(short s) { /** * Method toBinaryString - * + * * @param i * integer * @return the binary representation of the int @@ -239,7 +239,7 @@ public static String toBinaryString(int i) { /** * Method toBinaryString - * + * * @param l * long * @return the binary representation of the long @@ -250,7 +250,7 @@ public static String toBinaryString(long l) { /** * Method toByteArray - * + * * @param s * short * @return the short as array of bytes @@ -264,7 +264,7 @@ public static final byte[] toByteArray(short s) { /** * Method toByteArray - * + * * @param i * int * @return the int as array of bytes @@ -280,7 +280,7 @@ public static final byte[] toByteArray(int i) { /** * Method toByteArray - * + * * @param l * long * @return the long as array of bytes @@ -300,7 +300,7 @@ public static final byte[] toByteArray(long l) { /** * Description of the Method - * + * * @param block * Description of Parameter * @return Description of the Returned Value @@ -319,7 +319,7 @@ public static String byteArrayToHexString(byte[] block) { /** * Description of the Method - * + * * @param in * string to be converted * @return String in readable hex encoding @@ -331,7 +331,7 @@ public static String stringToHexString(String in) { /** * Description of the Method - * + * * @param block * Description of Parameter * @param offset @@ -358,7 +358,7 @@ public static String byteArrayToHexString(byte[] block, int offset, int length) /** * Returns a string of hexadecimal digits from a byte array. Each byte is converted to 2 hex symbols. - * + * * @param ba * Description of Parameter * @return Description of the Returned Value @@ -369,7 +369,7 @@ public static String toHexString(byte[] ba) { /** * Method toHexString - * + * * @param b * byte * @return the hexadecimal representation of the byte @@ -382,7 +382,7 @@ public static String toHexString(byte b) { /** * Description of the Method - * + * * @param s * short * @return Description of the Returned Value @@ -393,7 +393,7 @@ public static String toHexString(short s) { /** * Method toHexString - * + * * @param i * int * @return the hexadecimal representation of the int @@ -404,7 +404,7 @@ public static String toHexString(int i) { /** * Method toHexString - * + * * @param l * long * @return the hexadecimal representation of the long @@ -415,7 +415,7 @@ public static String toHexString(long l) { /** * Method toString - * + * * @param ba * byte array * @return the byte array as string @@ -426,7 +426,7 @@ public static String toString(byte[] ba) { /** * Method toString - * + * * @param b * byte * @return the byte as string @@ -439,7 +439,7 @@ public static String toString(byte b) { /** * converts String to Hex String. Example: niko == 6E696B6F - * + * * @param ba * byte array * @param offset @@ -468,7 +468,7 @@ public static String toHexString(byte[] ba, int offset, int length) { /** * Converts readable hex-String to byteArray - * + * * @param strA * string * @return the hexadecimal string as byte array @@ -678,7 +678,7 @@ public static byte[] hexStringToByteArray(String strA) { /** * Description of the Method - * + * * @param b * Description of Parameter * @param buf @@ -693,7 +693,7 @@ private static void byte2hex(byte b, StringBuffer buf) { /** * Description of the Method - * + * * @param b * Description of Parameter * @param buf @@ -714,7 +714,7 @@ private static void byte2bin(byte b, StringBuffer buf) { /** * Returns a string of 8 hexadecimal digits (most significant digit first) corresponding to the integer n , which is treated as * unsigned. - * + * * @param n * Description of Parameter * @return Description of the Returned Value diff --git a/io/src/main/java/org/red5/io/utils/IOUtils.java b/io/src/main/java/org/red5/io/utils/IOUtils.java index 70a96135c..3156132f3 100644 --- a/io/src/main/java/org/red5/io/utils/IOUtils.java +++ b/io/src/main/java/org/red5/io/utils/IOUtils.java @@ -15,7 +15,7 @@ /** * Miscellaneous I/O utility methods - * + * * @see Unsigned bytes in Java */ public class IOUtils { @@ -27,7 +27,7 @@ public class IOUtils { /** * Writes integer in reverse order - * + * * @param out * Data buffer to fill * @param value @@ -39,7 +39,7 @@ public final static void writeReverseInt(IoBuffer out, int value) { /** * Writes medium integer - * + * * @param out * Output buffer * @param value @@ -55,7 +55,7 @@ public final static void writeMediumInt(IoBuffer out, int value) { /** * Writes medium integer - * + * * @param out * Output buffer * @param value @@ -69,7 +69,7 @@ public final static void writeMediumInt(ByteBuffer out, int value) { /** * Writes extended medium integer (equivalent to a regular integer whose most significant byte has been moved to its end, past its least significant byte) - * + * * @param out * Output buffer * @param value @@ -82,7 +82,7 @@ public final static void writeExtendedMediumInt(IoBuffer out, int value) { /** * Writes extended medium integer (equivalent to a regular integer whose most significant byte has been moved to its end, past its least significant byte) - * + * * @param out * Output buffer * @param value @@ -95,7 +95,7 @@ public final static void writeExtendedMediumInt(ByteBuffer out, int value) { /** * Writes an unsigned byte value to the supplied buffer. - * + * * @param out * Output buffer * @param value @@ -107,7 +107,7 @@ public final static void writeUnsignedByte(ByteBuffer out, byte value) { /** * Reads unsigned medium integer (3 bytes) - * + * * @param in * Unsigned medium int source * @return int value @@ -118,7 +118,7 @@ public final static int readUnsignedMediumInt(ByteBuffer in) { /** * Reads unsigned medium integer (3 bytes) - * + * * @param in * Unsigned medium int source * @return int value @@ -129,7 +129,7 @@ public final static int readUnsignedMediumInt(IoBuffer in) { /** * Reads medium int - * + * * @param in * Source * @return int value @@ -140,7 +140,7 @@ public final static int readMediumInt(ByteBuffer in) { /** * Reads medium int - * + * * @param in * Source * @return int value @@ -151,7 +151,7 @@ public final static int readMediumInt(IoBuffer in) { /** * Reads extended medium int - * + * * @param in * Source * @return int value @@ -164,7 +164,7 @@ public final static int readExtendedMediumInt(IoBuffer in) { /** * Reads extended medium int - * + * * @param in * Source * @return int value @@ -177,7 +177,7 @@ public final static int readExtendedMediumInt(ByteBuffer in) { /** * Reads reverse int - * + * * @param in * Source * @return int @@ -190,7 +190,7 @@ public final static int readReverseInt(IoBuffer in) { /** * Format debug message - * + * * @param log * Logger * @param msg @@ -209,7 +209,7 @@ public final static void debug(Logger log, String msg, IoBuffer buf) { /** * String representation of byte buffer - * + * * @param buf Byte buffer * @return String representation */ @@ -225,7 +225,7 @@ public final static String toString(IoBuffer buf) { /** * Returns a byte array for the given hex encoded string. - * + * * @param s encoded hex string * @return byte array */ diff --git a/io/src/main/java/org/red5/io/utils/LEB128.java b/io/src/main/java/org/red5/io/utils/LEB128.java index 3f9210b7e..e9848fd9b 100644 --- a/io/src/main/java/org/red5/io/utils/LEB128.java +++ b/io/src/main/java/org/red5/io/utils/LEB128.java @@ -9,11 +9,11 @@ /** * This class encodes and decodes integers in the LEB128 compression format. - * - * Reference examples: + * + * Reference examples: * @see leb128.go * @see leb128.dart - * + * * @author The Red5 Project * @author Paul Gregoire (mondain@gmail.com) */ @@ -25,7 +25,7 @@ public final class LEB128 { /** * Encodes an int into an LEB128 unsigned integer. - * + * * @param value integer to encode * @return unsigned integer in LEB128 format */ @@ -46,7 +46,7 @@ public static int encode(int value) { /** * Decodes an LEB128 unsigned integer into a regular int. - * + * * @param value unsigned integer in LEB128 format to decode * @return int */ diff --git a/io/src/main/java/org/red5/io/utils/ObjectMap.java b/io/src/main/java/org/red5/io/utils/ObjectMap.java index 4457cb341..0b9c3baca 100644 --- a/io/src/main/java/org/red5/io/utils/ObjectMap.java +++ b/io/src/main/java/org/red5/io/utils/ObjectMap.java @@ -11,7 +11,7 @@ /** * Map that should be transmitted as object through RTMP. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) * @param diff --git a/io/src/main/java/org/red5/io/utils/RandomGUID.java b/io/src/main/java/org/red5/io/utils/RandomGUID.java index 6bf102205..5636042e3 100644 --- a/io/src/main/java/org/red5/io/utils/RandomGUID.java +++ b/io/src/main/java/org/red5/io/utils/RandomGUID.java @@ -19,7 +19,7 @@ private RandomGUID() { /** * Returns a byte array for the given uuid or guid. - * + * * @param uid * unique id * @return array of bytes containing the id @@ -42,7 +42,7 @@ public final static byte[] toByteArray(String uid) { /** * Returns a uuid / guid for a given byte array. - * + * * @param ba * array of bytes containing the id * @return id @@ -64,7 +64,7 @@ public static String fromByteArray(byte[] ba) { /** * Returns a nice neat formatted string. - * + * * @param str * unformatted string * @return formatted string diff --git a/io/src/main/java/org/red5/io/utils/Stax2DomBuilder.java b/io/src/main/java/org/red5/io/utils/Stax2DomBuilder.java index 22c7a5cf5..1c671b965 100644 --- a/io/src/main/java/org/red5/io/utils/Stax2DomBuilder.java +++ b/io/src/main/java/org/red5/io/utils/Stax2DomBuilder.java @@ -22,7 +22,7 @@ /** * Builds a DOM {@link org.w3c.dom.Document} using a {@link javax.xml.stream.XMLStreamReader}. - * + * * @version $Revision: 1.00 $, $Date: 2004/12/11 00:00:00 $ * @author Tatu Saloranta */ @@ -53,7 +53,7 @@ public Stax2DomBuilder() { * Method used to change whether the build methods will add ignorable (element) white space in the DOM tree or not. *

    * Whether all-whitespace text segment is ignorable white space or not is based on DTD read in, as per XML specifications (white space is only significant in mixed content or pure text elements). - * + * * @param ignoreWS * true to ignore whitespace; false otherwise. */ @@ -63,7 +63,7 @@ public void setIgnoreWhitespace(boolean ignoreWS) { /** * This method will create a {@link org.w3c.dom.Document} instance using the default JAXP mechanism and populate using the given StAX stream reader. - * + * * @param r * Stream reader from which input is read. * @return Document - DOM document object. @@ -84,7 +84,7 @@ public Document build(XMLStreamReader r, DocumentBuilder docbuilder) throws XMLS /** * This method will populate given {@link org.w3c.dom.Document} using the given StAX stream reader instance. - * + * * @param r * Stream reader from which input is read. * @param doc @@ -98,7 +98,7 @@ public void build(XMLStreamReader r, Document doc) throws XMLStreamException { /** * This method takes a XMLStreamReader and builds up a JDOM tree. Recursion has been eliminated by using nodes' parent/child relationship; this improves performance somewhat (classic recursion-by-iteration-and-explicit stack transformation) - * + * * @param r * Stream reader to use for reading the document from which to build the tree * @param doc diff --git a/io/src/main/java/org/red5/io/utils/XMLUtils.java b/io/src/main/java/org/red5/io/utils/XMLUtils.java index fd3b32077..75fecbd04 100644 --- a/io/src/main/java/org/red5/io/utils/XMLUtils.java +++ b/io/src/main/java/org/red5/io/utils/XMLUtils.java @@ -42,7 +42,7 @@ public class XMLUtils { /** * Converts string representation of XML into Document - * + * * @param str * String representation of XML * @return DOM object @@ -67,7 +67,7 @@ public static Document stringToDoc(String str) throws IOException { /** * Converts doc to String - * + * * @param dom * DOM object to convert * @return XML as String @@ -78,7 +78,7 @@ public static String docToString(Document dom) { /** * Convert a DOM tree into a String using Dom2Writer - * + * * @return XML as String * @param dom * DOM object to convert @@ -91,7 +91,7 @@ public static String docToString1(Document dom) { /** * Convert a DOM tree into a String using transform - * + * * @param domDoc * DOM object * @throws java.io.IOException diff --git a/io/src/main/java/org/red5/io/webm/TagConsumer.java b/io/src/main/java/org/red5/io/webm/TagConsumer.java index 9a7eb5627..d6b904645 100644 --- a/io/src/main/java/org/red5/io/webm/TagConsumer.java +++ b/io/src/main/java/org/red5/io/webm/TagConsumer.java @@ -18,7 +18,7 @@ public interface TagConsumer { /** * Method will be called as soon as webm Tag is available - * + * * @param tag * - tag to be processed * @throws IOException diff --git a/io/src/main/java/org/red5/io/webm/WebmReader.java b/io/src/main/java/org/red5/io/webm/WebmReader.java index 2aeaf0de7..e39448212 100644 --- a/io/src/main/java/org/red5/io/webm/WebmReader.java +++ b/io/src/main/java/org/red5/io/webm/WebmReader.java @@ -39,7 +39,7 @@ public class WebmReader implements Closeable { /** * Constructor - * + * * @param file * - file to be read * @param processor @@ -115,7 +115,7 @@ public TagHandler createSkipHandler() { /** * will process given file and send all tags found to the consumer - * + * * @throws IOException * - in case of any exception during reading and/or consumeng * @throws ConverterException diff --git a/io/src/main/java/org/red5/io/webm/WebmWriter.java b/io/src/main/java/org/red5/io/webm/WebmWriter.java index 1f676405f..0e9420382 100644 --- a/io/src/main/java/org/red5/io/webm/WebmWriter.java +++ b/io/src/main/java/org/red5/io/webm/WebmWriter.java @@ -44,7 +44,7 @@ public class WebmWriter implements Closeable, TagConsumer { /** * Constructor - * + * * @param file * - file the data need to written to * @param append @@ -82,7 +82,7 @@ public WebmWriter(File file, boolean append) { /** * method to write webm header to the new file - * + * * @throws IOException * - in case of IO errors * @throws ConverterException @@ -106,7 +106,7 @@ public void writeHeader() throws IOException, ConverterException { /** * will write tag bytesWritten counter will be increased by the number of bytes actually written - * + * * @param tag * - tag to be written * @throws IOException diff --git a/io/src/main/java/org/red5/media/processor/GenericWriterPostProcessor.java b/io/src/main/java/org/red5/media/processor/GenericWriterPostProcessor.java index 803c6610e..98c93f467 100644 --- a/io/src/main/java/org/red5/media/processor/GenericWriterPostProcessor.java +++ b/io/src/main/java/org/red5/media/processor/GenericWriterPostProcessor.java @@ -18,7 +18,7 @@ /** * Example post-processor implementation which counts data types in a given file. - * + * * @author Paul Gregoire (mondain@gmail.com) */ public class GenericWriterPostProcessor implements IPostProcessor { diff --git a/io/src/main/java/org/red5/media/processor/IPostProcessor.java b/io/src/main/java/org/red5/media/processor/IPostProcessor.java index e5dd40683..7c7170ae0 100644 --- a/io/src/main/java/org/red5/media/processor/IPostProcessor.java +++ b/io/src/main/java/org/red5/media/processor/IPostProcessor.java @@ -9,14 +9,14 @@ /** * Post processes media. - * + * * @author Paul Gregoire (mondain@gmail.com) */ public interface IPostProcessor extends Runnable { /** * Initialize processor with given objects. - * + * * @param objs Objects for processing */ void init(Object... objs); diff --git a/io/src/main/java/org/red5/media/processor/IPreProcessor.java b/io/src/main/java/org/red5/media/processor/IPreProcessor.java index d254ed6dd..7ef99f789 100644 --- a/io/src/main/java/org/red5/media/processor/IPreProcessor.java +++ b/io/src/main/java/org/red5/media/processor/IPreProcessor.java @@ -9,14 +9,14 @@ /** * Pre-processes media. - * + * * @author Paul Gregoire (mondain@gmail.com) */ public interface IPreProcessor extends Runnable { /** * Initialize processor with given objects. - * + * * @param objs Objects for processing */ void init(Object... objs); diff --git a/io/src/test/java/org/red5/codec/AVCVideoTest.java b/io/src/test/java/org/red5/codec/AVCVideoTest.java index c33e6ebf9..9cd4e6d84 100644 --- a/io/src/test/java/org/red5/codec/AVCVideoTest.java +++ b/io/src/test/java/org/red5/codec/AVCVideoTest.java @@ -37,7 +37,7 @@ public void testCanHandleData() { IoBuffer data = IoBuffer.allocate(8); data.put((byte) 0x17); data.flip(); - // + // IoBuffer badData = IoBuffer.allocate(8); badData.put((byte) 0x44); badData.flip(); diff --git a/io/src/test/java/org/red5/io/AMFIOTest.java b/io/src/test/java/org/red5/io/AMFIOTest.java index ff91a35e7..f8ca49a44 100644 --- a/io/src/test/java/org/red5/io/AMFIOTest.java +++ b/io/src/test/java/org/red5/io/AMFIOTest.java @@ -26,7 +26,7 @@ /** * AMF I/O test - * + * * @author The Red5 Project * @author Luke Hubbard, Codegent Ltd (luke@codegent.com) * @author Paul Gregoire (mondain@gmail.com) @@ -78,7 +78,7 @@ public void testAMF0Wiki() { /** * Sample data from https://en.wikipedia.org/wiki/Action_Message_Format - * @throws Exception + * @throws Exception */ @Test public void testAMF0Wiki2() throws Exception { diff --git a/io/src/test/java/org/red5/io/TestJavaBean.java b/io/src/test/java/org/red5/io/TestJavaBean.java index e16473295..2d493fc05 100644 --- a/io/src/test/java/org/red5/io/TestJavaBean.java +++ b/io/src/test/java/org/red5/io/TestJavaBean.java @@ -31,7 +31,7 @@ public class TestJavaBean { /** * Getter for property 'testByte'. - * + * * @return Value for property 'testByte'. */ public byte getTestByte() { @@ -40,7 +40,7 @@ public byte getTestByte() { /** * Setter for property 'testByte'. - * + * * @param testByte * Value to set for property 'testByte'. */ @@ -50,7 +50,7 @@ public void setTestByte(byte testByte) { /** * Getter for property 'testBoolean'. - * + * * @return Value for property 'testBoolean'. */ public boolean isTestBoolean() { @@ -59,7 +59,7 @@ public boolean isTestBoolean() { /** * Setter for property 'testBoolean'. - * + * * @param testBoolean * Value to set for property 'testBoolean'. */ @@ -69,7 +69,7 @@ public void setTestBoolean(boolean testBoolean) { /** * Getter for property 'testBooleanObject'. - * + * * @return Value for property 'testBooleanObject'. */ public Boolean getTestBooleanObject() { @@ -78,7 +78,7 @@ public Boolean getTestBooleanObject() { /** * Setter for property 'testBooleanObject'. - * + * * @param testBooleanObject * Value to set for property 'testBooleanObject'. */ @@ -88,7 +88,7 @@ public void setTestBooleanObject(Boolean testBooleanObject) { /** * Getter for property 'testDate'. - * + * * @return Value for property 'testDate'. */ public Date getTestDate() { @@ -97,7 +97,7 @@ public Date getTestDate() { /** * Setter for property 'testDate'. - * + * * @param testDate * Value to set for property 'testDate'. */ @@ -107,7 +107,7 @@ public void setTestDate(Date testDate) { /** * Getter for property 'testNumberObject'. - * + * * @return Value for property 'testNumberObject'. */ public Integer getTestNumberObject() { @@ -116,7 +116,7 @@ public Integer getTestNumberObject() { /** * Setter for property 'testNumberObject'. - * + * * @param testNumberObject * Value to set for property 'testNumberObject'. */ @@ -126,7 +126,7 @@ public void setTestNumberObject(Integer testNumberObject) { /** * Getter for property 'testPrimitiveNumber'. - * + * * @return Value for property 'testPrimitiveNumber'. */ public int getTestPrimitiveNumber() { @@ -135,7 +135,7 @@ public int getTestPrimitiveNumber() { /** * Setter for property 'testPrimitiveNumber'. - * + * * @param testPrimitiveNumber * Value to set for property 'testPrimitiveNumber'. */ @@ -145,7 +145,7 @@ public void setTestPrimitiveNumber(int testPrimitiveNumber) { /** * Getter for property 'testString'. - * + * * @return Value for property 'testString'. */ public String getTestString() { @@ -154,7 +154,7 @@ public String getTestString() { /** * Setter for property 'testString'. - * + * * @param testString * Value to set for property 'testString'. */ diff --git a/io/src/test/java/org/red5/io/matroska/EncoderTest.java b/io/src/test/java/org/red5/io/matroska/EncoderTest.java index c3256ce2a..b60c37c63 100644 --- a/io/src/test/java/org/red5/io/matroska/EncoderTest.java +++ b/io/src/test/java/org/red5/io/matroska/EncoderTest.java @@ -30,7 +30,7 @@ public class EncoderTest { /** * tests if created and parsed {@link Tag}s have same IDs - * + * * @throws IOException * - in case of any IO errors * @throws ConverterException @@ -56,7 +56,7 @@ public void testCreateTags() throws IOException, ConverterException { /** * tests if manually created and encoded "master" {@link Tag} can be parsed successfully - * + * * @throws IOException * - in case of any IO errors * @throws ConverterException @@ -80,7 +80,7 @@ public void testEncodeTagEBML() throws IOException, ConverterException { /** * tests if manually created and encoded "uint" {@link Tag} can be parsed successfully - * + * * @throws IOException * - in case of any IO errors * @throws ConverterException @@ -102,7 +102,7 @@ public void testEncodeTagUint() throws IOException, ConverterException { /** * tests if manually created and encoded "string" {@link Tag} can be parsed successfully - * + * * @throws IOException * - in case of any IO errors * @throws ConverterException @@ -124,7 +124,7 @@ public void testEncodeTagString() throws IOException, ConverterException { /** * tests if manually created and encoded "double" {@link Tag} can be parsed successfully - * + * * @throws IOException * - in case of any IO errors * @throws ConverterException @@ -146,7 +146,7 @@ public void testEncodeTagDouble() throws IOException, ConverterException { /** * tests if manually created and encoded "date" {@link Tag} can be parsed successfully - * + * * @throws IOException * - in case of any IO errors * @throws ConverterException diff --git a/io/src/test/java/org/red5/io/matroska/ParserTest.java b/io/src/test/java/org/red5/io/matroska/ParserTest.java index 76e23825e..f540a5831 100644 --- a/io/src/test/java/org/red5/io/matroska/ParserTest.java +++ b/io/src/test/java/org/red5/io/matroska/ParserTest.java @@ -51,7 +51,7 @@ public class ParserTest { /** * tests if EBML tag parsed as expected - * + * * @throws IOException * - in case of any IO errors * @throws ConverterException @@ -71,7 +71,7 @@ public void testParseTagEBML() throws IOException, ConverterException { /** * tests if EBMLVersion tag parsed as expected - * + * * @throws IOException * - in case of any IO errors * @throws ConverterException @@ -93,7 +93,7 @@ public void testParseTagEBMLVersion() throws IOException, ConverterException { /** * tests if EBMLReadVersion tag parsed as expected - * + * * @throws IOException * - in case of any IO errors * @throws ConverterException @@ -115,7 +115,7 @@ public void testParseTagEBMLReadVersion() throws IOException, ConverterException /** * tests if DocType tag parsed as expected - * + * * @throws IOException * - in case of any IO errors * @throws ConverterException diff --git a/io/src/test/java/org/red5/io/matroska/VintTest.java b/io/src/test/java/org/red5/io/matroska/VintTest.java index ffb88051d..68d12031a 100644 --- a/io/src/test/java/org/red5/io/matroska/VintTest.java +++ b/io/src/test/java/org/red5/io/matroska/VintTest.java @@ -57,7 +57,7 @@ public void createVINT() { /** * tests if {@link VINT} can be parsed successfully - * + * * @throws IOException * - in case of any IO errors */ diff --git a/io/src/test/java/org/red5/io/mp4/impl/MP4ReaderTest.java b/io/src/test/java/org/red5/io/mp4/impl/MP4ReaderTest.java index b95e00ccc..3c68b2f66 100644 --- a/io/src/test/java/org/red5/io/mp4/impl/MP4ReaderTest.java +++ b/io/src/test/java/org/red5/io/mp4/impl/MP4ReaderTest.java @@ -56,7 +56,7 @@ public void testCtor() throws Exception { @Test public void testBytes() throws Exception { - //00 40 94 00 00 00 00 00 00 00 06 == + //00 40 94 00 00 00 00 00 00 00 06 == byte width[] = { (byte) 0x00, (byte) 0x40, (byte) 0x94, (byte) 0x00, (byte) 0x00, (byte) 0x00, (byte) 0x00, (byte) 0x00 }; System.out.println("width: {}" + bytesToLong(width)); @@ -92,10 +92,10 @@ public void testBytes() throws Exception { // (byte) 0x00, (byte) 0x00, (byte) 0x00, (byte) 0x00, (byte) 0x00 }; // System.out.println("moovposition: {}" + bytesToLong(moovposition)); // - // + // //byte[] arr = {(byte) 0x0f}; //System.out.println("bbb: {}" + bytesToByte(arr)); - //byte[] arr = {(byte) 0xE5, (byte) 0x88, (byte) 0x80, (byte) 0x00, + //byte[] arr = {(byte) 0xE5, (byte) 0x88, (byte) 0x80, (byte) 0x00, //(byte) 0x00, (byte) 0x00, (byte) 0x00, (byte) 0x00 }; //System.out.println("bbb: {}" + bytesToLong(arr)); byte[] arr = { (byte) 0, (byte) 0, (byte) 0x10, (byte) 0 }; diff --git a/io/src/test/java/org/red5/io/utils/IOUtilsTest.java b/io/src/test/java/org/red5/io/utils/IOUtilsTest.java index 3dfc5f9c4..18a553177 100644 --- a/io/src/test/java/org/red5/io/utils/IOUtilsTest.java +++ b/io/src/test/java/org/red5/io/utils/IOUtilsTest.java @@ -68,7 +68,7 @@ public void testReadReverseInt() { value += bytes[0]; System.out.printf("Results #1 - result: %d\n", value); assertTrue(ok == value); - // optimized + // optimized in.flip(); value = in.getInt(); value = ((value & 0xFF) << 24 | ((value >> 8) & 0x00FF) << 16 | ((value >>> 16) & 0x000000FF) << 8 | ((value >>> 24) & 0x000000FF)); diff --git a/io/src/test/java/org/red5/io/webm/WebmTest.java b/io/src/test/java/org/red5/io/webm/WebmTest.java index 2b8b397c9..0d1aec34f 100644 --- a/io/src/test/java/org/red5/io/webm/WebmTest.java +++ b/io/src/test/java/org/red5/io/webm/WebmTest.java @@ -40,7 +40,7 @@ public void before() { /** * This test checks if test webm file can be read till the end with no exceptions - * + * * @throws IOException * - in case of any IO exception * @throws ConverterException @@ -71,7 +71,7 @@ public TagHandler getHandler(Tag tag) { /** * This test checks if test webm file can be read and then be written with no exceptions - * + * * @throws IOException * - in case of any IO exception * @throws ConverterException diff --git a/io/src/test/java/org/red5/test/Foo.java b/io/src/test/java/org/red5/test/Foo.java index ff83230c6..828754d5a 100644 --- a/io/src/test/java/org/red5/test/Foo.java +++ b/io/src/test/java/org/red5/test/Foo.java @@ -6,7 +6,7 @@ /** * Used for testing AMF3 Vectors - * + * * @author Paul */ public class Foo implements IExternalizable { diff --git a/io/src/test/java/org/red5/test/Foo3.java b/io/src/test/java/org/red5/test/Foo3.java index 93466ed4d..3ffb0a58a 100644 --- a/io/src/test/java/org/red5/test/Foo3.java +++ b/io/src/test/java/org/red5/test/Foo3.java @@ -6,7 +6,7 @@ /** * Used for testing AMF3 Vectors - * + * * @author Paul */ public class Foo3 implements IExternalizable { diff --git a/pom.xml b/pom.xml index af5bf9858..3e751c4b2 100644 --- a/pom.xml +++ b/pom.xml @@ -23,7 +23,7 @@ Red5 The Red5 server org.red5 - 1.2.24 + 1.2.31 https://github.com/Red5/red5-server 2005 @@ -354,7 +354,7 @@ net.revelc.code.formatter formatter-maven-plugin - 2.8.1 + 2.19.0 @@ -363,7 +363,7 @@ - ../red5-eclipse-format.xml + ${project.parent.basedir}/red5-eclipse-format.xml LF diff --git a/server/pom.xml b/server/pom.xml index e2e564fcd..8536d0807 100644 --- a/server/pom.xml +++ b/server/pom.xml @@ -3,7 +3,7 @@ org.red5 red5-parent - 1.2.24 + 1.2.31 4.0.0 red5-server diff --git a/server/src/main/java/Version.java b/server/src/main/java/Version.java index e66d0beb0..7e004bbfb 100644 --- a/server/src/main/java/Version.java +++ b/server/src/main/java/Version.java @@ -2,7 +2,7 @@ /** * Provides information about the version of Red5 being used. - * + * * @author Paul Gregoire */ public class Version { diff --git a/server/src/main/java/org/red5/logging/ContextLoggingListener.java b/server/src/main/java/org/red5/logging/ContextLoggingListener.java index 834eb72e1..71cde7a8b 100644 --- a/server/src/main/java/org/red5/logging/ContextLoggingListener.java +++ b/server/src/main/java/org/red5/logging/ContextLoggingListener.java @@ -24,7 +24,7 @@ /** * A servlet context listener that puts this contexts LoggerContext into a static map of logger contexts within an overall singleton log context selector. - * + * * To use it, add the following line to a web.xml file * *

    diff --git a/server/src/main/java/org/red5/logging/LoggerContextFilter.java b/server/src/main/java/org/red5/logging/LoggerContextFilter.java
    index 735084762..56c0c3795 100644
    --- a/server/src/main/java/org/red5/logging/LoggerContextFilter.java
    +++ b/server/src/main/java/org/red5/logging/LoggerContextFilter.java
    @@ -25,7 +25,7 @@
     
     /**
      * A servlet filter that puts this contexts LoggerContext into a Threadlocal variable.
    - * 
    + *
      * It removes it after the request is processed.
      *
      * To use it, add the following lines to a web.xml file
    diff --git a/server/src/main/java/org/red5/logging/W3CAppender.java b/server/src/main/java/org/red5/logging/W3CAppender.java
    index 1d917e74b..6ef8109d7 100644
    --- a/server/src/main/java/org/red5/logging/W3CAppender.java
    +++ b/server/src/main/java/org/red5/logging/W3CAppender.java
    @@ -25,7 +25,7 @@
     
     /**
      * Logback appender for the Extended W3C format.
    - * 
    + *
      * @see "http://www.w3.org/TR/WD-logfile.html"
      * @author Paul Gregoire (mondain@gmail.com)
      */
    @@ -122,23 +122,23 @@ public synchronized void doAppend(LoggingEvent event) {
             }
             //Events					Categories
             //connect-pending			session
    -        //connect					session                     
    -        //disconnect                session                     
    -        //publish                   stream                         
    -        //unpublish                 stream                  
    -        //play                      stream                       
    -        //pause                     stream                     
    -        //unpause                   stream                      
    -        //seek                      stream                              
    -        //stop                      stream                       
    -        //record                    stream                              
    -        //recordstop                stream                              
    -        //server-start              server                              
    -        //server-stop               server                              
    -        //vhost-start               vhost                               
    -        //vhost-stop                vhost                               
    -        //app-start                 application                         
    -        //app-stop                  application    
    +        //connect					session
    +        //disconnect                session
    +        //publish                   stream
    +        //unpublish                 stream
    +        //play                      stream
    +        //pause                     stream
    +        //unpause                   stream
    +        //seek                      stream
    +        //stop                      stream
    +        //record                    stream
    +        //recordstop                stream
    +        //server-start              server
    +        //server-stop               server
    +        //vhost-start               vhost
    +        //vhost-stop                vhost
    +        //app-start                 application
    +        //app-stop                  application
             //filter based on event type - asterik allows all events
             if (!events.equals("*")) {
                 if (!eventsList.contains(elements.get("x-event"))) {
    @@ -148,46 +148,46 @@ public synchronized void doAppend(LoggingEvent event) {
                     return;
                 }
             }
    -        //x-category		event category		
    +        //x-category		event category
             //x-event			type of event
             //date				date at which the event occurred
             //time				time at which the event occurred
    -        //tz               	time zone information                           
    -        //x-ctx            	event dependant context information             
    -        //s-ip		        ip address[es] of the server                    
    -        //x-pid            	server process id                               
    -        //x-cpu-load       	cpu load                                        
    -        //x-mem-load       	memory load (as reported in getServerStats)     
    -        //x-adaptor        	adaptor name                                    
    -        //x-vhost          	vhost name                                      
    -        //x-app	          	application name                                
    -        //x-appinst        	application instance name                       
    -        //x-duration	    duration of an event/session                    
    -        //x-status		    status code					                            
    -        //c-ip             	client ip address                               
    -        //c-proto          	connection protocol - rtmp or rtmpt             
    -        //s-uri            	uri of the fms application                      
    -        //cs-uri-stem      	stem of s-uri                                   
    -        //cs-uri-query     	query portion of s-uri                          
    -        //c-referrer       	uri of the referrer                             
    -        //c-user-agent     	user agent                                      
    -        //c-client-id      	client id                                       
    -        //cs-bytes         	bytes transferred from client to server         
    -        //sc-bytes         	bytes transferred from server to client         
    -        //c-connect-type   	type of connection received by the server       
    -        //x-sname          	stream name                                     
    -        //x-sname-query    	query portion of stream uri                     
    -        //x-suri-query		same as x-sname-query              	
    -        //x-suri-stem		cs-uri-stem + x-sname + x-file-ext       	
    -        //x-suri			x-suri-stem + x-suri-query         
    -        //x-file-name      	full file path of recorded stream               
    -        //x-file-ext       	stream type (flv or mp3)                        
    -        //x-file-size      	stream size in bytes                            
    -        //x-file-length    	stream length in seconds                        
    -        //x-spos           	stream position                                 
    -        //cs-stream-bytes  	stream bytes transferred from client to server  
    -        //sc-stream-bytes  	stream bytes transferred from server to client  
    -        //x-service-name   	name of the service providing the connection    
    +        //tz               	time zone information
    +        //x-ctx            	event dependant context information
    +        //s-ip		        ip address[es] of the server
    +        //x-pid            	server process id
    +        //x-cpu-load       	cpu load
    +        //x-mem-load       	memory load (as reported in getServerStats)
    +        //x-adaptor        	adaptor name
    +        //x-vhost          	vhost name
    +        //x-app	          	application name
    +        //x-appinst        	application instance name
    +        //x-duration	    duration of an event/session
    +        //x-status		    status code
    +        //c-ip             	client ip address
    +        //c-proto          	connection protocol - rtmp or rtmpt
    +        //s-uri            	uri of the fms application
    +        //cs-uri-stem      	stem of s-uri
    +        //cs-uri-query     	query portion of s-uri
    +        //c-referrer       	uri of the referrer
    +        //c-user-agent     	user agent
    +        //c-client-id      	client id
    +        //cs-bytes         	bytes transferred from client to server
    +        //sc-bytes         	bytes transferred from server to client
    +        //c-connect-type   	type of connection received by the server
    +        //x-sname          	stream name
    +        //x-sname-query    	query portion of stream uri
    +        //x-suri-query		same as x-sname-query
    +        //x-suri-stem		cs-uri-stem + x-sname + x-file-ext
    +        //x-suri			x-suri-stem + x-suri-query
    +        //x-file-name      	full file path of recorded stream
    +        //x-file-ext       	stream type (flv or mp3)
    +        //x-file-size      	stream size in bytes
    +        //x-file-length    	stream length in seconds
    +        //x-spos           	stream position
    +        //cs-stream-bytes  	stream bytes transferred from client to server
    +        //sc-stream-bytes  	stream bytes transferred from server to client
    +        //x-service-name   	name of the service providing the connection
             //x-sc-qos-bytes	bytes transferred from server to client for quality of service
             //x-comment	      	comments
             //we may need date and/or time
    diff --git a/server/src/main/java/org/red5/net/websocket/WSConstants.java b/server/src/main/java/org/red5/net/websocket/WSConstants.java
    index 699e14139..de323617c 100644
    --- a/server/src/main/java/org/red5/net/websocket/WSConstants.java
    +++ b/server/src/main/java/org/red5/net/websocket/WSConstants.java
    @@ -9,7 +9,7 @@
     
     /**
      * Convenience class for holding constants.
    - * 
    + *
      * @author Paul Gregoire
      */
     public class WSConstants {
    diff --git a/server/src/main/java/org/red5/net/websocket/WebSocketPlugin.java b/server/src/main/java/org/red5/net/websocket/WebSocketPlugin.java
    index 0489e885a..a466c9ce1 100644
    --- a/server/src/main/java/org/red5/net/websocket/WebSocketPlugin.java
    +++ b/server/src/main/java/org/red5/net/websocket/WebSocketPlugin.java
    @@ -45,7 +45,7 @@
     /**
      * WebSocketPlugin - centralized WebSocket configuration and locator. 
    * This plugin will be called by Red5 plugin launcher to associate application components with WebSockets. - * + * * @author Paul Gregoire */ public class WebSocketPlugin extends Red5Plugin { @@ -139,7 +139,7 @@ public void doStop() throws Exception { /** * Configures a websocket scope for a given application scope. - * + * * @param scope * Server application scope */ @@ -169,7 +169,7 @@ private void configureApplicationScopeWebSocket(IScope scope) { /** * Configures a websocket scope for a given room scope. - * + * * @param scope * Server room scope */ @@ -205,7 +205,7 @@ private void configureRoomScopeWebSocket(IScope scope) { /** * Submit a task for execution. - * + * * @param task * @return Future */ @@ -227,7 +227,7 @@ public Server getServer() { /** * Returns the application scope for a given path. - * + * * @param path * @return IScope */ @@ -240,7 +240,7 @@ public IScope getApplicationScope(String path) { /** * Returns a WebSocketScopeManager for a given scope. - * + * * @param scope * @return WebSocketScopeManager if registered for the given scope and null otherwise */ @@ -250,7 +250,7 @@ public WebSocketScopeManager getManager(IScope scope) { /** * Returns a WebSocketScopeManager for a given path. - * + * * @param path * @return WebSocketScopeManager if registered for the given path and null otherwise */ @@ -293,7 +293,7 @@ public WebSocketScopeManager removeManager(IScope scope) { /** * Returns a DefaultWsServerContainer for a given path. - * + * * @param path * @return DefaultWsServerContainer */ @@ -342,7 +342,7 @@ public void setAllowedOrigins(String[] allowedOrigins) { /** * Returns an new instance of the configurator. - * + * * @return configurator */ public static Configurator getWsConfiguratorInstance() { @@ -352,7 +352,7 @@ public static Configurator getWsConfiguratorInstance() { /** * Returns a new instance of WsServerContainer if one does not already exist. - * + * * @param servletContext * @return WsServerContainer */ diff --git a/server/src/main/java/org/red5/net/websocket/WebSocketScope.java b/server/src/main/java/org/red5/net/websocket/WebSocketScope.java index 542c05a29..418c12b93 100644 --- a/server/src/main/java/org/red5/net/websocket/WebSocketScope.java +++ b/server/src/main/java/org/red5/net/websocket/WebSocketScope.java @@ -24,7 +24,7 @@ /** * WebSocketScope contains an IScope and keeps track of WebSocketConnection and IWebSocketDataListener instances. - * + * * @author Paul Gregoire (mondain@gmail.com) */ public class WebSocketScope implements InitializingBean, DisposableBean { @@ -90,7 +90,7 @@ public void unregister() { /** * Returns a connection matching the given HttpSession id. - * + * * @param id * @return WebSocketConnection for the given id or null if not found */ @@ -104,7 +104,7 @@ public WebSocketConnection getConnectionBySessionId(String id) { /** * Returns the set of connections. - * + * * @return conns */ public Set getConns() { @@ -113,7 +113,7 @@ public Set getConns() { /** * Returns the associated scope. - * + * * @return scope */ public IScope getScope() { @@ -122,7 +122,7 @@ public IScope getScope() { /** * Sets the associated scope. - * + * * @param scope */ public void setScope(IScope scope) { @@ -133,7 +133,7 @@ public void setScope(IScope scope) { /** * Sets the path. - * + * * @param path */ public void setPath(String path) { @@ -142,7 +142,7 @@ public void setPath(String path) { /** * Returns the path of the scope. - * + * * @return path */ public String getPath() { @@ -151,7 +151,7 @@ public String getPath() { /** * Add new connection on scope. - * + * * @param conn WebSocketConnection */ public void addConnection(WebSocketConnection conn) { @@ -166,7 +166,7 @@ public void addConnection(WebSocketConnection conn) { /** * Remove connection from scope. - * + * * @param conn WebSocketConnection */ public void removeConnection(WebSocketConnection conn) { @@ -181,7 +181,7 @@ public void removeConnection(WebSocketConnection conn) { /** * Add new listener on scope. - * + * * @param listener IWebSocketDataListener */ public void addListener(IWebSocketDataListener listener) { @@ -191,7 +191,7 @@ public void addListener(IWebSocketDataListener listener) { /** * Remove listener from scope. - * + * * @param listener IWebSocketDataListener */ public void removeListener(IWebSocketDataListener listener) { @@ -201,7 +201,7 @@ public void removeListener(IWebSocketDataListener listener) { /** * Add new listeners on scope. - * + * * @param listeners * list of IWebSocketDataListener */ @@ -212,7 +212,7 @@ public void setListeners(Collection listeners) { /** * Returns the listeners in an unmodifiable set. - * + * * @return listeners */ public Set getListeners() { @@ -221,7 +221,7 @@ public Set getListeners() { /** * Checks for a listener by class type. - * + * * @param clazz * @return true if one exists and false otherwise */ @@ -231,7 +231,7 @@ public boolean hasListener(Class clazz) { /** * Check the scope state. - * + * * @return true:still have relation */ public boolean isValid() { @@ -240,7 +240,7 @@ public boolean isValid() { /** * Message received from client and passed on to the listeners. - * + * * @param message */ public void onMessage(WSMessage message) { diff --git a/server/src/main/java/org/red5/net/websocket/WebSocketScopeManager.java b/server/src/main/java/org/red5/net/websocket/WebSocketScopeManager.java index 10ff28af4..99c649a25 100644 --- a/server/src/main/java/org/red5/net/websocket/WebSocketScopeManager.java +++ b/server/src/main/java/org/red5/net/websocket/WebSocketScopeManager.java @@ -56,7 +56,7 @@ public void removeListener(IWebSocketScopeListener listener) { /** * Returns the enable state of a given path. - * + * * @param path * scope / context path * @return enabled if registered as active and false otherwise @@ -80,7 +80,7 @@ public boolean isEnabled(String path) { /** * Adds a scope to the enabled applications. - * + * * @param scope * the application scope */ @@ -116,7 +116,7 @@ public void addScope(IScope scope) { /** * Removes the application scope. - * + * * @param scope * the application scope */ @@ -126,7 +126,7 @@ public void removeApplication(IScope scope) { /** * Adds a websocket scope. - * + * * @param webSocketScope * @return true if added and false otherwise */ @@ -142,7 +142,7 @@ public boolean addWebSocketScope(WebSocketScope webSocketScope) { /** * Removes a websocket scope. - * + * * @param webSocketScope * @return true if removed and false otherwise */ @@ -158,7 +158,7 @@ public boolean removeWebSocketScope(WebSocketScope webSocketScope) { /** * Add the connection on scope. - * + * * @param conn * WebSocketConnection */ @@ -169,7 +169,7 @@ public void addConnection(WebSocketConnection conn) { /** * Remove connection from scope. - * + * * @param conn * WebSocketConnection */ @@ -188,7 +188,7 @@ public void removeConnection(WebSocketConnection conn) { /** * Add the listener on scope via its path. - * + * * @param listener * IWebSocketDataListener * @param path @@ -205,7 +205,7 @@ public void addListener(IWebSocketDataListener listener, String path) { /** * Remove listener from scope via its path. - * + * * @param listener * IWebSocketDataListener * @param path @@ -226,7 +226,7 @@ public void removeListener(IWebSocketDataListener listener, String path) { /** * Create a web socket scope. Use the IWebSocketScopeListener interface to configure the created scope. - * + * * @param path */ public void makeScope(String path) { @@ -246,7 +246,7 @@ public void makeScope(String path) { /** * Create a web socket scope from a server IScope. Use the IWebSocketScopeListener interface to configure the created scope. - * + * * @param scope */ public void makeScope(IScope scope) { @@ -270,7 +270,7 @@ public void makeScope(IScope scope) { /** * Get the corresponding scope. - * + * * @param path * scope path * @return scope @@ -288,7 +288,7 @@ public WebSocketScope getScope(String path) { /** * Notifies listeners of scope lifecycle events. - * + * * @param event * @param wsScope */ @@ -313,7 +313,7 @@ private void notifyListeners(WebSocketEvent event, WebSocketScope wsScope) { /** * Get the corresponding scope, if none exists, make new one. - * + * * @param conn * @return wsScope */ @@ -352,7 +352,7 @@ public void stop() { /** * Set the application scope for this manager. - * + * * @param appScope * @return true if added and false otherwise */ diff --git a/server/src/main/java/org/red5/net/websocket/listener/DefaultWebSocketDataListener.java b/server/src/main/java/org/red5/net/websocket/listener/DefaultWebSocketDataListener.java index 39ce5ef77..2004f6df8 100644 --- a/server/src/main/java/org/red5/net/websocket/listener/DefaultWebSocketDataListener.java +++ b/server/src/main/java/org/red5/net/websocket/listener/DefaultWebSocketDataListener.java @@ -22,7 +22,7 @@ /** * Default WebSocket data listener. In this default implementation, all messages are echoed back to every connection in the current scope. - * + * * @author Paul Gregoire (mondain@gmail.com) */ public class DefaultWebSocketDataListener extends WebSocketDataListener { @@ -44,7 +44,7 @@ public void onWSMessage(WSMessage message) { // assume we have text String msg = new String(message.getPayload().array()); log.info("onWSMessage: {}", msg); - // get the path + // get the path String path = message.getPath(); // just echo back the message WebSocketScopeManager manager = ((WebSocketPlugin) PluginRegistry.getPlugin(WebSocketPlugin.NAME)).getManager(path); diff --git a/server/src/main/java/org/red5/net/websocket/listener/IWebSocketDataListener.java b/server/src/main/java/org/red5/net/websocket/listener/IWebSocketDataListener.java index e4ef5117b..87c2d73ae 100644 --- a/server/src/main/java/org/red5/net/websocket/listener/IWebSocketDataListener.java +++ b/server/src/main/java/org/red5/net/websocket/listener/IWebSocketDataListener.java @@ -17,28 +17,28 @@ public interface IWebSocketDataListener { /** * Returns the protocol for which this listener is interested. - * + * * @return protocol */ public String getProtocol(); /** * Sets the protocol for which this listener is interested. - * + * * @param protocol */ public void setProtocol(String protocol); /** * Dispatch message. - * + * * @param message */ public void onWSMessage(WSMessage message); /** * Connect a WebSocket client. - * + * * @param conn * WebSocketConnection */ @@ -46,7 +46,7 @@ public interface IWebSocketDataListener { /** * Disconnect WebSocket client. - * + * * @param conn * WebSocketConnection */ diff --git a/server/src/main/java/org/red5/net/websocket/listener/WebSocketDataListener.java b/server/src/main/java/org/red5/net/websocket/listener/WebSocketDataListener.java index 20a36e848..eb758a930 100644 --- a/server/src/main/java/org/red5/net/websocket/listener/WebSocketDataListener.java +++ b/server/src/main/java/org/red5/net/websocket/listener/WebSocketDataListener.java @@ -9,7 +9,7 @@ /** * Adapter class for WebSocket data listener interface. - * + * * @author Paul Gregoire */ public abstract class WebSocketDataListener implements IWebSocketDataListener { diff --git a/server/src/main/java/org/red5/net/websocket/model/WSMessage.java b/server/src/main/java/org/red5/net/websocket/model/WSMessage.java index 631f1712f..ec84ff738 100644 --- a/server/src/main/java/org/red5/net/websocket/model/WSMessage.java +++ b/server/src/main/java/org/red5/net/websocket/model/WSMessage.java @@ -15,7 +15,7 @@ /** * Represents WebSocket message data. - * + * * @author Paul Gregoire (mondain@gmail.com) */ public class WSMessage { @@ -49,7 +49,7 @@ public WSMessage(String message) throws UnsupportedEncodingException { /** * Returns the payload data as a UTF8 string. - * + * * @return string * @throws UnsupportedEncodingException */ @@ -77,7 +77,7 @@ public void setConnection(WebSocketConnection connection) { /** * Returns the payload. - * + * * @return payload */ public IoBuffer getPayload() { @@ -90,7 +90,7 @@ public void setPayload(IoBuffer payload) { /** * Adds additional payload data. - * + * * @param additionalPayload */ public void addPayload(IoBuffer additionalPayload) { @@ -103,7 +103,7 @@ public void addPayload(IoBuffer additionalPayload) { /** * Adds additional payload data. - * + * * @param additionalPayload */ public void addPayload(byte[] additionalPayload) { diff --git a/server/src/main/java/org/red5/net/websocket/model/WebSocketEvent.java b/server/src/main/java/org/red5/net/websocket/model/WebSocketEvent.java index 1e9d172d8..9d1856ccc 100644 --- a/server/src/main/java/org/red5/net/websocket/model/WebSocketEvent.java +++ b/server/src/main/java/org/red5/net/websocket/model/WebSocketEvent.java @@ -9,7 +9,7 @@ /** * WebSocket event enumeration. - * + * * @author Paul Gregoire */ public enum WebSocketEvent { diff --git a/server/src/main/java/org/red5/net/websocket/server/DefaultServerEndpointConfigurator.java b/server/src/main/java/org/red5/net/websocket/server/DefaultServerEndpointConfigurator.java index 8bcf85835..40f518c2f 100644 --- a/server/src/main/java/org/red5/net/websocket/server/DefaultServerEndpointConfigurator.java +++ b/server/src/main/java/org/red5/net/websocket/server/DefaultServerEndpointConfigurator.java @@ -27,7 +27,7 @@ /** * Red5 implementation of the WebSocket JSR365 ServerEndpointConfig.Configurator. - * + * * @author Paul Gregoire */ public class DefaultServerEndpointConfigurator extends ServerEndpointConfig.Configurator { @@ -208,7 +208,7 @@ public String[] getAllowedOrigins() { /** * Sets the allowed origins for this instance. - * + * * @param allowedOrigins */ public void setAllowedOrigins(String[] allowedOrigins) { @@ -218,7 +218,7 @@ public void setAllowedOrigins(String[] allowedOrigins) { /** * Adds a HandshakeModifier implementation to the instances modifiers. - * + * * @param modifier * @return true if added and false otherwise */ @@ -228,7 +228,7 @@ public boolean addHandshakeModifier(HandshakeModifier modifier) { /** * Removes a HandshakeModifier implementation from the instances modifiers. - * + * * @param modifier * @return true if removed and false otherwise */ diff --git a/server/src/main/java/org/red5/net/websocket/server/DefaultWebSocketEndpoint.java b/server/src/main/java/org/red5/net/websocket/server/DefaultWebSocketEndpoint.java index 4cee9a5bb..158fce61b 100644 --- a/server/src/main/java/org/red5/net/websocket/server/DefaultWebSocketEndpoint.java +++ b/server/src/main/java/org/red5/net/websocket/server/DefaultWebSocketEndpoint.java @@ -31,7 +31,7 @@ /** * Default WebSocket endpoint. - * + * * @author Paul Gregoire */ public class DefaultWebSocketEndpoint extends Endpoint { diff --git a/server/src/main/java/org/red5/net/websocket/server/HandshakeModifier.java b/server/src/main/java/org/red5/net/websocket/server/HandshakeModifier.java index 1b6b4cf17..031419b5b 100644 --- a/server/src/main/java/org/red5/net/websocket/server/HandshakeModifier.java +++ b/server/src/main/java/org/red5/net/websocket/server/HandshakeModifier.java @@ -5,14 +5,14 @@ /** * Allows for modification of a WebSocket handshake. - * + * * @author Paul Gregoire */ public class HandshakeModifier { /** * Modifies the handshake request and / or response. - * + * * @param request * @param response */ diff --git a/server/src/main/java/org/red5/net/websocket/server/UpgradeUtil.java b/server/src/main/java/org/red5/net/websocket/server/UpgradeUtil.java index bb9df389d..43150cfb5 100644 --- a/server/src/main/java/org/red5/net/websocket/server/UpgradeUtil.java +++ b/server/src/main/java/org/red5/net/websocket/server/UpgradeUtil.java @@ -48,7 +48,7 @@ private UpgradeUtil() { * Checks to see if this is an HTTP request that includes a valid upgrade request to web socket. *

    * Note: RFC 2616 does not limit HTTP upgrade to GET requests but the Java WebSocket spec 1.0, section 8.2 implies such a limitation and RFC 6455 section 4.1 requires that a WebSocket Upgrade uses GET. - * + * * @param request * The request to check if it is an HTTP upgrade request for a WebSocket connection * @param response diff --git a/server/src/main/java/org/red5/net/websocket/server/WsHttpUpgradeHandler.java b/server/src/main/java/org/red5/net/websocket/server/WsHttpUpgradeHandler.java index 6ae6676fd..3c822a983 100644 --- a/server/src/main/java/org/red5/net/websocket/server/WsHttpUpgradeHandler.java +++ b/server/src/main/java/org/red5/net/websocket/server/WsHttpUpgradeHandler.java @@ -243,7 +243,7 @@ public void setSslSupport(SSLSupport sslSupport) { /** * Check to see if the timeout has expired and process a timeout if that is that case. Note: The name of this method originated with the Servlet 3.0 asynchronous processing but evolved over time to represent a timeout that is triggered independently of the socket read/write timeouts. - * + * * @param now * - The time (as returned by System.currentTimeMillis() to use as the current time to determine whether the timeout has expired. If negative, the timeout will always be treated as if it has expired. */ diff --git a/server/src/main/java/org/red5/net/websocket/server/WsPerSessionServerEndpointConfig.java b/server/src/main/java/org/red5/net/websocket/server/WsPerSessionServerEndpointConfig.java index 561f27a5f..c05bf8071 100644 --- a/server/src/main/java/org/red5/net/websocket/server/WsPerSessionServerEndpointConfig.java +++ b/server/src/main/java/org/red5/net/websocket/server/WsPerSessionServerEndpointConfig.java @@ -10,7 +10,7 @@ import javax.websocket.server.ServerEndpointConfig; /** - * Wraps the provided {@link ServerEndpointConfig} and provides a per session view - the difference being that the map returned by + * Wraps the provided {@link ServerEndpointConfig} and provides a per session view - the difference being that the map returned by * {@link #getUserProperties()} is unique to this instance rather than shared with the wrapped {@link ServerEndpointConfig}. */ public class WsPerSessionServerEndpointConfig implements ServerEndpointConfig { diff --git a/server/src/main/java/org/red5/server/Context.java b/server/src/main/java/org/red5/server/Context.java index 8c4fbe2ac..d00272d52 100644 --- a/server/src/main/java/org/red5/server/Context.java +++ b/server/src/main/java/org/red5/server/Context.java @@ -91,7 +91,7 @@ public Context() { /** * Initializes app context and context path from given parameters - * + * * @param context * Application context * @param contextPath @@ -105,7 +105,7 @@ public Context(ApplicationContext context, String contextPath) { /** * Return global scope - * + * * @return Global scope */ public IGlobalScope getGlobalScope() { @@ -116,7 +116,7 @@ public IGlobalScope getGlobalScope() { /** * Return scope resolver - * + * * @return scope resolver */ public IScopeResolver getScopeResolver() { @@ -125,7 +125,7 @@ public IScopeResolver getScopeResolver() { /** * Resolves scope using scope resolver collaborator - * + * * @param path * Path to resolve * @return Scope resolution result @@ -136,7 +136,7 @@ public IScope resolveScope(String path) { /** * Resolves scope from given root using scope resolver. - * + * * @param root * Scope to start from. * @param path @@ -149,7 +149,7 @@ public IScope resolveScope(IScope root, String path) { /** * Setter for client registry - * + * * @param clientRegistry * Client registry */ @@ -159,7 +159,7 @@ public void setClientRegistry(IClientRegistry clientRegistry) { /** * Setter for mapping strategy - * + * * @param mappingStrategy * Mapping strategy */ @@ -169,7 +169,7 @@ public void setMappingStrategy(IMappingStrategy mappingStrategy) { /** * Setter for scope resolver - * + * * @param scopeResolver * Scope resolver used to resolve scopes */ @@ -179,7 +179,7 @@ public void setScopeResolver(IScopeResolver scopeResolver) { /** * Setter for service invoker - * + * * @param serviceInvoker * Service invoker object */ @@ -189,7 +189,7 @@ public void setServiceInvoker(IServiceInvoker serviceInvoker) { /** * Return persistence store - * + * * @return Persistence store */ public IPersistenceStore getPersistanceStore() { @@ -198,7 +198,7 @@ public IPersistenceStore getPersistanceStore() { /** * Setter for persistence store - * + * * @param persistanceStore * Persistence store */ @@ -208,7 +208,7 @@ public void setPersistanceStore(IPersistenceStore persistanceStore) { /** * Setter for application context - * + * * @param context * App context */ @@ -233,7 +233,7 @@ public void setApplicationContext(ApplicationContext context) { /** * Return application context - * + * * @return App context */ public ApplicationContext getApplicationContext() { @@ -242,7 +242,7 @@ public ApplicationContext getApplicationContext() { /** * Setter for context path. Adds a slash at the end of path if there isn't one - * + * * @param contextPath * Context path */ @@ -255,7 +255,7 @@ public void setContextPath(String contextPath) { /** * Return client registry - * + * * @return Client registry */ public IClientRegistry getClientRegistry() { @@ -264,7 +264,7 @@ public IClientRegistry getClientRegistry() { /** * Return scope - * + * * @return null */ public IScope getScope() { @@ -273,7 +273,7 @@ public IScope getScope() { /** * Return service invoker - * + * * @return Service invoker */ public IServiceInvoker getServiceInvoker() { @@ -282,7 +282,7 @@ public IServiceInvoker getServiceInvoker() { /** * Look up service by name - * + * * @param serviceName * Service name * @return Service object @@ -307,7 +307,7 @@ public Object lookupService(String serviceName) { /** * Look up scope handler for context path - * + * * @param contextPath * Context path * @return Scope handler @@ -328,7 +328,7 @@ public IScopeHandler lookupScopeHandler(String contextPath) { /** * Return mapping strategy used by this context. Mapping strategy define naming rules (prefixes, postfixes, default application name, etc) for all named objects in context. - * + * * @return Mapping strategy */ public IMappingStrategy getMappingStrategy() { @@ -337,13 +337,13 @@ public IMappingStrategy getMappingStrategy() { /** * Return array or resource that match given pattern - * + * * @param pattern * Pattern to check against * @return Array of Resource objects * @throws IOException * On I/O exception - * + * * @see org.springframework.core.io.Resource */ public Resource[] getResources(String pattern) throws IOException { @@ -352,11 +352,11 @@ public Resource[] getResources(String pattern) throws IOException { /** * Return resource by path - * + * * @param path * Resource path * @return Resource - * + * * @see org.springframework.core.io.Resource */ public Resource getResource(String path) { @@ -365,13 +365,13 @@ public Resource getResource(String path) { /** * Resolve scope from host and path - * + * * @param host * Host * @param path * Path * @return Scope - * + * * @see org.red5.server.api.scope.IScope * @see org.red5.server.scope.Scope */ @@ -388,11 +388,11 @@ public boolean hasBean(String beanId) { /** * Return bean instantiated by bean factory - * + * * @param beanId * Bean name * @return Instantiated bean - * + * * @see org.springframework.beans.factory.BeanFactory */ public Object getBean(String beanId) { @@ -413,11 +413,11 @@ public Object getBean(String beanId) { /** * Return core Red5 service instantiated by core context bean factory - * + * * @param beanId * Bean name * @return Core Red5 service instantiated - * + * * @see org.springframework.beans.factory.BeanFactory */ public Object getCoreService(String beanId) { @@ -430,7 +430,7 @@ public void setCoreBeanFactory(BeanFactory core) { /** * Return current thread's context classloader - * + * * @return Classloder context of current thread */ public ClassLoader getClassLoader() { @@ -439,7 +439,7 @@ public ClassLoader getClassLoader() { /** * Allows for reconstruction via CompositeData. - * + * * @param cd * composite data * @return Context class instance diff --git a/server/src/main/java/org/red5/server/CoreHandler.java b/server/src/main/java/org/red5/server/CoreHandler.java index e313840f6..d29f9fb30 100644 --- a/server/src/main/java/org/red5/server/CoreHandler.java +++ b/server/src/main/java/org/red5/server/CoreHandler.java @@ -62,7 +62,7 @@ public boolean connect(IConnection conn, IScope scope) { */ public boolean connect(IConnection conn, IScope scope, Object[] params) { log.debug("connect - conn: {} scope: {}", conn, scope); - // this is where we create the Client object that consolidates connections from a single client/FP. + // this is where we create the Client object that consolidates connections from a single client/FP. // Now for more strangeness, I've only been looking at RTMPConnection derivatives, but it's setup() method // seems the only way that the session id is passed in to the newly established connection and this is currently *always* passed in // as null. I'm guessing that either the Flash Player passes some kind of unique id to us that is not being used, or that the idea diff --git a/server/src/main/java/org/red5/server/Launcher.java b/server/src/main/java/org/red5/server/Launcher.java index e5b254a46..f1f62789c 100644 --- a/server/src/main/java/org/red5/server/Launcher.java +++ b/server/src/main/java/org/red5/server/Launcher.java @@ -23,7 +23,7 @@ public class Launcher { /** * Launch Red5 under it's own classloader - * + * * @throws Exception * on error */ diff --git a/server/src/main/java/org/red5/server/MappingStrategy.java b/server/src/main/java/org/red5/server/MappingStrategy.java index eb369cee8..b0be81ded 100644 --- a/server/src/main/java/org/red5/server/MappingStrategy.java +++ b/server/src/main/java/org/red5/server/MappingStrategy.java @@ -40,7 +40,7 @@ public class MappingStrategy implements IMappingStrategy { /** * Setter for default application name ('default' by default). - * + * * @param defaultApp * Default application */ @@ -50,7 +50,7 @@ public void setDefaultApp(String defaultApp) { /** * Resolves resource prefix from path. Default application used as root when path is specified. - * + * * @param path * Path * @return Resource prefix according to this naming strategy @@ -65,7 +65,7 @@ public String mapResourcePrefix(String path) { /** * Resolves scope handler name for path. Default application used as root when path is specified. - * + * * @param path * Path * @return Scope handler name according to this naming strategy @@ -80,7 +80,7 @@ public String mapScopeHandlerName(String path) { /** * Resolves service filename name from name - * + * * @param name * Service name * @return Service filename according to this naming strategy diff --git a/server/src/main/java/org/red5/server/PersistableAttributeStore.java b/server/src/main/java/org/red5/server/PersistableAttributeStore.java index 169aaffb8..12ae83e79 100644 --- a/server/src/main/java/org/red5/server/PersistableAttributeStore.java +++ b/server/src/main/java/org/red5/server/PersistableAttributeStore.java @@ -95,7 +95,7 @@ public boolean isPersistent() { /** * Set for persistence - * + * * @param persistent * Persistence flag value */ @@ -105,7 +105,7 @@ public void setPersistent(boolean persistent) { /** * Returns last modification time as timestamp - * + * * @return Timestamp of last attribute modification */ public long getLastModified() { @@ -114,7 +114,7 @@ public long getLastModified() { /** * Return store name - * + * * @return Store name */ public String getName() { @@ -123,7 +123,7 @@ public String getName() { /** * Setter for name - * + * * @param name * Name */ @@ -133,7 +133,7 @@ public void setName(String name) { /** * Ruturn scope path - * + * * @return Path */ public String getPath() { @@ -142,7 +142,7 @@ public String getPath() { /** * Setter for scope path - * + * * @param path * Path */ @@ -152,7 +152,7 @@ public void setPath(String path) { /** * Return scope type - * + * * @return Scope type */ public String getType() { @@ -210,7 +210,7 @@ public void setStore(IPersistenceStore store) { /** * Return persistent store - * + * * @return Persistence store */ public IPersistenceStore getStore() { @@ -263,7 +263,7 @@ public boolean setAttributes(IAttributeStore values) { /** * Removes attribute - * + * * @param name * Attribute name * @return true if attribute was removed, false otherwise diff --git a/server/src/main/java/org/red5/server/adapter/Config.java b/server/src/main/java/org/red5/server/adapter/Config.java index 72661c10c..e588dad53 100644 --- a/server/src/main/java/org/red5/server/adapter/Config.java +++ b/server/src/main/java/org/red5/server/adapter/Config.java @@ -12,7 +12,7 @@ /** * Provides configuration details for Applications. - * + * * @author Paul Gregoire (mondain@gmail.com) */ @SuppressWarnings("unchecked") diff --git a/server/src/main/java/org/red5/server/api/remoting/IRemotingConnection.java b/server/src/main/java/org/red5/server/api/remoting/IRemotingConnection.java index 039800c7f..86f3be5e1 100644 --- a/server/src/main/java/org/red5/server/api/remoting/IRemotingConnection.java +++ b/server/src/main/java/org/red5/server/api/remoting/IRemotingConnection.java @@ -13,7 +13,7 @@ /** * Connection coming from Remoting clients. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ @@ -21,7 +21,7 @@ public interface IRemotingConnection extends IConnection { /** * Tell the client to add a header with all further requests. This is returned to the client as response for the next request received. - * + * * @param name * name of the header to add * @param value @@ -31,7 +31,7 @@ public interface IRemotingConnection extends IConnection { /** * Tell the client to add a header with all further requests. This is returned to the client as response for the next request received. - * + * * @param name * name of the header to add * @param value @@ -43,7 +43,7 @@ public interface IRemotingConnection extends IConnection { /** * Tell the client to no longer send a header with all further requests. This is returned to the client as response for the next request received. - * + * * @param name * name of the header to remove */ @@ -51,7 +51,7 @@ public interface IRemotingConnection extends IConnection { /** * Return headers to send. - * + * * @return headers to send */ public Collection getHeaders(); diff --git a/server/src/main/java/org/red5/server/api/scope/IScopeResolver.java b/server/src/main/java/org/red5/server/api/scope/IScopeResolver.java index 9c590b8d6..b9a68a82a 100644 --- a/server/src/main/java/org/red5/server/api/scope/IScopeResolver.java +++ b/server/src/main/java/org/red5/server/api/scope/IScopeResolver.java @@ -16,14 +16,14 @@ public interface IScopeResolver { /** * Return the global scope. - * + * * @return Global scope */ public IGlobalScope getGlobalScope(); /** * Get the scope for a given path. - * + * * @param path * Path to return the scope for * @return Scope for passed path @@ -34,7 +34,7 @@ public interface IScopeResolver { /** * Get the scope for a given path from a root scope. - * + * * @param root * The scope to start traversing from. * @param path diff --git a/server/src/main/java/org/red5/server/api/session/ISession.java b/server/src/main/java/org/red5/server/api/session/ISession.java index 209f50d28..cd2833168 100644 --- a/server/src/main/java/org/red5/server/api/session/ISession.java +++ b/server/src/main/java/org/red5/server/api/session/ISession.java @@ -20,14 +20,14 @@ public interface ISession extends Serializable { /** * Returns creation time in milliseconds. - * + * * @return creation time */ public long getCreated(); /** * Returns the session's identifier. - * + * * @return session id */ public String getSessionId(); @@ -39,7 +39,7 @@ public interface ISession extends Serializable { /** * Returns the active state of the session. - * + * * @return is active */ public boolean isActive(); @@ -51,7 +51,7 @@ public interface ISession extends Serializable { /** * Sets the associated client id. - * + * * @param clientId * client id */ @@ -59,14 +59,14 @@ public interface ISession extends Serializable { /** * Returns the client id associated with this session. - * + * * @return client id */ public String getClientId(); /** * Sets where session resources will be located if persisted to disk. - * + * * @param destinationDirectory * destination directory */ diff --git a/server/src/main/java/org/red5/server/api/statistics/IStatisticsService.java b/server/src/main/java/org/red5/server/api/statistics/IStatisticsService.java index 00020151b..4e78fccd6 100644 --- a/server/src/main/java/org/red5/server/api/statistics/IStatisticsService.java +++ b/server/src/main/java/org/red5/server/api/statistics/IStatisticsService.java @@ -16,35 +16,35 @@ /** * Statistics methods for Red5. They can be used to poll for updates of given elements inside the server. Statistics data will be stored as properties of different shared objects. - * + * * Use - * + * *

      * getScopeStatisticsSO
      * 
    - * + * * and - * + * *
      * getSharedObjectStatisticsSO
      * 
    - * + * * to get these shared objects. The property names are - * + * *
      * scopeName
      * 
    - * + * * for scope attributes and - * + * *
      * scopeName | sharedObjectName
      * 
    - * + * * for shared object attributes. Each property holds a Map containing key/value mappings of the corresponding attributes. - * + * * Sometime in the future, the updates on the shared objects will be done automatically so a client doesn't need to poll for them. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ @@ -52,7 +52,7 @@ public interface IStatisticsService { /** * Return the shared object that will be used to keep scope statistics. - * + * * @param scope * A scope to return the shared object for. * @return the shared object containing scope statistics @@ -61,7 +61,7 @@ public interface IStatisticsService { /** * Return the shared object that will be used to keep SO statistics. - * + * * @param scope * A scope to return the shared object for. * @return the shared object containing SO statistics @@ -70,14 +70,14 @@ public interface IStatisticsService { /** * Return a list of all scopes that currently exist on the server. - * + * * @return list of scope names */ public Set getScopes(); /** * Return a list of all scopes that currently exist on the server below a current path. - * + * * @param path * Path to start looking for scopes. * @return list of scope names @@ -88,7 +88,7 @@ public interface IStatisticsService { /** * Update statistics for a given scope. - * + * * @param path * Path to scope to update. * @throws ScopeNotFoundException @@ -98,7 +98,7 @@ public interface IStatisticsService { /** * Return informations about shared objects for a given scope. - * + * * @param path * Path to scope to return shared object names for. * @return list of informations about shared objects @@ -107,7 +107,7 @@ public interface IStatisticsService { /** * Update informations about a shared object in a given scope. - * + * * @param path * Path to scope that contains the shared object. * @param name diff --git a/server/src/main/java/org/red5/server/api/stream/IServerStream.java b/server/src/main/java/org/red5/server/api/stream/IServerStream.java index f5b3f6578..95c90bc06 100644 --- a/server/src/main/java/org/red5/server/api/stream/IServerStream.java +++ b/server/src/main/java/org/red5/server/api/stream/IServerStream.java @@ -19,7 +19,7 @@ public interface IServerStream extends IPlaylist, IBroadcastStream { /** * Seek to a given position in the stream. - * + * * @param position * new playback position in milliseconds */ diff --git a/server/src/main/java/org/red5/server/api/stream/IStreamHandler.java b/server/src/main/java/org/red5/server/api/stream/IStreamHandler.java index 7f1340abc..8263b19a6 100644 --- a/server/src/main/java/org/red5/server/api/stream/IStreamHandler.java +++ b/server/src/main/java/org/red5/server/api/stream/IStreamHandler.java @@ -11,7 +11,7 @@ public interface IStreamHandler { /** * Called when the client begins publishing - * + * * @param stream * the stream object */ @@ -19,7 +19,7 @@ public interface IStreamHandler { /** * Called when the client stops publishing - * + * * @param stream * the stream object */ @@ -27,7 +27,7 @@ public interface IStreamHandler { /** * Called when the broadcast starts - * + * * @param stream * the stream object */ @@ -35,7 +35,7 @@ public interface IStreamHandler { /** * Called when a recording starts - * + * * @param stream * the stream object */ @@ -43,7 +43,7 @@ public interface IStreamHandler { /** * Called when a recording stops - * + * * @param stream * the stream object */ @@ -51,7 +51,7 @@ public interface IStreamHandler { /** * Called when a client subscribes to a broadcast - * + * * @param stream * the stream object */ @@ -59,7 +59,7 @@ public interface IStreamHandler { /** * Called when a client unsubscribes from a broadcast - * + * * @param stream * the stream object */ @@ -67,7 +67,7 @@ public interface IStreamHandler { /** * Called when a client connects to an on demand stream - * + * * @param stream * the stream object */ @@ -75,7 +75,7 @@ public interface IStreamHandler { /** * Called when a client disconnects from an on demand stream - * + * * @param stream * the stream object */ diff --git a/server/src/main/java/org/red5/server/api/stream/IStreamSecurityService.java b/server/src/main/java/org/red5/server/api/stream/IStreamSecurityService.java index 98b3c85ae..9a13ff19d 100644 --- a/server/src/main/java/org/red5/server/api/stream/IStreamSecurityService.java +++ b/server/src/main/java/org/red5/server/api/stream/IStreamSecurityService.java @@ -13,7 +13,7 @@ /** * Service that supports protecting access to streams. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ @@ -26,7 +26,7 @@ public interface IStreamSecurityService extends IScopeService { /** * Add handler that protects stream publishing. - * + * * @param handler * Handler to add. */ @@ -34,7 +34,7 @@ public interface IStreamSecurityService extends IScopeService { /** * Remove handler that protects stream publishing. - * + * * @param handler * Handler to remove. */ @@ -42,14 +42,14 @@ public interface IStreamSecurityService extends IScopeService { /** * Get handlers that protect stream publishing. - * + * * @return list of handlers */ public Set getStreamPublishSecurity(); /** * Add handler that protects stream playback. - * + * * @param handler * Handler to add. */ @@ -57,7 +57,7 @@ public interface IStreamSecurityService extends IScopeService { /** * Remove handler that protects stream playback. - * + * * @param handler * Handler to remove. */ @@ -65,7 +65,7 @@ public interface IStreamSecurityService extends IScopeService { /** * Get handlers that protect stream plaback. - * + * * @return list of handlers */ public Set getStreamPlaybackSecurity(); diff --git a/server/src/main/java/org/red5/server/api/stream/IStreamableFile.java b/server/src/main/java/org/red5/server/api/stream/IStreamableFile.java index c403d4d44..e15d7137e 100644 --- a/server/src/main/java/org/red5/server/api/stream/IStreamableFile.java +++ b/server/src/main/java/org/red5/server/api/stream/IStreamableFile.java @@ -19,7 +19,7 @@ public interface IStreamableFile { /** * Returns a reader to parse and read the tags inside the file. - * + * * @return the reader Tag reader * @throws java.io.IOException * I/O exception @@ -28,7 +28,7 @@ public interface IStreamableFile { /** * Returns a writer that creates a new file or truncates existing contents. - * + * * @return the writer Tag writer * @throws java.io.IOException * I/O exception @@ -37,7 +37,7 @@ public interface IStreamableFile { /** * Returns a Writer which is setup to append to the file. - * + * * @return the writer Tag writer used for append mode * @throws java.io.IOException * I/O exception diff --git a/server/src/main/java/org/red5/server/api/stream/support/DenyAllStreamAccess.java b/server/src/main/java/org/red5/server/api/stream/support/DenyAllStreamAccess.java index 720c82484..4b0f4aa51 100644 --- a/server/src/main/java/org/red5/server/api/stream/support/DenyAllStreamAccess.java +++ b/server/src/main/java/org/red5/server/api/stream/support/DenyAllStreamAccess.java @@ -13,7 +13,7 @@ /** * Stream security handler that denies access to all streams. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ diff --git a/server/src/main/java/org/red5/server/api/stream/support/StreamUtils.java b/server/src/main/java/org/red5/server/api/stream/support/StreamUtils.java index 442c9f769..b1227d16e 100644 --- a/server/src/main/java/org/red5/server/api/stream/support/StreamUtils.java +++ b/server/src/main/java/org/red5/server/api/stream/support/StreamUtils.java @@ -18,7 +18,7 @@ /** * Stream helper methods. - * + * * @author The Red5 Project * @author Steven Gong (steven.gong@gmail.com) * @author Paul Gregoire (mondain@gmail.com) @@ -32,7 +32,7 @@ public abstract class StreamUtils { /** * Creates server stream - * + * * @param scope * Scope of stream * @param name diff --git a/server/src/main/java/org/red5/server/exception/AccessDeniedException.java b/server/src/main/java/org/red5/server/exception/AccessDeniedException.java index 25fdc660f..f34d7a837 100644 --- a/server/src/main/java/org/red5/server/exception/AccessDeniedException.java +++ b/server/src/main/java/org/red5/server/exception/AccessDeniedException.java @@ -13,7 +13,7 @@ public class AccessDeniedException extends RuntimeException { /** - * + * */ private static final long serialVersionUID = 2023603817704741161L; diff --git a/server/src/main/java/org/red5/server/exception/ScopeHandlerNotFoundException.java b/server/src/main/java/org/red5/server/exception/ScopeHandlerNotFoundException.java index d09dc1eb2..318c15488 100644 --- a/server/src/main/java/org/red5/server/exception/ScopeHandlerNotFoundException.java +++ b/server/src/main/java/org/red5/server/exception/ScopeHandlerNotFoundException.java @@ -16,7 +16,7 @@ public class ScopeHandlerNotFoundException extends RuntimeException { /** * Create exception from given scope handler name - * + * * @param handlerName * Scope handler name */ diff --git a/server/src/main/java/org/red5/server/exception/ServiceNotFoundException.java b/server/src/main/java/org/red5/server/exception/ServiceNotFoundException.java index eb01eaaa7..84a88a6dd 100644 --- a/server/src/main/java/org/red5/server/exception/ServiceNotFoundException.java +++ b/server/src/main/java/org/red5/server/exception/ServiceNotFoundException.java @@ -13,7 +13,7 @@ public class ServiceNotFoundException extends RuntimeException { /** - * + * */ private static final long serialVersionUID = -2400159517485748708L; diff --git a/server/src/main/java/org/red5/server/exception/SharedObjectException.java b/server/src/main/java/org/red5/server/exception/SharedObjectException.java index 25fb55fff..0b08e6e75 100644 --- a/server/src/main/java/org/red5/server/exception/SharedObjectException.java +++ b/server/src/main/java/org/red5/server/exception/SharedObjectException.java @@ -13,7 +13,7 @@ public class SharedObjectException extends RuntimeException { /** - * + * */ private static final long serialVersionUID = 4152370716169030341L; diff --git a/server/src/main/java/org/red5/server/exception/StreamControlException.java b/server/src/main/java/org/red5/server/exception/StreamControlException.java index cca3b8629..d06272bdb 100644 --- a/server/src/main/java/org/red5/server/exception/StreamControlException.java +++ b/server/src/main/java/org/red5/server/exception/StreamControlException.java @@ -13,7 +13,7 @@ public class StreamControlException extends RuntimeException { /** - * + * */ private static final long serialVersionUID = -8396541091694329882L; diff --git a/server/src/main/java/org/red5/server/exception/StreamDataException.java b/server/src/main/java/org/red5/server/exception/StreamDataException.java index d1f46297f..2b7833df7 100644 --- a/server/src/main/java/org/red5/server/exception/StreamDataException.java +++ b/server/src/main/java/org/red5/server/exception/StreamDataException.java @@ -13,7 +13,7 @@ public class StreamDataException extends RuntimeException { /** - * + * */ private static final long serialVersionUID = 5529626622367065317L; diff --git a/server/src/main/java/org/red5/server/messaging/IPullableProvider.java b/server/src/main/java/org/red5/server/messaging/IPullableProvider.java index 2797d4f6f..67a6d2cb4 100644 --- a/server/src/main/java/org/red5/server/messaging/IPullableProvider.java +++ b/server/src/main/java/org/red5/server/messaging/IPullableProvider.java @@ -11,7 +11,7 @@ /** * A provider that supports passive pulling of messages. - * + * * @author The Red5 Project * @author Steven Gong (steven.gong@gmail.com) */ diff --git a/server/src/main/java/org/red5/server/messaging/InMemoryPullPullPipe.java b/server/src/main/java/org/red5/server/messaging/InMemoryPullPullPipe.java index 522d56d8e..8ac3d2d5e 100644 --- a/server/src/main/java/org/red5/server/messaging/InMemoryPullPullPipe.java +++ b/server/src/main/java/org/red5/server/messaging/InMemoryPullPullPipe.java @@ -15,7 +15,7 @@ /** * A simple in-memory version of pull-pull pipe. It is triggered by an active consumer that pulls messages through it from a pullable provider. - * + * * @author The Red5 Project * @author Steven Gong (steven.gong@gmail.com) */ diff --git a/server/src/main/java/org/red5/server/messaging/PipeUtils.java b/server/src/main/java/org/red5/server/messaging/PipeUtils.java index 04a526db4..a80cdae7b 100644 --- a/server/src/main/java/org/red5/server/messaging/PipeUtils.java +++ b/server/src/main/java/org/red5/server/messaging/PipeUtils.java @@ -9,14 +9,14 @@ /** * Helper class for pipe structure. - * + * * @author The Red5 Project * @author Steven Gong (steven.gong@gmail.com) */ public class PipeUtils { /** * Connect a provider/consumer with a pipe. - * + * * @param provider * Provider * @param pipe @@ -31,7 +31,7 @@ public static void connect(IProvider provider, IPipe pipe, IConsumer consumer) { /** * Disconnect a provider/consumer from a pipe. - * + * * @param provider * Provider * @param pipe diff --git a/server/src/main/java/org/red5/server/messaging/ServiceAdapter.java b/server/src/main/java/org/red5/server/messaging/ServiceAdapter.java index 785049055..5f83b5821 100644 --- a/server/src/main/java/org/red5/server/messaging/ServiceAdapter.java +++ b/server/src/main/java/org/red5/server/messaging/ServiceAdapter.java @@ -12,7 +12,7 @@ /** * The ServiceAdapter class is the base definition of a service adapter. - * + * * @author Paul Gregoire */ public abstract class ServiceAdapter { @@ -34,7 +34,7 @@ public void stop() { /** * Handle a data message intended for this adapter. This method is responsible for handling the message and returning a result (if any). The return value of this message is used as the body of the acknowledge message returned to the client. It may be null if there is no data being returned for this message. Typically the data content for the message is stored in the body property of the message. The headers of * the message are used to store fields which relate to the transport of the message. The type of operation is stored as the operation property of the message. - * + * * @param message * the message as sent by the client intended for this adapter * @return the body of the acknowledge message (or null if there is no body) @@ -44,7 +44,7 @@ public void stop() { /** * Accept a command from the adapter's service and perform some internal action based upon it. CommandMessages are used for messages which control the state of the connection between the client and the server. For example, this handles subscribe, unsubscribe, and ping operations. The messageRefType property of the CommandMessage is used to associate a command message with a particular service. Services are * configured to handle messages of a particular concrete type. For example, the MessageService is typically invoked to handle messages of type flex.messaging.messages.AsyncMessage. To ensure a given CommandMessage is routed to the right service, its MessageRefType is set to the string name of the message type for messages handled by that service. - * + * * @param commandMessage * message * @return Exception if not implemented @@ -55,7 +55,7 @@ public Object manage(CommandMessage commandMessage) { /** * Returns true if the adapter performs custom subscription management. The default return value is false, and subclasses should override this method as necessary. - * + * * @return true if subscriptions are handled */ public boolean handlesSubscriptions() { diff --git a/server/src/main/java/org/red5/server/net/IConnectionEventQueue.java b/server/src/main/java/org/red5/server/net/IConnectionEventQueue.java index f1dc12033..8192b739e 100644 --- a/server/src/main/java/org/red5/server/net/IConnectionEventQueue.java +++ b/server/src/main/java/org/red5/server/net/IConnectionEventQueue.java @@ -19,7 +19,7 @@ public interface IConnectionEventQueue { /** * Whether queue has waiting connection events - * + * * @param conn * Connection * @return true if queue has waiting events for connection, false otherwise @@ -28,7 +28,7 @@ public interface IConnectionEventQueue { /** * Return iterator over waiting events - * + * * @param conn * Connection * @return Iterator over events diff --git a/server/src/main/java/org/red5/server/net/proxy/NetworkDumpFilter.java b/server/src/main/java/org/red5/server/net/proxy/NetworkDumpFilter.java index 2f2b647a8..aed212316 100644 --- a/server/src/main/java/org/red5/server/net/proxy/NetworkDumpFilter.java +++ b/server/src/main/java/org/red5/server/net/proxy/NetworkDumpFilter.java @@ -34,7 +34,7 @@ public class NetworkDumpFilter extends IoFilterAdapter { /** * Create network dump filter from given dump channels - * + * * @param headers * Channel to dump headers * @param raw diff --git a/server/src/main/java/org/red5/server/net/proxy/ProxyFilter.java b/server/src/main/java/org/red5/server/net/proxy/ProxyFilter.java index 4b80edc12..9281ddad6 100644 --- a/server/src/main/java/org/red5/server/net/proxy/ProxyFilter.java +++ b/server/src/main/java/org/red5/server/net/proxy/ProxyFilter.java @@ -34,7 +34,7 @@ public class ProxyFilter extends IoFilterAdapter { /** * Create proxy filter with given name - * + * * @param name * name */ diff --git a/server/src/main/java/org/red5/server/net/remoting/FlexMessagingService.java b/server/src/main/java/org/red5/server/net/remoting/FlexMessagingService.java index 64708350e..80d7111c3 100644 --- a/server/src/main/java/org/red5/server/net/remoting/FlexMessagingService.java +++ b/server/src/main/java/org/red5/server/net/remoting/FlexMessagingService.java @@ -43,7 +43,7 @@ /** * Service that can execute compatibility Flex messages. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) * @author Paul Gregoire (mondain@gmail.com) @@ -70,7 +70,7 @@ public class FlexMessagingService { /** * Setup available end points. - * + * * @param endpoints * end points */ @@ -81,7 +81,7 @@ public void setEndpoints(Map endpoints) { /** * Set the service invoker to use. - * + * * @param serviceInvoker * service invoker */ @@ -91,7 +91,7 @@ public void setServiceInvoker(IServiceInvoker serviceInvoker) { /** * Construct error message. - * + * * @param request * request * @param faultCode @@ -116,7 +116,7 @@ public static ErrorMessage returnError(AbstractMessage request, String faultCode /** * Construct error message from exception. - * + * * @param request * request * @param faultCode @@ -145,13 +145,13 @@ public static ErrorMessage returnError(AbstractMessage request, String faultCode /** * Handle request coming from - * + * *
          * mx:RemoteObject
          * 
    - * + * * tags. - * + * * @see Adobe Livedocs (external) * * @param msg @@ -233,7 +233,7 @@ public AsyncMessage handleRequest(RemotingMessage msg) { /** * Handle command message (external) request. - * + * * @param msg * message * @return message @@ -290,7 +290,7 @@ public Message handleRequest(CommandMessageExt msg) { /** * Handle command message request. - * + * * @param msg * message * @return message @@ -405,7 +405,7 @@ public Message handleRequest(CommandMessage msg) { /** * Evaluate update requests sent by a client. - * + * * @param msg * @param event */ @@ -433,7 +433,7 @@ private void evaluateDataUpdate(DataMessage msg, DataMessage event) { /** * Handle messages related to shared objects. - * + * * @param msg * message * @return async message @@ -477,7 +477,7 @@ public AsyncMessage handleRequest(DataMessage msg) { /** * Fallback method to handle arbitrary messages. - * + * * @param msg * message * @return error message @@ -517,7 +517,7 @@ public Message handleRequest(AbstractMessage msg) { ServiceAdapter adapter = (ServiceAdapter) endpoint; //log.debug("Invoke: {}", adapter.invoke(msg)); Object o = adapter.invoke(msg); - //the result of the invocation will make up the message body + //the result of the invocation will make up the message body //AsyncMessage ext = new AsyncMessage(); //ext.setClientId(msg.getClientId()); //ext.setCorrelationId(result.getMessageId()); @@ -534,7 +534,7 @@ public Message handleRequest(AbstractMessage msg) { /** * This is mandatory for client built from Flex 3 or later, or client will hang with concurrent accesses. - * + * * @param msg */ private void setClientId(AbstractMessage msg) { @@ -555,7 +555,7 @@ private void setClientId(AbstractMessage msg) { /** * Maps a client to an adapter for lookups on messages that do not contain a destination. - * + * * @param clientId * a subscribed client id * @param adapter @@ -570,7 +570,7 @@ private final void registerClientToAdapter(String clientId, ServiceAdapter adapt /** * Removes a mapping for a client with an adapter. - * + * * @param clientId * a subscribed client id */ diff --git a/server/src/main/java/org/red5/server/net/remoting/RemotingConnection.java b/server/src/main/java/org/red5/server/net/remoting/RemotingConnection.java index 82fd10f3e..21873b0cf 100644 --- a/server/src/main/java/org/red5/server/net/remoting/RemotingConnection.java +++ b/server/src/main/java/org/red5/server/net/remoting/RemotingConnection.java @@ -38,7 +38,7 @@ /** * Connection class so the Red5 object works in methods invoked through remoting. Attributes are stored in the session of the implementing * servlet container. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) * @author Paul Gregoire (mondain@gmail.com) @@ -110,7 +110,7 @@ public RemotingConnection(HttpServletRequest request, IScope scope, RemotingPack /** * Return string representation of the connection. - * + * * @return string */ public String toString() { @@ -119,7 +119,7 @@ public String toString() { /** * Update the current packet. - * + * * @param packet * remoting packet */ @@ -399,7 +399,7 @@ public Object getAttribute(String name, Object defaultValue) { if (name == null) { return null; } - // Synchronize so default value doesn't override other default value + // Synchronize so default value doesn't override other default value synchronized (session) { Object result = session.getAttribute(name); if (result == null && defaultValue != null) { diff --git a/server/src/main/java/org/red5/server/net/remoting/codec/RemotingCodecFactory.java b/server/src/main/java/org/red5/server/net/remoting/codec/RemotingCodecFactory.java index d057f3be3..c3e857712 100644 --- a/server/src/main/java/org/red5/server/net/remoting/codec/RemotingCodecFactory.java +++ b/server/src/main/java/org/red5/server/net/remoting/codec/RemotingCodecFactory.java @@ -32,7 +32,7 @@ public void init() { /** * Returns the remoting decoder. - * + * * @return decoder */ public RemotingProtocolDecoder getRemotingDecoder() { @@ -41,7 +41,7 @@ public RemotingProtocolDecoder getRemotingDecoder() { /** * Returns the remoting encoder. - * + * * @return encoder */ public RemotingProtocolEncoder getRemotingEncoder() { diff --git a/server/src/main/java/org/red5/server/net/remoting/codec/RemotingProtocolDecoder.java b/server/src/main/java/org/red5/server/net/remoting/codec/RemotingProtocolDecoder.java index af0b10580..18be20d9a 100644 --- a/server/src/main/java/org/red5/server/net/remoting/codec/RemotingProtocolDecoder.java +++ b/server/src/main/java/org/red5/server/net/remoting/codec/RemotingProtocolDecoder.java @@ -31,7 +31,7 @@ public class RemotingProtocolDecoder { /** * Decodes the given buffer. - * + * * @param buffer * input buffer * @return a List of {@link RemotingPacket} objects. @@ -53,7 +53,7 @@ public List decodeBuffer(IoBuffer buffer) { /** * Decodes the buffer and returns a remoting packet. - * + * * @param in * input buffer * @return A {@link RemotingPacket} @@ -68,7 +68,7 @@ public Object decode(IoBuffer in) throws Exception { /** * Read remoting headers. - * + * * @param in * Input data as byte buffer * @return header map diff --git a/server/src/main/java/org/red5/server/net/remoting/codec/RemotingProtocolEncoder.java b/server/src/main/java/org/red5/server/net/remoting/codec/RemotingProtocolEncoder.java index 807e55fee..942aa3ed9 100644 --- a/server/src/main/java/org/red5/server/net/remoting/codec/RemotingProtocolEncoder.java +++ b/server/src/main/java/org/red5/server/net/remoting/codec/RemotingProtocolEncoder.java @@ -41,7 +41,7 @@ public class RemotingProtocolEncoder { /** * Encodes the given buffer. - * + * * @param message * message * @return buffer @@ -124,7 +124,7 @@ public IoBuffer encode(Object message) throws Exception { /** * Generate error object to return for given exception. - * + * * @param code * call * @param error diff --git a/server/src/main/java/org/red5/server/net/remoting/message/RemotingPacket.java b/server/src/main/java/org/red5/server/net/remoting/message/RemotingPacket.java index c779c7f9c..65db8c2d9 100644 --- a/server/src/main/java/org/red5/server/net/remoting/message/RemotingPacket.java +++ b/server/src/main/java/org/red5/server/net/remoting/message/RemotingPacket.java @@ -46,7 +46,7 @@ public class RemotingPacket { /** * Create remoting packet from list of pending calls - * + * * @param headers * headers * @param calls @@ -59,7 +59,7 @@ public RemotingPacket(Map headers, List calls) { /** * Get the headers sent with the request. - * + * * @return headers */ public Map getHeaders() { @@ -96,7 +96,7 @@ public String getScopePath() { /** * Return the encoding of the included calls. - * + * * @return encoding */ public Encoding getEncoding() { diff --git a/server/src/main/java/org/red5/server/net/rtmp/IRTMPConnManager.java b/server/src/main/java/org/red5/server/net/rtmp/IRTMPConnManager.java index 542c57ac1..1c5add5b8 100644 --- a/server/src/main/java/org/red5/server/net/rtmp/IRTMPConnManager.java +++ b/server/src/main/java/org/red5/server/net/rtmp/IRTMPConnManager.java @@ -13,7 +13,7 @@ public interface IRTMPConnManager { /** * Returns a connection matching the given client id. - * + * * @param clientId * client id * @return connection @@ -22,7 +22,7 @@ public interface IRTMPConnManager { /** * Returns a connection matching the given session id. - * + * * @param sessionId * session id * @return connection @@ -31,7 +31,7 @@ public interface IRTMPConnManager { /** * Creates a connection based on the given RTMPConnection class. - * + * * @param connCls * class * @return connection @@ -40,7 +40,7 @@ public interface IRTMPConnManager { /** * Removes a connection matching the client id specified. If found, the connection will be returned. - * + * * @param clientId * client id * @return connection @@ -49,7 +49,7 @@ public interface IRTMPConnManager { /** * Removes all the connections from the set. - * + * * @return connections */ Collection removeConnections(); diff --git a/server/src/main/java/org/red5/server/net/rtmp/InboundHandshake.java b/server/src/main/java/org/red5/server/net/rtmp/InboundHandshake.java index 9b6ff3330..206adbf7e 100644 --- a/server/src/main/java/org/red5/server/net/rtmp/InboundHandshake.java +++ b/server/src/main/java/org/red5/server/net/rtmp/InboundHandshake.java @@ -20,7 +20,7 @@ /** * Performs handshaking for server connections. - * + * * @author Paul Gregoire */ public class InboundHandshake extends RTMPHandshake { @@ -51,7 +51,7 @@ public InboundHandshake(byte handshakeType, int algorithm) { /** * Generates response for versioned connections. - * + * * @param in * incoming RTMP handshake bytes * @return outgoing handshake @@ -65,13 +65,13 @@ public IoBuffer doHandshake(IoBuffer in) { /** * Decodes the first client request (C1) and returns a server response (S0S1). - * + * *
          * C1 = 1536 bytes from the client
          * S0 = 0x03 (server handshake type - 0x03, 0x06, 0x08, or 0x09)
          * S1 = 1536 bytes from server
          * 
    - * + * * @param in * incoming handshake C1 * @return server response S0+S1 @@ -198,7 +198,7 @@ public IoBuffer decodeClientRequest1(IoBuffer in) { System.arraycopy(signatureResponse, 0, c1, (Constants.HANDSHAKE_SIZE - DIGEST_LENGTH), DIGEST_LENGTH); // create output buffer for S0+S1+S2 IoBuffer s0s1s2 = IoBuffer.allocate(Constants.HANDSHAKE_SIZE * 2 + 1); // 3073 - // set handshake with encryption type + // set handshake with encryption type s0s1s2.put(handshakeType); // 1 s0s1s2.put(s1); // 1536 s0s1s2.put(c1); // 1536 @@ -213,12 +213,12 @@ public IoBuffer decodeClientRequest1(IoBuffer in) { /** * Decodes the second client request (C2) and returns a server response (S2). - * + * *
          * C2 = Copy of S1 bytes
          * S2 = Copy of C1 bytes
          * 
    - * + * * @param in * incoming handshake C2 * @return true if C2 was processed successfully and false otherwise @@ -294,7 +294,7 @@ public boolean decodeClientRequest2(IoBuffer in) { /** * Generates response for non-versioned connections, such as those before FP9. - * + * * @param input * incoming RTMP bytes * @return outgoing handshake @@ -355,7 +355,7 @@ protected void createHandshakeBytes() { /** * Determines the validation scheme for given input. - * + * * @param handshake * handshake bytes from the client * @return true if client used a supported validation scheme, false if unsupported @@ -405,7 +405,7 @@ private boolean validateScheme(byte[] handshake, int scheme) { /** * Encrypt via xtea. - * + * * @param in * @param index * @param keyId @@ -417,7 +417,7 @@ private void encryptXtea(byte[] in, int index, int keyId) { /** * Encrypt via blowfish. - * + * * @param in * @param index * @param keyId diff --git a/server/src/main/java/org/red5/server/net/rtmp/RTMPConnManager.java b/server/src/main/java/org/red5/server/net/rtmp/RTMPConnManager.java index 9527a97c5..b0377b2f3 100644 --- a/server/src/main/java/org/red5/server/net/rtmp/RTMPConnManager.java +++ b/server/src/main/java/org/red5/server/net/rtmp/RTMPConnManager.java @@ -39,7 +39,7 @@ /** * Responsible for management and creation of RTMP based connections. - * + * * @author The Red5 Project */ public class RTMPConnManager implements IConnectionManager, ApplicationContextAware, DisposableBean { @@ -91,7 +91,7 @@ public void run() { break; default: // XXX implement as a task and fix logic - // ghost clean up + // ghost clean up // if (max time allowed for no response from client exceeded, ping) // // Ping client // conn.ping(); @@ -189,7 +189,7 @@ public RTMPConnection createConnection(Class connCls, String sessionId) { /** * Adds a connection. - * + * * @param conn * connection */ @@ -216,7 +216,7 @@ public void setConnection(RTMPConnection conn) { /** * Returns a connection for a given client id. - * + * * @param clientId * client id * @return connection if found and null otherwise @@ -233,7 +233,7 @@ public RTMPConnection getConnection(int clientId) { /** * Returns a connection for a given session id. - * + * * @param sessionId session id * @return connection if found and null otherwise */ @@ -296,7 +296,7 @@ public Collection removeConnections() { /** * Creates a connection instance based on the supplied type. - * + * * @param cls * class * @return connection diff --git a/server/src/main/java/org/red5/server/net/rtmp/RTMPMinaIoHandler.java b/server/src/main/java/org/red5/server/net/rtmp/RTMPMinaIoHandler.java index 249431364..81036f161 100644 --- a/server/src/main/java/org/red5/server/net/rtmp/RTMPMinaIoHandler.java +++ b/server/src/main/java/org/red5/server/net/rtmp/RTMPMinaIoHandler.java @@ -251,7 +251,7 @@ public void exceptionCaught(IoSession session, Throwable cause) throws Exception /** * Close and clean-up the IoSession. - * + * * @param session * @param immediately * close without waiting for the write queue to flush diff --git a/server/src/main/java/org/red5/server/net/rtmp/RTMPMinaTransport.java b/server/src/main/java/org/red5/server/net/rtmp/RTMPMinaTransport.java index 718779c21..bed27af1b 100644 --- a/server/src/main/java/org/red5/server/net/rtmp/RTMPMinaTransport.java +++ b/server/src/main/java/org/red5/server/net/rtmp/RTMPMinaTransport.java @@ -40,10 +40,10 @@ /** * Transport setup class configures socket acceptor and thread pools for RTMP in Mina. - * + * *
    * Note: This code originates from AsyncWeb. Originally modified by Luke Hubbard.
    - * + * * @author Luke Hubbard * @author Paul Gregoire */ @@ -388,7 +388,7 @@ public void setReaderIdleTime(int readerIdleTime) { /** * Sets the idle time for connected sessions. - * + * * @param idleTime in seconds */ public void setIdleTime(int idleTime) { @@ -397,7 +397,7 @@ public void setIdleTime(int idleTime) { /** * Returns all the bound addresses and ports as string. - * + * * @return addresses */ public String getAddress() { @@ -406,7 +406,7 @@ public String getAddress() { /** * Returns the current statistics as a json formatted string. - * + * * @return json */ public String getStatistics() { diff --git a/server/src/main/java/org/red5/server/net/rtmpe/RTMPEIoFilter.java b/server/src/main/java/org/red5/server/net/rtmpe/RTMPEIoFilter.java index a4ec50ca5..b1557bcf8 100644 --- a/server/src/main/java/org/red5/server/net/rtmpe/RTMPEIoFilter.java +++ b/server/src/main/java/org/red5/server/net/rtmpe/RTMPEIoFilter.java @@ -27,7 +27,7 @@ /** * RTMPE IO filter - Server version. - * + * * @author Peter Thomas (ptrthomas@gmail.com) * @author Paul Gregoire (mondain@gmail.com) */ diff --git a/server/src/main/java/org/red5/server/net/rtmps/RTMPSIoFilter.java b/server/src/main/java/org/red5/server/net/rtmps/RTMPSIoFilter.java index 97cd6daa1..e8599e171 100644 --- a/server/src/main/java/org/red5/server/net/rtmps/RTMPSIoFilter.java +++ b/server/src/main/java/org/red5/server/net/rtmps/RTMPSIoFilter.java @@ -27,7 +27,7 @@ /** * RTMPS IO filter - Server version. - * + * * @author Paul Gregoire (mondain@gmail.com) */ public class RTMPSIoFilter extends RTMPEIoFilter { diff --git a/server/src/main/java/org/red5/server/net/rtmps/RTMPSMinaIoHandler.java b/server/src/main/java/org/red5/server/net/rtmps/RTMPSMinaIoHandler.java index 5e5cf78a1..94679b101 100644 --- a/server/src/main/java/org/red5/server/net/rtmps/RTMPSMinaIoHandler.java +++ b/server/src/main/java/org/red5/server/net/rtmps/RTMPSMinaIoHandler.java @@ -33,20 +33,20 @@ /** * Handles Native RTMPS protocol events fired by the MINA framework. - * + * *
      * var nc:NetConnection = new NetConnection();
      * nc.proxyType = "best";
      * nc.connect("rtmps:\\localhost\app");
      * 
    - * + * * https://issues.apache.org/jira/browse/DIRMINA-272 https://issues.apache.org/jira/browse/DIRMINA-997 - * + * * Transport Layer Security (TLS) Renegotiation Issue http://www.oracle.com/technetwork/java/javase/documentation/tlsreadme2-176330.html * Secure renegotiation https://jce.iaik.tugraz.at/sic/Products/Communication-Messaging-Security/iSaSiLk/documentation/Secure-Renegotiation * Troubleshooting a HTTPS TLSv1 handshake http://integr8consulting.blogspot.com/2012/02/troubleshooting-https-tlsv1-handshake.html * How to analyze Java SSL errors http://www.smartjava.org/content/how-analyze-java-ssl-errors - * + * * @author Kevin Green (kevygreen@gmail.com) * @author Paul Gregoire (mondain@gmail.com) */ @@ -158,7 +158,7 @@ public void sessionCreated(IoSession session) throws Exception { log.debug("SSL context supported protocol: {}", protocol); } } - // compatibility: remove the SSLv2Hello message in the available protocols - some systems will fail + // compatibility: remove the SSLv2Hello message in the available protocols - some systems will fail // to handshake if TSLv1 messages are enwrapped with SSLv2 messages, Java 6 tries to send TSLv1 embedded in SSLv2 } else { log.warn("Keystore or Truststore file does not exist"); @@ -210,7 +210,7 @@ public void sessionCreated(IoSession session) throws Exception { /** * Password used to access the keystore file. - * + * * @param password * keystore password */ @@ -220,7 +220,7 @@ public void setKeystorePassword(String password) { /** * Password used to access the truststore file. - * + * * @param password * truststore password */ @@ -230,7 +230,7 @@ public void setTruststorePassword(String password) { /** * Set keystore data from a file. - * + * * @param path * contains keystore */ @@ -240,7 +240,7 @@ public void setKeystoreFile(String path) { /** * Set truststore file path. - * + * * @param path * contains truststore */ diff --git a/server/src/main/java/org/red5/server/net/rtmpt/BaseRTMPTConnection.java b/server/src/main/java/org/red5/server/net/rtmpt/BaseRTMPTConnection.java index 3d1220167..9e41398a1 100644 --- a/server/src/main/java/org/red5/server/net/rtmpt/BaseRTMPTConnection.java +++ b/server/src/main/java/org/red5/server/net/rtmpt/BaseRTMPTConnection.java @@ -30,7 +30,7 @@ /** * Base RTMPT client / session. - * + * * @author The Red5 Project * @author Paul Gregoire (mondain@gmail.com) */ diff --git a/server/src/main/java/org/red5/server/net/rtmpt/RTMPTConnection.java b/server/src/main/java/org/red5/server/net/rtmpt/RTMPTConnection.java index 6fc572912..e5eeb8aac 100644 --- a/server/src/main/java/org/red5/server/net/rtmpt/RTMPTConnection.java +++ b/server/src/main/java/org/red5/server/net/rtmpt/RTMPTConnection.java @@ -24,7 +24,7 @@ /** * A RTMPT client / session. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) * @author Paul Gregoire (mondain@gmail.com) @@ -84,7 +84,7 @@ public class RTMPTConnection extends BaseRTMPTConnection { /** * Returns the IoSession. Note that this is a compatibility item and is not constructed by Mina. - * + * * @return ioSession */ @Override @@ -127,7 +127,7 @@ public void close() { /** * Received message object router. - * + * * @param message * an IoBuffer or Packet */ @@ -197,7 +197,7 @@ public void setRemotePort(int remotePort) { /** * Set the servlet that created the connection. - * + * * @param servlet * rtmp servlet */ @@ -207,7 +207,7 @@ protected void setServlet(RTMPTServlet servlet) { /** * Setter for servlet request. - * + * * @param request * Servlet request */ @@ -224,7 +224,7 @@ public void setServletRequest(HttpServletRequest request) { /** * Return the polling delay to use. - * + * * @return the polling delay */ public byte getPollingDelay() { @@ -271,7 +271,7 @@ public void dataReceived() { /** * Get the timestamp of last data received - * + * * @return time when last data received */ public Long getLastDataReceived() { diff --git a/server/src/main/java/org/red5/server/net/rtmpt/RTMPTHandler.java b/server/src/main/java/org/red5/server/net/rtmpt/RTMPTHandler.java index 4eec6ff67..8925cdf7c 100644 --- a/server/src/main/java/org/red5/server/net/rtmpt/RTMPTHandler.java +++ b/server/src/main/java/org/red5/server/net/rtmpt/RTMPTHandler.java @@ -14,7 +14,7 @@ /** * Handler for RTMPT messages. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) * @author Paul Gregoire (mondain@gmail.com) @@ -49,7 +49,7 @@ public RTMPTCodecFactory getCodecFactory() { /** * Return hostname for URL. - * + * * @param url * URL * @return Hostname from that URL diff --git a/server/src/main/java/org/red5/server/net/rtmpt/RTMPTServlet.java b/server/src/main/java/org/red5/server/net/rtmpt/RTMPTServlet.java index 3ae410e43..86ca5d667 100644 --- a/server/src/main/java/org/red5/server/net/rtmpt/RTMPTServlet.java +++ b/server/src/main/java/org/red5/server/net/rtmpt/RTMPTServlet.java @@ -42,7 +42,7 @@ /** * Servlet that handles all RTMPT requests. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) * @author Paul Gregoire (mondain@gmail.com) @@ -99,7 +99,7 @@ public class RTMPTServlet extends HttpServlet { /** * Return an error message to the client. - * + * * @param message * Message * @param resp @@ -145,7 +145,7 @@ protected void handleBadRequest(String message, HttpServletResponse resp) throws /** * Return a single byte to the client. - * + * * @param message * Message * @param resp @@ -166,7 +166,7 @@ protected void returnMessage(byte message, HttpServletResponse resp) throws IOEx /** * Return a message to the client. - * + * * @param message * Message * @param resp @@ -187,7 +187,7 @@ protected void returnMessage(String message, HttpServletResponse resp) throws IO /** * Return raw data to the client. - * + * * @param conn * RTMP connection * @param buffer @@ -241,7 +241,7 @@ protected void setRequestInfo(HttpServletRequest req) { /** * Skip data sent by the client. - * + * * @param req * Servlet request * @throws IOException @@ -261,7 +261,7 @@ protected void skipData(HttpServletRequest req) throws IOException { /** * Send pending messages to client. - * + * * @param conn * RTMP connection * @param resp @@ -302,7 +302,7 @@ protected void returnPendingMessages(RTMPTConnection conn, HttpServletResponse r /** * Start a new RTMPT session. - * + * * @param req * Servlet request * @param resp @@ -323,7 +323,7 @@ protected void handleOpen(HttpServletRequest req, HttpServletResponse resp) thro conn.setServletRequest(req); // add the connection to the manager manager.setConnection(conn); - // set handler + // set handler conn.setHandler(handler); conn.setDecoder(handler.getCodecFactory().getRTMPDecoder()); conn.setEncoder(handler.getCodecFactory().getRTMPEncoder()); @@ -349,7 +349,7 @@ protected void handleOpen(HttpServletRequest req, HttpServletResponse resp) thro /** * Close a RTMPT session. - * + * * @param req * Servlet request * @param resp @@ -374,7 +374,7 @@ protected void handleClose(HttpServletRequest req, HttpServletResponse resp) thr /** * Add data for an established session. - * + * * @param req * Servlet request * @param resp @@ -485,7 +485,7 @@ protected void handleSend(HttpServletRequest req, HttpServletResponse resp) thro /** * Poll RTMPT session for updates. - * + * * @param req * Servlet request * @param resp @@ -511,7 +511,7 @@ protected void handleIdle(HttpServletRequest req, HttpServletResponse resp) thro /** * Main entry point for the servlet. - * + * * @param req * Request object * @param resp @@ -582,7 +582,7 @@ protected void service(HttpServletRequest req, HttpServletResponse resp) throws break; case 'f': // HTTPIdent request (ident and ident2) //if HTTPIdent is requested send back some Red5 info - //http://livedocs.adobe.com/flashmediaserver/3.0/docs/help.html?content=08_xmlref_011.html + //http://livedocs.adobe.com/flashmediaserver/3.0/docs/help.html?content=08_xmlref_011.html String ident = "Red5Red5 Server"; // handle ident2 slightly different to appease osx clients if (uri.charAt(uri.length() - 1) == '2') { @@ -629,7 +629,7 @@ public void destroy() { /** * Returns a connection based on the current client session id. - * + * * @return RTMPTConnection */ protected RTMPTConnection getConnection() { @@ -651,7 +651,7 @@ protected RTMPTConnection getConnection() { /** * Removes a connection matching the given session id from the connection manager. - * + * * @param sessionId * session id */ @@ -676,7 +676,7 @@ public void setManager(IConnectionManager manager) { /** * Set the RTMPTHandler to use in this servlet. - * + * * @param handler * handler */ @@ -687,7 +687,7 @@ public void setHandler(RTMPTHandler handler) { /** * Set the fcs/ident2 string - * + * * @param ident2 * ident2 string */ @@ -697,7 +697,7 @@ public void setIdent2(String ident2) { /** * Sets the target size for responses - * + * * @param targetResponseSize * the targetResponseSize to set */ diff --git a/server/src/main/java/org/red5/server/net/servlet/AMFGatewayServlet.java b/server/src/main/java/org/red5/server/net/servlet/AMFGatewayServlet.java index 8e3c669a3..c9c6a47ae 100644 --- a/server/src/main/java/org/red5/server/net/servlet/AMFGatewayServlet.java +++ b/server/src/main/java/org/red5/server/net/servlet/AMFGatewayServlet.java @@ -35,7 +35,7 @@ /** * Servlet that handles remoting requests. - * + * * @author The Red5 Project * @author Luke Hubbard (luke@codegent.com) * @author Paul Gregoire (mondain@gmail.com) @@ -86,7 +86,7 @@ public void service(HttpServletRequest req, HttpServletResponse resp) throws Ser if (codecFactory == null) { ServletContext ctx = getServletContext(); log.debug("Context path: {}", ctx.getContextPath()); - //attempt to lookup the webapp context + //attempt to lookup the webapp context webAppCtx = WebApplicationContextUtils.getRequiredWebApplicationContext(ctx); //now try to look it up as an attribute if (webAppCtx == null) { @@ -111,7 +111,7 @@ public void service(HttpServletRequest req, HttpServletResponse resp) throws Ser /** * Return the global scope to use for the given request. - * + * * @param req * http request * @return scope @@ -137,7 +137,7 @@ protected IGlobalScope getGlobalScope(HttpServletRequest req) { /** * Works out AMF request - * + * * @param req * Request * @param resp @@ -193,7 +193,7 @@ protected void serviceAMF(HttpServletRequest req, HttpServletResponse resp) thro /** * Decode request - * + * * @param req * Request * @return Remoting packet @@ -231,7 +231,7 @@ protected RemotingPacket decodeRequest(HttpServletRequest req) throws Exception /** * Handles AMF request by making calls - * + * * @param req * Request * @param context @@ -243,7 +243,7 @@ protected RemotingPacket decodeRequest(HttpServletRequest req) throws Exception * @return
          * true
          * 
    - * + * * on success */ protected boolean handleRemotingPacket(HttpServletRequest req, IContext context, IScope scope, RemotingPacket message) { @@ -262,7 +262,7 @@ protected boolean handleRemotingPacket(HttpServletRequest req, IContext context, /** * Sends response to client - * + * * @param resp * Response * @param packet diff --git a/server/src/main/java/org/red5/server/net/servlet/AMFTunnelServlet.java b/server/src/main/java/org/red5/server/net/servlet/AMFTunnelServlet.java index 5fb5b7f61..d0a5fe895 100644 --- a/server/src/main/java/org/red5/server/net/servlet/AMFTunnelServlet.java +++ b/server/src/main/java/org/red5/server/net/servlet/AMFTunnelServlet.java @@ -29,7 +29,7 @@ /** * Servlet to tunnel to the AMF gateway servlet. - * + * * @author The Red5 Project * @author Paul Gregoire (mondain@gmail.com) */ diff --git a/server/src/main/java/org/red5/server/net/servlet/RedirectHTTPServlet.java b/server/src/main/java/org/red5/server/net/servlet/RedirectHTTPServlet.java index 40b2f3985..0d282bf1e 100644 --- a/server/src/main/java/org/red5/server/net/servlet/RedirectHTTPServlet.java +++ b/server/src/main/java/org/red5/server/net/servlet/RedirectHTTPServlet.java @@ -16,7 +16,7 @@ /** * Servlet to redirect to HTTP port of Red5. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ diff --git a/server/src/main/java/org/red5/server/persistence/FilePersistence.java b/server/src/main/java/org/red5/server/persistence/FilePersistence.java index 0de672784..4b769e36f 100644 --- a/server/src/main/java/org/red5/server/persistence/FilePersistence.java +++ b/server/src/main/java/org/red5/server/persistence/FilePersistence.java @@ -34,7 +34,7 @@ /** * Simple file-based persistence for objects. Lowers memory usage if used instead of RAM memory storage. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ @@ -84,7 +84,7 @@ public class FilePersistence extends RamPersistence { /** * Create file persistence object from given resource pattern resolver - * + * * @param resolver * Resource pattern resolver and loader */ @@ -95,7 +95,7 @@ public FilePersistence(ResourcePatternResolver resolver) { /** * Create file persistence object for given scope - * + * * @param scope * Scope */ @@ -115,7 +115,7 @@ public FilePersistence(IScope scope) { /** * Returns the context path. - * + * * @param rootFile * @return context path */ @@ -139,7 +139,7 @@ private String getContextPath(Resource rootFile) { /** * Initializes the root directory and creates it if it doesn't already exist. - * + * * @param rootFile * @param contextPath * @throws IOException @@ -229,7 +229,7 @@ public void setPersistenceInterval(int persistenceInterval) { /** * Return file path for persistable object - * + * * @param object * Object to obtain file path for * @return Path on disk @@ -240,7 +240,7 @@ private String getObjectFilepath(IPersistable object) { /** * Return file path for persistable object - * + * * @param object * Object to obtain file path for * @param completePath @@ -300,7 +300,7 @@ protected String getObjectPath(String id, String name) { /** * Get filename for persistable object - * + * * @param object * Persistable object * @return Name of file where given object is persisted to @@ -316,7 +316,7 @@ private String getObjectFilename(IPersistable object) { /** * Load resource with given name - * + * * @param name * Resource name * @return Persistable object @@ -327,7 +327,7 @@ private IPersistable doLoad(String name) { /** * Load resource with given name and attaches to persistable object - * + * * @param name * Resource name * @param object @@ -469,21 +469,21 @@ public boolean load(IPersistable object) { /** * Save persistable object - * + * * @param object * Persistable object * @return - * + * *
          *         true
          *         
    - * + * * on success, - * + * *
          *         false
          *         
    - * + * * otherwise */ protected boolean saveObject(IPersistable object) { @@ -590,7 +590,7 @@ public boolean save(IPersistable object) { /** * Remove empty dirs - * + * * @param base * Base directory */ diff --git a/server/src/main/java/org/red5/server/scope/BroadcastScope.java b/server/src/main/java/org/red5/server/scope/BroadcastScope.java index 0297029c3..b740798a9 100644 --- a/server/src/main/java/org/red5/server/scope/BroadcastScope.java +++ b/server/src/main/java/org/red5/server/scope/BroadcastScope.java @@ -52,7 +52,7 @@ public class BroadcastScope extends BasicScope implements IBroadcastScope, IPipe /** * Creates broadcast scope - * + * * @param parent * Parent scope * @param name @@ -66,7 +66,7 @@ public BroadcastScope(IScope parent, String name) { /** * Register pipe connection event listener with this scope's pipe. A listener that wants to listen to events when provider/consumer connects to or disconnects from a specific pipe. - * + * * @param listener * Pipe connection event listener * @see org.red5.server.messaging.IPipeConnectionListener @@ -77,7 +77,7 @@ public void addPipeConnectionListener(IPipeConnectionListener listener) { /** * Unregisters pipe connection event listener with this scope's pipe - * + * * @param listener * Pipe connection event listener * @see org.red5.server.messaging.IPipeConnectionListener @@ -88,7 +88,7 @@ public void removePipeConnectionListener(IPipeConnectionListener listener) { /** * Pull message from pipe - * + * * @return Message object * @see org.red5.server.messaging.IMessage */ @@ -98,7 +98,7 @@ public IMessage pullMessage() { /** * Pull message with timeout - * + * * @param wait * Timeout * @return Message object @@ -123,7 +123,7 @@ public boolean subscribe(IConsumer consumer, Map paramMap) { /** * Disconnects scope's pipe from given consumer - * + * * @param consumer * Consumer * @return true on success, false otherwise @@ -134,7 +134,7 @@ public boolean unsubscribe(IConsumer consumer) { /** * Getter for pipe consumers - * + * * @return Pipe consumers */ public List getConsumers() { @@ -155,7 +155,7 @@ public void sendOOBControlMessage(IConsumer consumer, OOBControlMessage oobCtrlM /** * Push a message to this output endpoint. May block the pusher when output can't handle the message at the time. - * + * * @param message * Message to be pushed * @throws IOException @@ -167,7 +167,7 @@ public void pushMessage(IMessage message) throws IOException { /** * Connect scope's pipe with given provider - * + * * @param provider * Provider * @param paramMap @@ -180,7 +180,7 @@ public boolean subscribe(IProvider provider, Map paramMap) { /** * Disconnects scope's pipe from given provider - * + * * @param provider * Provider * @return true on success, false otherwise @@ -191,7 +191,7 @@ public boolean unsubscribe(IProvider provider) { /** * Getter for providers list - * + * * @return List of providers */ public List getProviders() { @@ -212,7 +212,7 @@ public void sendOOBControlMessage(IProvider provider, OOBControlMessage oobCtrlM /** * Pipe connection event handler - * + * * @param event * Pipe connection event */ @@ -252,7 +252,7 @@ public IClientBroadcastStream getClientBroadcastStream() { /** * Sets the client broadcast stream - * + * * @param clientBroadcastStream * stream */ diff --git a/server/src/main/java/org/red5/server/scope/GlobalScope.java b/server/src/main/java/org/red5/server/scope/GlobalScope.java index 385cf274b..6e0585d68 100644 --- a/server/src/main/java/org/red5/server/scope/GlobalScope.java +++ b/server/src/main/java/org/red5/server/scope/GlobalScope.java @@ -17,7 +17,7 @@ /** * Global scope is a top level scope. Server instance is meant to be injected with Spring before initialization (otherwise NullPointerException is thrown). - * + * * @see org.red5.server.api.scope.IGlobalScope * @see org.red5.server.api.scope.IScope * @see org.red5.server.scope.Scope @@ -34,7 +34,7 @@ public class GlobalScope extends Scope implements IGlobalScope, GlobalScopeMXBea } /** - * + * * @param persistenceClass Persistent class name * @throws Exception Exception */ @@ -47,7 +47,7 @@ public void setPersistenceClass(String persistenceClass) throws Exception { /** * Get persistence store for scope - * + * * @return Persistence store */ @Override @@ -65,7 +65,7 @@ public IPersistenceStore getStore() { /** * Setter for server - * + * * @param server Server */ public void setServer(IServer server) { diff --git a/server/src/main/java/org/red5/server/scope/RoomScope.java b/server/src/main/java/org/red5/server/scope/RoomScope.java index d6462470a..c334662d2 100644 --- a/server/src/main/java/org/red5/server/scope/RoomScope.java +++ b/server/src/main/java/org/red5/server/scope/RoomScope.java @@ -4,7 +4,7 @@ /** * Represents a subscope to other scopes. - * + * * @author Paul Gregoire (mondain@gmail.com) */ public class RoomScope extends Scope { diff --git a/server/src/main/java/org/red5/server/scope/ScopeResolver.java b/server/src/main/java/org/red5/server/scope/ScopeResolver.java index 6118ef596..eab7592e0 100644 --- a/server/src/main/java/org/red5/server/scope/ScopeResolver.java +++ b/server/src/main/java/org/red5/server/scope/ScopeResolver.java @@ -34,7 +34,7 @@ public class ScopeResolver implements IScopeResolver { /** * Getter for global scope - * + * * @return Global scope */ public IGlobalScope getGlobalScope() { @@ -43,7 +43,7 @@ public IGlobalScope getGlobalScope() { /** * Setter for global scope - * + * * @param root * Global scope */ diff --git a/server/src/main/java/org/red5/server/scope/WebScope.java b/server/src/main/java/org/red5/server/scope/WebScope.java index 6318a2fe4..2f6ba7854 100644 --- a/server/src/main/java/org/red5/server/scope/WebScope.java +++ b/server/src/main/java/org/red5/server/scope/WebScope.java @@ -37,7 +37,7 @@ *

    * Then it loads virtual hosts configuration, adds mappings of paths to global scope that is injected thru Spring IoC context file and runs initialization process. *

    - * + * * Red5 server implementation instance and ServletContext are injected as well. */ @ManagedResource @@ -110,7 +110,7 @@ public void destroy() throws Exception { /** * Setter for global scope. Sets persistence class. - * + * * @param globalScope * Red5 global scope */ @@ -141,7 +141,7 @@ public void setParent() { /** * Setter for server - * + * * @param server * Server instance */ @@ -152,7 +152,7 @@ public void setServer(IServer server) { /** * Servlet context - * + * * @param servletContext * Servlet context */ @@ -162,7 +162,7 @@ public void setServletContext(ServletContext servletContext) { /** * Setter for context path - * + * * @param contextPath * Context path */ @@ -173,7 +173,7 @@ public void setContextPath(String contextPath) { /** * Return scope context path - * + * * @return Scope context path */ @Override @@ -183,7 +183,7 @@ public String getContextPath() { /** * Setter for virtual hosts. Creates array of hostnames. - * + * * @param virtualHosts * Virtual hosts list as string */ @@ -278,7 +278,7 @@ public IServer getServer() { /** * Return object that can be used to load new applications. - * + * * @return the application loader */ public IApplicationLoader getApplicationLoader() { @@ -308,7 +308,7 @@ private final void getAppContext() { /** * Is the scope currently shutting down? - * + * * @return is shutting down */ public boolean isShuttingDown() { diff --git a/server/src/main/java/org/red5/server/security/IRed5Realm.java b/server/src/main/java/org/red5/server/security/IRed5Realm.java index 9010a4c42..a2e3d7995 100644 --- a/server/src/main/java/org/red5/server/security/IRed5Realm.java +++ b/server/src/main/java/org/red5/server/security/IRed5Realm.java @@ -12,35 +12,35 @@ /** * Red5 security realm. - * + * * @author Paul Gregoire */ public interface IRed5Realm { /** * Sets a servlet context. - * + * * @param servletContext */ void setServletContext(ServletContext servletContext); /** * Returns the servlet context. - * + * * @return servlet context */ ServletContext getServletContext(); /** * Sets an application context. - * + * * @param applicationContext */ void setApplicationContext(ApplicationContext applicationContext); /** * Returns the application context. - * + * * @return application context */ ApplicationContext getApplicationContext(); diff --git a/server/src/main/java/org/red5/server/security/jaas/SimpleLoginModule.java b/server/src/main/java/org/red5/server/security/jaas/SimpleLoginModule.java index ec98c3edc..5818aa7db 100644 --- a/server/src/main/java/org/red5/server/security/jaas/SimpleLoginModule.java +++ b/server/src/main/java/org/red5/server/security/jaas/SimpleLoginModule.java @@ -26,7 +26,7 @@ /** * This LoginModule authenticates a user with a password. This module comes pre-loaded with one user / password pair and the ability for implementers to add additional pairs. The pre-loaded user is "red5" and their password is "password". - * + * * @author Paul Gregoire (mondain@gmail.com) */ public class SimpleLoginModule implements LoginModule { @@ -150,7 +150,7 @@ public boolean logout() throws LoginException { /** * Adds a new Principal, given a user name and password. - * + * * @param userName * @param password */ diff --git a/server/src/main/java/org/red5/server/security/jaas/SimplePrincipal.java b/server/src/main/java/org/red5/server/security/jaas/SimplePrincipal.java index 0e638be0a..b0a0706ea 100644 --- a/server/src/main/java/org/red5/server/security/jaas/SimplePrincipal.java +++ b/server/src/main/java/org/red5/server/security/jaas/SimplePrincipal.java @@ -13,7 +13,7 @@ /** * Represents a user.
    * Principals may be associated with a particular Subject to augment it with an additional identity. Authorization decisions can be based upon the Principals associated with a Subject. - * + * * @see java.security.Principal * @see javax.security.auth.Subject */ @@ -30,7 +30,7 @@ public class SimplePrincipal implements Principal, Serializable { /** * Create a Principal with the given name. - * + * * @param name * the username for this user * @param password diff --git a/server/src/main/java/org/red5/server/service/BaseStreamableFileService.java b/server/src/main/java/org/red5/server/service/BaseStreamableFileService.java index 6f76443a3..b60330ba2 100644 --- a/server/src/main/java/org/red5/server/service/BaseStreamableFileService.java +++ b/server/src/main/java/org/red5/server/service/BaseStreamableFileService.java @@ -17,7 +17,7 @@ /** * Base class for streamable file services. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) * @author Paul Gregoire (mondain@gmail.com) diff --git a/server/src/main/java/org/red5/server/service/ContextServiceResolver.java b/server/src/main/java/org/red5/server/service/ContextServiceResolver.java index 857025973..d2b2c378e 100644 --- a/server/src/main/java/org/red5/server/service/ContextServiceResolver.java +++ b/server/src/main/java/org/red5/server/service/ContextServiceResolver.java @@ -11,7 +11,7 @@ /** * Resolve services that have been configured in the context of a scope. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ diff --git a/server/src/main/java/org/red5/server/service/ShutdownServer.java b/server/src/main/java/org/red5/server/service/ShutdownServer.java index 5e3bbf738..ef0fa2ecd 100644 --- a/server/src/main/java/org/red5/server/service/ShutdownServer.java +++ b/server/src/main/java/org/red5/server/service/ShutdownServer.java @@ -41,7 +41,7 @@ /** * Server/service to perform orderly and controlled shutdown and clean up of Red5. - * + * * @author Paul Gregoire (mondain@gmail.com) */ public class ShutdownServer implements ApplicationContextAware, InitializingBean, DisposableBean { diff --git a/server/src/main/java/org/red5/server/service/flv/IFLVService.java b/server/src/main/java/org/red5/server/service/flv/IFLVService.java index d3e841172..f11a71ede 100644 --- a/server/src/main/java/org/red5/server/service/flv/IFLVService.java +++ b/server/src/main/java/org/red5/server/service/flv/IFLVService.java @@ -11,7 +11,7 @@ /** * A FLVService sets up the service and hands out FLV objects to its callers - * + * * @author The Red5 Project * @author Dominick Accattato (daccattato@gmail.com) * @author Luke Hubbard, Codegent Ltd (luke@codegent.com) diff --git a/server/src/main/java/org/red5/server/service/flv/impl/FLVService.java b/server/src/main/java/org/red5/server/service/flv/impl/FLVService.java index f21255479..7ca684d21 100644 --- a/server/src/main/java/org/red5/server/service/flv/impl/FLVService.java +++ b/server/src/main/java/org/red5/server/service/flv/impl/FLVService.java @@ -17,7 +17,7 @@ /** * A FLVServiceImpl sets up the service and hands out FLV objects to its callers. - * + * * @author The Red5 Project * @author Dominick Accattato (daccattato@gmail.com) * @author Luke Hubbard, Codegent Ltd (luke@codegent.com) diff --git a/server/src/main/java/org/red5/server/service/m4a/IM4AService.java b/server/src/main/java/org/red5/server/service/m4a/IM4AService.java index ed7f0bb1d..296df940a 100644 --- a/server/src/main/java/org/red5/server/service/m4a/IM4AService.java +++ b/server/src/main/java/org/red5/server/service/m4a/IM4AService.java @@ -11,7 +11,7 @@ /** * A M4AService sets up the service and hands out M4A objects to its callers - * + * * @author The Red5 Project * @author Paul Gregoire (mondain@gmail.com) */ diff --git a/server/src/main/java/org/red5/server/service/m4a/impl/M4AService.java b/server/src/main/java/org/red5/server/service/m4a/impl/M4AService.java index b8740f9f9..f8398c6c1 100644 --- a/server/src/main/java/org/red5/server/service/m4a/impl/M4AService.java +++ b/server/src/main/java/org/red5/server/service/m4a/impl/M4AService.java @@ -17,7 +17,7 @@ /** * A M4AServiceImpl sets up the service and hands out M4A objects to its callers. - * + * * @author The Red5 Project * @author Paul Gregoire, (mondain@gmail.com) */ diff --git a/server/src/main/java/org/red5/server/service/mp3/IMP3Service.java b/server/src/main/java/org/red5/server/service/mp3/IMP3Service.java index 50aeddf79..82d236259 100644 --- a/server/src/main/java/org/red5/server/service/mp3/IMP3Service.java +++ b/server/src/main/java/org/red5/server/service/mp3/IMP3Service.java @@ -11,7 +11,7 @@ /** * Provide access to MP3 objects. Marker interface. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ diff --git a/server/src/main/java/org/red5/server/service/mp4/IMP4Service.java b/server/src/main/java/org/red5/server/service/mp4/IMP4Service.java index 987ac0371..972380eee 100644 --- a/server/src/main/java/org/red5/server/service/mp4/IMP4Service.java +++ b/server/src/main/java/org/red5/server/service/mp4/IMP4Service.java @@ -11,7 +11,7 @@ /** * A MP4Service sets up the service and hands out MP4 objects to its callers - * + * * @author The Red5 Project * @author Paul Gregoire (mondain@gmail.com) */ diff --git a/server/src/main/java/org/red5/server/service/mp4/impl/MP4Service.java b/server/src/main/java/org/red5/server/service/mp4/impl/MP4Service.java index a09a43558..52fbed853 100644 --- a/server/src/main/java/org/red5/server/service/mp4/impl/MP4Service.java +++ b/server/src/main/java/org/red5/server/service/mp4/impl/MP4Service.java @@ -17,7 +17,7 @@ /** * A MP4ServiceImpl sets up the service and hands out MP4 objects to its callers. - * + * * @author The Red5 Project * @author Paul Gregoire, (mondain@gmail.com) */ @@ -25,7 +25,7 @@ public class MP4Service extends BaseStreamableFileService implements IMP4Service /** * File extensions handled by this service. If there are more than one, they are comma separated. '.mp4' must be the first on the list because it is the default file extension for mp4 files. - * + * * @see http://help.adobe.com/en_US/flashmediaserver/devguide/WS5b3ccc516d4fbf351e63e3d11a0773d117-7fc8.html */ private static String extension = ".mp4,.f4v,.mov,.3gp,.3g2"; diff --git a/server/src/main/java/org/red5/server/statistics/StatisticsService.java b/server/src/main/java/org/red5/server/statistics/StatisticsService.java index 0fcba5094..7776ca98a 100644 --- a/server/src/main/java/org/red5/server/statistics/StatisticsService.java +++ b/server/src/main/java/org/red5/server/statistics/StatisticsService.java @@ -22,7 +22,7 @@ /** * Implementation of the statistics service. - * + * * @author The Red5 Project * @author Joachim Bauch (jojo@struktur.de) */ diff --git a/server/src/main/java/org/red5/server/stream/FileStreamSource.java b/server/src/main/java/org/red5/server/stream/FileStreamSource.java index fbb92f1fc..4ab828d48 100644 --- a/server/src/main/java/org/red5/server/stream/FileStreamSource.java +++ b/server/src/main/java/org/red5/server/stream/FileStreamSource.java @@ -42,7 +42,7 @@ public class FileStreamSource implements ISeekableStreamSource, Constants { /** * Creates file stream source with tag reader - * + * * @param reader * Tag reader */ @@ -59,7 +59,7 @@ public void close() { /** * Get tag from queue and convert to message - * + * * @return RTMP event */ public IRTMPEvent dequeue() { diff --git a/server/src/main/java/org/red5/server/stream/ISeekableStreamSource.java b/server/src/main/java/org/red5/server/stream/ISeekableStreamSource.java index 944240310..aacd57560 100644 --- a/server/src/main/java/org/red5/server/stream/ISeekableStreamSource.java +++ b/server/src/main/java/org/red5/server/stream/ISeekableStreamSource.java @@ -9,14 +9,14 @@ /** * Stream source that can be seeked in timeline - * + * * @author The Red5 Project * @author Steven Gong (steven.gong@gmail.com) */ public interface ISeekableStreamSource extends IStreamSource { /** * Seek the stream source to timestamp ts (in milliseconds). - * + * * @param ts * Timestamp to seek to * @return Actual timestamp seeked to diff --git a/server/src/main/java/org/red5/server/stream/IStreamControl.java b/server/src/main/java/org/red5/server/stream/IStreamControl.java index c9938e76c..ce8fc7f7c 100644 --- a/server/src/main/java/org/red5/server/stream/IStreamControl.java +++ b/server/src/main/java/org/red5/server/stream/IStreamControl.java @@ -9,7 +9,7 @@ /** * Stream Control Event. - * + * * Marker interface for stream control operations. Play, Pause, Resume, Seek, Stop, etc. */ public interface IStreamControl { diff --git a/server/src/main/java/org/red5/server/stream/IStreamSource.java b/server/src/main/java/org/red5/server/stream/IStreamSource.java index ab4718fae..12078b504 100644 --- a/server/src/main/java/org/red5/server/stream/IStreamSource.java +++ b/server/src/main/java/org/red5/server/stream/IStreamSource.java @@ -15,24 +15,24 @@ public interface IStreamSource { /** * Is there something more to stream? - * + * * @return
          * true
          * 
    - * + * * if there's streamable data, - * + * *
          * false
          * 
    - * + * * otherwise */ public abstract boolean hasMore(); /** * Double ended queue of event objects - * + * * @return Event from queue */ public abstract IEvent dequeue(); diff --git a/server/src/main/java/org/red5/server/stream/ITokenBucket.java b/server/src/main/java/org/red5/server/stream/ITokenBucket.java index e45e98a06..71be149e9 100644 --- a/server/src/main/java/org/red5/server/stream/ITokenBucket.java +++ b/server/src/main/java/org/red5/server/stream/ITokenBucket.java @@ -10,14 +10,14 @@ /** * Basically token bucket is used to control the bandwidth used by a stream or a connection or a client. There's a background thread that distributes tokens to the buckets in the system according to the configuration of the bucket. The configuration includes how fast the tokens are distributed. When a stream, for example, needs to send out a packet, the packet's byte count is calculated and each byte corresponds to a * token in the bucket. The stream is assigned a bucket and the tokens in the bucket are acquired before the packet can be sent out. So if the speed(or bandwidth) in configuration is low, the stream can't send out packets fast. - * + * * @author The Red5 Project * @author Steven Gong (steven.gong@gmail.com) */ public interface ITokenBucket { /** * Acquire tokens amount of tokenCount waiting wait milliseconds if token not available. - * + * * @param tokenCount * The count of tokens to acquire. * @param wait @@ -28,7 +28,7 @@ public interface ITokenBucket { /** * Nonblockingly acquire token. If the token is not available and task is not null, the callback will be executed when the token is available. The tokens are not consumed automatically before callback, so it's recommended to acquire token again in callback function. - * + * * @param tokenCount * Number of tokens * @param callback @@ -39,7 +39,7 @@ public interface ITokenBucket { /** * Nonblockingly acquire token. The upper limit is specified. If not enough tokens are left in bucket, all remaining will be returned. - * + * * @param upperLimitCount * Upper limit of aquisition * @return Remaining tokens from bucket @@ -48,14 +48,14 @@ public interface ITokenBucket { /** * Get the capacity of this bucket in Byte. - * + * * @return Capacity of this bucket in bytes */ long getCapacity(); /** * The amount of tokens increased per millisecond. - * + * * @return Amount of tokens increased per millisecond. */ double getSpeed(); @@ -71,7 +71,7 @@ public interface ITokenBucket { public interface ITokenBucketCallback { /** * Being called when the tokens requested are available. - * + * * @param bucket * Bucket * @param tokenCount @@ -81,7 +81,7 @@ public interface ITokenBucketCallback { /** * Resets tokens in bucket - * + * * @param bucket * Bucket * @param tokenCount diff --git a/server/src/main/java/org/red5/server/stream/ITokenBucketService.java b/server/src/main/java/org/red5/server/stream/ITokenBucketService.java index fa5477530..4238c7235 100644 --- a/server/src/main/java/org/red5/server/stream/ITokenBucketService.java +++ b/server/src/main/java/org/red5/server/stream/ITokenBucketService.java @@ -9,7 +9,7 @@ /** * A service used to create and manage token buckets. - * + * * @author The Red5 Project * @author Steven Gong (steven.gong@gmail.com) */ @@ -18,7 +18,7 @@ public interface ITokenBucketService { /** * Create a token bucket. - * + * * @param capacity * Capacity of the bucket. * @param speed @@ -29,7 +29,7 @@ public interface ITokenBucketService { /** * Remove this bucket. - * + * * @param bucket * Bucket to remove */ diff --git a/server/src/main/java/org/red5/server/stream/PlayBuffer.java b/server/src/main/java/org/red5/server/stream/PlayBuffer.java index 4285ed0a6..53727f60f 100644 --- a/server/src/main/java/org/red5/server/stream/PlayBuffer.java +++ b/server/src/main/java/org/red5/server/stream/PlayBuffer.java @@ -15,7 +15,7 @@ /** * A Play buffer for sending VOD. The implementation is not synchronized. - * + * * @author The Red5 Project * @author Steven Gong (steven.gong@gmail.com) */ @@ -38,7 +38,7 @@ public class PlayBuffer { /** * Create play buffer with given capacity - * + * * @param capacity * Capacity of buffer */ @@ -48,7 +48,7 @@ public PlayBuffer(long capacity) { /** * Buffer capacity in bytes. - * + * * @return Buffer capacity in bytes */ public long getCapacity() { @@ -67,7 +67,7 @@ public void setCapacity(long capacity) { /** * Number of messages in buffer. - * + * * @return Number of messages in buffer */ public int getMessageCount() { @@ -76,7 +76,7 @@ public int getMessageCount() { /** * Total message size in bytes. - * + * * @return Total message size in bytes */ public long getMessageSize() { @@ -85,7 +85,7 @@ public long getMessageSize() { /** * Put a message into this buffer. - * + * * @param message * RTMP message * @return true indicates success and false indicates buffer is full. @@ -106,7 +106,7 @@ public boolean putMessage(RTMPMessage message) { /** * Take a message from this buffer. The message count decreases. - * + * * @return null if buffer is empty. */ public RTMPMessage takeMessage() { @@ -123,7 +123,7 @@ public RTMPMessage takeMessage() { /** * Peek a message but not take it from the buffer. The message count doesn't change. - * + * * @return null if buffer is empty. */ public RTMPMessage peekMessage() { diff --git a/server/src/main/java/org/red5/server/stream/RtmpSampleAccess.java b/server/src/main/java/org/red5/server/stream/RtmpSampleAccess.java index 1d87e7071..5932aabd6 100644 --- a/server/src/main/java/org/red5/server/stream/RtmpSampleAccess.java +++ b/server/src/main/java/org/red5/server/stream/RtmpSampleAccess.java @@ -14,7 +14,7 @@ /** * Default RtmpSampleAccess bean - * + * * @see org.red5.server.api.stream.IRtmpSampleAccess */ public class RtmpSampleAccess implements IRtmpSampleAccess { @@ -27,7 +27,7 @@ public class RtmpSampleAccess implements IRtmpSampleAccess { /** * Setter audioAllowed. - * + * * @param permission * permission */ @@ -38,7 +38,7 @@ public void setAudioAllowed(boolean permission) { /** * Setter videoAllowed - * + * * @param permission * permission */ diff --git a/server/src/main/java/org/red5/server/stream/ServerStream.java b/server/src/main/java/org/red5/server/stream/ServerStream.java index 222201e43..37db1aa62 100644 --- a/server/src/main/java/org/red5/server/stream/ServerStream.java +++ b/server/src/main/java/org/red5/server/stream/ServerStream.java @@ -56,7 +56,7 @@ /** * An implementation for server side stream. - * + * * @author The Red5 Project * @author Steven Gong (steven.gong@gmail.com) * @author Paul Gregoire (mondain@gmail.com) @@ -611,7 +611,7 @@ protected void onItemEnd() { /** * Push message - * + * * @param message * Message */ @@ -809,7 +809,7 @@ protected RTMPMessage getNextRTMPMessage() { /** * Send VOD initialization control message - * + * * @param msgIn * Message input * @param start @@ -835,7 +835,7 @@ private void sendVODInitCM(IMessageInput msgIn, int start) { /** * Send VOD seek control message - * + * * @param msgIn * Message input * @param position diff --git a/server/src/main/java/org/red5/server/stream/provider/FileProvider.java b/server/src/main/java/org/red5/server/stream/provider/FileProvider.java index b25993d67..7afb3cc83 100644 --- a/server/src/main/java/org/red5/server/stream/provider/FileProvider.java +++ b/server/src/main/java/org/red5/server/stream/provider/FileProvider.java @@ -89,7 +89,7 @@ public class FileProvider implements IPassive, ISeekableProvider, IPullableProvi /** * Create file provider for given file and scope - * + * * @param scope * Scope * @param file diff --git a/server/src/main/java/org/red5/server/tomcat/EmbeddedTomcat.java b/server/src/main/java/org/red5/server/tomcat/EmbeddedTomcat.java index 7efccb681..98801850e 100644 --- a/server/src/main/java/org/red5/server/tomcat/EmbeddedTomcat.java +++ b/server/src/main/java/org/red5/server/tomcat/EmbeddedTomcat.java @@ -19,7 +19,7 @@ /** * Extension of Tomcat's Tomcat class, tailored for Red5. - * + * * @author Paul Gregoire (mondain@gmail.com) */ public class EmbeddedTomcat extends Tomcat { @@ -40,7 +40,7 @@ public Context addWebapp(Host host, String contextPath, String docBase, ContextC config.setDefaultWebXml(noDefaultWebXmlPath()); // get the host first, creates a new std host if not already set getHost(); - // reset ParentClassLoader + // reset ParentClassLoader if (!host.getParentClassLoader().equals(Thread.currentThread().getContextClassLoader())) { host.setParentClassLoader(Thread.currentThread().getContextClassLoader()); } diff --git a/server/src/main/java/org/red5/server/tomcat/TomcatApplicationContext.java b/server/src/main/java/org/red5/server/tomcat/TomcatApplicationContext.java index df9926444..b0e578cfc 100644 --- a/server/src/main/java/org/red5/server/tomcat/TomcatApplicationContext.java +++ b/server/src/main/java/org/red5/server/tomcat/TomcatApplicationContext.java @@ -20,7 +20,7 @@ /** * Class that wraps a Tomcat webapp context. - * + * * @author The Red5 Project (red5@osflash.org) * @author Joachim Bauch (jojo@struktur.de) * @author Paul Gregoire @@ -34,7 +34,7 @@ public class TomcatApplicationContext implements IApplicationContext { /** * Wrap the passed Tomcat webapp context. - * + * * @param context */ protected TomcatApplicationContext(Context context) { diff --git a/server/src/main/java/org/red5/server/tomcat/TomcatApplicationLoader.java b/server/src/main/java/org/red5/server/tomcat/TomcatApplicationLoader.java index 3c5114fef..95e1ae037 100644 --- a/server/src/main/java/org/red5/server/tomcat/TomcatApplicationLoader.java +++ b/server/src/main/java/org/red5/server/tomcat/TomcatApplicationLoader.java @@ -18,7 +18,7 @@ /** * Class that can load new applications in Tomcat. - * + * * @author The Red5 Project (red5@osflash.org) * @author Joachim Bauch (jojo@struktur.de) */ @@ -38,7 +38,7 @@ public class TomcatApplicationLoader implements IApplicationLoader { /** * Wrap Tomcat engine and host. - * + * * @param embedded * @param host */ diff --git a/server/src/main/java/org/red5/server/tomcat/TomcatLoader.java b/server/src/main/java/org/red5/server/tomcat/TomcatLoader.java index 394e6bf18..3c83ab12a 100644 --- a/server/src/main/java/org/red5/server/tomcat/TomcatLoader.java +++ b/server/src/main/java/org/red5/server/tomcat/TomcatLoader.java @@ -62,9 +62,9 @@ /** * Red5 loader for Tomcat. - * + * * http://tomcat.apache.org/tomcat-8.5-doc/api/index.html - * + * * @author Paul Gregoire (mondain@gmail.com) */ @ManagedResource(objectName = "org.red5.server:type=TomcatLoader", description = "TomcatLoader") @@ -85,7 +85,7 @@ public class TomcatLoader extends LoaderBase implements InitializingBean, Dispos protected final static class DirectoryFilter implements FilenameFilter { /** * Check whether file matches filter rules - * + * * @param dir * Directory * @param name @@ -174,7 +174,7 @@ public void afterPropertiesSet() throws Exception { /** * Add context for path and docbase to current host. - * + * * @param contextPath * Path * @param docBase @@ -188,7 +188,7 @@ public Context addContext(String path, String docBase) throws ServletException { /** * Add context for path and docbase to a host. - * + * * @param contextPath * Path * @param docBase @@ -224,7 +224,7 @@ public Context addContext(String contextPath, String docBase, Host host) throws /** * Remove context from the current host. - * + * * @param path * Path */ @@ -514,7 +514,7 @@ public void run() { /** * Starts a web application and its red5 (spring) component. This is basically a stripped down version of start(). - * + * * @return true on success * @throws ServletException */ @@ -633,7 +633,7 @@ public void run() { /** * Set base host. - * + * * @param baseHost * Base host */ @@ -644,7 +644,7 @@ public void setBaseHost(Host baseHost) { /** * Get base host. - * + * * @return Base host */ public Host getBaseHost() { @@ -653,7 +653,7 @@ public Host getBaseHost() { /** * Return Tomcat engine. - * + * * @return Tomcat engine */ public Engine getEngine() { @@ -662,7 +662,7 @@ public Engine getEngine() { /** * Set connectors. - * + * * @param connectors */ public void setConnectors(List connectors) { @@ -672,7 +672,7 @@ public void setConnectors(List connectors) { /** * Set additional contexts. - * + * * @param contexts * Map of contexts * @throws ServletException @@ -686,7 +686,7 @@ public void setContexts(Map contexts) throws ServletException { /** * Setter for embedded object. - * + * * @param embedded * Embedded object */ @@ -697,7 +697,7 @@ public void setEmbedded(EmbeddedTomcat embedded) { /** * Getter for embedded object. - * + * * @return Embedded object */ public EmbeddedTomcat getEmbedded() { @@ -706,7 +706,7 @@ public EmbeddedTomcat getEmbedded() { /** * Get the host. - * + * * @return host */ public Host getHost() { @@ -715,7 +715,7 @@ public Host getHost() { /** * Set the host. - * + * * @param host * Host */ @@ -726,7 +726,7 @@ public void setHost(Host host) { /** * Set additional hosts. - * + * * @param hosts * List of hosts added to engine */ @@ -737,7 +737,7 @@ public void setHosts(List hosts) { /** * Setter for realm. - * + * * @param realm * Realm */ @@ -748,7 +748,7 @@ public void setRealm(Realm realm) { /** * Getter for realm. - * + * * @return Realm */ public Realm getRealm() { @@ -757,7 +757,7 @@ public Realm getRealm() { /** * Set additional valves. - * + * * @param valves * List of valves */ @@ -768,7 +768,7 @@ public void setValves(List valves) { /** * Returns enabled state of websocket support. - * + * * @return true if enabled and false otherwise */ public boolean isWebsocketEnabled() { @@ -777,7 +777,7 @@ public boolean isWebsocketEnabled() { /** * Set websocket feature enabled / disabled. - * + * * @param websocketEnabled */ public void setWebsocketEnabled(boolean websocketEnabled) { @@ -786,7 +786,7 @@ public void setWebsocketEnabled(boolean websocketEnabled) { /** * Returns a semi-unique id for this host based on its host values - * + * * @return host id */ protected String getHostId() { diff --git a/server/src/main/java/org/red5/server/tomcat/TomcatVHostLoader.java b/server/src/main/java/org/red5/server/tomcat/TomcatVHostLoader.java index 3e281a5f5..f1ace5e67 100644 --- a/server/src/main/java/org/red5/server/tomcat/TomcatVHostLoader.java +++ b/server/src/main/java/org/red5/server/tomcat/TomcatVHostLoader.java @@ -39,7 +39,7 @@ /** * Red5 loader for Tomcat virtual hosts. - * + * * @author Paul Gregoire (mondain@gmail.com) */ @ManagedResource(objectName = "org.red5.server:type=TomcatVHostLoader", description = "TomcatVHostLoader") @@ -76,7 +76,7 @@ public class TomcatVHostLoader extends TomcatLoader implements TomcatVHostLoader /** * Initialization. - * + * * @throws ServletException */ @Override @@ -193,7 +193,7 @@ public void start() throws ServletException { } // appctx.setServletContext(servletContext); - //set the root webapp ctx attr on the each servlet context so spring can find it later + //set the root webapp ctx attr on the each servlet context so spring can find it later servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, appctx); appctx.refresh(); } catch (Throwable t) { @@ -247,7 +247,7 @@ public void destroy() throws Exception { /** * Starts a web application and its red5 (spring) component. This is basically a stripped down version of init(). - * + * * @return true on success * @throws ServletException */ @@ -319,7 +319,7 @@ public boolean startWebApplication(String applicationName) throws ServletExcepti } // appctx.setServletContext(servletContext); - //set the root webapp ctx attr on the each servlet context so spring can find it later + //set the root webapp ctx attr on the each servlet context so spring can find it later servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, appctx); appctx.refresh(); result = true; @@ -335,7 +335,7 @@ public boolean startWebApplication(String applicationName) throws ServletExcepti /** * Create a standard host. - * + * * @return host */ public Host createHost() { @@ -368,7 +368,7 @@ public Host getHost() { /** * Adds an alias to the current host. - * + * * @param alias * alias */ @@ -379,7 +379,7 @@ public void addAlias(String alias) { /** * Removes an alias from the current host. - * + * * @param alias * Alias */ @@ -396,7 +396,7 @@ public void removeAlias(String alias) { /** * Adds a valve to the current host. - * + * * @param valve * Valve */ @@ -408,7 +408,7 @@ public void addValve(Valve valve) { /** * Removes a valve from the current host. - * + * * @param valveInfo * Valve Information. */ @@ -423,12 +423,12 @@ public void removeValve(String valveInfo) { log.error("", e); } //TODO: fix removing valves - //((StandardHost) host).removeValve(valve); + //((StandardHost) host).removeValve(valve); } /** * Set additional contexts. - * + * * @param contexts * Map of contexts * @throws ServletException diff --git a/server/src/main/java/org/red5/server/tomcat/WarDeployer.java b/server/src/main/java/org/red5/server/tomcat/WarDeployer.java index 2cc11f1fc..e4d610b6d 100644 --- a/server/src/main/java/org/red5/server/tomcat/WarDeployer.java +++ b/server/src/main/java/org/red5/server/tomcat/WarDeployer.java @@ -34,7 +34,7 @@ /** * This service provides the means to auto-deploy a war. - * + * * @author Paul Gregoire (mondain@gmail.com) */ public final class WarDeployer implements ApplicationContextAware, InitializingBean, DisposableBean { @@ -208,7 +208,7 @@ public void setWebappFolder(String webappFolder) { /** * Whether or not to expand war files prior to start up. - * + * * @param expandWars * to expand or not */ @@ -218,7 +218,7 @@ public void setExpandWars(boolean expandWars) { /** * Returns the LoaderMBean. - * + * * @return LoadeerMBean */ public LoaderMXBean getLoader() { @@ -246,7 +246,7 @@ public LoaderMXBean getLoader() { protected class DirectoryFilter implements FilenameFilter { /** * Check whether file matches filter rules - * + * * @param dir * Directory * @param name diff --git a/server/src/main/java/org/red5/server/tomcat/rtmps/RTMPSLoader.java b/server/src/main/java/org/red5/server/tomcat/rtmps/RTMPSLoader.java index 7cbd1403d..518e70111 100644 --- a/server/src/main/java/org/red5/server/tomcat/rtmps/RTMPSLoader.java +++ b/server/src/main/java/org/red5/server/tomcat/rtmps/RTMPSLoader.java @@ -30,7 +30,7 @@ /** * Loader for the RTMPS server which uses Tomcat. - * + * * @author The Red5 Project (red5@osflash.org) * @author Paul Gregoire (mondain@gmail.com) */ @@ -46,7 +46,7 @@ public class RTMPSLoader extends RTMPTLoader { /** * Setter for server - * + * * @param server * Value to set for property 'server'. */ @@ -57,7 +57,7 @@ public void setServer(IServer server) { /** * {@inheritDoc} - * + * * @throws ServletException */ @SuppressWarnings("deprecation") diff --git a/server/src/main/java/org/red5/server/tomcat/rtmpt/RTMPTLoader.java b/server/src/main/java/org/red5/server/tomcat/rtmpt/RTMPTLoader.java index 28fae67ec..e47d00b1b 100644 --- a/server/src/main/java/org/red5/server/tomcat/rtmpt/RTMPTLoader.java +++ b/server/src/main/java/org/red5/server/tomcat/rtmpt/RTMPTLoader.java @@ -32,7 +32,7 @@ /** * Loader for the RTMPT server which uses Tomcat. - * + * * @author The Red5 Project (red5@osflash.org) * @author Paul Gregoire (mondain@gmail.com) */ @@ -63,7 +63,7 @@ public class RTMPTLoader extends TomcatLoader { /** * Setter for server - * + * * @param server * Value to set for property 'server'. */ @@ -74,7 +74,7 @@ public void setServer(IServer server) { /** * {@inheritDoc} - * + * * @throws ServletException */ @SuppressWarnings("deprecation") @@ -159,7 +159,7 @@ public void start() throws ServletException { /** * Set servlet mappings - * + * * @param mappings * mappings */ diff --git a/server/src/main/java/org/red5/server/util/LocalNetworkUtil.java b/server/src/main/java/org/red5/server/util/LocalNetworkUtil.java index ceb816f6e..1a9525264 100644 --- a/server/src/main/java/org/red5/server/util/LocalNetworkUtil.java +++ b/server/src/main/java/org/red5/server/util/LocalNetworkUtil.java @@ -17,11 +17,11 @@ public class LocalNetworkUtil { /** * Returns a loopback IP address. - * + * * @return the current environment's IP address, taking into account the Internet connection to any of the available machine's Network interfaces. - * + * * Examples of the outputs: - * + * * fec0:0:0:9:213:e8ff:fef1:b717%4 siteLocal: true isLoopback: false isIPV6: true * ============================================ * 130.212.150.216 siteLocal: false isLoopback: false isIPV6: false diff --git a/server/src/main/java/org/red5/server/util/ServerDetector.java b/server/src/main/java/org/red5/server/util/ServerDetector.java index 4155466ec..2be7c4c14 100644 --- a/server/src/main/java/org/red5/server/util/ServerDetector.java +++ b/server/src/main/java/org/red5/server/util/ServerDetector.java @@ -9,7 +9,7 @@ /** * Simple JEE server detector, based on an idea created by Brian Wing Shun Chan. - * + * * @author Paul Gregoire (mondain@gmail.com) */ public class ServerDetector { diff --git a/server/src/main/java/org/red5/server/util/UrlQueryStringMap.java b/server/src/main/java/org/red5/server/util/UrlQueryStringMap.java index 7416344e2..c3d234479 100644 --- a/server/src/main/java/org/red5/server/util/UrlQueryStringMap.java +++ b/server/src/main/java/org/red5/server/util/UrlQueryStringMap.java @@ -9,7 +9,7 @@ * key * @param * value - * + * * @author Paul Gregoire */ @SuppressWarnings("serial") @@ -21,7 +21,7 @@ public UrlQueryStringMap() { /** * Parse a given query string and return an instance of this class. - * + * * @param queryString * query string * @return query string items as map entries diff --git a/server/src/main/java/org/red5/server/war/WarLoaderServlet.java b/server/src/main/java/org/red5/server/war/WarLoaderServlet.java index 03b544319..e4e6bf769 100644 --- a/server/src/main/java/org/red5/server/war/WarLoaderServlet.java +++ b/server/src/main/java/org/red5/server/war/WarLoaderServlet.java @@ -41,9 +41,9 @@ /** * Entry point from which the server config file is loaded while running within a J2EE application container. - * + * * This listener should be registered after Log4jConfigListener in web.xml, if the latter is used. - * + * * @author The Red5 Project * @author Paul Gregoire (mondain@gmail.com) */ diff --git a/server/src/main/java/org/red5/spring/ExtendedPropertyPlaceholderConfigurer.java b/server/src/main/java/org/red5/spring/ExtendedPropertyPlaceholderConfigurer.java index 3f4ecf3a0..b95eb2303 100644 --- a/server/src/main/java/org/red5/spring/ExtendedPropertyPlaceholderConfigurer.java +++ b/server/src/main/java/org/red5/spring/ExtendedPropertyPlaceholderConfigurer.java @@ -25,13 +25,13 @@ /** * An extension of {@link PropertyPlaceholderConfigurer}. Provides runtime additions of properties and wildcard location lookups. - * + * * Properties can be added at runtime by using the static {@link #addGlobalProperty} before* the bean definition is instantiated in the ApplicationContext. A property added by {@link #addGlobalProperty} will get merged into properties specified by the bean definition, overriding keys that overlap. - * + * * wildcard locations can be used instead of locations, if both are declared the last will override. Wildcard locations are handled by {@link #setWildcardLocations(String[])}, using {@link PathMatchingResourcePatternResolver} for matching locations. For wildcard locations that matches multiple Properties files, they are merged in by alphabetical filename order. - * + * * @author Michael Guymon (michael.guymon@gmail.com) - * + * */ @SuppressWarnings("deprecation") public class ExtendedPropertyPlaceholderConfigurer extends PropertyPlaceholderConfigurer { @@ -55,7 +55,7 @@ protected void processProperties(ConfigurableListableBeanFactory beanFactoryToPr /** * Merged {@link Properties} created by {@link #processProperties} - * + * * @return {@link Properties} */ public Properties getMergedProperties() { @@ -64,7 +64,7 @@ public Properties getMergedProperties() { /** * String[] of wildcard locations of properties that are converted to Resource[] using using {@link PathMatchingResourcePatternResolver} - * + * * @param locations * String[] * @throws IOException @@ -104,7 +104,7 @@ public void setWildcardLocations(String[] locations) throws IOException { /** * Add a global property to be merged - * + * * @param key * String * @param val @@ -116,7 +116,7 @@ public static synchronized void addGlobalProperty(String key, String val) { /** * Copy of the manual properties - * + * * @return {@link Properties} */ private static synchronized Properties copyOfGlobalProperties() { diff --git a/server/src/main/java/org/red5/spring/InetAddressEditor.java b/server/src/main/java/org/red5/spring/InetAddressEditor.java index b508f052a..c8abddb80 100644 --- a/server/src/main/java/org/red5/spring/InetAddressEditor.java +++ b/server/src/main/java/org/red5/spring/InetAddressEditor.java @@ -28,7 +28,7 @@ public class InetAddressEditor extends PropertyEditorSupport { private static Pattern ipv6 = Pattern.compile("([0-9a-fA-F]{4}:){7}[0-9a-fA-F]{4}"); @Override - /** + /** * Converts String IP address to InetAddress object. * * @param textValue ex. "255.255.222.255" diff --git a/server/src/test/java/org/red5/net/websocket/WebSocketServerTest.java b/server/src/test/java/org/red5/net/websocket/WebSocketServerTest.java index 3921e44ba..b797b5eb1 100644 --- a/server/src/test/java/org/red5/net/websocket/WebSocketServerTest.java +++ b/server/src/test/java/org/red5/net/websocket/WebSocketServerTest.java @@ -54,7 +54,7 @@ /** * Tests for websocket operations. - * + * * @author Paul Gregoire (mondain@gmail.com) */ public class WebSocketServerTest { diff --git a/server/src/test/java/org/red5/server/net/rtmp/ServerRTMPHandshakeTest.java b/server/src/test/java/org/red5/server/net/rtmp/ServerRTMPHandshakeTest.java index 8db381e05..458e630aa 100644 --- a/server/src/test/java/org/red5/server/net/rtmp/ServerRTMPHandshakeTest.java +++ b/server/src/test/java/org/red5/server/net/rtmp/ServerRTMPHandshakeTest.java @@ -20,7 +20,7 @@ /** * Tests for server side handshaking. Test command for using rtmpdump, if targeting specific player version use: -f "WIN 10,0,2,0" - * + * *
      * rtmpdump -V -z -r "rtmp://localhost/live" -a "live" -W "http://localhost:5080/demos/publisher.swf" -p "http://localhost:5080/live" -y "test" -v -o t.flv
      * rtmpdump -V -z -r "rtmpe://localhost/live" -a "live" -W "http://localhost:5080/demos/publisher.swf" -p "http://localhost:5080/live" -y "test" -v -o t.flv
    @@ -28,11 +28,11 @@
      * 
    * * Test server - * + * *
      * rtmpsrv - V - z
      * 
    - * + * * @author Paul Gregoire (mondain@gmail.com) */ public class ServerRTMPHandshakeTest { @@ -41,7 +41,7 @@ public class ServerRTMPHandshakeTest { // Red5 client generated C1 // Time and version: 0000000580000702 - // Algorithm: 0 + // Algorithm: 0 // Offset: 460 // Digest: a143cbbc7b8b4838496f2667402c1bd742e6c73d051e94a284519d8d7966c6c6 private String red5clientC1 = "0000000580000702dc0578676cf5adfbf9be471bd4903991ae3d34421109e4d6612e5613100c31e9d3842743689dd57b5f675dd8af1081fbc24c266873044fa372045a1a32e9f08cc974ec3b1152f898893fb7b91ee9d45a8a84c7125e77447b9273e9caff90b240a59985355a30ac6650a3363baf6e34aeb6fc78ecc8a7f746711980e4d83d45248191eb9458f52338df757d7fb60c9e876c965c5907da9f8956bc0afa21698bc92d67962bc65e6d5c36383077cad969e1c336519659396c1d9949a4f1c4279a02a9f4f26d821beb92a86ff4bc463cb2d749d14b545e50dc052a248426af96b7ccae15321d0d4cec0d5d5c6543c99e7cd37e42d71098117f6a09c3f7a351570acf26aadba70f9383f3d1ff789fb63494f956fac4fbf26f5a4acb9f8131211c0c2cb068cfc7d2b5ff6e53730fcfb5ce483bbb76587136877d7e1c757711174511751d819d4fc2cca78f878ea6d830bf833b098e77ef95547f3037cdb964318c7767f60e61acf3039d63e5dd6b86d7cee4569189a9f324ffebff70e05e1ff0c14dbbf35b865c9beb03f837e926cc1d41d9811610ef5e59b0e2afabc36a5bd89986b385f2267f9358d7291fcab51cb8e8de5b52e0bcd392fc655ce1e6ee9ff38608504d80e5aaa143cbbc7b8b4838496f2667402c1bd742e6c73d051e94a284519d8d7966c6c612a0c2814e03344821dafeb196df6cf9f130a2718e9b88af7bc57e4410e72a38014017aa7a12fa53312ed4cc53f2bc73c5e450b1dba68d380e5bd0ded42165e512a13ad401c25add1b658ba1303b7a6bf48b9abfd2121cce20b7f02f618c7ae5d1c62c3826c64ee66b81156c2c4e8d8ccfa01e6352709c27cf259c1edd3993af730c8ed9027c0136efdf135e3646bebe8a4bd8b44c32eb71bc2d7473a4bfb3454bf5cc1801b0a5883bbcc724b42fbb83bdba881a455c23108bdc12e6c4c7afa2568d0d8161b4ac1126c5bd96fd4291f6e40be4e5d780a01067238b578073ec3bb0596c7ab6c7593c4bc1a79edfee22fae0c342d83010d2c77b43e8f4ce8d1c331dd97e1a69cbeb5b894316f519b3648b75d7d94091f6b9db7a4a7efcd98d606f819433e7344ad729846f04ffe2ca6a3bca43bb69d08a30cc189f1da97f69749868bf7302a7ceca8521ce673361a7918cec36218ed6cc47ad8e9d7b56d337d5d97f6828dfa78977e80e3236be323a4b4d4ac8c5a222f4675a1a44624a9ca30867193a8552e948585f38ac93b3e70f5b123a4149cf454effe17cef78aed52d70f5abcaba8e7bbdf0b452901a0a853a8ba173f5e895646ddf4a7b27b82e2b4052c3507d72563c123f9e55896fbf030c247591ab084db9a6a11d5e7bda60820f034f45f2b5825fd25963fabd93fecea0b07f959550bc12e1ac4d746e5c91704e57946e0724c7ec1f747e4205a7db483adafe62d9616551b3b6368c74ddd2c1afca81d068957a3f3ac219ef2a0c3d4469647b41a9633eead2d9647dfef334f138045a15b1920c8754f829084421d68c08940b5eecea6a68d29bc6a096c6d7b564a2e10b1a3eba48bc5d205913feab5c078b8c4877fecde82f7cb9510dfc297215798c25bd9207da4faed4f07dea78e40363ce75d439269cb3e61a71b5d4fec457ab58f8631b7ce7444454a10f7f67c9b5109ebc9c50c3491ea328e7b07e52f9f44aa9bfe88224f13e44b9838fa10aa4285a2fd95f74cac9271c851a4df78294d5673dd826a064cab5c50971a4cf2b81c669a8ec1c5f6d8acd1725796f0b7cca33b953457bdfb719ac31648b8969056232c877fa4a046e0ef1ba45f31149d5089e4a262cd52b18dcb5516bb2d2eec2baf2c6ac6b712ac76946f2ca7fcff3286bc9d62c5756b9e5e14ec9f90f415fadf3eba5c18a506f58c6929a8f96804efb4634baffb58353544b81f3a18ca7313ee8aafd25099a7802e23a0242b4e7cb61a098a748d705119513dc5e6459df926f6b7f385f7a3953b68f219e60da6df839b32e88e974f98e2d85b9615469ccde04c06624c4d62c439933d60bcc0fef2e286ebf3165e5cf1530bfd58097f271853220c6e7affaec85844613bb2cda966ac6f486dca0a9bf49523535a249f116ce0038f5e2872566c9d6d88cd81bcaccc7631be78248e3c44832305b4655a47a2a01a79848177c8059c3"; diff --git a/server/src/test/java/org/red5/server/scope/ScopeTest.java b/server/src/test/java/org/red5/server/scope/ScopeTest.java index 13bc4fd32..cbe5f99ea 100644 --- a/server/src/test/java/org/red5/server/scope/ScopeTest.java +++ b/server/src/test/java/org/red5/server/scope/ScopeTest.java @@ -143,7 +143,7 @@ public void testScopeCreation() throws InterruptedException { } } assertTrue(appScope.getBasicScopeNames(ScopeType.ROOM).size() == 1); - * + * */ log.info("testScopeCreation-end"); } diff --git a/server/src/test/java/org/red5/server/service/CuePointInjectionTest.java b/server/src/test/java/org/red5/server/service/CuePointInjectionTest.java index bf5e48751..5bfa28017 100644 --- a/server/src/test/java/org/red5/server/service/CuePointInjectionTest.java +++ b/server/src/test/java/org/red5/server/service/CuePointInjectionTest.java @@ -45,7 +45,7 @@ public void setUp() { /** * Test MetaData injection - * + * * @throws IOException * for fun */ @@ -82,7 +82,7 @@ public void testCuePointInjection() throws IOException { /** * Write FLV tags and inject Cue Points - * + * * @param reader * @param writer * @throws IOException @@ -139,7 +139,7 @@ private void writeTagsWithInjection(ITagReader reader, ITagWriter writer) throws /** * Injects metadata (Cue Points) into a tag - * + * * @param cue * @param writer * @param tag @@ -162,7 +162,7 @@ private ITag injectCuePoint(Object cue, ITag tag) { /** * Returns a timestamp in milliseconds - * + * * @param object * @return int time */ diff --git a/server/src/test/java/org/red5/server/service/MetaDataInjectionTest.java b/server/src/test/java/org/red5/server/service/MetaDataInjectionTest.java index 5652620df..de9219922 100644 --- a/server/src/test/java/org/red5/server/service/MetaDataInjectionTest.java +++ b/server/src/test/java/org/red5/server/service/MetaDataInjectionTest.java @@ -48,7 +48,7 @@ public void setUp() { /** * Test MetaData injection - * + * * @throws IOException * if io exception */ @@ -83,7 +83,7 @@ public void testMetaDataInjection() throws IOException { /** * Write FLV tags and inject Cue Points - * + * * @param reader * @param writer * @throws IOException @@ -148,7 +148,7 @@ private void writeTagsWithInjection(ITagReader reader, ITagWriter writer) throws /** * Injects metadata (Cue Points) into a tag - * + * * @param cue * @param writer * @param tag @@ -171,7 +171,7 @@ private ITag injectMetaData(Object cue, ITag tag) { /** * Returns a timestamp in milliseconds - * + * * @param object * @return int time */ diff --git a/server/src/test/java/org/red5/server/service/MetaDataTest.java b/server/src/test/java/org/red5/server/service/MetaDataTest.java index b90cf1d8f..2d1c3a4df 100644 --- a/server/src/test/java/org/red5/server/service/MetaDataTest.java +++ b/server/src/test/java/org/red5/server/service/MetaDataTest.java @@ -13,7 +13,7 @@ /** * MetaData TestCase - * + * * @author The Red5 Project * @author daccattato (daccattato@gmail.com) */ diff --git a/server/src/test/java/org/red5/server/service/MetaServiceTest.java b/server/src/test/java/org/red5/server/service/MetaServiceTest.java index 14ed81d11..0c5eb28ac 100644 --- a/server/src/test/java/org/red5/server/service/MetaServiceTest.java +++ b/server/src/test/java/org/red5/server/service/MetaServiceTest.java @@ -41,7 +41,7 @@ protected void setUp() throws Exception { /** * Test writing meta data - * + * * @throws IOException * if io exception */ diff --git a/server/src/test/java/org/red5/server/so/SharedObjectTest.java b/server/src/test/java/org/red5/server/so/SharedObjectTest.java index 4603604ba..dd47c6eed 100644 --- a/server/src/test/java/org/red5/server/so/SharedObjectTest.java +++ b/server/src/test/java/org/red5/server/so/SharedObjectTest.java @@ -45,9 +45,9 @@ /** * This is for testing SharedObject issues. - * + * * http://help.adobe.com/en_US/FlashMediaServer/3.5_SS_ASD/WS5b3ccc516d4fbf351e63e3d11a11afc95e-7e63.html - * + * * @author Paul Gregoire (mondain@gmail.com) */ @FixMethodOrder(MethodSorters.NAME_ASCENDING) diff --git a/service/pom.xml b/service/pom.xml index ef3856acd..39cf8376f 100644 --- a/service/pom.xml +++ b/service/pom.xml @@ -3,7 +3,7 @@ org.red5 red5-parent - 1.2.24 + 1.2.31 4.0.0 red5-service diff --git a/service/src/main/java/org/red5/classloading/ChildFirstClassLoader.java b/service/src/main/java/org/red5/classloading/ChildFirstClassLoader.java index 6cf912f4c..2883cc496 100644 --- a/service/src/main/java/org/red5/classloading/ChildFirstClassLoader.java +++ b/service/src/main/java/org/red5/classloading/ChildFirstClassLoader.java @@ -12,7 +12,7 @@ /** * An almost trivial no-fuss implementation of a class loader following the child-first delegation model. Based on code from Ceki Gulcu - * + * * @author Paul Gregoire (mondain@gmail.com) */ public final class ChildFirstClassLoader extends URLClassLoader { @@ -57,7 +57,7 @@ public Class loadClass(String name) throws ClassNotFoundException { * We override the parent-first behavior established by java.lang.Classloader. *

    * The implementation is surprisingly straightforward. - * + * * @param name the name of the class to load, should not be null * @param resolve flag that indicates whether the class should be resolved * @return the loaded class, never null @@ -119,7 +119,7 @@ protected Class loadClass(String name, boolean resolve) throws ClassNotFoundE /** * Override the parent-first resource loading model established by java.lang.Classloader with child-first behavior. - * + * * @param name the name of the resource to load, should not be null * @return a {@link URL} for the resource, or null if it could not be found */ diff --git a/service/src/main/java/org/red5/classloading/ClassLoaderBuilder.java b/service/src/main/java/org/red5/classloading/ClassLoaderBuilder.java index 7b6b31581..c2dfd6a4f 100644 --- a/service/src/main/java/org/red5/classloading/ClassLoaderBuilder.java +++ b/service/src/main/java/org/red5/classloading/ClassLoaderBuilder.java @@ -32,10 +32,10 @@ /** * Class used to get the Servlet Class loader. The class loader returned is a child first class loader. - * + * *
    * This class is based on original code from the XINS project, by Anthony Goubard (anthony.goubard@japplis.com) - * + * * @author Paul Gregoire (mondain@gmail.com) */ public final class ClassLoaderBuilder { @@ -62,7 +62,7 @@ public final class ClassLoaderBuilder { /** * Default build uses Red5 common lib without a parent classloader. - * + * * @return the class loader */ public static ClassLoader build() { @@ -71,12 +71,12 @@ public static ClassLoader build() { /** * Gets a class loader based on mode. - * + * * @param path * the directory or file containing classes * @param mode * the mode in which the servlet should be loaded. The possible values are - * + * *

          * USE_CURRENT_CLASSPATH, USE_CLASSPATH_LIB, USE_WAR_LIB
          * 
    @@ -285,7 +285,7 @@ public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IO /** * Unpack the specified entry from the JAR file. - * + * * @param jarStream * The input stream of the JAR file positioned at the entry * @param entryName @@ -310,7 +310,7 @@ private static Path unpack(JarInputStream jarStream, String entryName) throws IO /** * Removes older versions of libraries from a given list based on their version numbers. - * + * * @param list */ private final static void scrubURLList(Collection list) { @@ -532,7 +532,7 @@ private final static void scrubURLList(Collection list) { /** * Parses url and returns the jar filename stripped of the ending .jar - * + * * @param url * @return */ diff --git a/service/src/main/java/org/red5/daemon/EngineLauncher.java b/service/src/main/java/org/red5/daemon/EngineLauncher.java index fadf57c43..58b9b2771 100644 --- a/service/src/main/java/org/red5/daemon/EngineLauncher.java +++ b/service/src/main/java/org/red5/daemon/EngineLauncher.java @@ -32,7 +32,7 @@ public class EngineLauncher implements Daemon { /** * The Java entry point. - * + * * @param args * Command line arguments */ diff --git a/service/src/main/java/org/red5/server/Bootstrap.java b/service/src/main/java/org/red5/server/Bootstrap.java index a4d0d92f6..91eeb2265 100644 --- a/service/src/main/java/org/red5/server/Bootstrap.java +++ b/service/src/main/java/org/red5/server/Bootstrap.java @@ -27,7 +27,7 @@ public class Bootstrap { /** * BootStrapping entry point - * + * * @param args * command line arguments * @throws Exception @@ -49,7 +49,7 @@ public static void main(String[] args) throws Exception { /** * Loads classloader with dependencies - * + * * @throws InstantiationException * @throws IllegalAccessException * @throws ClassNotFoundException @@ -114,7 +114,7 @@ private static void bootStrap() throws InstantiationException, IllegalAccessExce /** * Gets the configuration root - * + * * @param root * @return */ @@ -136,7 +136,7 @@ static Path getConfigurationRoot(Path root) { /** * Gets the Red5 root - * + * * @return * @throws IOException */ diff --git a/service/src/main/java/org/red5/server/Shutdown.java b/service/src/main/java/org/red5/server/Shutdown.java index c648ac8e9..4388b49fb 100644 --- a/service/src/main/java/org/red5/server/Shutdown.java +++ b/service/src/main/java/org/red5/server/Shutdown.java @@ -29,7 +29,7 @@ public class Shutdown { *
  • Arg 0 = port number
  • *
  • Arg 1 = token
  • * - * + * * @param args * see args list */