com.nimbusds.jose.mint.JWSMinterConfiguration 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.47

package com.nimbusds.jose.mint;

import com.nimbusds.jose.JWSSigner;
import com.nimbusds.jose.jwk.source.JWKSource;
import com.nimbusds.jose.proc.SecurityContext;
import com.nimbusds.jose.produce.JWSSignerFactory;

/**
 * JSON Web Signature (JWS) minter configuration.
 *
 * Specifies the required components to mint JWS objects:
 *
 * 

 *     JWK source to determine key candidate(s) for the JWS based on the
 *     JWS header and application-specific context information.
 *
 *     
Optional JWS signer factory. Creates the appropriate
 *     {@link com.nimbusds.jose.JWSSigner} for signing the object.
 * 
 *
 * @author Josh Cummings
 * @version 2021-01-14
 */
public interface JWSMinterConfiguration {
	
	/**
	 * Gets the source for looking up JWKs.
	 *
	 * @return The {@link JWKSource} in use.
	 */
	JWKSource getJWKSource();

	
	/**
	 * Sets the source for to look up JWKs from.
	 *
	 * @param jwkSource The JWK source to use.
	 */
	void setJWKSource(final JWKSource jwkSource);

	
	/**
	 * Gets the factory for generating {@link JWSSigner}s.
	 *
	 * @return The {@link JWSSignerFactory} in use.
	 */
	JWSSignerFactory getJWSSignerFactory();

	
	/**
	 * Sets the factory for generating {@link JWSSigner}s.
	 *
	 * @param jwsSignerFactory The JWS signer factory to use.
	 */
	void setJWSSignerFactory(final JWSSignerFactory jwsSignerFactory);
}