org.jooq.util.oracle

Class OracleDSL.DBMS_AQ

java.lang.Object

org.jooq.util.oracle.OracleDSL.DBMS_AQ

Enclosing class:

OracleDSL

public static final class OracleDSL.DBMS_AQ
extends Object

Oracle AQ related features are located here.

Author:

Lukas Eder

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OracleDSL.DBMS_AQ.DELIVERY_MODE A flag corresponding to DBMS_AQ.DEQUEUE_OPTIONS_T.DELIVERY_MODE and to DBMS_AQ.ENQUEUE_OPTIONS_T.DELIVERY_MODE.
static class	OracleDSL.DBMS_AQ.DEQUEUE_MODE A flag corresponding to DBMS_AQ.DEQUEUE_OPTIONS_T.DEQUEUE_MODE.
static class	OracleDSL.DBMS_AQ.DEQUEUE_OPTIONS_T A RECORD corresponding to DBMS_AQ.DEQUEUE_OPTIONS_T.
static class	OracleDSL.DBMS_AQ.ENQUEUE_OPTIONS_T A RECORD corresponding to DBMS_AQ.ENQUEUE_OPTIONS_T.
static class	OracleDSL.DBMS_AQ.MESSAGE_PROPERTIES_T A RECORD corresponding to DBMS_AQ.MESSAGE_PROPERTIES_T.
static class	OracleDSL.DBMS_AQ.NAVIGATION A flag corresponding to DBMS_AQ.DEQUEUE_OPTIONS_T.NAVIGATION.
static class	OracleDSL.DBMS_AQ.SEQUENCE_DEVIATION A flag corresponding to DBMS_AQ.ENQUEUE_OPTIONS_T.SEQUENCE_DEVIATION.
static class	OracleDSL.DBMS_AQ.VISIBILITY A flag corresponding to DBMS_AQ.DEQUEUE_OPTIONS_T.VISIBILITY and to DBMS_AQ.ENQUEUE_OPTIONS_T.VISIBILITY.
static class	OracleDSL.DBMS_AQ.WAIT A flag corresponding to DBMS_AQ.DEQUEUE_OPTIONS_T.WAIT.

Method Summary

Modifier and Type	Method and Description
static <R extends UDTRecord<R>> R	dequeue(Configuration configuration, Queue<R> queue) Dequeue a message in an Oracle AQ.
static <R extends UDTRecord<R>> R	dequeue(Configuration configuration, Queue<R> queue, OracleDSL.DBMS_AQ.DEQUEUE_OPTIONS_T options) Dequeue a message in an Oracle AQ.
static <R extends UDTRecord<R>> R	dequeue(Configuration configuration, Queue<R> queue, OracleDSL.DBMS_AQ.DEQUEUE_OPTIONS_T options, OracleDSL.DBMS_AQ.MESSAGE_PROPERTIES_T properties) Dequeue a message in an Oracle AQ.
static <R extends UDTRecord<R>> CompletionStage<R>	dequeueAsync(Configuration configuration, Queue<R> queue) Dequeue a message in an Oracle AQ asynchronously.
static <R extends UDTRecord<R>> CompletionStage<R>	dequeueAsync(Configuration configuration, Queue<R> queue, OracleDSL.DBMS_AQ.DEQUEUE_OPTIONS_T options) Dequeue a message in an Oracle AQ asynchronously.
static <R extends UDTRecord<R>> CompletionStage<R>	dequeueAsync(Configuration configuration, Queue<R> queue, OracleDSL.DBMS_AQ.DEQUEUE_OPTIONS_T options, OracleDSL.DBMS_AQ.MESSAGE_PROPERTIES_T properties) Dequeue a message in an Oracle AQ asynchronously.
static <R extends UDTRecord<R>> CompletionStage<R>	dequeueAsync(Executor executor, Configuration configuration, Queue<R> queue) Dequeue a message in an Oracle AQ, asynchronously in the given executor.
static <R extends UDTRecord<R>> CompletionStage<R>	dequeueAsync(Executor executor, Configuration configuration, Queue<R> queue, OracleDSL.DBMS_AQ.DEQUEUE_OPTIONS_T options) Dequeue a message in an Oracle AQ, asynchronously in the given executor.
static <R extends UDTRecord<R>> CompletionStage<R>	dequeueAsync(Executor executor, Configuration configuration, Queue<R> queue, OracleDSL.DBMS_AQ.DEQUEUE_OPTIONS_T options, OracleDSL.DBMS_AQ.MESSAGE_PROPERTIES_T properties) Dequeue a message in an Oracle AQ, asynchronously in the given executor.
static <R extends UDTRecord<R>> Iterable<R>	dequeueIterable(Configuration configuration, Queue<R> queue) Dequeue messages as an Oracle AQ Iterable.
static <R extends UDTRecord<R>> Iterable<R>	dequeueIterable(Configuration configuration, Queue<R> queue, OracleDSL.DBMS_AQ.DEQUEUE_OPTIONS_T options) Dequeue messages as an Oracle AQ Iterable.
static <R extends UDTRecord<R>> Iterable<R>	dequeueIterable(Configuration configuration, Queue<R> queue, OracleDSL.DBMS_AQ.DEQUEUE_OPTIONS_T options, OracleDSL.DBMS_AQ.MESSAGE_PROPERTIES_T properties) Dequeue messages as an Oracle AQ Iterable.
static <R extends UDTRecord<R>> Stream<R>	dequeueStream(Configuration configuration, Queue<R> queue) Dequeue messages as an Oracle AQ Stream.
static <R extends UDTRecord<R>> Stream<R>	dequeueStream(Configuration configuration, Queue<R> queue, OracleDSL.DBMS_AQ.DEQUEUE_OPTIONS_T options) Dequeue messages as an Oracle AQ Stream.
static <R extends UDTRecord<R>> Stream<R>	dequeueStream(Configuration configuration, Queue<R> queue, OracleDSL.DBMS_AQ.DEQUEUE_OPTIONS_T options, OracleDSL.DBMS_AQ.MESSAGE_PROPERTIES_T properties) Dequeue messages as an Oracle AQ Stream.
static <R extends UDTRecord<R>> void	enqueue(Configuration configuration, Queue<R> queue, R payload) Enqueue a message in an Oracle AQ.
static <R extends UDTRecord<R>> void	enqueue(Configuration configuration, Queue<R> queue, R payload, OracleDSL.DBMS_AQ.ENQUEUE_OPTIONS_T options, OracleDSL.DBMS_AQ.MESSAGE_PROPERTIES_T properties) Enqueue a message in an Oracle AQ.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

