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

Class TrustNegotiationRequest

java.lang.Object

com.nimbusds.oauth2.sdk.AbstractRequest

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

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

All Implemented Interfaces:

Message, Request

@Immutable
public class TrustNegotiationRequest
extends FederationAPIRequest

Trust negotiation request.

Related specifications:

• OpenID Connect Federation 1.0, section 6.2.1.

Constructor Summary

Constructors

Constructor	Description
TrustNegotiationRequest(URI endpoint, EntityID respondent, EntityID peer, FederationMetadataType metadataType, EntityID anchor)	Creates a new trust negotiation request.

Method Summary

Modifier and Type	Method	Description
FederationMetadataType	getMetadataType()	Returns the metadata type.
EntityID	getPeer()	Returns the peer.
EntityID	getRespondent()	Returns the respondent.
EntityID	getTrustAnchor()	Returns the trust anchor.
static TrustNegotiationRequest	parse(HTTPRequest httpRequest)	Parses a trust negotiation request from the specified HTTP request.
static TrustNegotiationRequest	parse(Map<String,List<String>> params)	Parses a trust negotiation 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

Methods inherited from class java.lang.Object

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

Constructor Detail

TrustNegotiationRequest

public TrustNegotiationRequest(URI endpoint,
                               EntityID respondent,
                               EntityID peer,
                               FederationMetadataType metadataType,
                               EntityID anchor)

Creates a new trust negotiation request.

Parameters:

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

respondent - The respondent. Must not be null.

peer - The peer. Must not be null.

metadataType - The metadata type to resolve. Must not be null.

anchor - The trust anchor. Must not be null.

Method Detail

getRespondent

public EntityID getRespondent()

Returns the respondent.

Returns:

The respondent.

getPeer

public EntityID getPeer()

Returns the peer.

Returns:

The peer.

getMetadataType

public FederationMetadataType getMetadataType()

Returns the metadata type.

Returns:

The metadata type to resolve.

getTrustAnchor

public EntityID getTrustAnchor()

Returns the trust anchor.

Returns:

The trust anchor.

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 TrustNegotiationRequest parse(Map<String,List<String>> params)
                                     throws ParseException

Parses a trust negotiation request from the specified query string parameters.

Parameters:

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

Returns:

The trust negotiation request.

Throws:

ParseException - If parsing failed.

parse

public static TrustNegotiationRequest parse(HTTPRequest httpRequest)
                                     throws ParseException

Parses a trust negotiation request from the specified HTTP request.

Parameters:

httpRequest - The HTTP request. Must not be null.

Returns:

The trust negotiation request.

Throws:

ParseException - If parsing failed.