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

java.lang.Object
- com.nimbusds.openid.connect.sdk.federation.api.EntityListingResponse
- - com.nimbusds.openid.connect.sdk.federation.api.EntityListingErrorResponse

All Implemented Interfaces:

Message, Response
```
@Immutable
public class EntityListingErrorResponse
extends EntityListingResponse
```
Entity listing error response.
Related specifications:
- OpenID Connect Federation 1.0, sections 6.3.2 and 6.4.

Constructor Summary

Constructors
Constructor Description

EntityListingErrorResponse(FederationAPIError error)
Creates a new entity listing error response.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`FederationAPIError`	`getErrorObject()`	Returns the federation API error.
`boolean`	`indicatesSuccess()`	Checks if the response indicates success.
`static EntityListingErrorResponse`	`parse(HTTPResponse httpResponse)`	Parses an entity listing error response from the specified HTTP response.
`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 Detail
  - EntityListingErrorResponse
```
public EntityListingErrorResponse(FederationAPIError error)
```
    Creates a new entity listing error response.
    
    Parameters:
    
    error - The federation API error. Must not be null.
- Method Detail
  - getErrorObject
```
public FederationAPIError getErrorObject()
```
    Returns the federation API error.
    
    Returns:
    
    The federation API error.
  - 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 EntityListingErrorResponse parse(HTTPResponse httpResponse)
                                        throws ParseException
```
    Parses an entity listing error response from the specified HTTP response.
    
    Parameters:
    
    httpResponse - The HTTP response. Must not be null.
    
    Returns:
    
    The entity listing error response.
    
    Throws:
    
    ParseException - If parsing failed.