enqueue

public static <R extends UDTRecord<R>> void enqueue(Configuration configuration,
                                                    Queue<R> queue,
                                                    R payload)

Enqueue a message in an Oracle AQ.

Parameters:

configuration - The configuration from which to get a connection.

queue - The queue reference.

payload - The message payload.

enqueue

public static <R extends UDTRecord<R>> void enqueue(Configuration configuration,
                                                    Queue<R> queue,
                                                    R payload,
                                                    OracleDSL.DBMS_AQ.ENQUEUE_OPTIONS_T options,
                                                    OracleDSL.DBMS_AQ.MESSAGE_PROPERTIES_T properties)

Enqueue a message in an Oracle AQ.

Parameters:

configuration - The configuration from which to get a connection.

queue - The queue reference.

payload - The message payload.

options - The enqueue options.

properties - The message properties.

dequeueIterable

public static <R extends UDTRecord<R>> Iterable<R> dequeueIterable(Configuration configuration,
                                                                   Queue<R> queue)

Dequeue messages as an Oracle AQ Iterable.

This returns an infinite Iterable of AQ messages. Messages are dequeued via individual calls to DBMS_AQ, so no resources are bound by the stream. The Iterator is blocking on the AQ until new messages are delivered.

Individual dequeue calls run in a TransactionalCallable and are committed immediately. Use dequeue(Configuration, Queue) instead, if you want to commit / rollback individual messages.

Parameters:

configuration - The configuration from which to get a connection.

queue - The queue reference.

Returns:

The message payload.

dequeueIterable

public static <R extends UDTRecord<R>> Iterable<R> dequeueIterable(Configuration configuration,
                                                                   Queue<R> queue,
                                                                   OracleDSL.DBMS_AQ.DEQUEUE_OPTIONS_T options)

Dequeue messages as an Oracle AQ Iterable.

This returns an infinite Iterable of AQ messages. Messages are dequeued via individual calls to DBMS_AQ, so no resources are bound by the stream. The Iterator is blocking on the AQ until new messages are delivered.

Individual dequeue calls run in a TransactionalCallable and are committed immediately. Use dequeue(Configuration, Queue, DEQUEUE_OPTIONS_T) instead, if you want to commit / rollback individual messages.

Parameters:

configuration - The configuration from which to get a connection.

queue - The queue reference.

options - The dequeue options.

