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;
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.ldap.LdapSession;
27
28
29 /**
30 * An interface for retrieving a {@link SaslServer} for a session.
31 *
32 * @see javax.security.sasl.SaslServer
33 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
34 */
35 public interface MechanismHandler
36 {
37 /**
38 * Implementors will use the session and message to determine what kind of
39 * {@link SaslServer} to create and what initialization parameters it will require.
40 *
41 * @param session The LdapSession in use
42 * @param bindRequest The BindRequest
43 * @return The {@link SaslServer} to use for the duration of the bound session.
44 * @throws Exception If we can't find the SASL Mechanism
45 */
46 SaslServer handleMechanism( LdapSession session, BindRequest bindRequest ) throws Exception;
47
48
49 /**
50 * Initialize the saslProperties with some mechanism's specific data
51 *
52 * @param ldapSession the Ldapsession instance
53 */
54 void init( LdapSession ldapSession );
55
56
57 /**
58 * Clean the Sasl properties when the use has been authenticated
59 *
60 * @param ldapSession the Ldapsession instance
61 */
62 void cleanup( LdapSession ldapSession );
63 }