com.nimbusds.jose.jwk.source.JWKSourceWithFailover Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nimbus-jose-jwt Show documentation

Java library for Javascript Object Signing and Encryption (JOSE) and JSON Web Tokens (JWT)

There is a newer version: 9.48

/*
 * nimbus-jose-jwt
 *
 * Copyright 2012-2022, Connect2id Ltd.
 *
 * 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.jose.jwk.source;


import java.io.Closeable;
import java.util.List;
import java.util.Objects;

import net.jcip.annotations.ThreadSafe;

import com.nimbusds.jose.KeySourceException;
import com.nimbusds.jose.jwk.JWK;
import com.nimbusds.jose.jwk.JWKSelector;
import com.nimbusds.jose.proc.SecurityContext;
import com.nimbusds.jose.util.IOUtils;


/**
 * JWK source with optional failover.
 *
 * @author Thomas Rørvik Skjølberg
 * @author Vladimir Dzhuvinov
 * @version 2022-08-24
 */
@ThreadSafe
public class JWKSourceWithFailover implements JWKSource, Closeable {
	
	private final JWKSource jwkSource;
	private final JWKSource failoverJWKSource;

	
	/**
	 * Creates a new JWK source with optional failover.
	 *
	 * @param jwkSource         The primary JWK source. Must not be
	 *                          {@code null}.
	 * @param failoverJWKSource Optional failover JWK source if retrieval
	 *                          from the primary JWK source fails,
	 *                          {@code null} if no failover.
	 */
	public JWKSourceWithFailover(final JWKSource jwkSource, final JWKSource failoverJWKSource) {
		Objects.requireNonNull(jwkSource, "The primary JWK source must not be null");
		this.jwkSource = jwkSource;
		this.failoverJWKSource = failoverJWKSource;
	}

	
	/**
	 * Fails over to the configured JWK source.
	 */
	private List failover(final Exception exception, final JWKSelector jwkSelector, final C context)
		throws KeySourceException {

		try {
			return failoverJWKSource.get(jwkSelector, context);
		} catch (KeySourceException kse) {
			throw new KeySourceException(
				exception.getMessage() + "; Failover JWK source retrieval failed with: " + kse.getMessage(), kse
			);
		}
	}
	

	@Override
	public List get(final JWKSelector jwkSelector, final C context)
		throws KeySourceException {
		
		try {
			return jwkSource.get(jwkSelector, context);
		} catch (Exception e) {
			return failover(e, jwkSelector, context);
		}
	}

	
	@Override
	public void close() {
		if (jwkSource instanceof Closeable) {
			IOUtils.closeSilently((Closeable)jwkSource);
		}
		if (failoverJWKSource instanceof Closeable) {
			IOUtils.closeSilently((Closeable)failoverJWKSource);
		}
	}
}