001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *  
010 *    http://www.apache.org/licenses/LICENSE-2.0
011 *  
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License. 
018 *  
019 */
020package org.apache.directory.api.ldap.model.exception;
021
022
023import java.util.ArrayList;
024import java.util.Collection;
025import java.util.Hashtable;
026import java.util.List;
027
028import javax.naming.Context;
029import javax.naming.NamingException;
030
031import org.apache.directory.api.ldap.model.message.ResultCodeEnum;
032import org.apache.directory.api.ldap.model.name.Dn;
033import org.apache.directory.api.util.exception.NotImplementedException;
034
035
036/**
037 * A {@link LdapOperationException} which associates a resultCode namely the
038 * {@link org.apache.directory.api.ldap.model.message.ResultCodeEnum#REFERRAL} resultCode with the exception.
039 * 
040 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
041 */
042public class LdapReferralException extends AbstractLdapReferralException
043{
044    /** The serial version UUID */
045    static final long serialVersionUID = 1L;
046
047    /** The list of referrals */
048    private final List<String> refs;
049
050    /** The current index in the list of referrals */
051    private int index = 0;
052
053    /** The remaining Dn */
054    private Dn remainingDn;
055
056    /** TODO */
057    private Object resolvedObject;
058
059
060    /**
061     * 
062     * Creates a new instance of LdapReferralException.
063     *
064     * @param refs The list of referrals
065     */
066    public LdapReferralException( Collection<String> refs )
067    {
068        super( null );
069        this.refs = new ArrayList<String>( refs );
070    }
071
072
073    /**
074     * 
075     * Creates a new instance of LdapReferralException.
076     *
077     * @param refs The list of referrals
078     * @param explanation The associated error message
079     */
080    public LdapReferralException( Collection<String> refs, String explanation )
081    {
082        super( explanation );
083        this.refs = new ArrayList<String>( refs );
084    }
085
086
087    /**
088     * Always returns {@link ResultCodeEnum#REFERRAL}
089     * 
090     * @return The ResultCode
091     */
092    public ResultCodeEnum getResultCode()
093    {
094        return ResultCodeEnum.REFERRAL;
095    }
096
097
098    /**
099     * @return The current Referral
100     */
101    public String getReferralInfo()
102    {
103        return refs.get( index );
104    }
105
106
107    public Context getReferralContext() throws NamingException
108    {
109        throw new NotImplementedException();
110    }
111
112
113    public Context getReferralContext( Hashtable<?, ?> arg ) throws NamingException
114    {
115        throw new NotImplementedException();
116    }
117
118
119    /**
120     * Move to the next referral
121     * @return true if there is some next referral
122     */
123    public boolean skipReferral()
124    {
125        index++;
126        return index < refs.size();
127    }
128
129
130    public void retryReferral()
131    {
132        throw new NotImplementedException();
133    }
134
135
136    /**
137     * @return the remainingDn
138     */
139    public Dn getRemainingDn()
140    {
141        return remainingDn;
142    }
143
144
145    /**
146     * @param remainingDn the remainingName to set
147     */
148    public void setRemainingDn( Dn remainingDn )
149    {
150        this.remainingDn = remainingDn;
151    }
152
153
154    /**
155     * @return the resolvedObject
156     */
157    public Object getResolvedObject()
158    {
159        return resolvedObject;
160    }
161
162
163    /**
164     * @param resolvedObject the resolvedObject to set
165     */
166    public void setResolvedObject( Object resolvedObject )
167    {
168        this.resolvedObject = resolvedObject;
169    }
170}