BearerAuthSupplier (Apache CXF JavaDoc 3.1.0 API)

java.lang.Object
- org.apache.cxf.rs.security.oauth2.client.AbstractAuthSupplier
- - org.apache.cxf.rs.security.oauth2.client.BearerAuthSupplier

All Implemented Interfaces:: HttpAuthSupplier

public class BearerAuthSupplier
extends AbstractAuthSupplier
implements HttpAuthSupplier

Constructor Summary

Constructors
Constructor and Description

BearerAuthSupplier()

Constructors
Constructor and Description
`BearerAuthSupplier()`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getAuthorization(AuthorizationPolicy authPolicy, URI currentURI, Message message, String fullHeader)` The HTTPConduit makes a call to this method to obtain an Authentication token for http authentication.
`Consumer`	`getConsumer()`
`boolean`	`requiresRequestCaching()` If the supplier requires the request to be cached to be resent, return true
`void`	`setAccessTokenServiceUri(String uri)`
`void`	`setConsumer(Consumer consumer)`
`void`	`setRefreshEarly(boolean refreshEarly)`
`void`	`setRefreshToken(String refreshToken)`

Methods inherited from class org.apache.cxf.rs.security.oauth2.client.AbstractAuthSupplier
createAuthorizationHeader, getClientAccessToken, setAccessToken, setClientAccessToken

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

- Constructor Detail
  - BearerAuthSupplier
```
public BearerAuthSupplier()
```
- Method Detail
  - requiresRequestCaching
```
public boolean requiresRequestCaching()
```
    Description copied from interface: HttpAuthSupplier
    
    If the supplier requires the request to be cached to be resent, return true
    
    Specified by:
    
    requiresRequestCaching in interface HttpAuthSupplier
  - getAuthorization
```
public String getAuthorization(AuthorizationPolicy authPolicy,
                      URI currentURI,
                      Message message,
                      String fullHeader)
```
    Description copied from interface: HttpAuthSupplier
    
    The HTTPConduit makes a call to this method to obtain an Authentication token for http authentication.
    
    Specified by:
    
    getAuthorization in interface HttpAuthSupplier
    
    Parameters:
    authPolicy - credentials for the authentication
    message - The CXF Message
    fullHeader - The full WWW-Authenticate header or null if preemptive auth
    
    Returns:
    token for Authenticate string or null if authentication is not possible
  - setRefreshToken
```
public void setRefreshToken(String refreshToken)
```
  - setAccessTokenServiceUri
```
public void setAccessTokenServiceUri(String uri)
```
  - getConsumer
```
public Consumer getConsumer()
```
  - setConsumer
```
public void setConsumer(Consumer consumer)
```
  - setRefreshEarly
```
public void setRefreshEarly(boolean refreshEarly)
```

Class BearerAuthSupplier

Constructor Summary

Method Summary

Methods inherited from class org.apache.cxf.rs.security.oauth2.client.AbstractAuthSupplier

Methods inherited from class java.lang.Object

Constructor Detail

BearerAuthSupplier

Method Detail

requiresRequestCaching

getAuthorization

setRefreshToken

setAccessTokenServiceUri

getConsumer

setConsumer

setRefreshEarly