LuciadCPillar C# 2023.1.04
|
This interface provides methods to retrieve a user and password for sites requesting authentication. More...
Public Member Functions | |
void | ConfirmCredentials (Luciad.Loaders.AuthenticationScope authenticationScope, Luciad.Loaders.Credentials credentials) |
This method indicates that previously supplied credentials are accepted by the server. More... | |
Luciad.Loaders.Credentials | GetCredentials (Luciad.Loaders.AuthenticationScope authenticationScope) |
Get the user credentials for the authentication request. More... | |
void | RemoveCredentials (Luciad.Loaders.AuthenticationScope authenticationScope, Luciad.Loaders.Credentials credentials) |
This method indicates that previously supplied credentials are not accepted by the server. More... | |
This interface provides methods to retrieve a user and password for sites requesting authentication.
Implementations of this interface must be thread-safe. This interface allows writing a credentials provider that caches valid user credentials such that a user doesn't have to supply them on every http(s) request. The main method to implement is the getCredentials method. When no user credentials are available a typical implementation shows a login dialog to the user to enter the information. The implementation can cache those credentials for the authentication scope. The methods confirmCredentials and removeCredentials allow to manage cached credentials. They provide information on whether the supplied credentials were accepted or rejected by the server. See also the related guide on How to provide authentication credentials. 2022.0
void Luciad.Loaders.ICredentialsProvider.ConfirmCredentials | ( | Luciad.Loaders.AuthenticationScope | authenticationScope, |
Luciad.Loaders.Credentials | credentials | ||
) |
This method indicates that previously supplied credentials are accepted by the server.
The confirmation allows to cache the credentials.
authenticationScope
the authentication scope.
credentials
the confirmed credentials, cannot be nullptr.
Luciad.Loaders.Credentials Luciad.Loaders.ICredentialsProvider.GetCredentials | ( | Luciad.Loaders.AuthenticationScope | authenticationScope | ) |
Get the user credentials for the authentication request.
authenticationScope
the scope for the authentication request.
the user credentials for the authentication scope. Can be nullptr.
void Luciad.Loaders.ICredentialsProvider.RemoveCredentials | ( | Luciad.Loaders.AuthenticationScope | authenticationScope, |
Luciad.Loaders.Credentials | credentials | ||
) |
This method indicates that previously supplied credentials are not accepted by the server.
The remove call indicates that cached values are invalid and that correct credentials have to be supplied on the next getCredentials call.
authenticationScope
the authentication scope.
credentials
the rejected credentials, cannot be nullptr.