Returns:

The message payload.

dequeueIterable

public static <R extends UDTRecord<R>> Iterable<R> dequeueIterable(Configuration configuration,
                                                                   Queue<R> queue,
                                                                   OracleDSL.DBMS_AQ.DEQUEUE_OPTIONS_T options,
                                                                   OracleDSL.DBMS_AQ.MESSAGE_PROPERTIES_T properties)

Dequeue messages as an Oracle AQ Iterable.

This returns an infinite Iterable of AQ messages. Messages are dequeued via individual calls to DBMS_AQ, so no resources are bound by the stream. The Iterator is blocking on the AQ until new messages are delivered.

Individual dequeue calls run in a TransactionalCallable and are committed immediately. Use dequeue(Configuration, Queue, DEQUEUE_OPTIONS_T, MESSAGE_PROPERTIES_T) instead, if you want to commit / rollback individual messages.

Parameters:

configuration - The configuration from which to get a connection.

queue - The queue reference.

options - The dequeue options.

properties - The message properties OUT parameter. Resulting values will be stored here.

Returns:

The message payload.

dequeueStream

public static <R extends UDTRecord<R>> Stream<R> dequeueStream(Configuration configuration,
                                                               Queue<R> queue)

Dequeue messages as an Oracle AQ Stream.

This returns an infinite Stream of AQ messages. Messages are dequeued via individual calls to DBMS_AQ, so no resources are bound by the stream. The stream is blocking on the AQ until new messages are delivered.

Individual dequeue calls run in a TransactionalCallable and are committed immediately. Use dequeue(Configuration, Queue) instead, if you want to commit / rollback individual messages.

Parameters:

configuration - The configuration from which to get a connection.

queue - The queue reference.

Returns:

The message payload.

dequeueStream

public static <R extends UDTRecord<R>> Stream<R> dequeueStream(Configuration configuration,
                                                               Queue<R> queue,
                                                               OracleDSL.DBMS_AQ.DEQUEUE_OPTIONS_T options)

Dequeue messages as an Oracle AQ Stream.

This returns an infinite Stream of AQ messages. Messages are dequeued via individual calls to DBMS_AQ, so no resources are bound by the stream. The stream is blocking on the AQ until new messages are delivered.

Individual dequeue calls run in a TransactionalCallable and are committed immediately. Use dequeue(Configuration, Queue, DEQUEUE_OPTIONS_T) instead, if you want to commit / rollback individual messages.

Parameters:

configuration - The configuration from which to get a connection.

queue - The queue reference.

options - The dequeue options.

Returns:

The message payload.

dequeueStream

public static <R extends UDTRecord<R>> Stream<R> dequeueStream(Configuration configuration,
                                                               Queue<R> queue,
                                                               OracleDSL.DBMS_AQ.DEQUEUE_OPTIONS_T options,
                                                               OracleDSL.DBMS_AQ.MESSAGE_PROPERTIES_T properties)

Dequeue messages as an Oracle AQ Stream.

This returns an infinite Stream of AQ messages. Messages are dequeued via individual calls to DBMS_AQ, so no resources are bound by the stream. The stream is blocking on the AQ until new messages are delivered.

Individual dequeue calls run in a TransactionalCallable and are committed immediately. Use dequeue(Configuration, Queue, DEQUEUE_OPTIONS_T, MESSAGE_PROPERTIES_T) instead, if you want to commit / rollback individual messages.

Parameters:

configuration - The configuration from which to get a connection.

queue - The queue reference.

options - The dequeue options.

properties - The message properties OUT parameter. Resulting values will be stored here.

Returns:

The message payload.

dequeueAsync

public static <R extends UDTRecord<R>> CompletionStage<R> dequeueAsync(Configuration configuration,
                                                                       Queue<R> queue)

Dequeue a message in an Oracle AQ asynchronously.

The dequeue call is completed asynchronously in a CompletionStage run in an Executor provided by the configuration's Configuration.executorProvider()

The dequeue operation will happen in a (nested) transaction. In order to control transaction behaviour, supply a Configuration with appropriate TransactionProvider.

Parameters:

configuration - The configuration from which to get a connection.

queue - The queue reference.

Returns:

The message payload.

dequeueAsync

public static <R extends UDTRecord<R>> CompletionStage<R> dequeueAsync(Configuration configuration,
                                                                       Queue<R> queue,
                                                                       OracleDSL.DBMS_AQ.DEQUEUE_OPTIONS_T options)

Dequeue a message in an Oracle AQ asynchronously.

