001/* 002 * The contents of this file are subject to the terms of the Common Development and 003 * Distribution License (the License). You may not use this file except in compliance with the 004 * License. 005 * 006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the 007 * specific language governing permission and limitations under the License. 008 * 009 * When distributing Covered Software, include this CDDL Header Notice in each file and include 010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL 011 * Header, with the fields enclosed by brackets [] replaced by your own identifying 012 * information: "Portions Copyright [year] [name of copyright owner]". 013 * 014 * Copyright 2010 Sun Microsystems, Inc. 015 * Portions copyright 2012 ForgeRock AS. 016 */ 017 018package org.forgerock.opendj.ldap; 019 020import java.io.IOException; 021 022import org.forgerock.opendj.ldap.responses.SearchResultReference; 023 024import org.forgerock.util.Reject; 025 026/** 027 * Thrown when an iteration over a set of search results using a 028 * {@code ConnectionEntryReader} encounters a {@code SearchResultReference}. 029 */ 030@SuppressWarnings("serial") 031public final class SearchResultReferenceIOException extends IOException { 032 private final SearchResultReference reference; 033 034 /** 035 * Creates a new referral result IO exception with the provided 036 * {@code SearchResultReference}. 037 * 038 * @param reference 039 * The {@code SearchResultReference} which may be later retrieved 040 * by the {@link #getReference} method. 041 * @throws NullPointerException 042 * If {@code reference} was {@code null}. 043 */ 044 public SearchResultReferenceIOException(final SearchResultReference reference) { 045 super(Reject.checkNotNull(reference).toString()); 046 this.reference = reference; 047 } 048 049 /** 050 * Returns the {@code SearchResultReference} which was encountered while 051 * processing the search results. 052 * 053 * @return The {@code SearchResultReference} which was encountered while 054 * processing the search results. 055 */ 056 public SearchResultReference getReference() { 057 return reference; 058 } 059}