/* * Copyright 2020 the original author or authors. * * 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 * * https://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.springframework.security.oauth2.jwt; import org.springframework.security.oauth2.jose.JoseHeader; /** * Implementations of this interface are responsible for encoding * a JSON Web Token (JWT) to it's compact claims representation format. * *

* JWTs may be represented using the JWS Compact Serialization format for a * JSON Web Signature (JWS) structure or JWE Compact Serialization format for a * JSON Web Encryption (JWE) structure. Therefore, implementors are responsible * for signing a JWS and/or encrypting a JWE. * * @author Anoop Garlapati * @author Joe Grandja * @since 0.0.1 * @see Jwt * @see JoseHeader * @see JwtClaimsSet * @see JwtDecoder * @see JSON Web Token (JWT) * @see JSON Web Signature (JWS) * @see JSON Web Encryption (JWE) * @see JWS Compact Serialization * @see JWE Compact Serialization */ @FunctionalInterface public interface JwtEncoder { /** * Encode the JWT to it's compact claims representation format. * * @param headers the JOSE header * @param claims the JWT Claims Set * @return a {@link Jwt} * @throws JwtEncodingException if an error occurs while attempting to encode the JWT */ Jwt encode(JoseHeader headers, JwtClaimsSet claims) throws JwtEncodingException; }