View Javadoc
1   /*
2    *  Licensed to the Apache Software Foundation (ASF) under one
3    *  or more contributor license agreements.  See the NOTICE file
4    *  distributed with this work for additional information
5    *  regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    *  "License"); you may not use this file except in compliance
8    *  with the License.  You may obtain a copy of the License at
9    *  
10   *    http://www.apache.org/licenses/LICENSE-2.0
11   *  
12   *  Unless required by applicable law or agreed to in writing,
13   *  software distributed under the License is distributed on an
14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *  KIND, either express or implied.  See the License for the
16   *  specific language governing permissions and limitations
17   *  under the License. 
18   *  
19   */
20  package org.apache.directory.server.core.api.interceptor.context;
21  
22  
23  import org.apache.directory.api.ldap.model.name.Dn;
24  import org.apache.directory.server.core.api.CoreSession;
25  import org.apache.directory.server.i18n.I18n;
26  
27  
28  /**
29   * An EmptySuffix context used for Interceptors. It contains no data, and mask
30   * the Dn in AbstractOperationContext
31   *
32   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
33   */
34  public abstract class EmptyOperationContext extends AbstractOperationContext
35  {
36      /**
37       * Creates a new instance of EmptyOperationContext.
38       * 
39       * @param session The session to use
40       */
41      public EmptyOperationContext( CoreSession session )
42      {
43          super( session, Dn.EMPTY_DN );
44      }
45  
46  
47      /**
48       * Set the context Dn
49       *
50       * @param dn The Dn to set
51       */
52      @Override
53      public void setDn( Dn dn )
54      {
55          if ( dn.equals( Dn.EMPTY_DN ) )
56          {
57              return;
58          }
59  
60          throw new UnsupportedOperationException( I18n.err( I18n.ERR_324 ) );
61      }
62  
63  
64      /**
65       * @see Object#toString()
66       */
67      public String toString()
68      {
69          return "EmptyOperationContext";
70      }
71  }