Package org.apache.iceberg.rest.auth
Class OAuth2Properties
- java.lang.Object
-
- org.apache.iceberg.rest.auth.OAuth2Properties
-
public class OAuth2Properties extends java.lang.Object
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ACCESS_TOKEN_TYPE
static java.lang.String
CATALOG_SCOPE
Scope for OAuth2 flows.static java.lang.String
CREDENTIAL
A credential to exchange for a token in the OAuth2 client credentials flow.static java.lang.String
ID_TOKEN_TYPE
static java.lang.String
INVALID_CLIENT_ERROR
static java.lang.String
INVALID_GRANT_ERROR
static java.lang.String
INVALID_REQUEST_ERROR
static java.lang.String
INVALID_SCOPE_ERROR
static java.lang.String
JWT_TOKEN_TYPE
static java.lang.String
OAUTH2_SERVER_URI
Token endpoint URI to fetch token from if the Rest Catalog is not the authorization server.static java.lang.String
REFRESH_TOKEN_TYPE
static java.lang.String
SAML1_TOKEN_TYPE
static java.lang.String
SAML2_TOKEN_TYPE
static java.lang.String
SCOPE
Additional scope for OAuth2.static java.lang.String
TOKEN
A Bearer token which will be used for interaction with the server.static java.lang.String
TOKEN_EXPIRES_IN_MS
Interval in milliseconds to wait before attempting to exchange the configured catalog Bearer token.static long
TOKEN_EXPIRES_IN_MS_DEFAULT
static java.lang.String
TOKEN_REFRESH_ENABLED
Controls whether a token should be refreshed if information about its expiration time is availablestatic boolean
TOKEN_REFRESH_ENABLED_DEFAULT
static java.lang.String
UNAUTHORIZED_CLIENT_ERROR
static java.lang.String
UNSUPPORTED_GRANT_TYPE_ERROR
-
-
-
Field Detail
-
TOKEN
public static final java.lang.String TOKEN
A Bearer token which will be used for interaction with the server.- See Also:
- Constant Field Values
-
CREDENTIAL
public static final java.lang.String CREDENTIAL
A credential to exchange for a token in the OAuth2 client credentials flow.- See Also:
- Constant Field Values
-
OAUTH2_SERVER_URI
public static final java.lang.String OAUTH2_SERVER_URI
Token endpoint URI to fetch token from if the Rest Catalog is not the authorization server.- See Also:
- Constant Field Values
-
TOKEN_EXPIRES_IN_MS
public static final java.lang.String TOKEN_EXPIRES_IN_MS
Interval in milliseconds to wait before attempting to exchange the configured catalog Bearer token. By default, token exchange will be attempted after 1 hour.- See Also:
- Constant Field Values
-
TOKEN_EXPIRES_IN_MS_DEFAULT
public static final long TOKEN_EXPIRES_IN_MS_DEFAULT
- See Also:
- Constant Field Values
-
TOKEN_REFRESH_ENABLED
public static final java.lang.String TOKEN_REFRESH_ENABLED
Controls whether a token should be refreshed if information about its expiration time is available- See Also:
- Constant Field Values
-
TOKEN_REFRESH_ENABLED_DEFAULT
public static final boolean TOKEN_REFRESH_ENABLED_DEFAULT
- See Also:
- Constant Field Values
-
SCOPE
public static final java.lang.String SCOPE
Additional scope for OAuth2.- See Also:
- Constant Field Values
-
CATALOG_SCOPE
public static final java.lang.String CATALOG_SCOPE
Scope for OAuth2 flows.- See Also:
- Constant Field Values
-
ACCESS_TOKEN_TYPE
public static final java.lang.String ACCESS_TOKEN_TYPE
- See Also:
- Constant Field Values
-
REFRESH_TOKEN_TYPE
public static final java.lang.String REFRESH_TOKEN_TYPE
- See Also:
- Constant Field Values
-
ID_TOKEN_TYPE
public static final java.lang.String ID_TOKEN_TYPE
- See Also:
- Constant Field Values
-
SAML1_TOKEN_TYPE
public static final java.lang.String SAML1_TOKEN_TYPE
- See Also:
- Constant Field Values
-
SAML2_TOKEN_TYPE
public static final java.lang.String SAML2_TOKEN_TYPE
- See Also:
- Constant Field Values
-
JWT_TOKEN_TYPE
public static final java.lang.String JWT_TOKEN_TYPE
- See Also:
- Constant Field Values
-
INVALID_REQUEST_ERROR
public static final java.lang.String INVALID_REQUEST_ERROR
- See Also:
- Constant Field Values
-
INVALID_CLIENT_ERROR
public static final java.lang.String INVALID_CLIENT_ERROR
- See Also:
- Constant Field Values
-
INVALID_GRANT_ERROR
public static final java.lang.String INVALID_GRANT_ERROR
- See Also:
- Constant Field Values
-
UNAUTHORIZED_CLIENT_ERROR
public static final java.lang.String UNAUTHORIZED_CLIENT_ERROR
- See Also:
- Constant Field Values
-
UNSUPPORTED_GRANT_TYPE_ERROR
public static final java.lang.String UNSUPPORTED_GRANT_TYPE_ERROR
- See Also:
- Constant Field Values
-
INVALID_SCOPE_ERROR
public static final java.lang.String INVALID_SCOPE_ERROR
- See Also:
- Constant Field Values
-
-