HttpAuthenticationChannelProvider (Keycloak Docs Distribution 21.0.2 API)

java.lang.Object
- org.keycloak.protocol.oidc.grants.ciba.channel.HttpAuthenticationChannelProvider

All Implemented Interfaces:: AuthenticationChannelProvider, Provider

public class HttpAuthenticationChannelProvider
extends Object
implements AuthenticationChannelProvider

Author:: Takashi Norimatsu

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`AUTHENTICATION_CHANNEL_ID`
`protected Map<String,String>`	`clientAuthAttributes`
`protected Cors`	`cors`
`protected javax.ws.rs.core.MultivaluedMap<String,String>`	`formParams`
`protected String`	`httpAuthenticationChannelUri`
`protected RealmModel`	`realm`
`protected KeycloakSession`	`session`

Constructor Summary

Constructors
Constructor Description

HttpAuthenticationChannelProvider(KeycloakSession session, String httpAuthenticationRequestUri)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`checkAuthenticationChannel()`
`void`	`close()`
`protected SimpleHttp`	`completeDecoupledAuthnRequest(SimpleHttp simpleHttp, AuthenticationChannelRequest channelRequest)`	Extension point to allow subclass to override this method in order to add data to post to decoupled server.
`boolean`	`requestAuthentication(CIBAAuthenticationRequest request, String infoUsedByAuthenticator)`	Request the authentication(AuthN) and authorization(AuthZ) by an authentication device (AD) to the external entity via Authentication Channel.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

AUTHENTICATION_CHANNEL_ID

public static final String AUTHENTICATION_CHANNEL_ID

See Also:: Constant Field Values

session
```
protected KeycloakSession session
```

formParams

protected javax.ws.rs.core.MultivaluedMap<String,String> formParams

realm
```
protected RealmModel realm
```

clientAuthAttributes

protected Map<String,String> clientAuthAttributes

cors
```
protected Cors cors
```

httpAuthenticationChannelUri

protected final String httpAuthenticationChannelUri

Constructor Detail

HttpAuthenticationChannelProvider

public HttpAuthenticationChannelProvider(KeycloakSession session,
                                         String httpAuthenticationRequestUri)

Method Detail
- requestAuthentication
```
public boolean requestAuthentication(CIBAAuthenticationRequest request,
                                     String infoUsedByAuthenticator)
```
  Description copied from interface: AuthenticationChannelProvider
  
  Request the authentication(AuthN) and authorization(AuthZ) by an authentication device (AD) to the external entity via Authentication Channel.
  
  Specified by:
  
  requestAuthentication in interface AuthenticationChannelProvider
  
  Parameters:
  
  request - the representation of Authentication Request received on Backchannel Authentication Endpoint
  
  infoUsedByAuthenticator - some value to help the AD to identify the user
  
  Returns:
- checkAuthenticationChannel
```
protected void checkAuthenticationChannel()
```
- completeDecoupledAuthnRequest
```
protected SimpleHttp completeDecoupledAuthnRequest(SimpleHttp simpleHttp,
                                                   AuthenticationChannelRequest channelRequest)
```
  Extension point to allow subclass to override this method in order to add data to post to decoupled server.
- close
```
public void close()
```
  Specified by:
  
  close in interface Provider