/* * Copyright (c) 1999, 2004, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * * This code 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 * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ package javax.naming.ldap; import javax.naming.ReferralException; import javax.naming.Context; import javax.naming.NamingException; import java.util.Hashtable; /** * This abstract class is used to represent an LDAP referral exception. * It extends the base ReferralException by providing a * getReferralContext() method that accepts request controls. * LdapReferralException is an abstract class. Concrete implementations of it * determine its synchronization and serialization properties. *

* A Control[] array passed as a parameter to * the getReferralContext() method is owned by the caller. * The service provider will not modify the array or keep a reference to it, * although it may keep references to the individual Control objects * in the array. * * @author Rosanna Lee * @author Scott Seligman * @author Vincent Ryan * @since 1.3 */ public abstract class LdapReferralException extends ReferralException { /** * Constructs a new instance of LdapReferralException using the * explanation supplied. All other fields are set to null. * * @param explanation Additional detail about this exception. Can be null. * @see java.lang.Throwable#getMessage */ protected LdapReferralException(String explanation) { super(explanation); } /** * Constructs a new instance of LdapReferralException. * All fields are set to null. */ protected LdapReferralException() { super(); } /** * Retrieves the context at which to continue the method using the * context's environment and no controls. * The referral context is created using the environment properties of * the context that threw the ReferralException and no controls. *

* This method is equivalent to *

     * getReferralContext(ctx.getEnvironment(), null);
     *
* where ctx is the context that threw the ReferralException. *

* It is overridden in this class for documentation purposes only. * See ReferralException for how to use this method. * * @return The non-null context at which to continue the method. * @exception NamingException If a naming exception was encountered. * Call either retryReferral() or skipReferral() * to continue processing referrals. */ public abstract Context getReferralContext() throws NamingException; /** * Retrieves the context at which to continue the method using * environment properties and no controls. * The referral context is created using env as its environment * properties and no controls. *

* This method is equivalent to *

     * getReferralContext(env, null);
     *
*

* It is overridden in this class for documentation purposes only. * See ReferralException for how to use this method. * * @param env The possibly null environment to use when retrieving the * referral context. If null, no environment properties will be used. * * @return The non-null context at which to continue the method. * @exception NamingException If a naming exception was encountered. * Call either retryReferral() or skipReferral() * to continue processing referrals. */ public abstract Context getReferralContext(Hashtable env) throws NamingException; /** * Retrieves the context at which to continue the method using * request controls and environment properties. * Regardless of whether a referral is encountered directly during a * context operation, or indirectly, for example, during a search * enumeration, the referral exception should provide a context * at which to continue the operation. * To continue the operation, the client program should re-invoke * the method using the same arguments as the original invocation. *

* reqCtls is used when creating the connection to the referred * server. These controls will be used as the connection request controls for * the context and context instances * derived from the context. * reqCtls will also be the context's request controls for * subsequent context operations. See the LdapContext class * description for details. *

* This method should be used instead of the other two overloaded forms * when the caller needs to supply request controls for creating * the referral context. It might need to do this, for example, when * it needs to supply special controls relating to authentication. *

* Service provider implementors should read the "Service Provider" section * in the LdapContext class description for implementation details. * * @param reqCtls The possibly null request controls to use for the new context. * If null or the empty array means use no request controls. * @param env The possibly null environment properties to use when * for the new context. If null, the context is initialized with no environment * properties. * @return The non-null context at which to continue the method. * @exception NamingException If a naming exception was encountered. * Call either retryReferral() or skipReferral() * to continue processing referrals. */ public abstract Context getReferralContext(Hashtable env, Control[] reqCtls) throws NamingException; private static final long serialVersionUID = -1668992791764950804L; }