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.
EntityListingRequest(URI endpoint, EntityType entityType)	Creates a new entity listing request.

Method Summary

Modifier and Type	Method	Description
EntityType	getEntityType()	Returns the type of the entities to list.
static EntityListingRequest	parse(HTTPRequest httpRequest)	Parses an entity listing request from the specified HTTP request.
HTTPRequest	toHTTPRequest()	Returns the matching HTTP request.
Map<String,List<String>>	toParameters()	Returns the request 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 Details

EntityListingRequest

public EntityListingRequest(URI endpoint)

Creates a new entity listing request.

Parameters:

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

EntityListingRequest

public EntityListingRequest(URI endpoint,
 EntityType entityType)

Creates a new entity listing request.

Parameters:

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

entityType - The type of the entities to list, null for all.

Method Details

getEntityType

public EntityType getEntityType()

Returns the type of the entities to list.

Returns:

The type of the entities to list, null for all.

toParameters

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

Description copied from class: FederationAPIRequest

Returns the request parameters.

Specified by:

toParameters in class FederationAPIRequest

Returns:

The request parameters.

toHTTPRequest

public HTTPRequest toHTTPRequest()

Description copied from interface: Request

Returns the matching HTTP request.

Specified by:

toHTTPRequest in interface Request

Overrides:

toHTTPRequest in class FederationAPIRequest

Returns:

The HTTP request.

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.