[hornetq-commits] JBoss hornetq SVN: r8675 - in trunk/src/main/org/hornetq: core/client and 10 other directories.

Author: jmesnil Date: 2009-12-11 09:45:28 -0500 (Fri, 11 Dec 2009) New Revision: 8675 Added: trunk/src/main/org/hornetq/core/config/package-info.java trunk/src/main/org/hornetq/core/exception/package-info.java trunk/src/main/org/hornetq/core/message/package-info.java trunk/src/main/org/hornetq/core/remoting/package-info.java trunk/src/main/org/hornetq/core/remoting/spi/package-info.java trunk/src/main/org/hornetq/jms/client/package-info.java trunk/src/main/org/hornetq/jms/management/package-info.java trunk/src/main/org/hornetq/jms/package-info.java trunk/src/main/org/hornetq/utils/package-info.java Modified: trunk/src/main/org/hornetq/core/buffers/package-info.java trunk/src/main/org/hornetq/core/client/package-info.java trunk/src/main/org/hornetq/core/management/package-info.java trunk/src/main/org/hornetq/core/remoting/Channel.java trunk/src/main/org/hornetq/jms/HornetQDestination.java trunk/src/main/org/hornetq/jms/HornetQQueue.java trunk/src/main/org/hornetq/jms/HornetQTemporaryQueue.java trunk/src/main/org/hornetq/jms/HornetQTemporaryTopic.java trunk/src/main/org/hornetq/jms/HornetQTopic.java trunk/src/main/org/hornetq/jms/management/JMSServerControl.java trunk/src/main/org/hornetq/jms/management/SubscriptionInfo.java Log: HORNETQ-185 + HORNETQ-186: API review + javadoc * added javadoc for org.hornet.jms package * added package javadoc for all documented packages Modified: trunk/src/main/org/hornetq/core/buffers/package-info.java =================================================================== --- trunk/src/main/org/hornetq/core/buffers/package-info.java 2009-12-11 13:18:01 UTC (rev 8674) +++ trunk/src/main/org/hornetq/core/buffers/package-info.java 2009-12-11 14:45:28 UTC (rev 8675) @@ -12,7 +12,7 @@ */ /** - * HornetQ Buffering. + * Buffering API. * <br> * This package defines the buffers used by HornetQ. The underlying implementations uses * Netty's ChannelBuffer and wraps it with methods required by HornetQ usage. Modified: trunk/src/main/org/hornetq/core/client/package-info.java =================================================================== --- trunk/src/main/org/hornetq/core/client/package-info.java 2009-12-11 13:18:01 UTC (rev 8674) +++ trunk/src/main/org/hornetq/core/client/package-info.java 2009-12-11 14:45:28 UTC (rev 8675) @@ -13,7 +13,7 @@ /** * Core API to produce and consume messages. - * + * <br> * This package defines the API used by HornetQ clients to produce and consume messages. */ package org.hornetq.core.client; Added: trunk/src/main/org/hornetq/core/config/package-info.java =================================================================== --- trunk/src/main/org/hornetq/core/config/package-info.java (rev 0) +++ trunk/src/main/org/hornetq/core/config/package-info.java 2009-12-11 14:45:28 UTC (rev 8675) @@ -0,0 +1,22 @@ +/* + * Copyright 2009 Red Hat, Inc. + * Red Hat licenses this file to you under the Apache License, version + * 2.0 (the "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + * implied. See the License for the specific language governing + * permissions and limitations under the License. + */ + +/** + * Configuration API to configure HornetQ clients and servers. + * <br> + * This package defines the API used by HornetQ clients configure how they connect to HornetQ servers. + * <br> + * It also defined the API to configure HornetQ servers. + */ +package org.hornetq.core.config; + Added: trunk/src/main/org/hornetq/core/exception/package-info.java =================================================================== --- trunk/src/main/org/hornetq/core/exception/package-info.java (rev 0) +++ trunk/src/main/org/hornetq/core/exception/package-info.java 2009-12-11 14:45:28 UTC (rev 8675) @@ -0,0 +1,20 @@ +/* + * Copyright 2009 Red Hat, Inc. + * Red Hat licenses this file to you under the Apache License, version + * 2.0 (the "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + * implied. See the License for the specific language governing + * permissions and limitations under the License. + */ + +/** + * Core Exception. + * <br> + * This package defines the root exception used by HornetQ when exceptions occur. + */ +package org.hornetq.core.exception; + Modified: trunk/src/main/org/hornetq/core/management/package-info.java =================================================================== --- trunk/src/main/org/hornetq/core/management/package-info.java 2009-12-11 13:18:01 UTC (rev 8674) +++ trunk/src/main/org/hornetq/core/management/package-info.java 2009-12-11 14:45:28 UTC (rev 8675) @@ -12,7 +12,7 @@ */ /** - * API management to manage HornetQ server and its Core resources. + * management API for HornetQ servers and its Core resources. * <br> * HornetQ can be managed either using JMX or by sending management messages to the * server's special management address. Please refer to the user manual for more information. Added: trunk/src/main/org/hornetq/core/message/package-info.java =================================================================== --- trunk/src/main/org/hornetq/core/message/package-info.java (rev 0) +++ trunk/src/main/org/hornetq/core/message/package-info.java 2009-12-11 14:45:28 UTC (rev 8675) @@ -0,0 +1,20 @@ +/* + * Copyright 2009 Red Hat, Inc. + * Red Hat licenses this file to you under the Apache License, version + * 2.0 (the "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + * implied. See the License for the specific language governing + * permissions and limitations under the License. + */ + +/** + * Core Message API. + * <br> + * This package defines HornetQ Core Message API. + */ +package org.hornetq.core.message; + Modified: trunk/src/main/org/hornetq/core/remoting/Channel.java =================================================================== --- trunk/src/main/org/hornetq/core/remoting/Channel.java 2009-12-11 13:18:01 UTC (rev 8674) +++ trunk/src/main/org/hornetq/core/remoting/Channel.java 2009-12-11 14:45:28 UTC (rev 8675) @@ -126,8 +126,6 @@ /** * returns the Remoting Connection being used by the channel - * - * @return */ RemotingConnection getConnection(); Added: trunk/src/main/org/hornetq/core/remoting/package-info.java =================================================================== --- trunk/src/main/org/hornetq/core/remoting/package-info.java (rev 0) +++ trunk/src/main/org/hornetq/core/remoting/package-info.java 2009-12-11 14:45:28 UTC (rev 8675) @@ -0,0 +1,20 @@ +/* + * Copyright 2009 Red Hat, Inc. + * Red Hat licenses this file to you under the Apache License, version + * 2.0 (the "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + * implied. See the License for the specific language governing + * permissions and limitations under the License. + */ + +/** + * Remoting API. + * <br> + * This package defines the API used by HornetQ for remoting. + */ +package org.hornetq.core.remoting; + Added: trunk/src/main/org/hornetq/core/remoting/spi/package-info.java =================================================================== --- trunk/src/main/org/hornetq/core/remoting/spi/package-info.java (rev 0) +++ trunk/src/main/org/hornetq/core/remoting/spi/package-info.java 2009-12-11 14:45:28 UTC (rev 8675) @@ -0,0 +1,21 @@ +/* + * Copyright 2009 Red Hat, Inc. + * Red Hat licenses this file to you under the Apache License, version + * 2.0 (the "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + * implied. See the License for the specific language governing + * permissions and limitations under the License. + */ + +/** + * Remoting SPI. + * <br> + * This package defines the Service Provide Interface that + * remoting providers must implement to be supported by HornetQ. + */ +package org.hornetq.core.remoting.spi; + Modified: trunk/src/main/org/hornetq/jms/HornetQDestination.java =================================================================== --- trunk/src/main/org/hornetq/jms/HornetQDestination.java 2009-12-11 13:18:01 UTC (rev 8674) +++ trunk/src/main/org/hornetq/jms/HornetQDestination.java 2009-12-11 14:45:28 UTC (rev 8675) @@ -25,6 +25,8 @@ import org.hornetq.utils.SimpleString; /** + * HornetQ implementation of a JMS Destination. + * * @author <a href="mailto:ovidiu@feodorov.com">Ovidiu Feodorov</a> * @author <a href="mailto:tim.fox@jboss.com">Tim Fox</a> * @version <tt>$Revision$</tt> Modified: trunk/src/main/org/hornetq/jms/HornetQQueue.java =================================================================== --- trunk/src/main/org/hornetq/jms/HornetQQueue.java 2009-12-11 13:18:01 UTC (rev 8674) +++ trunk/src/main/org/hornetq/jms/HornetQQueue.java 2009-12-11 14:45:28 UTC (rev 8675) @@ -20,6 +20,10 @@ import org.hornetq.utils.SimpleString; /** + * HornetQ implementation of a JMS Queue. + * <br> + * This class can be instantiated directly. + * * @author <a href="mailto:ovidiu@feodorov.com">Ovidiu Feodorov</a> * @author <a href="mailto:tim.fox@jboss.com">Tim Fox</a> * @version <tt>$Revision$</tt> Modified: trunk/src/main/org/hornetq/jms/HornetQTemporaryQueue.java =================================================================== --- trunk/src/main/org/hornetq/jms/HornetQTemporaryQueue.java 2009-12-11 13:18:01 UTC (rev 8674) +++ trunk/src/main/org/hornetq/jms/HornetQTemporaryQueue.java 2009-12-11 14:45:28 UTC (rev 8675) @@ -19,6 +19,10 @@ import org.hornetq.jms.client.HornetQSession; /** + * HornetQ implementation of a JMS TemporaryQueue. + * <br> + * This class can be instantiated directly. + * * @author <a href="mailto:tim.fox@jboss.com">Tim Fox</a> * @version <tt>$Revision: 3569 $</tt> * Modified: trunk/src/main/org/hornetq/jms/HornetQTemporaryTopic.java =================================================================== --- trunk/src/main/org/hornetq/jms/HornetQTemporaryTopic.java 2009-12-11 13:18:01 UTC (rev 8674) +++ trunk/src/main/org/hornetq/jms/HornetQTemporaryTopic.java 2009-12-11 14:45:28 UTC (rev 8675) @@ -19,6 +19,10 @@ import org.hornetq.jms.client.HornetQSession; /** + * HornetQ implementation of a JMS TemporaryTopic. + * <br> + * This class can be instantiated directly. + * * @author <a href="mailto:tim.fox@jboss.com">Tim Fox</a> * @version <tt>$Revision: 3569 $</tt> * Modified: trunk/src/main/org/hornetq/jms/HornetQTopic.java =================================================================== --- trunk/src/main/org/hornetq/jms/HornetQTopic.java 2009-12-11 13:18:01 UTC (rev 8674) +++ trunk/src/main/org/hornetq/jms/HornetQTopic.java 2009-12-11 14:45:28 UTC (rev 8675) @@ -20,6 +20,10 @@ import org.hornetq.utils.SimpleString; /** + * HornetQ implementation of a JMS Topic. + * <br> + * This class can be instantiated directly. + * * @author <a href="mailto:ovidiu@feodorov.com">Ovidiu Feodorov</a> * @author <a href="mailto:tim.fox@jboss.com">Tim Fox</a> * @version <tt>$Revision$</tt> Added: trunk/src/main/org/hornetq/jms/client/package-info.java =================================================================== --- trunk/src/main/org/hornetq/jms/client/package-info.java (rev 0) +++ trunk/src/main/org/hornetq/jms/client/package-info.java 2009-12-11 14:45:28 UTC (rev 8675) @@ -0,0 +1,23 @@ +/* + * Copyright 2009 Red Hat, Inc. + * Red Hat licenses this file to you under the Apache License, version + * 2.0 (the "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + * implied. See the License for the specific language governing + * permissions and limitations under the License. + */ + +/** + * Implementation of the JMS API. + * <br> + * Classes in this package are not meant to be used directly + * except {@link org.hornetq.jms.client.HornetQConnectionFactory} which can be instantiated directly + * if JMS resources are not looked up in JNDI. + * + */ +package org.hornetq.jms.client; + Modified: trunk/src/main/org/hornetq/jms/management/JMSServerControl.java =================================================================== --- trunk/src/main/org/hornetq/jms/management/JMSServerControl.java 2009-12-11 13:18:01 UTC (rev 8674) +++ trunk/src/main/org/hornetq/jms/management/JMSServerControl.java 2009-12-11 14:45:28 UTC (rev 8675) @@ -17,6 +17,9 @@ import javax.management.MBeanOperationInfo; +import org.hornetq.core.client.ClientSessionFactory; +import org.hornetq.core.config.TransportConfiguration; +import org.hornetq.core.remoting.spi.ConnectorFactory; import org.hornetq.core.server.management.Operation; import org.hornetq.core.server.management.Parameter; @@ -57,20 +60,51 @@ // Operations ---------------------------------------------------- + /** + * Creates a JMS Queue with the specified name and JNDI binding. + * + * @return {@code true}�if the queue was created, {@code false} else + */ @Operation(desc = "Create a JMS Queue", impact = MBeanOperationInfo.ACTION) boolean createQueue(@Parameter(name = "name", desc = "Name of the queue to create") String name, @Parameter(name = "jndiBinding", desc = "the name of the binding for JNDI") String jndiBinding) throws Exception; + /** + * Destroys a JMS Queue with the specified name. + * + * @return {@code true}�if the queue was destroyed, {@code false} else + */ @Operation(desc = "Destroy a JMS Queue", impact = MBeanOperationInfo.ACTION) boolean destroyQueue(@Parameter(name = "name", desc = "Name of the queue to destroy") String name) throws Exception; + /** + * Creates a JMS Topic with the specified name and JNDI binding. + * + * @return {@code true}�if the topic was created, {@code false} else + */ @Operation(desc = "Create a JMS Topic", impact = MBeanOperationInfo.ACTION) boolean createTopic(@Parameter(name = "name", desc = "Name of the topic to create") String name, @Parameter(name = "jndiBinding", desc = "the name of the binding for JNDI") String jndiBinding) throws Exception; + /** + * Destroys a JMS Topic with the specified name. + * + * @return {@code true}�if the topic was destroyed, {@code false} else + */ @Operation(desc = "Destroy a JMS Topic", impact = MBeanOperationInfo.ACTION) boolean destroyTopic(@Parameter(name = "name", desc = "Name of the topic to destroy") String name) throws Exception; + /** + * Create a JMS ConnectionFactory with the specified name connected to a static list of live-backup servers. + * <br> + * The ConnectionFactory is bound to JNDI for all the specified bindings Strings. + * <br> + * {@code liveConnectorsTransportClassNames} (resp. {@code backupConnectorsTransportClassNames}) are the class names + * of the {@link ConnectorFactory} to connect to the live (resp. backup) servers + * and {@code liveConnectorTransportParams} (resp. backupConnectorTransportParams) are Map&lt;String, Object&gt; for the corresponding {@link TransportConfiguration}'s parameters. + * + * @see ClientSessionFactory#setStaticConnectors(java.util.List) + */ void createConnectionFactory(String name, Object[] liveConnectorsTransportClassNames, Object[] liveConnectorTransportParams, @@ -78,6 +112,13 @@ Object[] backupConnectorTransportParams, Object[] bindings) throws Exception; + /** + * Create a JMS ConnectionFactory with the specified name connected to a single live-backup pair of servers. + * <br> + * The ConnectionFactory is bound to JNDI for all the specified bindings Strings. + * <br> + * {@code backupTransportClassNames} and {@code backupTransportParams}�can be {@code null} if there is no backup server. + */ @Operation(desc = "Create a JMS ConnectionFactory", impact = MBeanOperationInfo.ACTION) void createConnectionFactory(@Parameter(name = "name") String name, @Parameter(name = "liveTransportClassNames", desc = "comma-separated list of class names for transport to live servers") String liveTransportClassNames, @@ -86,6 +127,13 @@ @Parameter(name = "backupTransportParams", desc = "comma-separated list of key=value parameters for the backup transports (enclosed between { } for each transport)") String backupTransportParams, @Parameter(name = "jndiBindings", desc = "comma-separated list of JNDI bindings") String jndiBindings) throws Exception; + /** + * Create a JMS ConnectionFactory with the specified name connected to a static list of live-backup servers. + * <br> + * Connections created by this ConnectionFactory will have their ClientID set to the specified ClientID. + * + * @see #createConnectionFactory(String, Object[], Object[], Object[], Object[], Object[]) + */ void createConnectionFactory(String name, Object[] liveConnectorsTransportClassNames, Object[] liveConnectorTransportParams, @@ -94,6 +142,15 @@ String clientID, Object[] jndiBindings) throws Exception; + /** + * Create a JMS ConnectionFactory with the specified name connected to a single live-backup pair of servers. + * <br> + * The ConnectionFactory is bound to JNDI for all the specified bindings Strings. + * <br> + * Connections created by this ConnectionFactory will have their ClientID set to the specified ClientID. + * <br> + * {@code backupTransportClassNames} and {@code backupTransportParams}�can be {@code null} if there is no backup server. + */ @Operation(desc = "Create a JMS ConnectionFactory", impact = MBeanOperationInfo.ACTION) void createConnectionFactory(@Parameter(name = "name") String name, @Parameter(name = "liveTransportClassNames", desc = "comma-separated list of class names for transport to live servers") String liveTransportClassNames, @@ -103,6 +160,16 @@ @Parameter(name = "clientID") String clientID, @Parameter(name = "jndiBindings", desc = "comma-separated list of JNDI bindings") String jndiBindings) throws Exception; + /** + * Create a JMS ConnectionFactory with the specified name connected to a static list of live-backup servers. + * <br> + * The ConnectionFactory is bound to JNDI for all the specified bindings Strings. + * <br> + * All parameters corresponds to the underlying ClientSessionFactory used by the factory. + * + * @see #createConnectionFactory(String, Object[], Object[], Object[], Object[], Object[]) + * @see ClientSessionFactory + */ void createConnectionFactory(String name, Object[] liveConnectorsTransportClassNames, Object[] liveConnectorTransportParams, @@ -138,6 +205,16 @@ String groupID, Object[] jndiBindings) throws Exception; + /** + * Create a JMS ConnectionFactory with the specified name connected to a single live-backup pair of servers. + * <br> + * The ConnectionFactory is bound to JNDI for all the specified bindings Strings. + * <br> + * All parameters corresponds to the underlying ClientSessionFactory used by the factory. + * + * @see #createConnectionFactory(String, Object[], Object[], Object[], Object[], Object[]) + * @see ClientSessionFactory + */ void createConnectionFactory(@Parameter(name = "name") String name, @Parameter(name = "liveTransportClassNames", desc = "comma-separated list of class names for transport to live servers") String liveTransportClassNames, @Parameter(name = "liveTransportParams", desc = "comma-separated list of key=value parameters for the live transports (enclosed between { } for each transport)") String liveTransportParams, @@ -173,12 +250,34 @@ @Parameter(name = "groupID") String groupID, @Parameter(name = "jndiBindings", desc = "comma-separated list of JNDI bindings") String jndiBindings) throws Exception; + /** + * Create a JMS ConnectionFactory with the specified name using a discovery group to discover HornetQ servers. + * <br> + * The ConnectionFactory is bound to JNDI for all the specified bindings Strings. + * <br> + * This factory listens to the specified {@code discoveryAddress} and {@code discoveryPort} to discover which servers it can connect to. + * <br> + * Connections created by this ConnectionFactory will have their ClientID set to the specified ClientID. + * + * @see #createConnectionFactory(String, Object[], Object[], Object[], Object[], Object[]) + */ void createConnectionFactory(String name, String discoveryAddress, int discoveryPort, String clientID, Object[] bindings) throws Exception; + /** + * Create a JMS ConnectionFactory with the specified name using a discovery group to discover HornetQ servers. + * <br> + * The ConnectionFactory is bound to JNDI for the specified bindings Strings + * <br> + * This factory listens to the specified {@code discoveryAddress} and {@code discoveryPort} to discover which servers it can connect to. + * <br> + * Connections created by this ConnectionFactory will have their ClientID set to the specified ClientID. + * + * @see #createConnectionFactory(String, Object[], Object[], Object[], Object[], Object[]) + */ @Operation(desc = "Create a JMS ConnectionFactory", impact = MBeanOperationInfo.ACTION) void createConnectionFactory(@Parameter(name = "name") String name, @Parameter(name = "discoveryAddress") String discoveryAddress, @@ -186,6 +285,17 @@ @Parameter(name = "clientID") String clientID, @Parameter(name = "jndiBindings") String jndiBindings) throws Exception; + /** + * Create a JMS ConnectionFactory with the specified name using a discovery group to discover HornetQ servers. + * <br> + * The ConnectionFactory is bound to JNDI for all the specified bindings Strings. + * <br> + * This factory listens to the specified {@code discoveryAddress} and {@code discoveryPort} to discover which servers it can connect to. + * <br> + * All parameters corresponds to the underlying ClientSessionFactory used by the factory. + * + * @see ClientSessionFactory + */ void createConnectionFactory(String name, String discoveryAddress, int discoveryPort, @@ -221,6 +331,17 @@ String groupID, Object[] jndiBindings) throws Exception; + /** + * Create a JMS ConnectionFactory with the specified name using a discovery group to discover HornetQ servers. + * <br> + * The ConnectionFactory is bound to JNDI for all the specified comma-separated bindings. + * <br> + * This factory listens to the specified {@code discoveryAddress} and {@code discoveryPort} to discover which servers it can connect to. + * <br> + * All parameters corresponds to the underlying ClientSessionFactory used by the factory. + * + * @see ClientSessionFactory + */ @Operation(desc = "Create a JMS ConnectionFactory", impact = MBeanOperationInfo.ACTION) void createConnectionFactory(@Parameter(name = "name") String name, @Parameter(name = "discoveryAddress") String discoveryAddress, @@ -257,23 +378,51 @@ @Parameter(name = "groupID") String groupID, @Parameter(name = "jndiBindings", desc = "comma-separated list of JNDI bindings") String jndiBindings) throws Exception; + /** + * Create a JMS ConnectionFactory with the specified name connected to a single HornetQ server. + * <br> + * The ConnectionFactory is bound to JNDI for all the specified bindings. + */ void createConnectionFactory(String name, String liveTransportClassName, Map<String, Object> liveTransportParams, Object[] jndiBindings) throws Exception; + /** + * Create a JMS ConnectionFactory with the specified name connected to a single HornetQ server. + * <br> + * The ConnectionFactory is bound to JNDI for all the specified comma-separated bindings. + * <br> + * The {@code liveTransportParams} is a comma-separated list of key=value for the transport parameters corresponding to the {@code TransportConfiguration}�parameters. + */ @Operation(desc = "Create a JMS ConnectionFactory", impact = MBeanOperationInfo.ACTION) void createConnectionFactory(@Parameter(name = "name") String name, @Parameter(name = "liveTransportClassName") String liveTransportClassName, @Parameter(name = "liveTransportParams", desc = "comma-separated list of key=value for the transport parameters") String liveTransportParams, @Parameter(name = "jndiBindings", desc = "comma-separated list of JNDI bindings") String jndiBindings) throws Exception; + /** + * Create a JMS ConnectionFactory with the specified name connected to a single HornetQ server. + * <br> + * The ConnectionFactory is bound to JNDI for all the specified comma-separated bindings. + * <br> + * Connections created by this ConnectionFactory will have their ClientID set to the specified ClientID. + */ void createConnectionFactory(String name, String liveTransportClassName, Map<String, Object> liveTransportParams, String clientID, Object[] jndiBindings) throws Exception; + /** + * Create a JMS ConnectionFactory with the specified name connected to a single HornetQ server. + * <br> + * The ConnectionFactory is bound to JNDI for all the specified comma-separated bindings. + * <br> + * The {@code liveTransportParams} is a comma-separated list of key=value for the transport parameters corresponding to the {@code TransportConfiguration}�parameters. + * <br> + * Connections created by this ConnectionFactory will have their ClientID set to the specified ClientID. + */ @Operation(desc = "Create a JMS ConnectionFactory", impact = MBeanOperationInfo.ACTION) void createConnectionFactory(@Parameter(name = "name") String name, @Parameter(name = "liveTransportClassName") String liveTransportClassName, @@ -281,6 +430,11 @@ @Parameter(name = "clientID") String clientID, @Parameter(name = "jndiBindings", desc = "comma-separated list of JNDI bindings") String jndiBindings) throws Exception; + /** + * Create a JMS ConnectionFactory with the specified name connected to a static list of live-backup HornetQ servers. + * <br> + * The ConnectionFactory is bound to JNDI for all the specified comma-separated bindings. + */ void createConnectionFactory(String name, String liveTransportClassName, Map<String, Object> liveTransportParams, @@ -288,6 +442,13 @@ Map<String, Object> backupTransportParams, Object[] jndiBindings) throws Exception; + /** + * Create a JMS ConnectionFactory with the specified name connected to a static list of live-backup HornetQ servers. + * <br> + * The ConnectionFactory is bound to JNDI for all the specified comma-separated bindings. + * <br> + * Connections created by this ConnectionFactory will have their ClientID set to the specified ClientID. + */ void createConnectionFactory(String name, String liveTransportClassName, Map<String, Object> liveTransportParams, @@ -296,21 +457,39 @@ String clientID, Object[] jndiBindings) throws Exception; + /** + * Destroy the ConnectionFactory corresponding to the specified name. + */ @Operation(desc = "Destroy a JMS ConnectionFactory", impact = MBeanOperationInfo.ACTION) void destroyConnectionFactory(@Parameter(name = "name", desc = "Name of the ConnectionFactory to destroy") String name) throws Exception; + /** + * Lists the addresses of all the clients connected to this address. + */ @Operation(desc = "List the client addresses", impact = MBeanOperationInfo.INFO) String[] listRemoteAddresses() throws Exception; + /** + * Lists the addresses of the clients connected to this address which matches the specified IP address. + */ @Operation(desc = "List the client addresses which match the given IP Address", impact = MBeanOperationInfo.INFO) String[] listRemoteAddresses(@Parameter(desc = "an IP address", name = "ipAddress") String ipAddress) throws Exception; + /** + * Closes all the connections of clients connected to this server which matches the specified IP address. + */ @Operation(desc = "Closes all the connections for the given IP Address", impact = MBeanOperationInfo.INFO) boolean closeConnectionsForAddress(@Parameter(desc = "an IP address", name = "ipAddress") String ipAddress) throws Exception; + /** + * Lists all the IDs of the connections connected to this server. + */ @Operation(desc = "List all the connection IDs", impact = MBeanOperationInfo.INFO) String[] listConnectionIDs() throws Exception; + /** + * Lists all the sessions IDs for the specified connection ID. + */ @Operation(desc = "List the sessions for the given connectionID", impact = MBeanOperationInfo.INFO) String[] listSessions(@Parameter(desc = "a connection ID", name = "connectionID") String connectionID) throws Exception; } Modified: trunk/src/main/org/hornetq/jms/management/SubscriptionInfo.java =================================================================== --- trunk/src/main/org/hornetq/jms/management/SubscriptionInfo.java 2009-12-11 13:18:01 UTC (rev 8674) +++ trunk/src/main/org/hornetq/jms/management/SubscriptionInfo.java 2009-12-11 14:45:28 UTC (rev 8675) @@ -13,14 +13,15 @@ package org.hornetq.jms.management; +import org.hornetq.core.management.AddressControl; import org.hornetq.utils.json.JSONArray; import org.hornetq.utils.json.JSONObject; /** + * Helper class to create Java Objects from the + * JSON serialization returned by {@link TopicControl#listAllSubscriptionsAsJSON()} and related methods. + * * @author <a href="mailto:jmesnil@redhat.com">Jeff Mesnil</a> - * - * @version <tt>$Revision$</tt> - * */ public class SubscriptionInfo { @@ -42,6 +43,10 @@ // Static -------------------------------------------------------- + /** + * Returns an array of SubscriptionInfo corresponding to the JSON serialization returned + * by {@link TopicControl#listAllSubscriptionsAsJSON()} and related methods. + */ public static SubscriptionInfo[] from(final String jsonString) throws Exception { JSONArray array = new JSONArray(jsonString); @@ -80,31 +85,49 @@ // Public -------------------------------------------------------- + /** + * Returns the name of the HornetQ core queue corresponding to this subscription. + */ public String getQueueName() { return queueName; } + /** + * Returns the client ID of this subscription or {@code null}. + */ public String getClientID() { return clientID; } + /** + * Returns the name of this subscription. + */ public String getName() { return name; } + /** + * Returns whether this subscription is durable. + */ public boolean isDurable() { return durable; } + /** + * Returns the JMS message selector associated to this subscription. + */ public String getSelector() { return selector; } + /** + * Returns the number of messages currently held by this subscription. + */ public int getMessageCount() { return messageCount; Added: trunk/src/main/org/hornetq/jms/management/package-info.java =================================================================== --- trunk/src/main/org/hornetq/jms/management/package-info.java (rev 0) +++ trunk/src/main/org/hornetq/jms/management/package-info.java 2009-12-11 14:45:28 UTC (rev 8675) @@ -0,0 +1,21 @@ +/* + * Copyright 2009 Red Hat, Inc. + * Red Hat licenses this file to you under the Apache License, version + * 2.0 (the "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + * implied. See the License for the specific language governing + * permissions and limitations under the License. + */ + +/** + * management API for HornetQ JMS resources. + * <br> + * HornetQ JMS resources can be managed either using JMX or by sending JMS management messages to the + * server's special management address. Please refer to the user manual for more information. + */ +package org.hornetq.jms.management; + Added: trunk/src/main/org/hornetq/jms/package-info.java =================================================================== --- trunk/src/main/org/hornetq/jms/package-info.java (rev 0) +++ trunk/src/main/org/hornetq/jms/package-info.java 2009-12-11 14:45:28 UTC (rev 8675) @@ -0,0 +1,22 @@ +/* + * Copyright 2009 Red Hat, Inc. + * Red Hat licenses this file to you under the Apache License, version + * 2.0 (the "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + * implied. See the License for the specific language governing + * permissions and limitations under the License. + */ + +/** + * Implementation of the JMS Destinations. + * <br> + * Classes in this package can be instantiated directly + * if JMS destinations are not looked up in JNDI. + * + */ +package org.hornetq.jms; + Added: trunk/src/main/org/hornetq/utils/package-info.java =================================================================== --- trunk/src/main/org/hornetq/utils/package-info.java (rev 0) +++ trunk/src/main/org/hornetq/utils/package-info.java 2009-12-11 14:45:28 UTC (rev 8675) @@ -0,0 +1,20 @@ +/* + * Copyright 2009 Red Hat, Inc. + * Red Hat licenses this file to you under the Apache License, version + * 2.0 (the "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + * implied. See the License for the specific language governing + * permissions and limitations under the License. + */ + +/** + * Utilities and helper classes. + * <br> + * This package defines the utilities class used by HornetQ. + */ +package org.hornetq.utils; +