The dequeue call is completed asynchronously in a CompletionStage run in an Executor provided by the configuration's Configuration.executorProvider()

The dequeue operation will happen in a (nested) transaction. In order to control transaction behaviour, supply a Configuration with appropriate TransactionProvider.

Parameters:

configuration - The configuration from which to get a connection.

queue - The queue reference.

options - The dequeue options.

Returns:

The message payload.

dequeueAsync

public static <R extends UDTRecord<R>> CompletionStage<R> dequeueAsync(Configuration configuration,
                                                                       Queue<R> queue,
                                                                       OracleDSL.DBMS_AQ.DEQUEUE_OPTIONS_T options,
                                                                       OracleDSL.DBMS_AQ.MESSAGE_PROPERTIES_T properties)

Dequeue a message in an Oracle AQ asynchronously.

The dequeue call is completed asynchronously in a CompletionStage run in an Executor provided by the configuration's Configuration.executorProvider()

The dequeue operation will happen in a (nested) transaction. In order to control transaction behaviour, supply a Configuration with appropriate TransactionProvider.

Parameters:

configuration - The configuration from which to get a connection.

queue - The queue reference.

options - The dequeue options.

properties - The message properties OUT parameter. Resulting values will be stored here.

Returns:

The message payload.

dequeueAsync

public static <R extends UDTRecord<R>> CompletionStage<R> dequeueAsync(Executor executor,
                                                                       Configuration configuration,
                                                                       Queue<R> queue)

Dequeue a message in an Oracle AQ, asynchronously in the given executor.

The dequeue operation will happen in a (nested) transaction. In order to control transaction behaviour, supply a Configuration with appropriate TransactionProvider.

Parameters:

configuration - The configuration from which to get a connection.

queue - The queue reference.

Returns:

The message payload.

dequeueAsync

public static <R extends UDTRecord<R>> CompletionStage<R> dequeueAsync(Executor executor,
                                                                       Configuration configuration,
                                                                       Queue<R> queue,
                                                                       OracleDSL.DBMS_AQ.DEQUEUE_OPTIONS_T options)

Dequeue a message in an Oracle AQ, asynchronously in the given executor.

The dequeue operation will happen in a (nested) transaction. In order to control transaction behaviour, supply a Configuration with appropriate TransactionProvider.

Parameters:

configuration - The configuration from which to get a connection.

queue - The queue reference.

options - The dequeue options.

Returns:

The message payload.

dequeueAsync

public static <R extends UDTRecord<R>> CompletionStage<R> dequeueAsync(Executor executor,
                                                                       Configuration configuration,
                                                                       Queue<R> queue,
                                                                       OracleDSL.DBMS_AQ.DEQUEUE_OPTIONS_T options,
                                                                       OracleDSL.DBMS_AQ.MESSAGE_PROPERTIES_T properties)

Dequeue a message in an Oracle AQ, asynchronously in the given executor.

The dequeue operation will happen in a (nested) transaction. In order to control transaction behaviour, supply a Configuration with appropriate TransactionProvider.

Parameters:

configuration - The configuration from which to get a connection.

queue - The queue reference.

options - The dequeue options.

properties - The message properties OUT parameter. Resulting values will be stored here.

Returns:

The message payload.

dequeue

public static <R extends UDTRecord<R>> R dequeue(Configuration configuration,
                                                 Queue<R> queue)

Dequeue a message in an Oracle AQ.

Parameters:

configuration - The configuration from which to get a connection.

queue - The queue reference.

Returns:

The message payload.

dequeue

public static <R extends UDTRecord<R>> R dequeue(Configuration configuration,
                                                 Queue<R> queue,
                                                 OracleDSL.DBMS_AQ.DEQUEUE_OPTIONS_T options)

Dequeue a message in an Oracle AQ.

Parameters:

configuration - The configuration from which to get a connection.

queue - The queue reference.

options - The dequeue options.

Returns:

The message payload.

dequeue

public static <R extends UDTRecord<R>> R dequeue(Configuration configuration,
                                                 Queue<R> queue,
                                                 OracleDSL.DBMS_AQ.DEQUEUE_OPTIONS_T options,
                                                 OracleDSL.DBMS_AQ.MESSAGE_PROPERTIES_T properties)

Dequeue a message in an Oracle AQ.

Parameters:

configuration - The configuration from which to get a connection.

queue - The queue reference.

options - The dequeue options.

properties - The message properties OUT parameter. Resulting values will be stored here.

Returns:

The message payload.