com.nimbusds.jose

Interface HeaderFilter

All Known Subinterfaces:

JWEHeaderFilter, JWSHeaderFilter

All Known Implementing Classes:

DefaultHeaderFilter, DefaultJWEHeaderFilter, DefaultJWSHeaderFilter

public interface HeaderFilter

Javascript Object Signing and Encryption (JOSE) header filter. Specifies the names of the accepted header parameters.

Version:

$version$ (2013-03-22)

Author:

Vladimir Dzhuvinov

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	getAcceptedParameters() Gets the names of the accepted header parameters.
void	setAcceptedParameters(java.util.Set<java.lang.String> acceptedParams) Sets the names of the accepted header parameters.

Method Detail

getAcceptedParameters

java.util.Set<java.lang.String> getAcceptedParameters()

Gets the names of the accepted header parameters.

Returns:

The accepted header parameters, as a read-only set. Must contain at least the alg parameter for JWS headers or the alg and enc parameters for JWE headers.

setAcceptedParameters

void setAcceptedParameters(java.util.Set<java.lang.String> acceptedParams)

Sets the names of the accepted header parameters.

Parameters:

acceptedParams - The accepted header parameters. Must contain at least the alg parameter for JWS headers or the alg and enc parameters for JWE headers. Must not be null.