com.unboundid.ldap.sdk.controls.VirtualListViewResponseControl 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-2018 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright (C) 2008-2018 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.controls;
import com.unboundid.asn1.ASN1Element;
import com.unboundid.asn1.ASN1Enumerated;
import com.unboundid.asn1.ASN1Exception;
import com.unboundid.asn1.ASN1Integer;
import com.unboundid.asn1.ASN1OctetString;
import com.unboundid.asn1.ASN1Sequence;
import com.unboundid.ldap.sdk.Control;
import com.unboundid.ldap.sdk.DecodeableControl;
import com.unboundid.ldap.sdk.LDAPException;
import com.unboundid.ldap.sdk.ResultCode;
import com.unboundid.ldap.sdk.SearchResult;
import com.unboundid.util.Debug;
import com.unboundid.util.NotMutable;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
import static com.unboundid.ldap.sdk.controls.ControlMessages.*;
/**
* This class provides an implementation of the virtual list view (VLV) response
* control, as defined in draft-ietf-ldapext-ldapv3-vlv. It may be used to
* provide information about the result of virtual list view processing for a
* search containing the {@link VirtualListViewRequestControl}.
*
* The virtual list view response control may include the following elements:
*
* - {@code resultCode} -- A result code that indicates the result of the
* virtual list view processing. It may be the same as or different from
* the result code contained in the search result done message.
* - {@code targetPosition} -- The offset of the target entry specified by
* the client in the result set.
* - {@code contentCount} -- The estimated total number of entries in the
* entire result set.
* - {@code contextID} -- An optional cookie that the client should include
* in the next request as part of the virtual list view sequence.
*
*/
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class VirtualListViewResponseControl
extends Control
implements DecodeableControl
{
/**
* The OID (2.16.840.1.113730.3.4.10) for the virtual list view response
* control.
*/
public static final String VIRTUAL_LIST_VIEW_RESPONSE_OID =
"2.16.840.1.113730.3.4.10";
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = -534656674756287217L;
// The context ID for this VLV response control, if available.
private final ASN1OctetString contextID;
// The estimated total number of entries in the result set.
private final int contentCount;
// The result code for this VLV response control.
private final ResultCode resultCode;
// The offset of the target entry for this VLV response control.
private final int targetPosition;
/**
* Creates a new empty control instance that is intended to be used only for
* decoding controls via the {@code DecodeableControl} interface.
*/
VirtualListViewResponseControl()
{
targetPosition = -1;
contentCount = -1;
resultCode = null;
contextID = null;
}
/**
* Creates a new virtual list view response control with the provided
* information. It will not be marked critical.
*
* @param targetPosition The offset of the target entry for this VLV
* response control.
* @param contentCount The estimated total number of entries in the
* result set.
* @param resultCode The result code for this VLV response control.
* @param contextID The context ID for this VLV response control. It
* may be {@code null} if no context ID is available.
*/
public VirtualListViewResponseControl(final int targetPosition,
final int contentCount, final ResultCode resultCode,
final ASN1OctetString contextID)
{
super(VIRTUAL_LIST_VIEW_RESPONSE_OID, false,
encodeValue(targetPosition, contentCount, resultCode, contextID));
this.targetPosition = targetPosition;
this.contentCount = contentCount;
this.resultCode = resultCode;
this.contextID = contextID;
}
/**
* Creates a new virtual list view response control from the information
* contained in the provided control.
*
* @param oid The OID for the control.
* @param isCritical Indicates whether the control should be marked
* critical.
* @param value The encoded value for the control. This may be
* {@code null} if no value was provided.
*
* @throws LDAPException If a problem occurs while attempting to decode the
* provided control as a virtual list view response
* control.
*/
public VirtualListViewResponseControl(final String oid,
final boolean isCritical,
final ASN1OctetString value)
throws LDAPException
{
super(oid, isCritical, value);
if (value == null)
{
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_VLV_RESPONSE_NO_VALUE.get());
}
final ASN1Sequence valueSequence;
try
{
final ASN1Element valueElement =
ASN1Element.decode(value.getValue());
valueSequence = ASN1Sequence.decodeAsSequence(valueElement);
}
catch (final ASN1Exception ae)
{
Debug.debugException(ae);
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_VLV_RESPONSE_VALUE_NOT_SEQUENCE.get(ae), ae);
}
final ASN1Element[] valueElements = valueSequence.elements();
if ((valueElements.length < 3) || (valueElements.length > 4))
{
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_VLV_RESPONSE_INVALID_ELEMENT_COUNT.get(
valueElements.length));
}
try
{
targetPosition = ASN1Integer.decodeAsInteger(valueElements[0]).intValue();
}
catch (final ASN1Exception ae)
{
Debug.debugException(ae);
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_VLV_RESPONSE_FIRST_NOT_INTEGER.get(ae), ae);
}
try
{
contentCount = ASN1Integer.decodeAsInteger(valueElements[1]).intValue();
}
catch (final ASN1Exception ae)
{
Debug.debugException(ae);
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_VLV_RESPONSE_SECOND_NOT_INTEGER.get(ae), ae);
}
try
{
final int rc =
ASN1Enumerated.decodeAsEnumerated(valueElements[2]).intValue();
resultCode = ResultCode.valueOf(rc);
}
catch (final ASN1Exception ae)
{
Debug.debugException(ae);
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_VLV_RESPONSE_THIRD_NOT_ENUM.get(ae), ae);
}
if (valueElements.length == 4)
{
contextID = ASN1OctetString.decodeAsOctetString(valueElements[3]);
}
else
{
contextID = null;
}
}
/**
* {@inheritDoc}
*/
@Override()
public VirtualListViewResponseControl
decodeControl(final String oid, final boolean isCritical,
final ASN1OctetString value)
throws LDAPException
{
return new VirtualListViewResponseControl(oid, isCritical, value);
}
/**
* Extracts a virtual list view response control from the provided result.
*
* @param result The result from which to retrieve the virtual list view
* response control.
*
* @return The virtual list view response control contained in the provided
* result, or {@code null} if the result did not contain a virtual
* list view response control.
*
* @throws LDAPException If a problem is encountered while attempting to
* decode the virtual list view response control
* contained in the provided result.
*/
public static VirtualListViewResponseControl get(final SearchResult result)
throws LDAPException
{
final Control c = result.getResponseControl(VIRTUAL_LIST_VIEW_RESPONSE_OID);
if (c == null)
{
return null;
}
if (c instanceof VirtualListViewResponseControl)
{
return (VirtualListViewResponseControl) c;
}
else
{
return new VirtualListViewResponseControl(c.getOID(), c.isCritical(),
c.getValue());
}
}
/**
* Encodes the provided information into an octet string that can be used as
* the value for this control.
*
* @param targetPosition The offset of the target entry for this VLV
* response control.
* @param contentCount The estimated total number of entries in the
* result set.
* @param resultCode The result code for this VLV response control.
* @param contextID The context ID for this VLV response control. It
* may be {@code null} if no context ID is available.
*
* @return An ASN.1 octet string that can be used as the value for this
* control.
*/
private static ASN1OctetString encodeValue(final int targetPosition,
final int contentCount,
final ResultCode resultCode,
final ASN1OctetString contextID)
{
final ASN1Element[] vlvElements;
if (contextID == null)
{
vlvElements = new ASN1Element[]
{
new ASN1Integer(targetPosition),
new ASN1Integer(contentCount),
new ASN1Enumerated(resultCode.intValue())
};
}
else
{
vlvElements = new ASN1Element[]
{
new ASN1Integer(targetPosition),
new ASN1Integer(contentCount),
new ASN1Enumerated(resultCode.intValue()),
contextID
};
}
return new ASN1OctetString(new ASN1Sequence(vlvElements).encode());
}
/**
* Retrieves the offset of the target entry for this virtual list view
* response control.
*
* @return The offset of the target entry for this virtual list view response
* control.
*/
public int getTargetPosition()
{
return targetPosition;
}
/**
* Retrieves the estimated total number of entries in the result set.
*
* @return The estimated total number of entries in the result set.
*/
public int getContentCount()
{
return contentCount;
}
/**
* Retrieves the result code for this virtual list view response control.
*
* @return The result code for this virtual list view response control.
*/
public ResultCode getResultCode()
{
return resultCode;
}
/**
* Retrieves the context ID for this virtual list view response control, if
* available.
*
* @return The context ID for this virtual list view response control, or
* {@code null} if none was provided.
*/
public ASN1OctetString getContextID()
{
return contextID;
}
/**
* {@inheritDoc}
*/
@Override()
public String getControlName()
{
return INFO_CONTROL_NAME_VLV_RESPONSE.get();
}
/**
* {@inheritDoc}
*/
@Override()
public void toString(final StringBuilder buffer)
{
buffer.append("VirtualListViewResponseControl(targetPosition=");
buffer.append(targetPosition);
buffer.append(", contentCount=");
buffer.append(contentCount);
buffer.append(", resultCode=");
buffer.append(resultCode);
buffer.append(')');
}
}