org.jose4j.jwt.consumer.JwsCustomizer Maven / Gradle / Ivy
/*
* Copyright 2012-2017 Brian Campbell
*
* 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 org.jose4j.jwt.consumer;
import org.jose4j.jws.JsonWebSignature;
import org.jose4j.jwx.JsonWebStructure;
import java.util.List;
/**
* A callback interface that provides a hook to call arbitrary methods on the JsonWebSignature prior
* to the JwtConsumer using it to verify the signature.
*
* This allows the usage of new and/or esoteric features such as setting the known critical headers
* without having to have specific support at JwtConsumer[Builder] layer.
*/
public interface JwsCustomizer
{
/**
* Customize the JsonWebSignature
* @param jws the JsonWebSignature that can be customized prior to signature verification.
* @param nestingContext a list of JOSE objects, if any, in which the JWS was nested.
* The last item in the list is the outer most JOSE object (not including the current JWS).
*/
void customize(JsonWebSignature jws, List nestingContext);
}