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

Class ResolveRequest

java.lang.Object

com.nimbusds.oauth2.sdk.AbstractRequest

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

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

All Implemented Interfaces:

Message, Request

@Immutable
public class ResolveRequest
extends FederationAPIRequest

Resolve entity statement request.

Related specifications:

• OpenID Connect Federation 1.0, section 7.2.1.

Constructor Summary

Constructors

Constructor	Description
ResolveRequest(URI endpoint, Subject subject, EntityID anchor, EntityType entityType)	Creates a new resolve entity statement request.

Method Summary

Modifier and Type	Method	Description
EntityType	getEntityType()	Returns the entity type to resolve.
Subject	getSubject()	Returns the subject.
EntityID	getSubjectEntityID()	Returns the subject entity ID.
EntityID	getTrustAnchor()	Returns the trust anchor.
static ResolveRequest	parse(HTTPRequest httpRequest)	Parses a resolve entity statement request from the specified HTTP request.
static ResolveRequest	parse(Map<String,List<String>> params)	Parses a resolve 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

toHTTPRequest

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 Detail

ResolveRequest

public ResolveRequest(URI endpoint,
                      Subject subject,
                      EntityID anchor,
                      EntityType entityType)

Creates a new resolve entity statement request.

Parameters:

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

subject - The subject. Must not be null.

anchor - The trust anchor. Must not be null.

entityType - The entity type to resolve, null if not specified.

Method Detail

getSubject

public Subject getSubject()

Returns the subject.

Returns:

The subject.

getSubjectEntityID

public EntityID getSubjectEntityID()

Returns the subject entity ID.

Returns:

The subject entity ID.

getTrustAnchor

public EntityID getTrustAnchor()

Returns the trust anchor.

Returns:

The trust anchor.

getEntityType

public EntityType getEntityType()

Returns the entity type to resolve.

Returns:

The entity type to resolve.

toParameters

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

Description copied from class: FederationAPIRequest

Returns the request query parameters.

Specified by:

toParameters in class FederationAPIRequest

Returns:

The request query parameters.

parse

public static ResolveRequest parse(Map<String,List<String>> params)
                            throws ParseException

Parses a resolve entity statement request from the specified query string parameters.

Parameters:

params - The query string parameters. Must not be null.

Returns:

The resolve entity statement request.

Throws:

ParseException - If parsing failed.

parse

public static ResolveRequest parse(HTTPRequest httpRequest)
                            throws ParseException

Parses a resolve entity statement request from the specified HTTP request.

Parameters:

httpRequest - The HTTP request. Must not be null.

Returns:

The resolve entity statement request.

Throws:

ParseException - If parsing failed.