public interface ClientAuthenticationManager extends KeyIdentityProviderHolder
Modifier and Type | Field and Description |
---|---|
static int |
DEFAULT_PASSWORD_PROMPTS
Default value for
PASSWORD_PROMPTS if none configured |
static String |
PASSWORD_PROMPTS
Specifies the number of interactive prompts before giving up.
|
static String |
PREFERRED_AUTHS
Ordered comma separated list of authentications methods.
|
getKeyIdentityProvider, setKeyIdentityProvider
static final String PREFERRED_AUTHS
null
/empty, then the session's getUserAuthFactories()
is used as-isstatic final String PASSWORD_PROMPTS
DEFAULT_PASSWORD_PROMPTS
,
Constant Field Valuesstatic final int DEFAULT_PASSWORD_PROMPTS
PASSWORD_PROMPTS
if none configuredAuthenticationIdentitiesProvider getRegisteredIdentities()
AuthenticationIdentitiesProvider
to be used for attempting
password or public key authenticationPasswordIdentityProvider getPasswordIdentityProvider()
PasswordIdentityProvider
used to provide password
candidatesPasswordIdentityProvider
instance - ignored if null
(i.e., no passwords available).addPasswordIdentity(String)
void setPasswordIdentityProvider(PasswordIdentityProvider provider)
void addPasswordIdentity(String password)
password
- Password to be added - may not be null
/empty.
Note: this password is in addition to whatever passwords
are available via the PasswordIdentityProvider
(if any)String removePasswordIdentity(String password)
password
- The password to remove - ignored if null
/emptyaddPasswordIdentity(String)
- or null
if no
match foundvoid addPublicKeyIdentity(KeyPair key)
key
- The KeyPair
to add - may not be null
Note: this key is in addition to whatever keys
are available via the KeyIdentityProvider
(if any)KeyPair removePublicKeyIdentity(KeyPair kp)
kp
- The KeyPair
to remove - ignored if null
KeyPair
- same one that was added via
addPublicKeyIdentity(KeyPair)
- or null
if no
match foundServerKeyVerifier getServerKeyVerifier()
ServerKeyVerifier
to use - never null
void setServerKeyVerifier(ServerKeyVerifier serverKeyVerifier)
UserInteraction getUserInteraction()
UserInteraction
object to communicate with the user
(may be null
to indicate that no such communication is allowed)void setUserInteraction(UserInteraction userInteraction)
List<NamedFactory<UserAuth>> getUserAuthFactories()
List
of UserAuth
NamedFactory
-ies - never
null
/emptydefault String getUserAuthFactoriesNameList()
void setUserAuthFactories(List<NamedFactory<UserAuth>> userAuthFactories)
default void setUserAuthFactoriesNameList(String names)
default void setUserAuthFactoriesNames(String... names)
default void setUserAuthFactoriesNames(Collection<String> names)
Copyright © 2008–2022 The Apache Software Foundation. All rights reserved.