com.unboundid.ldap.protocol.SearchResultReferenceProtocolOp Maven / Gradle / Ivy
/*
* Copyright 2009-2021 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright 2009-2021 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) 2009-2021 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.protocol;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import com.unboundid.asn1.ASN1Buffer;
import com.unboundid.asn1.ASN1BufferSequence;
import com.unboundid.asn1.ASN1Element;
import com.unboundid.asn1.ASN1OctetString;
import com.unboundid.asn1.ASN1Sequence;
import com.unboundid.asn1.ASN1StreamReader;
import com.unboundid.asn1.ASN1StreamReaderSequence;
import com.unboundid.ldap.sdk.Control;
import com.unboundid.ldap.sdk.LDAPException;
import com.unboundid.ldap.sdk.ResultCode;
import com.unboundid.ldap.sdk.SearchResultReference;
import com.unboundid.util.Debug;
import com.unboundid.util.InternalUseOnly;
import com.unboundid.util.NotMutable;
import com.unboundid.util.NotNull;
import com.unboundid.util.Nullable;
import com.unboundid.util.StaticUtils;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
import static com.unboundid.ldap.protocol.ProtocolMessages.*;
/**
* This class provides an implementation of an LDAP search result reference
* protocol op.
*/
@InternalUseOnly()
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class SearchResultReferenceProtocolOp
implements ProtocolOp
{
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = -1526778443581862609L;
// The list of referral URLs for this search result reference.
@NotNull private final List referralURLs;
/**
* Creates a new search result reference protocol op with the provided
* information.
*
* @param referralURLs The list of referral URLs for this search result
* reference.
*/
public SearchResultReferenceProtocolOp(
@NotNull final List referralURLs)
{
this.referralURLs = Collections.unmodifiableList(referralURLs);
}
/**
* Creates a new search result reference protocol op from the provided search
* result reference.
*
* @param reference The search result reference to use to create this
* protocol op.
*/
public SearchResultReferenceProtocolOp(
@NotNull final SearchResultReference reference)
{
referralURLs = StaticUtils.toList(reference.getReferralURLs());
}
/**
* Creates a new search result reference protocol op read from the provided
* ASN.1 stream reader.
*
* @param reader The ASN.1 stream reader from which to read the search
* result reference protocol op.
*
* @throws LDAPException If a problem occurs while reading or parsing the
* search result reference.
*/
SearchResultReferenceProtocolOp(@NotNull final ASN1StreamReader reader)
throws LDAPException
{
try
{
final ArrayList refs = new ArrayList<>(5);
final ASN1StreamReaderSequence refSequence = reader.beginSequence();
while (refSequence.hasMoreElements())
{
refs.add(reader.readString());
}
referralURLs = Collections.unmodifiableList(refs);
}
catch (final Exception e)
{
Debug.debugException(e);
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_SEARCH_REFERENCE_CANNOT_DECODE.get(
StaticUtils.getExceptionMessage(e)),
e);
}
}
/**
* Retrieves the list of referral URLs for this search result reference.
*
* @return The list of referral URLs for this search result reference.
*/
@NotNull()
public List getReferralURLs()
{
return referralURLs;
}
/**
* {@inheritDoc}
*/
@Override()
public byte getProtocolOpType()
{
return LDAPMessage.PROTOCOL_OP_TYPE_SEARCH_RESULT_REFERENCE;
}
/**
* {@inheritDoc}
*/
@Override()
@NotNull()
public ASN1Element encodeProtocolOp()
{
final ArrayList urlElements =
new ArrayList<>(referralURLs.size());
for (final String url : referralURLs)
{
urlElements.add(new ASN1OctetString(url));
}
return new ASN1Sequence(
LDAPMessage.PROTOCOL_OP_TYPE_SEARCH_RESULT_REFERENCE,
urlElements);
}
/**
* Decodes the provided ASN.1 element as a search result reference protocol
* op.
*
* @param element The ASN.1 element to be decoded.
*
* @return The decoded search result reference protocol op.
*
* @throws LDAPException If the provided ASN.1 element cannot be decoded as
* a search result reference protocol op.
*/
@NotNull()
public static SearchResultReferenceProtocolOp decodeProtocolOp(
@NotNull final ASN1Element element)
throws LDAPException
{
try
{
final ASN1Element[] urlElements =
ASN1Sequence.decodeAsSequence(element).elements();
final ArrayList referralURLs =
new ArrayList<>(urlElements.length);
for (final ASN1Element e : urlElements)
{
referralURLs.add(ASN1OctetString.decodeAsOctetString(e).stringValue());
}
return new SearchResultReferenceProtocolOp(referralURLs);
}
catch (final Exception e)
{
Debug.debugException(e);
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_SEARCH_REFERENCE_CANNOT_DECODE.get(
StaticUtils.getExceptionMessage(e)),
e);
}
}
/**
* {@inheritDoc}
*/
@Override()
public void writeTo(@NotNull final ASN1Buffer buffer)
{
final ASN1BufferSequence opSequence = buffer.beginSequence(
LDAPMessage.PROTOCOL_OP_TYPE_SEARCH_RESULT_REFERENCE);
for (final String s : referralURLs)
{
buffer.addOctetString(s);
}
opSequence.end();
}
/**
* Creates a search result reference from this protocol op.
*
* @param controls The set of controls to include in the search result
* reference. It may be empty or {@code null} if no
* controls should be included.
*
* @return The search result reference that was created.
*/
@NotNull()
public SearchResultReference toSearchResultReference(
@Nullable final Control... controls)
{
final String[] referralArray = new String[referralURLs.size()];
referralURLs.toArray(referralArray);
return new SearchResultReference(referralArray, controls);
}
/**
* Retrieves a string representation of this protocol op.
*
* @return A string representation of this protocol op.
*/
@Override()
@NotNull()
public String toString()
{
final StringBuilder buffer = new StringBuilder();
toString(buffer);
return buffer.toString();
}
/**
* {@inheritDoc}
*/
@Override()
public void toString(@NotNull final StringBuilder buffer)
{
buffer.append("SearchResultReferenceProtocolOp(referralURLs={");
final Iterator iterator = referralURLs.iterator();
while (iterator.hasNext())
{
buffer.append('\'');
buffer.append(iterator.next());
buffer.append('\'');
if (iterator.hasNext())
{
buffer.append(',');
}
}
buffer.append("})");
}
}