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

Class EntityListingSuccessResponse

java.lang.Object

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

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

All Implemented Interfaces:

Message, Response

@Immutable
public class EntityListingSuccessResponse
extends EntityListingResponse

Entity listing success response.

Related specifications:

• OpenID Connect Federation 1.0, section 6.3.2.

Constructor Summary

Constructors

Constructor	Description
EntityListingSuccessResponse(List<EntityID> entityIDS)	Creates a new entity listing success response.

Method Summary

Modifier and Type	Method	Description
List<EntityID>	getEntityListing()	Returns the entity IDs.
boolean	indicatesSuccess()	Checks if the response indicates success.
static EntityListingSuccessResponse	parse(HTTPResponse httpResponse)	Parses an entity listing success response from the specified HTTP response.
static EntityListingSuccessResponse	parse(net.minidev.json.JSONArray jsonArray)	Parses an entity listing success response from the specified JSON array.
HTTPResponse	toHTTPResponse()	Returns the matching HTTP response.

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

toErrorResponse, toSuccessResponse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EntityListingSuccessResponse

public EntityListingSuccessResponse(List<EntityID> entityIDS)

Creates a new entity listing success response.

Parameters:

entityIDS - The entity IDs. Must not be null.

Method Details

getEntityListing

public List<EntityID> getEntityListing()

Returns the entity IDs.

Returns:

The entity IDs.

indicatesSuccess

public boolean indicatesSuccess()

Description copied from interface: Response

Checks if the response indicates success.

Returns:

true if the response indicates success, else false.

toHTTPResponse

public HTTPResponse toHTTPResponse()

Description copied from interface: Response

Returns the matching HTTP response.

Returns:

The HTTP response.

parse

public static EntityListingSuccessResponse parse(net.minidev.json.JSONArray jsonArray)

Parses an entity listing success response from the specified JSON array.

Parameters:

jsonArray - The JSON array. Must not be null.

Returns:

The entity listing success response.

parse

public static EntityListingSuccessResponse parse(HTTPResponse httpResponse)
                                          throws ParseException

Parses an entity listing success response from the specified HTTP response.

Parameters:

httpResponse - The HTTP response. Must not be null.

Returns:

The entity listing success response.

Throws:

ParseException - If parsing failed.