com.unboundid.ldap.sdk.unboundidds.extensions.EndBatchedTransactionExtendedRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of unboundid-ldapsdk Show documentation
Show all versions of unboundid-ldapsdk Show documentation
The UnboundID LDAP SDK for Java is a fast, comprehensive, and easy-to-use
Java API for communicating with LDAP directory servers and performing
related tasks like reading and writing LDIF, encoding and decoding data
using base64 and ASN.1 BER, and performing secure communication. This
package contains the Standard Edition of the LDAP SDK, which is a
complete, general-purpose library for communicating with LDAPv3 directory
servers.
/*
* Copyright 2007-2022 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright 2007-2022 Ping Identity Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* Copyright (C) 2007-2022 Ping Identity Corporation
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License (GPLv2 only)
* or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see .
*/
package com.unboundid.ldap.sdk.unboundidds.extensions;
import com.unboundid.asn1.ASN1Boolean;
import com.unboundid.asn1.ASN1Element;
import com.unboundid.asn1.ASN1OctetString;
import com.unboundid.asn1.ASN1Sequence;
import com.unboundid.ldap.sdk.Control;
import com.unboundid.ldap.sdk.ExtendedRequest;
import com.unboundid.ldap.sdk.ExtendedResult;
import com.unboundid.ldap.sdk.LDAPConnection;
import com.unboundid.ldap.sdk.LDAPException;
import com.unboundid.ldap.sdk.ResultCode;
import com.unboundid.util.Debug;
import com.unboundid.util.NotMutable;
import com.unboundid.util.NotNull;
import com.unboundid.util.Nullable;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
import com.unboundid.util.Validator;
import static com.unboundid.ldap.sdk.unboundidds.extensions.ExtOpMessages.*;
/**
* This class provides an implementation of the end batched transaction extended
* request. It may be used to either commit or abort a transaction that was
* created using the start batched transaction request. See the documentation
* for the {@link StartBatchedTransactionExtendedRequest} for an example of
* processing a batched transaction.
*
*
* NOTE: This class, and other classes within the
* {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
* supported for use against Ping Identity, UnboundID, and
* Nokia/Alcatel-Lucent 8661 server products. These classes provide support
* for proprietary functionality or for external specifications that are not
* considered stable or mature enough to be guaranteed to work in an
* interoperable way with other types of LDAP servers.
*
*/
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.NOT_THREADSAFE)
public final class EndBatchedTransactionExtendedRequest
extends ExtendedRequest
{
/**
* The OID (1.3.6.1.4.1.30221.2.6.2) for the end batched transaction extended
* request.
*/
@NotNull public static final String END_BATCHED_TRANSACTION_REQUEST_OID =
"1.3.6.1.4.1.30221.2.6.2";
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = -8569129721687583552L;
// The transaction ID for the associated transaction.
@NotNull private final ASN1OctetString transactionID;
// Indicates whether to commit or abort the associated transaction.
private final boolean commit;
/**
* Creates a new end batched transaction extended request with the provided
* information.
*
* @param transactionID The transaction ID for the transaction to commit or
* abort. It must not be {@code null}.
* @param commit {@code true} if the transaction should be committed,
* or {@code false} if the transaction should be
* aborted.
*/
public EndBatchedTransactionExtendedRequest(
@NotNull final ASN1OctetString transactionID,
final boolean commit)
{
this(transactionID, commit, null);
}
/**
* Creates a new end batched transaction extended request with the provided
* information.
*
* @param transactionID The transaction ID for the transaction to commit or
* abort. It must not be {@code null}.
* @param commit {@code true} if the transaction should be committed,
* or {@code false} if the transaction should be
* aborted.
* @param controls The set of controls to include in the request.
*/
public EndBatchedTransactionExtendedRequest(
@NotNull final ASN1OctetString transactionID,
final boolean commit,
@Nullable final Control[] controls)
{
super(END_BATCHED_TRANSACTION_REQUEST_OID,
encodeValue(transactionID, commit),
controls);
this.transactionID = transactionID;
this.commit = commit;
}
/**
* Creates a new end batched transaction extended request from the provided
* generic extended request.
*
* @param extendedRequest The generic extended request to use to create this
* end batched transaction extended request.
*
* @throws LDAPException If a problem occurs while decoding the request.
*/
public EndBatchedTransactionExtendedRequest(
@NotNull final ExtendedRequest extendedRequest)
throws LDAPException
{
super(extendedRequest);
final ASN1OctetString value = extendedRequest.getValue();
if (value == null)
{
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_END_TXN_REQUEST_NO_VALUE.get());
}
try
{
final ASN1Element valueElement = ASN1Element.decode(value.getValue());
final ASN1Element[] elements =
ASN1Sequence.decodeAsSequence(valueElement).elements();
if (elements.length == 1)
{
commit = true;
transactionID = ASN1OctetString.decodeAsOctetString(elements[0]);
}
else
{
commit = ASN1Boolean.decodeAsBoolean(elements[0]).booleanValue();
transactionID = ASN1OctetString.decodeAsOctetString(elements[1]);
}
}
catch (final Exception e)
{
Debug.debugException(e);
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_END_TXN_REQUEST_CANNOT_DECODE.get(e), e);
}
}
/**
* Generates the value to include in this extended request.
*
* @param transactionID The transaction ID for the transaction to commit or
* abort. It must not be {@code null}.
* @param commit {@code true} if the transaction should be committed,
* or {@code false} if the transaction should be
* aborted.
*
* @return The ASN.1 octet string containing the encoded request value.
*/
@NotNull()
private static ASN1OctetString encodeValue(
@NotNull final ASN1OctetString transactionID,
final boolean commit)
{
Validator.ensureNotNull(transactionID);
final ASN1Element[] valueElements;
if (commit)
{
valueElements = new ASN1Element[]
{
transactionID
};
}
else
{
valueElements = new ASN1Element[]
{
new ASN1Boolean(commit),
transactionID
};
}
return new ASN1OctetString(new ASN1Sequence(valueElements).encode());
}
/**
* Retrieves the transaction ID for the transaction to commit or abort.
*
* @return The transaction ID for the transaction to commit or abort.
*/
@NotNull()
public ASN1OctetString getTransactionID()
{
return transactionID;
}
/**
* Indicates whether the transaction should be committed or aborted.
*
* @return {@code true} if the transaction should be committed, or
* {@code false} if it should be aborted.
*/
public boolean commit()
{
return commit;
}
/**
* {@inheritDoc}
*/
@Override()
@NotNull()
public EndBatchedTransactionExtendedResult process(
@NotNull final LDAPConnection connection, final int depth)
throws LDAPException
{
final ExtendedResult extendedResponse = super.process(connection, depth);
return new EndBatchedTransactionExtendedResult(extendedResponse);
}
/**
* {@inheritDoc}
*/
@Override()
@NotNull()
public EndBatchedTransactionExtendedRequest duplicate()
{
return duplicate(getControls());
}
/**
* {@inheritDoc}
*/
@Override()
@NotNull()
public EndBatchedTransactionExtendedRequest duplicate(
@Nullable final Control[] controls)
{
final EndBatchedTransactionExtendedRequest r =
new EndBatchedTransactionExtendedRequest(transactionID, commit,
controls);
r.setResponseTimeoutMillis(getResponseTimeoutMillis(null));
return r;
}
/**
* {@inheritDoc}
*/
@Override()
@NotNull()
public String getExtendedRequestName()
{
return INFO_EXTENDED_REQUEST_NAME_END_BATCHED_TXN.get();
}
/**
* {@inheritDoc}
*/
@Override()
public void toString(@NotNull final StringBuilder buffer)
{
buffer.append("EndBatchedTransactionExtendedRequest(transactionID='");
buffer.append(transactionID.stringValue());
buffer.append("', commit=");
buffer.append(commit);
final Control[] controls = getControls();
if (controls.length > 0)
{
buffer.append("controls={");
for (int i=0; i < controls.length; i++)
{
if (i > 0)
{
buffer.append(", ");
}
buffer.append(controls[i]);
}
buffer.append('}');
}
buffer.append(')');
}
}