Package com.ibm.cloud.sdk.core.security
Interface Authenticator
-
- All Known Implementing Classes:
BasicAuthenticator,BearerTokenAuthenticator,CloudPakForDataAuthenticator,CloudPakForDataServiceAuthenticator,CloudPakForDataServiceInstanceAuthenticator,ContainerAuthenticator,IamAssumeAuthenticator,IamAuthenticator,IamRequestBasedAuthenticator,IamRequestBasedAuthenticatorImmutable,MCSPAuthenticator,MCSPV2Authenticator,NoAuthAuthenticator,TokenRequestBasedAuthenticator,TokenRequestBasedAuthenticatorImmutable,VpcInstanceAuthenticator
public interface AuthenticatorThis interface defines the common methods and constants associated with an Authenticator implementation.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringAUTHTYPE_BASICThese are the valid authentication types.static java.lang.StringAUTHTYPE_BEARER_TOKENstatic java.lang.StringAUTHTYPE_CONTAINERstatic java.lang.StringAUTHTYPE_CP4Dstatic java.lang.StringAUTHTYPE_CP4D_SERVICEstatic java.lang.StringAUTHTYPE_CP4D_SERVICE_INSTANCEstatic java.lang.StringAUTHTYPE_IAMstatic java.lang.StringAUTHTYPE_IAM_ASSUMEstatic java.lang.StringAUTHTYPE_MCSPstatic java.lang.StringAUTHTYPE_MCSPV2static java.lang.StringAUTHTYPE_NOAUTHstatic java.lang.StringAUTHTYPE_VPCstatic java.lang.StringPROPNAME_APIKEYstatic java.lang.StringPROPNAME_AUTH_TYPEConstants which define the names of external config propreties (credential file, environment variable, etc.).static java.lang.StringPROPNAME_BEARER_TOKENstatic java.lang.StringPROPNAME_CALLER_EXT_CLAIMstatic java.lang.StringPROPNAME_CLIENT_IDstatic java.lang.StringPROPNAME_CLIENT_SECRETstatic java.lang.StringPROPNAME_CR_TOKEN_FILENAMEstatic java.lang.StringPROPNAME_DISABLE_SSLstatic java.lang.StringPROPNAME_DISPLAY_NAMEstatic java.lang.StringPROPNAME_EXPIRATION_TIMEstatic java.lang.StringPROPNAME_IAM_ACCOUNT_IDstatic java.lang.StringPROPNAME_IAM_PROFILE_CRNstatic java.lang.StringPROPNAME_IAM_PROFILE_IDstatic java.lang.StringPROPNAME_IAM_PROFILE_NAMEstatic java.lang.StringPROPNAME_INCLUDE_BUILTIN_ACTIONSstatic java.lang.StringPROPNAME_INCLUDE_CUSTOM_ACTIONSstatic java.lang.StringPROPNAME_INCLUDE_ROLESstatic java.lang.StringPROPNAME_PASSWORDstatic java.lang.StringPROPNAME_PERMISSIONSstatic java.lang.StringPROPNAME_PREFIX_ROLESstatic java.lang.StringPROPNAME_SCOPEstatic java.lang.StringPROPNAME_SCOPE_COLLECTION_TYPEstatic java.lang.StringPROPNAME_SCOPE_IDstatic java.lang.StringPROPNAME_SERVICE_BROKER_SECRETstatic java.lang.StringPROPNAME_SERVICE_INSTANCE_IDstatic java.lang.StringPROPNAME_UIDstatic java.lang.StringPROPNAME_URLstatic java.lang.StringPROPNAME_USERNAME
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidauthenticate(okhttp3.Request.Builder requestBuilder)Perform the necessary authentication steps for the specified request.java.lang.StringauthenticationType()Returns the authentication type associated with the Authenticator instance.voidvalidate()Validates the current set of configuration information in the Authenticator.
-
-
-
Field Detail
-
AUTHTYPE_BASIC
static final java.lang.String AUTHTYPE_BASIC
These are the valid authentication types.- See Also:
- Constant Field Values
-
AUTHTYPE_NOAUTH
static final java.lang.String AUTHTYPE_NOAUTH
- See Also:
- Constant Field Values
-
AUTHTYPE_IAM
static final java.lang.String AUTHTYPE_IAM
- See Also:
- Constant Field Values
-
AUTHTYPE_IAM_ASSUME
static final java.lang.String AUTHTYPE_IAM_ASSUME
- See Also:
- Constant Field Values
-
AUTHTYPE_CP4D
static final java.lang.String AUTHTYPE_CP4D
- See Also:
- Constant Field Values
-
AUTHTYPE_CP4D_SERVICE
static final java.lang.String AUTHTYPE_CP4D_SERVICE
- See Also:
- Constant Field Values
-
AUTHTYPE_CP4D_SERVICE_INSTANCE
static final java.lang.String AUTHTYPE_CP4D_SERVICE_INSTANCE
- See Also:
- Constant Field Values
-
AUTHTYPE_BEARER_TOKEN
static final java.lang.String AUTHTYPE_BEARER_TOKEN
- See Also:
- Constant Field Values
-
AUTHTYPE_CONTAINER
static final java.lang.String AUTHTYPE_CONTAINER
- See Also:
- Constant Field Values
-
AUTHTYPE_VPC
static final java.lang.String AUTHTYPE_VPC
- See Also:
- Constant Field Values
-
AUTHTYPE_MCSP
static final java.lang.String AUTHTYPE_MCSP
- See Also:
- Constant Field Values
-
AUTHTYPE_MCSPV2
static final java.lang.String AUTHTYPE_MCSPV2
- See Also:
- Constant Field Values
-
PROPNAME_AUTH_TYPE
static final java.lang.String PROPNAME_AUTH_TYPE
Constants which define the names of external config propreties (credential file, environment variable, etc.).- See Also:
- Constant Field Values
-
PROPNAME_USERNAME
static final java.lang.String PROPNAME_USERNAME
- See Also:
- Constant Field Values
-
PROPNAME_PASSWORD
static final java.lang.String PROPNAME_PASSWORD
- See Also:
- Constant Field Values
-
PROPNAME_BEARER_TOKEN
static final java.lang.String PROPNAME_BEARER_TOKEN
- See Also:
- Constant Field Values
-
PROPNAME_URL
static final java.lang.String PROPNAME_URL
- See Also:
- Constant Field Values
-
PROPNAME_DISABLE_SSL
static final java.lang.String PROPNAME_DISABLE_SSL
- See Also:
- Constant Field Values
-
PROPNAME_APIKEY
static final java.lang.String PROPNAME_APIKEY
- See Also:
- Constant Field Values
-
PROPNAME_SERVICE_INSTANCE_ID
static final java.lang.String PROPNAME_SERVICE_INSTANCE_ID
- See Also:
- Constant Field Values
-
PROPNAME_CLIENT_ID
static final java.lang.String PROPNAME_CLIENT_ID
- See Also:
- Constant Field Values
-
PROPNAME_CLIENT_SECRET
static final java.lang.String PROPNAME_CLIENT_SECRET
- See Also:
- Constant Field Values
-
PROPNAME_SCOPE
static final java.lang.String PROPNAME_SCOPE
- See Also:
- Constant Field Values
-
PROPNAME_UID
static final java.lang.String PROPNAME_UID
- See Also:
- Constant Field Values
-
PROPNAME_DISPLAY_NAME
static final java.lang.String PROPNAME_DISPLAY_NAME
- See Also:
- Constant Field Values
-
PROPNAME_PERMISSIONS
static final java.lang.String PROPNAME_PERMISSIONS
- See Also:
- Constant Field Values
-
PROPNAME_EXPIRATION_TIME
static final java.lang.String PROPNAME_EXPIRATION_TIME
- See Also:
- Constant Field Values
-
PROPNAME_SERVICE_BROKER_SECRET
static final java.lang.String PROPNAME_SERVICE_BROKER_SECRET
- See Also:
- Constant Field Values
-
PROPNAME_CR_TOKEN_FILENAME
static final java.lang.String PROPNAME_CR_TOKEN_FILENAME
- See Also:
- Constant Field Values
-
PROPNAME_IAM_PROFILE_CRN
static final java.lang.String PROPNAME_IAM_PROFILE_CRN
- See Also:
- Constant Field Values
-
PROPNAME_IAM_PROFILE_ID
static final java.lang.String PROPNAME_IAM_PROFILE_ID
- See Also:
- Constant Field Values
-
PROPNAME_IAM_PROFILE_NAME
static final java.lang.String PROPNAME_IAM_PROFILE_NAME
- See Also:
- Constant Field Values
-
PROPNAME_IAM_ACCOUNT_ID
static final java.lang.String PROPNAME_IAM_ACCOUNT_ID
- See Also:
- Constant Field Values
-
PROPNAME_SCOPE_COLLECTION_TYPE
static final java.lang.String PROPNAME_SCOPE_COLLECTION_TYPE
- See Also:
- Constant Field Values
-
PROPNAME_SCOPE_ID
static final java.lang.String PROPNAME_SCOPE_ID
- See Also:
- Constant Field Values
-
PROPNAME_INCLUDE_BUILTIN_ACTIONS
static final java.lang.String PROPNAME_INCLUDE_BUILTIN_ACTIONS
- See Also:
- Constant Field Values
-
PROPNAME_INCLUDE_CUSTOM_ACTIONS
static final java.lang.String PROPNAME_INCLUDE_CUSTOM_ACTIONS
- See Also:
- Constant Field Values
-
PROPNAME_INCLUDE_ROLES
static final java.lang.String PROPNAME_INCLUDE_ROLES
- See Also:
- Constant Field Values
-
PROPNAME_PREFIX_ROLES
static final java.lang.String PROPNAME_PREFIX_ROLES
- See Also:
- Constant Field Values
-
PROPNAME_CALLER_EXT_CLAIM
static final java.lang.String PROPNAME_CALLER_EXT_CLAIM
- See Also:
- Constant Field Values
-
-
Method Detail
-
validate
void validate()
Validates the current set of configuration information in the Authenticator.
-
authenticationType
java.lang.String authenticationType()
Returns the authentication type associated with the Authenticator instance.- Returns:
- a string representing the authentication type (e.g. "iam", "basic", "icp4d", etc.)
-
authenticate
void authenticate(okhttp3.Request.Builder requestBuilder)
Perform the necessary authentication steps for the specified request.- Parameters:
requestBuilder- theRequest.Builderinstance to authenticate
-
-