org.opends.server.controls

Class TransactionIdControl

java.lang.Object

org.opends.server.types.Control

org.opends.server.controls.TransactionIdControl

public class TransactionIdControl
extends Control

Control that provides a transaction ID.

The transaction ID is related to Common Audit : it is used for tracking the processing of a user-interaction as it passes through the Forgerock stack

The control's value is the UTF-8 encoding of the transaction ID.

Field Summary

Fields

Modifier and Type	Field and Description
static ControlDecoder<TransactionIdControl>	DECODER The Control Decoder that can be used to decode this control.

Constructor Summary

Constructors

Constructor and Description
TransactionIdControl(boolean isCritical, String transactionId) Creates a new Transaction Id Control.

Method Summary

Methods

Modifier and Type	Method and Description
String	getTransactionId() Retrieves the transaction id associated with this control.
void	toString(StringBuilder buffer) Appends a string representation of this control to the provided buffer.
void	writeValue(org.forgerock.opendj.io.ASN1Writer writer) Writes this control's value to an ASN.1 writer.

Methods inherited from class org.opends.server.types.Control

getOID, isCritical, toString, write

Methods inherited from class java.lang.Object

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

Field Detail

DECODER

public static final ControlDecoder<TransactionIdControl> DECODER

The Control Decoder that can be used to decode this control.

Constructor Detail

TransactionIdControl

public TransactionIdControl(boolean isCritical,
                    String transactionId)

Creates a new Transaction Id Control.

Parameters:

isCritical - Indicates whether this control should be considered critical to the operation processing.

transactionId - The id to pass through this control.

Method Detail

writeValue

public void writeValue(org.forgerock.opendj.io.ASN1Writer writer)
                throws IOException

Writes this control's value to an ASN.1 writer. The value (if any) must be written as an ASN1OctetString.

Specified by:

writeValue in class Control

Parameters:

writer - The ASN.1 output stream to write to.

Throws:

IOException - If a problem occurs while writing to the stream.

getTransactionId

public String getTransactionId()

Retrieves the transaction id associated with this control.

Returns:

The transaction id associated with this control.

toString

public void toString(StringBuilder buffer)

Appends a string representation of this control to the provided buffer.

Overrides:

toString in class Control

Parameters:

buffer - The buffer to which the information should be appended.