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
-
@Immutable public class EntityListingRequest extends FederationAPIRequest
Entity listing request.Related specifications:
- OpenID Connect Federation 1.0, section 6.3.1.
-
-
Constructor Summary
Constructors Constructor Description EntityListingRequest(URI endpoint, Issuer issuer, EntityListingSpec listingSpec)
Creates a new entity listing request.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Issuer
getIssuer()
Returns the issuer.EntityListingSpec
getListingSpec()
Returns the federation entity listing spec.static EntityListingRequest
parse(HTTPRequest httpRequest)
Parses an entity listing request from the specified HTTP request.static EntityListingRequest
parse(Map<String,List<String>> params)
Parses an entity listing request from the specified query string parameters.Map<String,List<String>>
toParameters()
Returns the request query parameters.-
Methods inherited from class com.nimbusds.openid.connect.sdk.federation.api.FederationAPIRequest
getOperationType, toHTTPRequest
-
Methods inherited from class com.nimbusds.oauth2.sdk.AbstractRequest
getEndpointURI
-
-
-
-
Constructor Detail
-
EntityListingRequest
public EntityListingRequest(URI endpoint, Issuer issuer, EntityListingSpec listingSpec)
Creates a new entity listing request.- Parameters:
endpoint
- The federation API endpoint. Must not benull
.issuer
- The issuer entity identifier. Must not benull
.listingSpec
- The entity listing spec. Must not benull
.
-
-
Method Detail
-
getListingSpec
public EntityListingSpec getListingSpec()
Returns the federation entity listing spec.- Returns:
- The listing spec.
-
toParameters
public Map<String,List<String>> toParameters()
Description copied from class:FederationAPIRequest
Returns the request query parameters.- Specified by:
toParameters
in classFederationAPIRequest
- Returns:
- The request query parameters.
-
parse
public static EntityListingRequest parse(Map<String,List<String>> params) throws ParseException
Parses an entity listing request from the specified query string parameters.- Parameters:
params
- The query string parameters. Must not benull
.- Returns:
- The entity listing request.
- Throws:
ParseException
- If parsing failed.
-
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 benull
.- Returns:
- The entity listing request.
- Throws:
ParseException
- If parsing failed.
-
-