public class TransactionIdControl extends Control
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.
Control.RemoveOnceControlIsMigrated
Modifier and Type | Field and Description |
---|---|
static ControlDecoder<TransactionIdControl> |
DECODER
The Control Decoder that can be used to decode this control.
|
Constructor and Description |
---|
TransactionIdControl(boolean isCritical,
String transactionId)
Creates a new Transaction Id Control.
|
Modifier and Type | Method and Description |
---|---|
String |
getTransactionId()
Retrieves the transaction id associated with this control.
|
ByteString |
getValue()
Returns the value, if any, associated with this control.
|
boolean |
hasValue()
Returns
true if this control has a value. |
void |
toString(StringBuilder buffer)
Appends a string representation of this control to the provided buffer.
|
void |
writeValue(Asn1Writer writer)
Writes this control's value to an ASN.1 writer.
|
getOid, getValueAdapter, isCritical, toString, write
public static final ControlDecoder<TransactionIdControl> DECODER
public TransactionIdControl(boolean isCritical, String transactionId)
isCritical
- Indicates whether this control should be considered critical to the operation processing.transactionId
- The id to pass through this control.public boolean hasValue()
Control
true
if this control has a value. In some circumstances
it may be useful to determine if a control has a value, without actually
calculating the value and incurring any performance costs.true
if this control has a value, or false
if
there is no value.public ByteString getValue()
Control
public void writeValue(Asn1Writer writer) throws IOException
Control
writeValue
in class Control
writer
- The ASN.1 writer to use.IOException
- If a problem occurs while writing to the stream.public String getTransactionId()
public void toString(StringBuilder buffer)
Copyright 2010-2018 ForgeRock AS.