blob: 89e545d6f513faba96390ca3b486c5d6c50362e6 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|
/*
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*/
package org.apache.qpid.server.security.auth.sasl;
import java.util.Map;
import javax.security.auth.callback.CallbackHandler;
import javax.security.sasl.SaslServerFactory;
import org.apache.commons.configuration.Configuration;
import org.apache.qpid.server.security.auth.database.PrincipalDatabase;
public interface AuthenticationProviderInitialiser
{
/**
* @return the mechanism's name. This will be used in the list of mechanism's advertised to the
* client.
*/
String getMechanismName();
/**
* Initialise the authentication provider.
* @param baseConfigPath the path in the config file that points to any config options for this provider. Each
* provider can have its own set of configuration options
* @param configuration the Apache Commons Configuration instance used to configure this provider
* @param principalDatabases the set of principal databases that are available
* @throws Exception needs refined Exception is too broad.
*/
void initialise(String baseConfigPath, Configuration configuration,
Map<String, PrincipalDatabase> principalDatabases) throws Exception;
/**
* Initialise the authentication provider.
* @param db The principal database to initialise with
*/
void initialise(PrincipalDatabase db);
/**
* @return the callback handler that should be used to process authentication requests for this mechanism. This will
* be called after initialise and will be stored by the authentication manager. The callback handler <b>must</b> be
* fully threadsafe.
*/
CallbackHandler getCallbackHandler();
/**
* Get the properties that must be passed in to the Sasl.createSaslServer method.
* @return the properties, which may be null
*/
Map<String, ?> getProperties();
/**
* Get the class that is the server factory. This is used for the JCA registration.
* @return null if no JCA registration is required, otherwise return the class
* that will be used in JCA registration
*/
Class<? extends SaslServerFactory> getServerFactoryClassForJCARegistration();
}
|
