VCLDequeueOperation - Revision history

G.dimaio at 17:35, 21 December 2012

2012-12-21T17:35:42Z

G.dimaio at 17:13, 21 December 2012

2012-12-21T17:13:54Z

Anonymous: /* DequeueOperation public static methods */

2012-12-21T13:55:39Z

‎DequeueOperation public static methods

Anonymous: /* DequeueOperation public static methods */

2012-12-21T13:24:14Z

‎DequeueOperation public static methods

Anonymous at 13:22, 21 December 2012

2012-12-21T13:22:11Z

Anonymous at 09:12, 21 December 2012

2012-12-21T09:12:26Z

Show changes

Anonymous: Created page with "Interface: '''it.greenvulcano.gvesb.virtual.DequeueOperation''' public interface DequeueOperation extends Operation { public static final Stri..."

2012-12-18T08:52:54Z

Created page with "Interface: '''it.greenvulcano.gvesb.virtual.DequeueOperation''' <syntaxhighlight lang="java5"> public interface DequeueOperation extends Operation { public static final Stri..."

New page

Interface: '''it.greenvulcano.gvesb.virtual.DequeueOperation'''

<syntaxhighlight lang="java5">
public interface DequeueOperation extends Operation
{
public static final String TYPE = "dequeue";

/**
* Used in the <code>setTimeout()</code> in order to set an infinite
* timeout.
*/
public static final long TO_INDEFINITELY = 0;

/**
* Used in the <code>setTimeout()</code> in order to set a non-blocking
* receive.
*/
public static final long TO_NON_BLOCKING = -1;

/**
* Return <code>null</code> if no messages are available or timeout occurs.
*
* @param gvBuffer
* @return a <code>GVBuffer</code> or <code>null</code> if no messages are
* available or timeout occurs.
* @throws ConnectionException
* @throws DequeueException
* @throws InvalidDataException
*/
public GVBuffer perform(GVBuffer gvBuffer) throws ConnectionException, DequeueException, InvalidDataException;

/**
* This method acknowledge the message identified by the given Id.
*
* @param id
* @throws ConnectionException
* @throws AcknowledgeException
*/
public void acknowledge(Id id) throws ConnectionException, AcknowledgeException;

/**
* This method acknowledge all the messages.
*
* @throws ConnectionException
* @throws AcknowledgeException
*/
public void acknowledgeAll() throws ConnectionException, AcknowledgeException;

/**
* This method roll-back the dequeue of the message identified by the given
* Id.
*
* @param id
* @throws ConnectionException
* @throws AcknowledgeException
*/
public void rollback(Id id) throws ConnectionException, AcknowledgeException;

/**
* This method roll-back the dequeue of all the messages.
*
* @throws ConnectionException
* @throws AcknowledgeException
*/
public void rollbackAll() throws ConnectionException, AcknowledgeException;

/**
* This method set the filter for messages to receive. 
* This filter is valid only for the first perform() invocation.
* The filter is reset also if perform() terminate with an exception. 
* Despite the GVVCL is a virtual interface, the syntax for the filter is
* like the syntax for JMS selectors. The concrete implementation must
* adapt to the underlying MOM.
*
* @param filter
* @throws FilterException
*/
public void setFilter(String filter) throws FilterException;

/**
* This method set the timeout for the receive operation. 
* If 0 then the receive blocks indefinitely. If >
* 0 then this parameter specify, in milliseconds, the time that the
* receive must wait for a message. If < 0 then executes a
* non-blocking receive. 
* This parameter is valid only for the first perform() invocation.
* The timeout is reset also if perform() terminate with an exception.
*
* @param timeout
* Specify the receive timeout. If > 0 specifies the
* milliseconds for timeout. It is possible to use the
* <code>TO_xxx</code> constants in order to specify a non-blocking
* receive operation or a indefinitely blocking receive.
*
*/
public void setTimeout(long timeout);
}
</syntaxhighlight>

@@ Line 1: / Line 1: @@
-Interface: '''it.greenvulcano.gvesb.virtual.DequeueOperation'''
+Interface FQN: '''it.greenvulcano.gvesb.virtual.DequeueOperation'''
 <syntaxhighlight lang="java5">
@@ Line 12: / Line 14: @@
 </syntaxhighlight>
-==DequeueOperation constants==
+==Following the DequeueOperation constants==
 <syntaxhighlight lang="java5">
 public static final String TYPE  = "dequeue";
@@ Line 29: / Line 31: @@
 </syntaxhighlight>
-==DequeueOperation public static methods==
+==Following the DequeueOperation public methods==
 <syntaxhighlight lang="java5">
 /**
-* Returns null if no messages are available or timeout occurs.
+ * Execute the operation using an GVBuffer. Usually this method
+ * is used in order to retrieve data from external systems.
-* @param gvBuffer
+ * Returns null if no messages are available or timeout occurs.
-* @return a GVBuffer or null if no messages are
-*         available or timeout occurs.
+ * @param gvBuffer
-* @throws ConnectionException
+ *        input data for the operation.
-* @throws DequeueException
-* @throws InvalidDataException
+ * @return an GVBuffer containing the operation result or null if
-*/
+ *         no messages are available or timeout occurs.
 public GVBuffer perform(GVBuffer gvBuffer) throws ConnectionException, DequeueException, InvalidDataException;

@@ Line 53: / Line 53: @@
 /**
-* This method acknowledge all the messages.
+* This method acknowledges all the messages.
+*
 * @throws ConnectionException

@@ Line 44: / Line 44: @@
 /**
-* This method acknowledge the message identified by the given Id.
+* This method acknowledges the message identified by the given Id.
+*
 * @param id
@@ Line 79: / Line 79: @@
 /**
-* This method set the filter for messages to receive.
+* This method sets the filter for messages to receive.
 * This filter is valid only for the first perform() invocation.
-* The filter is reset also if perform() terminate with an exception.
+* The filter is reset also if perform() terminates with an exception.
 * Despite the GVVCL is a virtual interface, the syntax for the filter is
 * like the syntax for JMS selectors. The concrete implementation must
@@ Line 101: / Line 101: @@
+*
 * @param timeout
-*        Specify the receive timeout. If > 0 specifies the
+*        Specifies the receive timeout. If > 0 specifies the
 *        milliseconds for timeout. It is possible to use the
 *        TO_xxx constants in order to specify a non-blocking