001/*
002 * nimbus-jose-jwt
003 *
004 * Copyright 2012-2021, Connect2id Ltd and contributors.
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;
019
020
021/**
022 * JSON Web Encryption (JWE) encrypter for multiple recipients.
023 * It should be used only for General JSON Serialization {@link JWEObjectJSON}.
024 *
025 * @author Alexander Martynov
026 * @version 2021-08-19
027 */
028public interface JWEEncrypterMulti extends JWEProvider {
029
030    /**
031     * Encrypts the specified clear text of a {@link JWEObjectJSON JWE object}.
032     *
033     * @param header    The JSON Web Encryption (JWE) header. Must specify
034     *                  a supported JWE algorithm and method. Must not be
035     *                  {@code null}.
036     * @param clearText The clear text to encrypt. Must not be {@code null}.
037     *
038     * @return The resulting JWE crypto parts.
039     *
040     * @throws JOSEException If the JWE algorithm or method is not
041     *                       supported or if encryption failed for some
042     *                       other internal reason.
043     */
044    JWECryptoParts encrypt(final JWEHeader header, final byte[] clearText)
045            throws JOSEException;
046}