You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beehive.apache.org by ek...@apache.org on 2005/06/06 23:36:32 UTC
svn commit: r185047 - in /incubator/beehive/trunk/system-controls/src:
ejb/org/apache/beehive/controls/system/ejb/
jms/org/apache/beehive/controls/system/jms/
jms/org/apache/beehive/controls/system/jndi/
Author: ekoneil
Date: Mon Jun 6 14:36:31 2005
New Revision: 185047
URL: http://svn.apache.org/viewcvs?rev=185047&view=rev
Log:
Javadoc cleanup in the system controls. Generally fixing the @link and @see references.
BB: self
DRT: Beehive pass
Modified:
incubator/beehive/trunk/system-controls/src/ejb/org/apache/beehive/controls/system/ejb/EJBControl.java
incubator/beehive/trunk/system-controls/src/ejb/org/apache/beehive/controls/system/ejb/EJBControlAssembler.java
incubator/beehive/trunk/system-controls/src/ejb/org/apache/beehive/controls/system/ejb/EJBControlImpl.jcs
incubator/beehive/trunk/system-controls/src/ejb/org/apache/beehive/controls/system/ejb/EJBInfo.java
incubator/beehive/trunk/system-controls/src/ejb/org/apache/beehive/controls/system/ejb/SessionEJBControl.java
incubator/beehive/trunk/system-controls/src/ejb/org/apache/beehive/controls/system/ejb/SessionEJBControlImpl.jcs
incubator/beehive/trunk/system-controls/src/jms/org/apache/beehive/controls/system/jms/JMSControl.java
incubator/beehive/trunk/system-controls/src/jms/org/apache/beehive/controls/system/jndi/JndiControl.java
Modified: incubator/beehive/trunk/system-controls/src/ejb/org/apache/beehive/controls/system/ejb/EJBControl.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/system-controls/src/ejb/org/apache/beehive/controls/system/ejb/EJBControl.java?rev=185047&r1=185046&r2=185047&view=diff
==============================================================================
--- incubator/beehive/trunk/system-controls/src/ejb/org/apache/beehive/controls/system/ejb/EJBControl.java (original)
+++ incubator/beehive/trunk/system-controls/src/ejb/org/apache/beehive/controls/system/ejb/EJBControl.java Mon Jun 6 14:36:31 2005
@@ -34,7 +34,6 @@
@ControlInterface (defaultBinding="org.apache.beehive.controls.system.ejb.EJBControlImpl")
public interface EJBControl
{
-
/**
* EJBHome specifies the target EJB's home interface for the EJB control
* - jndiName specifies the JNDI name of the target EJB's home interface
Modified: incubator/beehive/trunk/system-controls/src/ejb/org/apache/beehive/controls/system/ejb/EJBControlAssembler.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/system-controls/src/ejb/org/apache/beehive/controls/system/ejb/EJBControlAssembler.java?rev=185047&r1=185046&r2=185047&view=diff
==============================================================================
--- incubator/beehive/trunk/system-controls/src/ejb/org/apache/beehive/controls/system/ejb/EJBControlAssembler.java (original)
+++ incubator/beehive/trunk/system-controls/src/ejb/org/apache/beehive/controls/system/ejb/EJBControlAssembler.java Mon Jun 6 14:36:31 2005
@@ -17,6 +17,12 @@
*/
package org.apache.beehive.controls.system.ejb;
+import java.io.IOException;
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.FileNotFoundException;
+import java.lang.String;
+
import org.apache.beehive.controls.api.assembly.ControlAssembler;
import org.apache.beehive.controls.api.assembly.ControlAssemblyException;
import org.apache.beehive.controls.api.assembly.ControlAssemblyContext;
@@ -25,12 +31,6 @@
import org.apache.xmlbeans.XmlOptions;
import org.apache.beehive.controls.system.ejb.schemas.j2ee.*;
-
-import java.io.IOException;
-import java.io.File;
-import java.io.FileInputStream;
-import java.io.FileNotFoundException;
-import java.lang.String;
/**
* The EJBControl needs to inject EJB reference entries into the
Modified: incubator/beehive/trunk/system-controls/src/ejb/org/apache/beehive/controls/system/ejb/EJBControlImpl.jcs
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/system-controls/src/ejb/org/apache/beehive/controls/system/ejb/EJBControlImpl.jcs?rev=185047&r1=185046&r2=185047&view=diff
==============================================================================
--- incubator/beehive/trunk/system-controls/src/ejb/org/apache/beehive/controls/system/ejb/EJBControlImpl.jcs (original)
+++ incubator/beehive/trunk/system-controls/src/ejb/org/apache/beehive/controls/system/ejb/EJBControlImpl.jcs Mon Jun 6 14:36:31 2005
@@ -43,15 +43,13 @@
import org.apache.beehive.controls.api.context.ResourceContext.ResourceEvents;
import org.apache.beehive.controls.api.events.EventHandler;
-import org.apache.beehive.controls.system.ejb.EJBControl.EJBHome;
-import org.apache.beehive.controls.system.ejb.EJBControl.JNDIContextEnv;
-
/**
* The Enterprise Java Bean Control implementation class
*/
@ControlImplementation
abstract public class EJBControlImpl
implements EJBControl, Extensible, java.io.Serializable {
+
static final long serialVersionUID = 1L;
static public final int SESSION_BEAN = 1;
Modified: incubator/beehive/trunk/system-controls/src/ejb/org/apache/beehive/controls/system/ejb/EJBInfo.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/system-controls/src/ejb/org/apache/beehive/controls/system/ejb/EJBInfo.java?rev=185047&r1=185046&r2=185047&view=diff
==============================================================================
--- incubator/beehive/trunk/system-controls/src/ejb/org/apache/beehive/controls/system/ejb/EJBInfo.java (original)
+++ incubator/beehive/trunk/system-controls/src/ejb/org/apache/beehive/controls/system/ejb/EJBInfo.java Mon Jun 6 14:36:31 2005
@@ -17,13 +17,13 @@
*/
package org.apache.beehive.controls.system.ejb;
-import org.apache.beehive.controls.api.ControlException;
-
-import javax.ejb.EJBLocalHome;
-import javax.ejb.FinderException;
+import java.lang.reflect.Method;
import java.util.HashMap;
import java.util.Vector;
-import java.lang.reflect.Method;
+import javax.ejb.EJBLocalHome;
+import javax.ejb.FinderException;
+
+import org.apache.beehive.controls.api.ControlException;
/**
* The EJBInfo class is a support class that derives EJB information by
Modified: incubator/beehive/trunk/system-controls/src/ejb/org/apache/beehive/controls/system/ejb/SessionEJBControl.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/system-controls/src/ejb/org/apache/beehive/controls/system/ejb/SessionEJBControl.java?rev=185047&r1=185046&r2=185047&view=diff
==============================================================================
--- incubator/beehive/trunk/system-controls/src/ejb/org/apache/beehive/controls/system/ejb/SessionEJBControl.java (original)
+++ incubator/beehive/trunk/system-controls/src/ejb/org/apache/beehive/controls/system/ejb/SessionEJBControl.java Mon Jun 6 14:36:31 2005
@@ -43,5 +43,4 @@
@ControlInterface (defaultBinding="org.apache.beehive.controls.system.ejb.SessionEJBControlImpl")
public interface SessionEJBControl extends EJBControl
{
-
}
Modified: incubator/beehive/trunk/system-controls/src/ejb/org/apache/beehive/controls/system/ejb/SessionEJBControlImpl.jcs
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/system-controls/src/ejb/org/apache/beehive/controls/system/ejb/SessionEJBControlImpl.jcs?rev=185047&r1=185046&r2=185047&view=diff
==============================================================================
--- incubator/beehive/trunk/system-controls/src/ejb/org/apache/beehive/controls/system/ejb/SessionEJBControlImpl.jcs (original)
+++ incubator/beehive/trunk/system-controls/src/ejb/org/apache/beehive/controls/system/ejb/SessionEJBControlImpl.jcs Mon Jun 6 14:36:31 2005
@@ -40,9 +40,10 @@
implements SessionEJBControl, java.io.Serializable
{
static final long serialVersionUID = 1L;
- //
- // Override ejbControl.onCreate to perform additional processing
- //
+
+ /**
+ * Override ejbControl.onCreate to perform additional processing
+ */
public void onCreate()
{
super.onCreate();
Modified: incubator/beehive/trunk/system-controls/src/jms/org/apache/beehive/controls/system/jms/JMSControl.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/system-controls/src/jms/org/apache/beehive/controls/system/jms/JMSControl.java?rev=185047&r1=185046&r2=185047&view=diff
==============================================================================
--- incubator/beehive/trunk/system-controls/src/jms/org/apache/beehive/controls/system/jms/JMSControl.java (original)
+++ incubator/beehive/trunk/system-controls/src/jms/org/apache/beehive/controls/system/jms/JMSControl.java Mon Jun 6 14:36:31 2005
@@ -15,22 +15,21 @@
*
* $Header:$
*/
-
package org.apache.beehive.controls.system.jms;
+import java.util.Map;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Target;
+import javax.jms.Session;
+
import org.apache.beehive.controls.api.ControlException;
+import org.apache.beehive.controls.api.packaging.FeatureInfo;
import org.apache.beehive.controls.api.bean.AnnotationMemberTypes;
-import org.apache.beehive.controls.api.bean.Control;
import org.apache.beehive.controls.api.bean.ControlInterface;
import org.apache.beehive.controls.api.bean.AnnotationConstraints;
import org.apache.beehive.controls.api.properties.PropertySet;
-import org.apache.beehive.controls.api.packaging.*;
-import org.apache.beehive.controls.api.events.EventSet;
-import java.lang.annotation.*;
-import java.util.Date;
-import java.util.Map;
-
-import javax.jms.Session;
/**
* The control interface for the jms control.
@@ -56,21 +55,21 @@
*/
enum HeaderType
{
- /** see javax.jms.Message.getJMSCorrelationID() */
+ /** @see javax.jms.Message#getJMSCorrelationID */
JMSCorrelationID,
- /** see javax.jms.Message.getJMSDeliveryMode */
+ /** @see javax.jms.Message#getJMSDeliveryMode */
JMSDeliveryMode,
- /** see javax.jms.Message.getJMSPriority */
+ /** @see javax.jms.Message#getJMSPriority */
JMSPriority,
- /** see javax.jms.Message.getJMSExpiration */
+ /** @see javax.jms.Message#getJMSExpiration */
JMSExpiration,
- /** see javax.jms.Message.getJMSMessageID */
+ /** @see javax.jms.Message#getJMSMessageID */
JMSMessageID,
- /** see javax.jms.Message.getJMSType */
+ /** @see javax.jms.Message#getJMSType */
JMSType,
- /** see javax.jms.Message.getJMSRedelivered */
+ /** @see javax.jms.Message#getJMSRedelivered */
JMSRedelivered,
- /** see javax.jms.Message.getJMSTimestamp */
+ /** @see javax.jms.Message#getJMSTimestamp */
JMSTimestamp
};
@@ -81,15 +80,15 @@
{
/** Message is determined from the body instance class. If the method is not annotated with Body, then the message type is Map. */
Auto,
- /** Message is a javax.jms.TextMessage */
+ /** Message is a {@link javax.jms.TextMessage} */
Text,
- /** Message is a javax.jms.BytesMessage */
+ /** Message is a {@link javax.jms.BytesMessage} */
Bytes,
- /** Message is a javax.jms.ObjectMessage */
+ /** Message is a {@link javax.jms.ObjectMessage} */
Object,
- /** Message is a javax.jms.MapMessage */
+ /** Message is a {@link javax.jms.MapMessage} */
Map,
- /** Message is a javax.jms.Message as given by the Body parameter */
+ /** Message is a {@link javax.jms.Message} as given by the Body parameter */
JMSMessage
};
@@ -98,9 +97,13 @@
*/
enum DeliveryMode
{
- /** see javax.jms.DeliveryMode.NON_PERSISTENT */
+ /**
+ * @see javax.jms.DeliveryMode#NON_PERSISTENT
+ */
NonPersistent,
- /** see javax.jms.DeliveryMode.PERSISTENT */
+ /**
+ * @see javax.jms.DeliveryMode#PERSISTENT
+ */
Persistent,
/** The default for the provider */
Auto
@@ -111,11 +114,17 @@
*/
enum AcknowledgeMode
{
- /** see javax.jms.Session.AUTO_ACKNOWLEDGE */
+ /**
+ * @see javax.jms.Session#AUTO_ACKNOWLEDGE
+ */
Auto,
- /** see javax.jms.Session.CLIENT_ACKNOWLEDGE */
+ /**
+ * @see javax.jms.Session#CLIENT_ACKNOWLEDGE
+ */
Client,
- /** see javax.jms.Session.DUPS_OK_ACKNOWLEDGE */
+ /**
+ * @see javax.jms.Session#DUPS_OK_ACKNOWLEDGE
+ */
DupsOk
};
@@ -123,74 +132,82 @@
* Indicates the JMSCorrelationID message header.
*
* @deprecated
- * @see HeaderType
+ * @see HeaderType#JMSCorrelationID
*/
public static final String HEADER_CORRELATIONID = HeaderType.JMSCorrelationID.toString();
+
/**
* Indicates the JMSDeliveryMode message header.
*
* @deprecated
- * @see HeaderType
+ * @see HeaderType#JMSDeliveryMode
*/
public static final String HEADER_DELIVERYMODE = HeaderType.JMSDeliveryMode.toString();
+
/**
* Indicates the JMSExpiration message header.
* Use with the getHeaders and setHeaders methods.
*
* @deprecated
- * @see HeaderType
+ * @see HeaderType#JMSExpiration
*/
public static final String HEADER_EXPIRATION = HeaderType.JMSExpiration.toString();
+
/**
* Indicates the JMSMessageID message header.
*
* @deprecated
- * @see HeaderType
+ * @see HeaderType#JMSMessageID
*/
public static final String HEADER_MESSAGEID = HeaderType.JMSMessageID.toString();
+
/**
* Indicates the JMSPriority message header.
*
* @deprecated
- * @see HeaderType
+ * @see HeaderType#JMSPriority
*/
public static final String HEADER_PRIORITY = HeaderType.JMSPriority.toString();
+
/**
* Indicates the JMSRedelivered message header.
*
* @deprecated
- * @see HeaderType
+ * @see HeaderType#JMSRedelivered
*/
public static final String HEADER_REDELIVERED = HeaderType.JMSRedelivered.toString();
+
/**
* Indicates the JMSTimestamp message header.
*
* @deprecated
- * @see HeaderType
+ * @see HeaderType#JMSTimestamp
*/
public static final String HEADER_TIMESTAMP = HeaderType.JMSTimestamp.toString();
+
/**
* Indicates the JMSType message header.
*
* @deprecated
- * @see HeaderType
+ * @see HeaderType#JMSType
*/
public static final String HEADER_TYPE = HeaderType.JMSType.toString();
/**
- * Get the JMS Session object.
+ * Get the {@link Session}.
* @return the session.
*/
public Session getSession() throws ControlException;
/**
- * Get the JMS Connection.
+ * Get the {@link javax.jms.Connection}.
+ *
* @return the connection.
*/
public javax.jms.Connection getConnection() throws ControlException;
/**
- * Get the jms-destination.
+ * Get the {@link javax.jms.Destination}.
*
* @return an instance destination object.
*/
@@ -236,13 +253,10 @@
public void setProperties(Map properties);
/**
- * Set the given JMS property to be assigned to the next JMS message
- * sent. Note that this property is set only on the next
- * message, subsequent messages will not get this
- * property. Also note that
- * if the body is a message itself,
- * then the property set here will override the property set
- * in the message.
+ * Set the given JMS property to be assigned to the next JMS message sent. Note that
+ * this property is set only on the next message, subsequent messages will not get this
+ * property. Also note that if the body is a message itself, then the property set here
+ * will override the property set in the message.
*
* @param name the property name.
* @param value the property value.
@@ -250,8 +264,7 @@
public void setProperty(String name,Object value);
/**
- * The message type used by the method. The default is
- * to use the type of the body parameter.
+ * The message type used by the method. The default is to use the type of the body parameter.
*/
@PropertySet(prefix="Message")
@Target({ElementType.METHOD})
@@ -264,8 +277,8 @@
/**
* The method parameter representing a message property with the given name.
- * see javax.jms.Message.getProperty()/setProperty().
- */
+ * For more information, see the property getter and setter methods on {@link Message}.
+ */
@Target({ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
public @interface Property
@@ -278,8 +291,8 @@
/**
* The method parameter representing a message property with the given name and value.
- * see javax.jms.Message.getProperty()/setProperty().
- */
+ * For more information, see the property getter and setter methods on {@link Message}.
+ */
@PropertySet(prefix="Property")
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@@ -315,16 +328,18 @@
@AnnotationMemberTypes.Optional
public int value() default -1;
}
+
/**
* The method/parameter representing the message JMS type.
*/
@PropertySet(prefix="Type")
- @Target({ElementType.PARAMETER,ElementType.METHOD})
+ @Target({ElementType.PARAMETER, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Type
{
public String value() default "";
}
+
/**
* The method/parameter representing the message JMS CorrelationID.
*/
@@ -335,6 +350,7 @@
{
public String value() default "";
}
+
/**
* The method parameter representing a message expiration in milliseconds.
* If not given then the default for the JMS provider is used.
@@ -348,6 +364,7 @@
@AnnotationMemberTypes.Optional
public long value() default -1L;
}
+
/**
* The method parameter representing a message delivery mode.
* If not given then the default for the JMS provider is used.
@@ -359,6 +376,7 @@
{
public JMSControl.DeliveryMode value() default JMSControl.DeliveryMode.Auto;
}
+
/**
* The method parameter representing one or more properties.
*/
@@ -369,6 +387,7 @@
{
public PropertyValue[] value();
}
+
/**
* The JMS destination annotation for a extended class method.
*/
@@ -441,8 +460,7 @@
@FeatureInfo(shortDescription="JNDI security principal")
@AnnotationMemberTypes.Optional
public String jndiUsername() default "";
-
-
+
/**
* The JNDI security credentials.
*/
@@ -450,6 +468,4 @@
@AnnotationMemberTypes.Optional
public String jndiPassword() default "";
}
-
-
}
Modified: incubator/beehive/trunk/system-controls/src/jms/org/apache/beehive/controls/system/jndi/JndiControl.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/system-controls/src/jms/org/apache/beehive/controls/system/jndi/JndiControl.java?rev=185047&r1=185046&r2=185047&view=diff
==============================================================================
--- incubator/beehive/trunk/system-controls/src/jms/org/apache/beehive/controls/system/jndi/JndiControl.java (original)
+++ incubator/beehive/trunk/system-controls/src/jms/org/apache/beehive/controls/system/jndi/JndiControl.java Mon Jun 6 14:36:31 2005
@@ -45,6 +45,7 @@
* @throws ControlException
*/
public Object getResource(String resource,Class resourceClass) throws ControlException;
+
/**
* Get the JNDI initial context.
* @return the initial context.
@@ -59,11 +60,12 @@
public @interface Properties
{
/**
- * The JNDI context factory.
+ * The JNDI context factory class name.
*/
@FeatureInfo(shortDescription="JNDI context factory")
@AnnotationMemberTypes.Optional
String factory();
+
/**
* The JNDI provider URL.
*/
@@ -71,14 +73,14 @@
@AnnotationMemberTypes.Optional
@AnnotationMemberTypes.URI
String url();
+
/**
* The JNDI security principal.
*/
@FeatureInfo(shortDescription="JNDI security principal")
@AnnotationMemberTypes.Optional
public String jndiSecurityPrincipal() default "";
-
-
+
/**
* The JNDI security credentials.
*/
@@ -86,5 +88,4 @@
@AnnotationMemberTypes.Optional
public String jndiSecurityCredentials() default "";
}
-
}