You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flex.apache.org by cd...@apache.org on 2015/12/20 13:47:48 UTC
[18/31] flex-blazeds git commit: Continued cleaning up the javadoc
comments
Continued cleaning up the javadoc comments
Project: http://git-wip-us.apache.org/repos/asf/flex-blazeds/repo
Commit: http://git-wip-us.apache.org/repos/asf/flex-blazeds/commit/897a2320
Tree: http://git-wip-us.apache.org/repos/asf/flex-blazeds/tree/897a2320
Diff: http://git-wip-us.apache.org/repos/asf/flex-blazeds/diff/897a2320
Branch: refs/heads/master
Commit: 897a232079b63e5650b99f7c1f2e177ecf210680
Parents: c480d9e
Author: Christofer Dutz <ch...@codecentric.de>
Authored: Thu Jul 30 15:52:30 2015 +0200
Committer: Christofer Dutz <ch...@codecentric.de>
Committed: Thu Jul 30 15:52:30 2015 +0200
----------------------------------------------------------------------
.../core/src/flex/management/BaseControl.java | 14 +++--
.../flex/management/ManageableComponent.java | 4 +-
.../flex/management/jmx/MBeanServerGateway.java | 9 ++--
.../src/flex/management/jmx/ObjectInstance.java | 1 +
.../src/flex/management/jmx/ObjectName.java | 1 +
.../src/flex/messaging/FactoryInstance.java | 2 +
.../core/src/flex/messaging/FlexContext.java | 36 ++++++++++---
.../core/src/flex/messaging/FlexFactory.java | 8 +--
.../core/src/flex/messaging/FlexSession.java | 6 ++-
.../src/flex/messaging/FlexSessionManager.java | 6 +--
.../src/flex/messaging/HttpFlexSession.java | 4 ++
.../core/src/flex/messaging/MessageBroker.java | 31 ++++++++---
.../core/src/flex/messaging/MessageClient.java | 6 ++-
.../src/flex/messaging/MessageDestination.java | 6 +--
.../src/flex/messaging/MessageException.java | 14 +++--
.../core/src/flex/messaging/VersionInfo.java | 2 -
.../flex/messaging/config/ThrottleSettings.java | 10 ++--
.../messaging/endpoints/AbstractEndpoint.java | 2 +-
.../src/flex/messaging/endpoints/Endpoint.java | 2 +-
.../factories/JavaFactoryInstance.java | 2 +-
.../services/AbstractBootstrapService.java | 54 ++++++++++----------
.../flex/messaging/services/MessageService.java | 2 +-
.../messaging/util/ToStringPrettyPrinter.java | 2 -
.../src/flex/messaging/util/URLDecoder.java | 2 -
.../services/http/ExternalProxySettings.java | 14 ++---
.../services/http/HTTPProxyAdapter.java | 6 +--
26 files changed, 151 insertions(+), 95 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/flex-blazeds/blob/897a2320/modules/core/src/flex/management/BaseControl.java
----------------------------------------------------------------------
diff --git a/modules/core/src/flex/management/BaseControl.java b/modules/core/src/flex/management/BaseControl.java
index b26b909..a66a104 100644
--- a/modules/core/src/flex/management/BaseControl.java
+++ b/modules/core/src/flex/management/BaseControl.java
@@ -113,7 +113,7 @@ public abstract class BaseControl implements BaseControlMBean,
/**
* Set the register object.
- * @param registar the registrar to set
+ * @param registrar the registrar to set
*/
protected void setRegistrar(AdminConsoleDisplayRegistrar registrar)
{
@@ -316,12 +316,14 @@ public abstract class BaseControl implements BaseControlMBean,
* <li><code>domain</code>: The domain specified by the DOMAIN_PREFIX
* constant followed by the application identifier if one is available.</li>
* <li><code>type</code>: The short type name of the resource managed by
- * the MBean.<br /> - The <code>MessageBrokerControlMBean</code> manages
+ * the MBean.
+ * - The <code>MessageBrokerControlMBean</code> manages
* the <code>flex.messaging.MessageBroker</code> so:
* <code>type=MessageBroker</code> </li>
* <li><code>id</code>: The id value for the resource managed by this
* MBean. If no name or id is available on the resource, an id will be
- * fabricated according to this strategy:<br />
+ * fabricated according to this strategy:
+ *
* <em>id = {type} + N</em> (where N is a numeric increment for instances
* of this type) </li>
* <li>* optional containment keys</li>
@@ -332,11 +334,13 @@ public abstract class BaseControl implements BaseControlMBean,
* containment in the following fashion. First, the 'type' key for a
* contained MBean indicates the containment hierarchy for the bean. So, the
* <code>ObjectName</code> for an <code>RTMPEndpointControlMBean</code>
- * would be: <code>type=MessageBroker.RTMPEndpoint</code><br />
+ * would be: <code>type=MessageBroker.RTMPEndpoint</code>
+ *
* In addition to the hierarchical 'type' key, the full
* <code>ObjectName</code> for this <code>RTMPEndpointControlMBean</code>
* also contains a containment key:
- * <code>MessageBroker=MessageBroker1</code><br />
+ * <code>MessageBroker=MessageBroker1</code>
+ *
* Optional containment keys have the format:
* <em>{parent type}={parent name}</em>. A containment key is added for
* each ancestor up to the root of the hierarchy and these keys allow the
http://git-wip-us.apache.org/repos/asf/flex-blazeds/blob/897a2320/modules/core/src/flex/management/ManageableComponent.java
----------------------------------------------------------------------
diff --git a/modules/core/src/flex/management/ManageableComponent.java b/modules/core/src/flex/management/ManageableComponent.java
index af27b6c..02cccfc 100644
--- a/modules/core/src/flex/management/ManageableComponent.java
+++ b/modules/core/src/flex/management/ManageableComponent.java
@@ -256,7 +256,7 @@ public abstract class ManageableComponent implements Manageable, FlexComponent
/**
* Sets if the component is started.
*
- * @param started
+ * @param started true if the component is started.
*/
protected void setStarted(boolean started)
{
@@ -292,7 +292,7 @@ public abstract class ManageableComponent implements Manageable, FlexComponent
/**
* Sets if the component is valid.
*
- * @param valid
+ * @param valid true if the comoponent is valid.
*/
protected void setValid(boolean valid)
{
http://git-wip-us.apache.org/repos/asf/flex-blazeds/blob/897a2320/modules/core/src/flex/management/jmx/MBeanServerGateway.java
----------------------------------------------------------------------
diff --git a/modules/core/src/flex/management/jmx/MBeanServerGateway.java b/modules/core/src/flex/management/jmx/MBeanServerGateway.java
index 329a4aa..f60c401 100644
--- a/modules/core/src/flex/management/jmx/MBeanServerGateway.java
+++ b/modules/core/src/flex/management/jmx/MBeanServerGateway.java
@@ -40,12 +40,12 @@ import javax.management.RuntimeOperationsException;
/**
* Remoting gateway to the MBean server that hosts Flex MBeans.
- * <p>
+ *
* Some base javax.management.MBeanServer methods are unimplemented due to the
* fact that we're interacting with the MBean server from remote Flash clients.
* Some methods have been modified to better suite remote Flash clients. Other
* methods are additive, serving as a convenience for Flex applications.
- * </p><p>
+ *
* Unimplemented methods from the base MBeanServer API:
* <ul>
* <li>getDomains() - JMX 1.2</li>
@@ -58,7 +58,7 @@ import javax.management.RuntimeOperationsException;
* <li>getClassLoader() - meaningless to a Flash client.</li>
* <li>getClassLoaderRepository() - meaningless to a Flash client.</li>
* </ul>
- * </p><p>
+ *
* Modifications to the base MBeanServer API:
* <ul>
* <li>* All ObjectName arguments are typed as String because serialization in either
@@ -71,14 +71,13 @@ import javax.management.RuntimeOperationsException;
* <li>getAttributes() returns an Array of Attributes rather than an AttributeList.</li>
* <li>setAttributes() accepts and returns Arrays of Attributes rather than AttributeLists.</li>
* </ul>
- * </p><p>
+ *
* Additonal Flex-specific methods:
* <ul>
* <li>getFlexMBeanCount()</li>
* <li>getFlexDomains()</li>
* <li>getFlexMBeanObjectNames()</li>
* </ul>
- * </p>
*/
public class MBeanServerGateway
{
http://git-wip-us.apache.org/repos/asf/flex-blazeds/blob/897a2320/modules/core/src/flex/management/jmx/ObjectInstance.java
----------------------------------------------------------------------
diff --git a/modules/core/src/flex/management/jmx/ObjectInstance.java b/modules/core/src/flex/management/jmx/ObjectInstance.java
index ceef619..8985ee0 100644
--- a/modules/core/src/flex/management/jmx/ObjectInstance.java
+++ b/modules/core/src/flex/management/jmx/ObjectInstance.java
@@ -57,6 +57,7 @@ public class ObjectInstance
* <code>javax.management.ObjectInstance</code> instance.
*
* @return A JMX <code>ObjectInstance</code> based upon this instance.
+ * @throws MalformedObjectNameException an exception
*/
public javax.management.ObjectInstance toObjectInstance() throws MalformedObjectNameException
{
http://git-wip-us.apache.org/repos/asf/flex-blazeds/blob/897a2320/modules/core/src/flex/management/jmx/ObjectName.java
----------------------------------------------------------------------
diff --git a/modules/core/src/flex/management/jmx/ObjectName.java b/modules/core/src/flex/management/jmx/ObjectName.java
index 9ab175d..b55ebb4 100644
--- a/modules/core/src/flex/management/jmx/ObjectName.java
+++ b/modules/core/src/flex/management/jmx/ObjectName.java
@@ -88,6 +88,7 @@ public class ObjectName
* <code>javax.management.ObjectName</code> instance.
*
* @return A JMX <code>ObjectName</code> based upon this instance.
+ * @throws MalformedObjectNameException an exception
*/
public javax.management.ObjectName toObjectName() throws MalformedObjectNameException
{
http://git-wip-us.apache.org/repos/asf/flex-blazeds/blob/897a2320/modules/core/src/flex/messaging/FactoryInstance.java
----------------------------------------------------------------------
diff --git a/modules/core/src/flex/messaging/FactoryInstance.java b/modules/core/src/flex/messaging/FactoryInstance.java
index 1e80655..e39faed 100644
--- a/modules/core/src/flex/messaging/FactoryInstance.java
+++ b/modules/core/src/flex/messaging/FactoryInstance.java
@@ -102,6 +102,8 @@ public class FactoryInstance
* This is by convention the main property for the defining the
* instance we create with this factory. It may be the class name
* for the JavaFactory or the id for a factory that uses ids.
+ *
+ * @param source source
*/
public void setSource(String source)
{
http://git-wip-us.apache.org/repos/asf/flex-blazeds/blob/897a2320/modules/core/src/flex/messaging/FlexContext.java
----------------------------------------------------------------------
diff --git a/modules/core/src/flex/messaging/FlexContext.java b/modules/core/src/flex/messaging/FlexContext.java
index 8d85cb3..79e4b96 100644
--- a/modules/core/src/flex/messaging/FlexContext.java
+++ b/modules/core/src/flex/messaging/FlexContext.java
@@ -56,6 +56,12 @@ public class FlexContext
/**
* Users should not call this.
*
+ * @param flexClient the Flex client
+ * @param session the Flex session
+ * @param broker the message broker
+ * @param request the http servlet request
+ * @param response the http servlet response
+ * @param servletConfig the servlet config
*/
public static void setThreadLocalObjects(FlexClient flexClient,
FlexSession session,
@@ -79,6 +85,9 @@ public class FlexContext
/**
* Users should not call this.
*
+ * @param flexClient the Flex client
+ * @param session the Flex session
+ * @param broker the message broker
*/
public static void setThreadLocalObjects(FlexClient flexClient, FlexSession session, MessageBroker broker)
{
@@ -112,6 +121,7 @@ public class FlexContext
* The HttpServletResponse for the current request if the request is via HTTP.
* Returns null if the client is using a non-HTTP channel.
* Available for users.
+ *
* @return HttpServletRequest current HttpServletRequest object
*/
public static HttpServletRequest getHttpRequest()
@@ -122,6 +132,7 @@ public class FlexContext
/**
* Users should not call this.
*
+ * @param value HttpServletRequest object
*/
public static void setThreadLocalHttpRequest(HttpServletRequest value)
{
@@ -138,6 +149,7 @@ public class FlexContext
* The HttpServletResponse for the current request if the request is via HTTP.
* Returns null if the using an non-HTTP channel.
* Available for users.
+ *
* @return HttpServletResponse current HttpServletResponse object
*/
public static HttpServletResponse getHttpResponse()
@@ -148,6 +160,7 @@ public class FlexContext
/**
* Users should not call this.
*
+ * @param value HttpServletResponse object
*/
public static void setThreadLocalHttpResponse(HttpServletResponse value)
{
@@ -164,6 +177,7 @@ public class FlexContext
* The HttpServletRequest for the current request if it is transporting a tunneled protocol.
* Returns null if the current request protocol it not tunneled.
* Available for users.
+ *
* @return HttpServletRequest tunnel HttpServletRequest object
*/
public static HttpServletRequest getTunnelHttpRequest()
@@ -174,6 +188,7 @@ public class FlexContext
/**
* Users should not call this.
*
+ * @param value HttpServletRequest object
*/
public static void setThreadLocalTunnelHttpRequest(HttpServletRequest value)
{
@@ -189,6 +204,7 @@ public class FlexContext
/**
* The ServletConfig for the current request, uses the last known ServletConfig
* when the request is not via HTTP. Available for users.
+ *
* @return ServletConfig current ServletConfig object
*/
public static ServletConfig getServletConfig()
@@ -203,6 +219,7 @@ public class FlexContext
/**
* Users should not call this.
*
+ * @param value ServletConfig object
*/
public static void setThreadLocalServletConfig(ServletConfig value)
{
@@ -222,6 +239,7 @@ public class FlexContext
/**
* The ServletContext for the current web application.
+ *
* @return ServletContext current ServletContext object
*/
public static ServletContext getServletContext()
@@ -231,6 +249,7 @@ public class FlexContext
/**
* The FlexClient for the current request. Available for users.
+ *
* @return FlexClient the current FlexClient object
*/
public static FlexClient getFlexClient()
@@ -241,6 +260,7 @@ public class FlexContext
/**
* Users should not call this.
*
+ * @param flexClient FlexClient object
*/
public static void setThreadLocalFlexClient(FlexClient flexClient)
{
@@ -255,6 +275,7 @@ public class FlexContext
/**
* The FlexSession for the current request. Available for users.
+ *
* @return FlexSession the current FlexSession object
*/
public static FlexSession getFlexSession()
@@ -265,6 +286,7 @@ public class FlexContext
/**
* Users should not call this.
*
+ * @param session FlexSession object
*/
public static void setThreadLocalSession(FlexSession session)
{
@@ -280,7 +302,7 @@ public class FlexContext
/**
* The MessageBroker for the current request. Not available for users.
*
- *
+ * @return The MessageBroker for the current request
*/
public static MessageBroker getMessageBroker()
{
@@ -290,6 +312,7 @@ public class FlexContext
/**
* Users should not call this.
*
+ * @param value MessageBroker object
*/
public static void setThreadLocalMessageBroker(MessageBroker value)
{
@@ -309,6 +332,7 @@ public class FlexContext
/**
* The Endpoint for the current message. Not available for users.
*
+ * @return The Endpoint for the current message
*/
public static Endpoint getEndpoint()
{
@@ -318,6 +342,7 @@ public class FlexContext
/**
* Users should not call this.
*
+ * @param value Endpoint object
*/
public static void setThreadLocalEndpoint(Endpoint value)
{
@@ -333,6 +358,7 @@ public class FlexContext
/**
* Users should not call this.
*
+ * @return MessageRoutedNotifier object
*/
public static MessageRoutedNotifier getMessageRoutedNotifier()
{
@@ -342,6 +368,7 @@ public class FlexContext
/**
* Users should not call this.
*
+ * @param value MessageRoutedNotifier object
*/
public static void setMessageRoutedNotifier(MessageRoutedNotifier value)
{
@@ -370,8 +397,6 @@ public class FlexContext
* a server peer in a cluster.
*
* @param value True if the message came from a peer; otherwise false.
- *
- *
*/
public static void setMessageFromPeer(boolean value)
{
@@ -384,6 +409,7 @@ public class FlexContext
/**
* Users should not call this.
*
+ * @return true if per-client-authentication is turned on.
*/
public static boolean isPerClientAuthentication()
{
@@ -419,7 +445,7 @@ public class FlexContext
* perClientAuthentication is in use.
*
* @param userPrincipal The principal to associate with the FlexClient or FlexSession
- * depending upon whether perClientAuthentication is in use.
+ * depending upon whether perClientAuthentication is in use.
*/
public static void setUserPrincipal(Principal userPrincipal)
{
@@ -430,7 +456,6 @@ public class FlexContext
}
/**
- *
* Create the static thread local storage.
*/
public static void createThreadLocalObjects()
@@ -451,7 +476,6 @@ public class FlexContext
}
/**
- *
* Destroy the static thread local storage.
* Call ONLY on shutdown
*/
http://git-wip-us.apache.org/repos/asf/flex-blazeds/blob/897a2320/modules/core/src/flex/messaging/FlexFactory.java
----------------------------------------------------------------------
diff --git a/modules/core/src/flex/messaging/FlexFactory.java b/modules/core/src/flex/messaging/FlexFactory.java
index 2633460..18cacf3 100644
--- a/modules/core/src/flex/messaging/FlexFactory.java
+++ b/modules/core/src/flex/messaging/FlexFactory.java
@@ -52,18 +52,20 @@ public interface FlexFactory extends FlexConfigurable
* an instance of this object. If the instance is application
* scoped, the FactoryInstance may contain a reference to the
* instance directly.
- * <p>
+ *
* Any valid properties used for this configuration
* must be accessed to avoid warnings about unused configuration
* elements. If your factory is only used for application
* scoped components, you do not need to implement
* this method as the lookup method itself can be used
* to validate its configuration.
- * </p><p>
+ *
* The id property is used as a name to help you identify
* this factory instance for any errors it might generate.
- * </p>
*
+ * @param id id of the factory
+ * @param properties properties
+ * @return a new FactoryInstance instance
*/
FactoryInstance createFactoryInstance(String id, ConfigMap properties);
http://git-wip-us.apache.org/repos/asf/flex-blazeds/blob/897a2320/modules/core/src/flex/messaging/FlexSession.java
----------------------------------------------------------------------
diff --git a/modules/core/src/flex/messaging/FlexSession.java b/modules/core/src/flex/messaging/FlexSession.java
index b01ebe1..4f34f8a 100644
--- a/modules/core/src/flex/messaging/FlexSession.java
+++ b/modules/core/src/flex/messaging/FlexSession.java
@@ -338,6 +338,8 @@ public abstract class FlexSession extends TimeoutAbstractObject implements FlexC
* small messages should be sent, even if they are supported.
*
* The default is false.
+ *
+ * @return true if the server can attempt to send small messages.
*/
public boolean useSmallMessages()
{
@@ -345,7 +347,7 @@ public abstract class FlexSession extends TimeoutAbstractObject implements FlexC
}
/**
- *
+ * @param value true if the server can attempt to send small messages.
*/
public void setUseSmallMessages(boolean value)
{
@@ -469,7 +471,7 @@ public abstract class FlexSession extends TimeoutAbstractObject implements FlexC
* Implements MessageClientListener.
* Handling created events is a no-op.
*
- * @messageClient The new MessageClient.
+ * @param messageClient The new MessageClient.
*/
public void messageClientCreated(MessageClient messageClient) {}
http://git-wip-us.apache.org/repos/asf/flex-blazeds/blob/897a2320/modules/core/src/flex/messaging/FlexSessionManager.java
----------------------------------------------------------------------
diff --git a/modules/core/src/flex/messaging/FlexSessionManager.java b/modules/core/src/flex/messaging/FlexSessionManager.java
index ffdbc10..bec0352 100644
--- a/modules/core/src/flex/messaging/FlexSessionManager.java
+++ b/modules/core/src/flex/messaging/FlexSessionManager.java
@@ -21,7 +21,6 @@ import flex.messaging.log.LogCategories;
import java.util.concurrent.ConcurrentHashMap;
/**
- *
* Manages FlexSession instances for a MessageBroker.
*/
public class FlexSessionManager extends ManageableComponent
@@ -50,9 +49,10 @@ public class FlexSessionManager extends ManageableComponent
/**
*
* Constructs a <tt>FlexSessionManager</tt> for the passed <tt>MessageBroker</tt> and optionally enables management.
- *
+ *
* @param enableManagement <code>true</code> if the <tt>FlexSessionManager</tt>
- * is manageable; otherwise <code>false</code>.
+ * is manageable; otherwise <code>false</code>.
+ * @param broker the message broker
*/
public FlexSessionManager(boolean enableManagement, MessageBroker broker)
{
http://git-wip-us.apache.org/repos/asf/flex-blazeds/blob/897a2320/modules/core/src/flex/messaging/HttpFlexSession.java
----------------------------------------------------------------------
diff --git a/modules/core/src/flex/messaging/HttpFlexSession.java b/modules/core/src/flex/messaging/HttpFlexSession.java
index 6b47cb6..3bf626a 100644
--- a/modules/core/src/flex/messaging/HttpFlexSession.java
+++ b/modules/core/src/flex/messaging/HttpFlexSession.java
@@ -59,6 +59,8 @@ public class HttpFlexSession extends FlexSession
/**
*
* Not for public use. Constructs new instances that effectively wrap pre-existing JEE HttpSession instances.
+ *
+ * @param provider HttpFlexSessionProvider object
*/
public HttpFlexSession(HttpFlexSessionProvider provider)
{
@@ -309,6 +311,8 @@ public class HttpFlexSession extends FlexSession
* disconnected its channel.
* Supports invalidating the HttpFlexSession and underlying JEE HttpSession without
* triggering session recreation.
+ *
+ * @param recreate true if the http session should be recreated.
*/
public void invalidate(boolean recreate)
{
http://git-wip-us.apache.org/repos/asf/flex-blazeds/blob/897a2320/modules/core/src/flex/messaging/MessageBroker.java
----------------------------------------------------------------------
diff --git a/modules/core/src/flex/messaging/MessageBroker.java b/modules/core/src/flex/messaging/MessageBroker.java
index 065b546..80b061e 100644
--- a/modules/core/src/flex/messaging/MessageBroker.java
+++ b/modules/core/src/flex/messaging/MessageBroker.java
@@ -682,8 +682,7 @@ public class MessageBroker extends ManageableComponent
* Returns the <code>Endpoint</code> with the specified id.
*
* @param id The id of the <code>Endpoint</code>/
- * @return The <code>Endpoint</code> with the specified id or null if no
- * <code>Endpoint</code> with the id exists.
+ * @return The <code>Endpoint</code> with the specified id or null if no <code>Endpoint</code> with the id exists.
*/
public Endpoint getEndpoint(String id)
{
@@ -693,6 +692,8 @@ public class MessageBroker extends ManageableComponent
/**
*
* Retrieve the map of all endpoints in this broker.
+ *
+ * @return the map of all endpoints in this broker
*/
public Map<String, Endpoint> getEndpoints()
{
@@ -703,6 +704,10 @@ public class MessageBroker extends ManageableComponent
*
* Retrieve an endpoint based on a requested URL path. Two endpoints should not be
* registered to the same path.
+ *
+ * @param path the URL path
+ * @param contextPath the context path
+ * @return endpoint based on a requested URL path
*/
public Endpoint getEndpoint(String path, String contextPath)
{
@@ -1179,7 +1184,7 @@ public class MessageBroker extends ManageableComponent
flexSessionManager = value;
}
- /** @exclude **/
+
public RedeployManager getRedeployManager()
{
return redeployManager;
@@ -1675,7 +1680,8 @@ public class MessageBroker extends ManageableComponent
* Services call this method in order to send a message
* to a FlexClient.
*
- *
+ * @param message the message
+ * @param messageClient the message client the message should be sent to
*/
public void routeMessageToMessageClient(Message message, MessageClient messageClient)
{
@@ -1761,6 +1767,9 @@ public class MessageBroker extends ManageableComponent
/**
*
* Returns the logging category to use for a given message.
+ *
+ * @param message the message
+ * @return the logging category to use for a given message
*/
public String getLogCategory(Message message)
{
@@ -1795,6 +1804,9 @@ public class MessageBroker extends ManageableComponent
* Used internally by AbstractService to check existence of destination and service id
* mapping in the destinationToService map.
*
+ * @param destId the destination id
+ * @param svcId the service id
+ * @param throwException true if an exception should be thrown if something goes wrong
* @return True if the destination is already registered.
*/
public boolean isDestinationRegistered(String destId, String svcId, boolean throwException)
@@ -1853,6 +1865,7 @@ public class MessageBroker extends ManageableComponent
* a destination is registered for.
*
* @param destId Destination id.
+ * @return the Destination oblect for the given destination id
*/
public Destination getRegisteredDestination(String destId)
{
@@ -1909,6 +1922,8 @@ public class MessageBroker extends ManageableComponent
/**
*
* Utility method to make sure that message has an assigned messageId.
+ *
+ * @param message the message that should be checked
*/
protected void checkMessageId(Message message)
{
@@ -1924,8 +1939,8 @@ public class MessageBroker extends ManageableComponent
*
* Check the headers for the message for the RemoteCredentials.
*
- * @param service
- * @param message
+ * @param service the service
+ * @param message the message
*/
protected void extractRemoteCredentials(Service service, Message message)
{
@@ -2009,6 +2024,8 @@ public class MessageBroker extends ManageableComponent
*
* This method was added so that Spring-BlazeDS Integration 1.0.2 works with latest BlazeDS binaries
* Internally, this method simply invokes the setServletContext(...) method
+ *
+ * @param servletContext ServletContext that should be set.
*/
protected void setInitServletContext(ServletContext servletContext)
{
@@ -2042,8 +2059,6 @@ public class MessageBroker extends ManageableComponent
/**
* Stop all of the broker's endpoints.
- *
- *
*/
protected void stopEndpoints()
{
http://git-wip-us.apache.org/repos/asf/flex-blazeds/blob/897a2320/modules/core/src/flex/messaging/MessageClient.java
----------------------------------------------------------------------
diff --git a/modules/core/src/flex/messaging/MessageClient.java b/modules/core/src/flex/messaging/MessageClient.java
index ccb28b0..56768e7 100644
--- a/modules/core/src/flex/messaging/MessageClient.java
+++ b/modules/core/src/flex/messaging/MessageClient.java
@@ -414,6 +414,8 @@ public class MessageClient extends TimeoutAbstractObject implements Serializable
* if it is attempting to notify the client, then we must leave the outbound queue containing
* the notification in place. Otherwise, any messages queued for the subscription may be
* removed from the queue and possibly shut down immediately.
+ *
+ * @return true if the MessageClient is currently trying to notify the client about it's invalidation.
*/
public boolean isAttemptingInvalidationClientNotification()
{
@@ -427,6 +429,8 @@ public class MessageClient extends TimeoutAbstractObject implements Serializable
* It allows the FlexClient class to cleanup the outbound queue for the channel's
* corresponding server endpoint for the remote client, because we know that no
* currently queued messages need to be retained for delivery.
+ *
+ * @param value true if the MessageClient is invalidated due to the client being disconnected
*/
public void setClientChannelDisconnected(boolean value)
{
@@ -434,7 +438,7 @@ public class MessageClient extends TimeoutAbstractObject implements Serializable
}
/**
- *
+ * @return true if the MessageClient is invalidated due to the client being disconnected
*/
public boolean isClientChannelDisconnected()
{
http://git-wip-us.apache.org/repos/asf/flex-blazeds/blob/897a2320/modules/core/src/flex/messaging/MessageDestination.java
----------------------------------------------------------------------
diff --git a/modules/core/src/flex/messaging/MessageDestination.java b/modules/core/src/flex/messaging/MessageDestination.java
index c7fcb24..141ac8a 100644
--- a/modules/core/src/flex/messaging/MessageDestination.java
+++ b/modules/core/src/flex/messaging/MessageDestination.java
@@ -282,7 +282,7 @@ public class MessageDestination extends FactoryDestination
return throttleManager;
}
- /** @exclude **/
+
@Override
public boolean equals(Object o)
{
@@ -302,7 +302,7 @@ public class MessageDestination extends FactoryDestination
return false;
}
- /** @exclude **/
+
@Override
public int hashCode()
{
@@ -310,7 +310,7 @@ public class MessageDestination extends FactoryDestination
(getId() == null ? 0 : getId().hashCode());
}
- /** @exclude **/
+
@Override
public String toString()
{
http://git-wip-us.apache.org/repos/asf/flex-blazeds/blob/897a2320/modules/core/src/flex/messaging/MessageException.java
----------------------------------------------------------------------
diff --git a/modules/core/src/flex/messaging/MessageException.java b/modules/core/src/flex/messaging/MessageException.java
index 9ebf0c2..f3b565a 100644
--- a/modules/core/src/flex/messaging/MessageException.java
+++ b/modules/core/src/flex/messaging/MessageException.java
@@ -43,7 +43,7 @@ public class MessageException extends LocalizedException
// Message exception code strings.
public static final String CODE_SERVER_RESOURCE_UNAVAILABLE = "Server.ResourceUnavailable";
- /** @exclude **/
+
static final long serialVersionUID = 3310842114461162689L;
//--------------------------------------------------------------------------
@@ -115,7 +115,7 @@ public class MessageException extends LocalizedException
// code
//----------------------------------
- /** @exclude **/
+
protected String code;
/**
@@ -144,6 +144,8 @@ public class MessageException extends LocalizedException
/**
* Returns the default initial text for use in the log output generated by <code>logAtHingePoint()</code>.
+ *
+ * @return the default initial text for use in the log output generated by <code>logAtHingePoint()</code>.
*/
public String getDefaultLogMessageIntro()
{
@@ -154,7 +156,7 @@ public class MessageException extends LocalizedException
// extendedData
//----------------------------------
- /** @exclude **/
+
protected Map extendedData;
/**
@@ -181,7 +183,7 @@ public class MessageException extends LocalizedException
// errorMessage
//----------------------------------
- /** @exclude **/
+
protected ErrorMessage errorMessage;
/**
@@ -217,6 +219,7 @@ public class MessageException extends LocalizedException
* Default is true.
*
* @see #logAtHingePoint(Message, ErrorMessage, String)
+ * @return true if the logging stack traces is enabled.
*/
public boolean isLogStackTraceEnabled()
{
@@ -261,6 +264,7 @@ public class MessageException extends LocalizedException
* The default value is <code>LogEvent.ERROR</code>.
*
* @see #logAtHingePoint(Message, ErrorMessage, String)
+ * @return the preffered log level.
*/
public short getPreferredLogLevel()
{
@@ -299,7 +303,7 @@ public class MessageException extends LocalizedException
// rootCauseErrorMessage
//----------------------------------
- /** @exclude **/
+
public Object getRootCauseErrorMessage()
{
if (rootCause == null)
http://git-wip-us.apache.org/repos/asf/flex-blazeds/blob/897a2320/modules/core/src/flex/messaging/VersionInfo.java
----------------------------------------------------------------------
diff --git a/modules/core/src/flex/messaging/VersionInfo.java b/modules/core/src/flex/messaging/VersionInfo.java
index 8275f60..0d60e4d 100644
--- a/modules/core/src/flex/messaging/VersionInfo.java
+++ b/modules/core/src/flex/messaging/VersionInfo.java
@@ -21,8 +21,6 @@ import flex.messaging.util.StringUtils;
/**
* Class representing the build version of Data Services.
- *
- *@exclude
*/
public class VersionInfo
{
http://git-wip-us.apache.org/repos/asf/flex-blazeds/blob/897a2320/modules/core/src/flex/messaging/config/ThrottleSettings.java
----------------------------------------------------------------------
diff --git a/modules/core/src/flex/messaging/config/ThrottleSettings.java b/modules/core/src/flex/messaging/config/ThrottleSettings.java
index 6457d1b..96b5a3b 100644
--- a/modules/core/src/flex/messaging/config/ThrottleSettings.java
+++ b/modules/core/src/flex/messaging/config/ThrottleSettings.java
@@ -36,15 +36,15 @@ public class ThrottleSettings
CONFLATE
};
- /** @exclude **/
+
public static final String ELEMENT_INBOUND = "throttle-inbound";
- /** @exclude **/
+
public static final String ELEMENT_OUTBOUND = "throttle-outbound";
- /** @exclude **/
+
public static final String ELEMENT_POLICY = "policy";
- /** @exclude **/
+
public static final String ELEMENT_DEST_FREQ = "max-frequency";
- /** @exclude **/
+
public static final String ELEMENT_CLIENT_FREQ = "max-client-frequency";
// Errors
http://git-wip-us.apache.org/repos/asf/flex-blazeds/blob/897a2320/modules/core/src/flex/messaging/endpoints/AbstractEndpoint.java
----------------------------------------------------------------------
diff --git a/modules/core/src/flex/messaging/endpoints/AbstractEndpoint.java b/modules/core/src/flex/messaging/endpoints/AbstractEndpoint.java
index c88e914..ffa1d0f 100644
--- a/modules/core/src/flex/messaging/endpoints/AbstractEndpoint.java
+++ b/modules/core/src/flex/messaging/endpoints/AbstractEndpoint.java
@@ -780,7 +780,7 @@ public abstract class AbstractEndpoint extends ManageableComponent
//
//--------------------------------------------------------------------------
- /** @exclude **/
+
public static void addNoCacheHeaders(HttpServletRequest req, HttpServletResponse res)
{
String userAgent = req.getHeader(UserAgentManager.USER_AGENT_HEADER_NAME);
http://git-wip-us.apache.org/repos/asf/flex-blazeds/blob/897a2320/modules/core/src/flex/messaging/endpoints/Endpoint.java
----------------------------------------------------------------------
diff --git a/modules/core/src/flex/messaging/endpoints/Endpoint.java b/modules/core/src/flex/messaging/endpoints/Endpoint.java
index 1d9ec42..3e1f7de 100644
--- a/modules/core/src/flex/messaging/endpoints/Endpoint.java
+++ b/modules/core/src/flex/messaging/endpoints/Endpoint.java
@@ -124,7 +124,7 @@ public interface Endpoint extends Manageable
*/
double getMessagingVersion();
- /** @exclude **/
+
String getParsedUrl(String contextPath);
/**
http://git-wip-us.apache.org/repos/asf/flex-blazeds/blob/897a2320/modules/core/src/flex/messaging/factories/JavaFactoryInstance.java
----------------------------------------------------------------------
diff --git a/modules/core/src/flex/messaging/factories/JavaFactoryInstance.java b/modules/core/src/flex/messaging/factories/JavaFactoryInstance.java
index 9131aa0..700545a 100644
--- a/modules/core/src/flex/messaging/factories/JavaFactoryInstance.java
+++ b/modules/core/src/flex/messaging/factories/JavaFactoryInstance.java
@@ -138,7 +138,7 @@ public class JavaFactoryInstance extends FactoryInstance
}
}
- /** @exclude **/
+
@Override public String toString()
{
return "JavaFactory instance for id=" + getId() + " source=" + getSource() + " scope=" + getScope();
http://git-wip-us.apache.org/repos/asf/flex-blazeds/blob/897a2320/modules/core/src/flex/messaging/services/AbstractBootstrapService.java
----------------------------------------------------------------------
diff --git a/modules/core/src/flex/messaging/services/AbstractBootstrapService.java b/modules/core/src/flex/messaging/services/AbstractBootstrapService.java
index 242f53e..4314250 100644
--- a/modules/core/src/flex/messaging/services/AbstractBootstrapService.java
+++ b/modules/core/src/flex/messaging/services/AbstractBootstrapService.java
@@ -169,163 +169,163 @@ public abstract class AbstractBootstrapService implements Service
*/
public abstract void stop();
- /** @exclude **/
+
public ConfigMap describeService(Endpoint endpoint)
{
return null;
}
- /** @exclude **/
+
public BaseControl getControl()
{
throw new UnsupportedOperationException();
}
- /** @exclude **/
+
public void setControl(BaseControl control)
{
throw new UnsupportedOperationException();
}
- /** @exclude **/
+
public void addDefaultChannel(String id)
{
// No-op
}
- /** @exclude **/
+
public void setDefaultChannels(List<String> ids)
{
// No-op
}
- /** @exclude **/
+
public boolean removeDefaultChannel(String id)
{
return false;
}
- /** @exclude **/
+
public void addDestination(Destination destination)
{
throw new UnsupportedOperationException();
}
- /** @exclude **/
+
public Destination createDestination(String destId)
{
throw new UnsupportedOperationException();
}
- /** @exclude **/
+
public Destination removeDestination(String id)
{
throw new UnsupportedOperationException();
}
- /** @exclude **/
+
public String getDefaultAdapter()
{
throw new UnsupportedOperationException();
}
- /** @exclude **/
+
public void setDefaultAdapter(String id)
{
throw new UnsupportedOperationException();
}
- /** @exclude **/
+
public List<String> getDefaultChannels()
{
throw new UnsupportedOperationException();
}
- /** @exclude **/
+
public Destination getDestination(Message message)
{
throw new UnsupportedOperationException();
}
- /** @exclude **/
+
public Destination getDestination(String id)
{
throw new UnsupportedOperationException();
}
- /** @exclude **/
+
public Map<String, Destination> getDestinations()
{
throw new UnsupportedOperationException();
}
- /** @exclude **/
+
public Map<String, String> getRegisteredAdapters()
{
throw new UnsupportedOperationException();
}
- /** @exclude **/
+
public boolean isStarted()
{
return false;
}
- /** @exclude **/
+
public boolean isSupportedMessage(Message message)
{
return false;
}
- /** @exclude **/
+
public boolean isSupportedMessageType(String messageClassName)
{
return false;
}
- /** @exclude **/
+
public String registerAdapter(String id, String className)
{
throw new UnsupportedOperationException();
}
- /** @exclude **/
+
public String unregisterAdapter(String id)
{
throw new UnsupportedOperationException();
}
- /** @exclude **/
+
public Object serviceCommand(CommandMessage message)
{
throw new UnsupportedOperationException();
}
- /** @exclude **/
+
public Object serviceMessage(Message message)
{
throw new UnsupportedOperationException();
}
- /** @exclude **/
+
public List getMessageTypes()
{
throw new UnsupportedOperationException();
}
- /** @exclude **/
+
public void addMessageType(String messageType)
{
throw new UnsupportedOperationException();
}
- /** @exclude **/
+
public void setMessageTypes(List messageTypes)
{
throw new UnsupportedOperationException();
}
- /** @exclude **/
+
public boolean removeMessageType(String messageType)
{
throw new UnsupportedOperationException();
http://git-wip-us.apache.org/repos/asf/flex-blazeds/blob/897a2320/modules/core/src/flex/messaging/services/MessageService.java
----------------------------------------------------------------------
diff --git a/modules/core/src/flex/messaging/services/MessageService.java b/modules/core/src/flex/messaging/services/MessageService.java
index d1a2b57..36aeb6d 100644
--- a/modules/core/src/flex/messaging/services/MessageService.java
+++ b/modules/core/src/flex/messaging/services/MessageService.java
@@ -71,7 +71,7 @@ public class MessageService extends AbstractService implements MessagingConstant
/** Log category for <code>MessageService</code> that captures message timing. */
public static final String TIMING_LOG_CATEGORY = LogCategories.MESSAGE_TIMING;
- /** @exclude **/
+
public static final String NOT_SUBSCRIBED_CODE = "Server.Processing.NotSubscribed";
// Errors
http://git-wip-us.apache.org/repos/asf/flex-blazeds/blob/897a2320/modules/core/src/flex/messaging/util/ToStringPrettyPrinter.java
----------------------------------------------------------------------
diff --git a/modules/core/src/flex/messaging/util/ToStringPrettyPrinter.java b/modules/core/src/flex/messaging/util/ToStringPrettyPrinter.java
index 5bff7f9..9f4b434 100644
--- a/modules/core/src/flex/messaging/util/ToStringPrettyPrinter.java
+++ b/modules/core/src/flex/messaging/util/ToStringPrettyPrinter.java
@@ -39,8 +39,6 @@ import flex.messaging.log.Log;
* should be able to extend the PrettyPrintable interface to handle
* any custom toString requirements without needing to actually call
* toString on a custom object.
- *
- * @exclude
*/
public class ToStringPrettyPrinter extends BasicPrettyPrinter
{
http://git-wip-us.apache.org/repos/asf/flex-blazeds/blob/897a2320/modules/core/src/flex/messaging/util/URLDecoder.java
----------------------------------------------------------------------
diff --git a/modules/core/src/flex/messaging/util/URLDecoder.java b/modules/core/src/flex/messaging/util/URLDecoder.java
index c6cfb89..c240e83 100644
--- a/modules/core/src/flex/messaging/util/URLDecoder.java
+++ b/modules/core/src/flex/messaging/util/URLDecoder.java
@@ -21,8 +21,6 @@ import java.io.UnsupportedEncodingException;
/**
* Utility class for URL decoding.
- *
- *@exclude
*/
public final class URLDecoder
{
http://git-wip-us.apache.org/repos/asf/flex-blazeds/blob/897a2320/modules/proxy/src/flex/messaging/services/http/ExternalProxySettings.java
----------------------------------------------------------------------
diff --git a/modules/proxy/src/flex/messaging/services/http/ExternalProxySettings.java b/modules/proxy/src/flex/messaging/services/http/ExternalProxySettings.java
index d425b5f..6664060 100755
--- a/modules/proxy/src/flex/messaging/services/http/ExternalProxySettings.java
+++ b/modules/proxy/src/flex/messaging/services/http/ExternalProxySettings.java
@@ -21,19 +21,19 @@ package flex.messaging.services.http;
*/
public class ExternalProxySettings
{
- /** @exclude **/
+
public static final int DEFAULT_PROXY_PORT = 80;
- /** @exclude **/
+
public static final String PORT = "port";
- /** @exclude **/
+
public static final String EXTERNAL_PROXY = "external-proxy";
- /** @exclude **/
+
public static final String SERVER = "server";
- /** @exclude **/
+
public static final String NT_DOMAIN = "nt-domain";
- /** @exclude **/
+
public static final String USERNAME = "username";
- /** @exclude **/
+
public static final String PASSWORD = "password";
private static final String HTTP = "http://";
http://git-wip-us.apache.org/repos/asf/flex-blazeds/blob/897a2320/modules/proxy/src/flex/messaging/services/http/HTTPProxyAdapter.java
----------------------------------------------------------------------
diff --git a/modules/proxy/src/flex/messaging/services/http/HTTPProxyAdapter.java b/modules/proxy/src/flex/messaging/services/http/HTTPProxyAdapter.java
index 1d38cb4..8ff5460 100755
--- a/modules/proxy/src/flex/messaging/services/http/HTTPProxyAdapter.java
+++ b/modules/proxy/src/flex/messaging/services/http/HTTPProxyAdapter.java
@@ -62,11 +62,11 @@ public class HTTPProxyAdapter extends ServiceAdapter
// NOTE: any changes to this class should also be made to the corresponding version in the .NET.
// The corresponding class is at src/dotNet/libs/FlexASPlib/Aspx/Proxy/ServiceProxyModule.cs
- /** @exclude **/
+
public static final String CONTENT_TYPE_XML = "application/xml";
- /** @exclude **/
+
public static final String CONTENT_TYPE_FORM = "application/x-www-form-urlencoded";
- /** @exclude **/
+
public static final int DEFAULT_COOKIE_LIMIT = 200;
private static final String COOKIE_LIMIT = "cookie-limit";