Package com.nimbusds.openid.connect.sdk.federation.api

Class FederationAPIRequest

java.lang.Object

com.nimbusds.oauth2.sdk.AbstractRequest

com.nimbusds.openid.connect.sdk.federation.api.FederationAPIRequest

All Implemented Interfaces:

Message, Request

Direct Known Subclasses:

EntityListingRequest, FetchEntityStatementRequest, TrustNegotiationRequest

public abstract class FederationAPIRequest
extends AbstractRequest

Federation API request.

Related specifications:

• OpenID Connect Federation 1.0, section 6.

Constructor Summary

Constructors

Constructor	Description
FederationAPIRequest(URI endpoint, OperationType operationType)	Creates a new federation API request.

Method Summary

Modifier and Type	Method	Description
OperationType	getOperationType()	Returns the requested operation type.
HTTPRequest	toHTTPRequest()	Returns the matching HTTP request.
abstract Map<String,List<String>>	toParameters()	Returns the request query parameters.

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

Constructor Detail

FederationAPIRequest

public FederationAPIRequest(URI endpoint,
                            OperationType operationType)

Creates a new federation API request.

Parameters:

endpoint - The federation API endpoint. Must not be null.

operationType - The requested operation type. Must not be null.

Method Detail

getOperationType

public OperationType getOperationType()

Returns the requested operation type.

Returns:

The operation type.

toParameters

public abstract Map<String,List<String>> toParameters()

Returns the request query parameters.

Returns:

The request query parameters.

toHTTPRequest

public HTTPRequest toHTTPRequest()

Description copied from interface: Request

Returns the matching HTTP request.

Returns:

The HTTP request.