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

Class EntityListingRequest

java.lang.Object

com.nimbusds.oauth2.sdk.AbstractRequest

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

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

All Implemented Interfaces:

Message, Request

@Immutable
public class EntityListingRequest
extends FederationAPIRequest

Entity listing request.

Related specifications:

• OpenID Connect Federation 1.0, section 7.3.1.

Constructor Summary

Constructors

Constructor	Description
EntityListingRequest(URI endpoint)	Creates a new entity listing request.

Method Summary

Modifier and Type	Method	Description
static EntityListingRequest	parse(HTTPRequest httpRequest)	Parses an entity listing request from the specified HTTP request.
Map<String,List<String>>	toParameters()	Returns the request query parameters.

Methods inherited from class com.nimbusds.openid.connect.sdk.federation.api.FederationAPIRequest

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

Constructor Detail

EntityListingRequest

public EntityListingRequest(URI endpoint)

Creates a new entity listing request.

Parameters:

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

Method Detail

toParameters

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

Description copied from class: FederationAPIRequest

Returns the request query parameters.

Specified by:

toParameters in class FederationAPIRequest

Returns:

The request query parameters.

parse

public static EntityListingRequest parse(HTTPRequest httpRequest)
                                  throws ParseException

Parses an entity listing request from the specified HTTP request.

Parameters:

httpRequest - The HTTP request. Must not be null.

Returns:

The entity listing request.

Throws:

ParseException - If parsing failed.