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.ldap.handlers.sasl.plain;
21  
22  
23  import javax.security.sasl.SaslServer;
24  
25  import org.apache.directory.api.ldap.model.message.BindRequest;
26  import org.apache.directory.server.core.api.CoreSession;
27  import org.apache.directory.server.ldap.LdapSession;
28  import org.apache.directory.server.ldap.handlers.sasl.AbstractMechanismHandler;
29  import org.apache.directory.server.ldap.handlers.sasl.SaslConstants;
30  
31  
32  /**
33   * A handler for the PLAIN Sasl mechanism. 
34   *
35   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
36   */
37  public class PlainMechanismHandler extends AbstractMechanismHandler
38  {
39  
40      /**
41       * {@inheritDoc}
42       */
43      public SaslServer handleMechanism( LdapSession ldapSession, BindRequest bindRequest ) throws Exception
44      {
45          SaslServer ss = ( SaslServer ) ldapSession.getSaslProperty( SaslConstants.SASL_SERVER );
46  
47          if ( ss == null )
48          {
49              CoreSession adminSession = ldapSession.getLdapServer().getDirectoryService().getAdminSession();
50  
51              ss = new PlainSaslServer( ldapSession, adminSession, bindRequest );
52              ldapSession.putSaslProperty( SaslConstants.SASL_SERVER, ss );
53          }
54  
55          return ss;
56      }
57  
58  
59      /**
60       * {@inheritDoc}
61       */
62      public void init( LdapSession ldapSession )
63      {
64          // Do nothing
65      }
66  
67  
68      /**
69       * Remove the SaslServer and Mechanism property.
70       * 
71       * @param ldapSession the Ldapsession instance
72       */
73      public void cleanup( LdapSession ldapSession )
74      {
75          ldapSession.clearSaslProperties();
76      }
77  }