Class FetchEntityStatementRequest
- java.lang.Object
-
- com.nimbusds.oauth2.sdk.AbstractRequest
-
- com.nimbusds.openid.connect.sdk.federation.api.FederationAPIRequest
-
- com.nimbusds.openid.connect.sdk.federation.api.FetchEntityStatementRequest
-
@Immutable public class FetchEntityStatementRequest extends FederationAPIRequest
Fetch entity statement request.Related specifications:
- OpenID Connect Federation 1.0, section 6.1.1.
-
-
Constructor Summary
Constructors Constructor Description FetchEntityStatementRequest(URI endpoint, Issuer issuer, Subject subject, Audience audience)
Creates a new entity fetch request.FetchEntityStatementRequest(URI endpoint, EntityID issuer, EntityID subject, EntityID audience)
Creates a new entity fetch request.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Audience
getAudience()
Returns the optional audience (requester).EntityID
getAudienceEntityID()
Returns the optional audience (requester) entity ID .Issuer
getIssuer()
Returns the issuer.EntityID
getIssuerEntityID()
Returns the issuer entity ID.Subject
getSubject()
Returns the optional subject.EntityID
getSubjectEntityID()
Returns the optional subject entity ID.static FetchEntityStatementRequest
parse(HTTPRequest httpRequest)
Parses a fetch entity statement request from the specified HTTP request.static FetchEntityStatementRequest
parse(Map<String,List<String>> params)
Parses a fetch entity statement 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
-
FetchEntityStatementRequest
public FetchEntityStatementRequest(URI endpoint, Issuer issuer, Subject subject, Audience audience)
Creates a new entity fetch request.- Parameters:
endpoint
- The federation API endpoint. Must not benull
.issuer
- The issuer entity identifier. Must not benull
.subject
- The subject entity identifier,null
if not specified.audience
- The audience (requester) entity identifier,null
if not specified.
-
FetchEntityStatementRequest
public FetchEntityStatementRequest(URI endpoint, EntityID issuer, EntityID subject, EntityID audience)
Creates a new entity fetch request.- Parameters:
endpoint
- The federation API endpoint. Must not benull
.issuer
- The issuer entity identifier. Must not benull
.subject
- The subject entity identifier,null
if not specified.audience
- The audience (requester) entity identifier,null
if not specified.
-
-
Method Detail
-
getIssuerEntityID
public EntityID getIssuerEntityID()
Returns the issuer entity ID.- Returns:
- The issuer entity ID.
-
getSubject
public Subject getSubject()
Returns the optional subject.- Returns:
- The subject,
null
if not specified.
-
getSubjectEntityID
public EntityID getSubjectEntityID()
Returns the optional subject entity ID.- Returns:
- The subject entity ID,
null
if not specified.
-
getAudience
public Audience getAudience()
Returns the optional audience (requester).- Returns:
- The audience,
null
if not specified.
-
getAudienceEntityID
public EntityID getAudienceEntityID()
Returns the optional audience (requester) entity ID .- Returns:
- The audience entity ID,
null
if not specified.
-
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 FetchEntityStatementRequest parse(Map<String,List<String>> params) throws ParseException
Parses a fetch entity statement request from the specified query string parameters.- Parameters:
params
- The query string parameters. Must not benull
.- Returns:
- The fetch entity statement request.
- Throws:
ParseException
- If parsing failed.
-
parse
public static FetchEntityStatementRequest parse(HTTPRequest httpRequest) throws ParseException
Parses a fetch entity statement request from the specified HTTP request.- Parameters:
httpRequest
- The HTTP request. Must not benull
.- Returns:
- The fetch entity statement request.
- Throws:
ParseException
- If parsing failed.
-
-