com.nimbusds.openid.connect.sdk.federation.api.FetchEntityStatementRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of oauth2-oidc-sdk Show documentation
OAuth 2.0 SDK with OpenID Connection extensions for developing client and server applications.
There is a newer version: 11.20.1
/*
 * oauth2-oidc-sdk
 *
 * Copyright 2012-2020, Connect2id Ltd and contributors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use
 * this file except in compliance with the License. You may obtain a copy of the
 * License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed
 * under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 */

package com.nimbusds.openid.connect.sdk.federation.api;


import java.net.URI;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import net.jcip.annotations.Immutable;

import com.nimbusds.oauth2.sdk.ParseException;
import com.nimbusds.oauth2.sdk.http.HTTPRequest;
import com.nimbusds.oauth2.sdk.id.Audience;
import com.nimbusds.oauth2.sdk.id.Issuer;
import com.nimbusds.oauth2.sdk.id.Subject;
import com.nimbusds.oauth2.sdk.util.MultivaluedMapUtils;
import com.nimbusds.openid.connect.sdk.federation.entities.EntityID;


/**
 * Fetch entity statement request.
 *
 * Related specifications:
 *
 * 

 *     OpenID Connect Federation 1.0, section 6.1.1.
 * 
 */
@Immutable
public class FetchEntityStatementRequest extends FederationAPIRequest {
	
	
	/**
	 * The issuer.
	 */
	private final Issuer issuer;
	
	
	/**
	 * The optional subject.
	 */
	private final Subject subject;
	
	
	/**
	 * The optional audience.
	 */
	private final Audience audience;
	
	
	/**
	 * Creates a new entity fetch request.
	 *
	 * @param endpoint The federation API endpoint. Must not be
	 *                 {@code null}.
	 * @param issuer   The issuer entity identifier. Must not be
	 *                 {@code null}.
	 * @param subject  The subject entity identifier, {@code null} if not
	 *                 specified.
	 * @param audience The audience (requester) entity identifier,
	 *                 {@code null} if not specified.
	 */
	public FetchEntityStatementRequest(final URI endpoint, final Issuer issuer, final Subject subject, final Audience audience) {
		super(endpoint, OperationType.FETCH);
		if (issuer == null) {
			throw new IllegalArgumentException("The issuer must not be null");
		}
		this.issuer = issuer;
		this.subject = subject;
		this.audience = audience;
	}
	
	
	/**
	 * Creates a new entity fetch request.
	 *
	 * @param endpoint The federation API endpoint. Must not be
	 *                 {@code null}.
	 * @param issuer   The issuer entity identifier. Must not be
	 *                 {@code null}.
	 * @param subject  The subject entity identifier, {@code null} if not
	 *                 specified.
	 * @param audience The audience (requester) entity identifier,
	 *                 {@code null} if not specified.
	 */
	public FetchEntityStatementRequest(final URI endpoint, final EntityID issuer, final EntityID subject, final EntityID audience) {
		this(endpoint,
			new Issuer(issuer.getValue()),
			subject != null ? new Subject(subject.getValue()) : null,
			audience != null ? new Audience(audience.getValue()) : null);
	}
	
	
	/**
	 * Returns the issuer.
	 *
	 * @return The issuer.
	 */
	public Issuer getIssuer() {
		return issuer;
	}
	
	
	/**
	 * Returns the issuer entity ID.
	 *
	 * @return The issuer entity ID.
	 */
	public EntityID getIssuerEntityID() {
		return new EntityID(getIssuer().getValue());
	}
	
	
	/**
	 * Returns the optional subject.
	 *
	 * @return The subject, {@code null} if not specified.
	 */
	public Subject getSubject() {
		return subject;
	}
	
	
	/**
	 * Returns the optional subject entity ID.
	 *
	 * @return The subject entity ID, {@code null} if not specified.
	 */
	public EntityID getSubjectEntityID() {
		return getSubject() != null ? new EntityID(getSubject().getValue()) : null;
	}
	
	
	/**
	 * Returns the optional audience (requester).
	 *
	 * @return The audience, {@code null} if not specified.
	 */
	public Audience getAudience() {
		return audience;
	}
	
	
	/**
	 * Returns the optional audience (requester) entity ID .
	 *
	 * @return The audience entity ID, {@code null} if not specified.
	 */
	public EntityID getAudienceEntityID() {
		return getAudience() != null ? new EntityID(getAudience().getValue()) : null;
	}
	
	
	@Override
	public Map> toParameters() {
		
		Map> params = new HashMap<>();
		params.put("iss", Collections.singletonList(getIssuer().getValue()));
		if (getSubject() != null) {
			params.put("sub", Collections.singletonList(getSubject().getValue()));
		}
		if (getAudience() != null) {
			params.put("aud", Collections.singletonList(getAudience().getValue()));
		}
		return params;
	}
	
	
	/**
	 * Parses a fetch entity statement request from the specified query
	 * string parameters.
	 *
	 * @param params The query string parameters. Must not be {@code null}.
	 *
	 * @return The fetch entity statement request.
	 *
	 * @throws ParseException If parsing failed.
	 */
	public static FetchEntityStatementRequest parse(final Map> params)
		throws ParseException {
		
		String value = MultivaluedMapUtils.getFirstValue(params, "operation");
		
		if (value != null && ! value.equalsIgnoreCase(OperationType.FETCH.getValue())) {
			throw new ParseException("The operation type must be fetch or unspecified");
		}
		
		value = MultivaluedMapUtils.getFirstValue(params, "iss");
		if (value == null) {
			throw new ParseException("Missing iss (issuer) parameter");
		}
		Issuer issuer = new Issuer(value);
		
		value = MultivaluedMapUtils.getFirstValue(params, "sub");
		Subject subject = null;
		if (value != null) {
			subject = new Subject(value);
		}
		
		value = MultivaluedMapUtils.getFirstValue(params, "aud");
		Audience audience = null;
		if (value != null) {
			audience = new Audience(value);
		}
		
		return new FetchEntityStatementRequest(null, issuer, subject, audience);
	}
	
	
	/**
	 * Parses a fetch entity statement request from the specified HTTP
	 * request.
	 *
	 * @param httpRequest The HTTP request. Must not be {@code null}.
	 *
	 * @return The fetch entity statement request.
	 *
	 * @throws ParseException If parsing failed.
	 */
	public static FetchEntityStatementRequest parse(final HTTPRequest httpRequest)
		throws ParseException {
		
		httpRequest.ensureMethod(HTTPRequest.Method.GET);
		FetchEntityStatementRequest request = parse(httpRequest.getQueryParameters());
		return new FetchEntityStatementRequest(
			httpRequest.getURI(),
			request.getIssuer(),
			request.getSubject(),
			request.getAudience());
	}
}