public interface ClientAuthenticationManager extends UserAuthFactoriesManager<ClientSession,UserAuth,UserAuthFactory>, KeyIdentityProviderHolder
getUserAuthFactories, getUserAuthFactoriesNameList, getUserAuthFactoriesNames, setUserAuthFactories, setUserAuthFactoriesNameList, setUserAuthFactoriesNames
getKeyIdentityProvider, setKeyIdentityProvider
AuthenticationIdentitiesProvider 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)
PasswordAuthenticationReporter getPasswordAuthenticationReporter()
void setPasswordAuthenticationReporter(PasswordAuthenticationReporter reporter)
PublicKeyAuthenticationReporter getPublicKeyAuthenticationReporter()
void setPublicKeyAuthenticationReporter(PublicKeyAuthenticationReporter reporter)
HostBasedAuthenticationReporter getHostBasedAuthenticationReporter()
void setHostBasedAuthenticationReporter(HostBasedAuthenticationReporter reporter)
default void setUserAuthFactoriesNames(Collection<String> names)
setUserAuthFactoriesNames
in interface UserAuthFactoriesManager<ClientSession,UserAuth,UserAuthFactory>
Copyright © 2008–2024 The Apache Software Foundation. All rights reserved.