com.github.cloudfiles.core.http.auth
Members list
Type members
Classlikes
A trait representing a configuration for an authentication mechanism.
A trait representing a configuration for an authentication mechanism.
This is just a marker interface. Concrete implementations define their own specific properties.
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
A data class that collects user credentials for accessing a server via basic auth.
A data class that collects user credentials for accessing a server via basic auth.
Value parameters
- password
-
the password
- user
-
the user name
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait AuthConfigclass Objecttrait Matchableclass AnyShow all
An actor implementation that adds basic authentication to HTTP requests.
An actor implementation that adds basic authentication to HTTP requests.
Based on the given configuration, a proper ''Authorization'' header is added to HTTP requests before they are forwarded to the actual actor responsible for sending requests.
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
BasicAuthExtension.type
An object representing a dummy configuration for the case that no authentication is needed.
An object representing a dummy configuration for the case that no authentication is needed.
Attributes
- Supertypes
-
trait Singletontrait Producttrait Mirrortrait Serializabletrait Producttrait Equalstrait AuthConfigclass Objecttrait Matchableclass AnyShow all
- Self type
-
NoAuthConfig.type
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
OAuthConfig.type
A data class collecting the properties required for an OAuth client application.
A data class collecting the properties required for an OAuth client application.
An instance of this class stores the information required for obtaining an OAuth access token based on a refresh token from a specific OAuth2 identity provider.
Value parameters
- clientID
-
the client ID
- clientSecret
-
the secret to identify the client
- initTokenData
-
an object with token information (the mandatory refresh token and a (possibly undefined) access token
- redirectUri
-
the redirect URI
- refreshNotificationFunc
-
a function to invoke when tokens are refreshed
- tokenEndpoint
-
the URI of the token endpoint
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait AuthConfigclass Objecttrait Matchableclass AnyShow all
An actor implementation supporting an OAuth flow when interacting with an HTTP server.
An actor implementation supporting an OAuth flow when interacting with an HTTP server.
This actor class wraps an com.github.cloudfiles.core.http.HttpRequestSender actor and adds a bearer token obtained from an OAuth identity provider to HTTP requests. The actor is configured with the parameters of an OAuth identity provider. When a request arrives, an authorization header with the current access token is added before the request is forwarded to the actual HTTP request actor. If the response has status code 401 (indicating that the access token is no longer valid), a request to refresh the token is sent to the IDP. The access token is then updated.
Token refresh operations and their outcome can be monitored, so that clients can take additional actions, e.g. store a new access token for later reuse.
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
OAuthExtension.type
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
OAuthTokenData.type
A data class representing the token material to be stored for a single OAuth client of a specific identity provider.
A data class representing the token material to be stored for a single OAuth client of a specific identity provider.
Value parameters
- accessToken
-
the access token
- refreshToken
-
the refresh token
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all