public class AQEnqueueOptions extends Object
Modifier and Type | Class and Description |
---|---|
static class |
AQEnqueueOptions.DeliveryMode |
static class |
AQEnqueueOptions.SequenceDeviationOption |
static class |
AQEnqueueOptions.VisibilityOption |
Constructor and Description |
---|
AQEnqueueOptions()
Construct the default enqueue options.
|
Modifier and Type | Method and Description |
---|---|
AQEnqueueOptions.DeliveryMode |
getDeliveryMode()
Returns the delivery option.
|
byte[] |
getRelativeMessageId()
Returns the relative message id.
|
boolean |
getRetrieveMessageId()
Returns the value of the enqueued message id option.
|
AQEnqueueOptions.SequenceDeviationOption |
getSequenceDeviation()
Returns the sequence deviation.
|
String |
getTransformation()
Returns the value of transformation option.
|
AQEnqueueOptions.VisibilityOption |
getVisibility()
Returns the transactional behavior.
|
void |
setDeliveryMode(AQEnqueueOptions.DeliveryMode delivery)
Specifies the delivery mode: persistent or buffered.
|
void |
setRelativeMessageId(byte[] relativeMessageId)
Deprecated.
|
void |
setRetrieveMessageId(boolean retrieveIt)
Set this to true to retrieve the message id back from the server when the message has been enqueued.
|
void |
setSequenceDeviation(AQEnqueueOptions.SequenceDeviationOption sequenceDeviation)
Deprecated.
|
void |
setTransformation(String _transformation)
Specifies a transformation that will be applied before enqueuing the message.
|
void |
setVisibility(AQEnqueueOptions.VisibilityOption visibility)
Specifies the transactional behavior of the enqueue request.
|
public AQEnqueueOptions()
public void setRelativeMessageId(byte[] relativeMessageId) throws SQLException
SequenceDeviationOption.BEFORE
is specified in setSequenceDeviation and is ignored if the sequence deviation is not specified.
This feature is deprecated and may be removed in a future release.
relativeMessageId
- relative message idSQLException
public byte[] getRelativeMessageId()
setRelativeMessageId(byte[])
public void setSequenceDeviation(AQEnqueueOptions.SequenceDeviationOption sequenceDeviation) throws SQLException
sequenceDeviation
- the possible values are:
SequenceDeviationOption.BOTTOM
SequenceDeviationOption.BEFORE
SequenceDeviationOption.TOP
SQLException
public AQEnqueueOptions.SequenceDeviationOption getSequenceDeviation()
public void setVisibility(AQEnqueueOptions.VisibilityOption visibility) throws SQLException
visibility
- The possible options are:
ENQUEUE_ON_COMMIT
ENQUEUE_IMMEDIATE
SQLException
public AQEnqueueOptions.VisibilityOption getVisibility()
setVisibility(VisibilityOption)
public void setDeliveryMode(AQEnqueueOptions.DeliveryMode delivery) throws SQLException
Possible values are:
delivery
- the delivery modeSQLException
public AQEnqueueOptions.DeliveryMode getDeliveryMode()
setDeliveryMode(DeliveryMode)
public void setRetrieveMessageId(boolean retrieveIt)
By default the message id won't be retrieved.
retrieveIt
- the enqueued message id optionpublic boolean getRetrieveMessageId()
setRetrieveMessageId(boolean)
public void setTransformation(String _transformation)
Transformations must be created in PLSQL using DBMS_TRANSFORM.CREATE_TRANSFORMATION(...)
.
For example if the transformation 'OBJ2XML' has been created under the schema 'SCOTT' then it can be specified in the dequeue option with enqueueOption.setTransformation("SCOTT.OBJ2XML")
.
_transformation
- the transformationpublic String getTransformation()
setTransformation(String)