001/*
002 * nimbus-jose-jwt
003 *
004 * Copyright 2012-2016, Connect2id Ltd.
005 *
006 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use
007 * this file except in compliance with the License. You may obtain a copy of the
008 * License at
009 *
010 *    http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software distributed
013 * under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
014 * CONDITIONS OF ANY KIND, either express or implied. See the License for the
015 * specific language governing permissions and limitations under the License.
016 */
017
018package com.nimbusds.jose.jwk.source;
019
020
021import java.util.List;
022
023import com.nimbusds.jose.KeySourceException;
024import com.nimbusds.jose.jwk.JWK;
025import com.nimbusds.jose.jwk.JWKSelector;
026import com.nimbusds.jose.proc.SecurityContext;
027
028
029/**
030 * JSON Web Key (JWK) source. Exposes a method for retrieving JWKs matching a
031 * specified selector. An optional context parameter is available to facilitate
032 * passing of additional data between the caller and the underlying JWK source
033 * (in both directions). Implementations must be thread-safe.
034 *
035 * @author Vladimir Dzhuvinov
036 * @version 2016-06-21
037 */
038public interface JWKSource <C extends SecurityContext> {
039        
040
041        /**
042         * Retrieves a list of JWKs matching the specified selector.
043         *
044         * @param jwkSelector A JWK selector. Must not be {@code null}.
045         * @param context     Optional context, {@code null} if not required.
046         *
047         * @return The matching JWKs, empty list if no matches were found.
048         *
049         * @throws KeySourceException If key sourcing failed.
050         */
051        List<JWK> get(final JWKSelector jwkSelector, final C context)
052                throws KeySourceException;
053}