FederationEntityConfigurationRequest (Nimbus OAuth 2.0 SDK with OpenID Connect 1.0 extensions v9.22)

java.lang.Object
- com.nimbusds.oauth2.sdk.AbstractRequest
- - com.nimbusds.oauth2.sdk.AbstractConfigurationRequest
  - - com.nimbusds.openid.connect.sdk.federation.config.FederationEntityConfigurationRequest

All Implemented Interfaces:

Message, Request
```
@Immutable
public class FederationEntityConfigurationRequest
extends AbstractConfigurationRequest
```
Federation entity configuration request.
Example HTTP request:
```
 GET /.well-known/openid-federation HTTP/1.1
 Host: example.com
 
```
Related specifications:
- OpenID Connect Federation 1.0, section 5.1.

Field Summary

Fields
Modifier and Type Field Description

static String OPENID_FEDERATION_ENTITY_WELL_KNOWN_PATH
The well-known path for federation entity metadata.

Constructor Summary

Constructors
Constructor	Description
`FederationEntityConfigurationRequest(EntityID entityID)`	Creates a new federation entity configuration request using the `postfix well-known path composition strategy`.
`FederationEntityConfigurationRequest(EntityID entityID, WellKnownPathComposeStrategy strategy)`	Creates a new federation entity configuration request.

Method Summary
- Methods inherited from class com.nimbusds.oauth2.sdk.AbstractConfigurationRequest
  toHTTPRequest
- Methods inherited from class com.nimbusds.oauth2.sdk.AbstractRequest
  getEndpointURI
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - OPENID_FEDERATION_ENTITY_WELL_KNOWN_PATH
```
public static final String OPENID_FEDERATION_ENTITY_WELL_KNOWN_PATH
```
    The well-known path for federation entity metadata.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FederationEntityConfigurationRequest
```
public FederationEntityConfigurationRequest(EntityID entityID)
```
    Creates a new federation entity configuration request using the postfix well-known path composition strategy.
    
    Parameters:
    
    entityID - The entity ID. Must represent a valid URL. Must not be null.
  - FederationEntityConfigurationRequest
```
public FederationEntityConfigurationRequest(EntityID entityID,
                                            WellKnownPathComposeStrategy strategy)
```
    Creates a new federation entity configuration request.
    
    Parameters:
    
    entityID - The entity ID. Must represent a valid URL. Must not be null.
    
    strategy - The well-known path composition strategy. Must not be null.