com.nimbusds.jose.proc

Interface JOSEProcessor<T,C extends SecurityContext>

All Known Implementing Classes:

DefaultJOSEProcessor

public interface JOSEProcessor<T,C extends SecurityContext>

Interface for parsing and processing unsecured (plain), JWS and JWE objects.

Version:

2015-07-01

Author:

Vladimir Dzhuvinov

Method Summary

Methods

Modifier and Type	Method and Description
T	process(JOSEObject joseObject, C context) Processes the specified JOSE object (unsecured, JWS or JWE).
T	process(JWEObject jweObject, C context) Processes the specified JWE object by decrypting it.
T	process(JWSObject jwsObject, C context) Processes the specified JWS object by verifying its signature.
T	process(PlainObject plainObject, C context) Processes the specified unsecured (plain) JOSE object, typically by checking its context.
T	process(String compactEncodedJOSE, C context) Parses and processes the specified JOSE object (unsecured, JWS or JWE).

Method Detail

process

T process(String compactEncodedJOSE,
        C context)
          throws ParseException,
                 BadJOSEException,
                 JOSEException

Parses and processes the specified JOSE object (unsecured, JWS or JWE).

Parameters:

compactEncodedJOSE - The JOSE object, compact-encoded to a URL-safe string. Must not be null.

context - Optional context of the JOSE object, null if not required.

Returns:

An application-specific object (the payload) on success, or null if no return value is necessary.

Throws:

ParseException - If the string couldn't be parsed to a valid JOSE object.

BadJOSEException - If the JOSE object is rejected.

JOSEException - If an internal processing exception is encountered.

process

T process(JOSEObject joseObject,
        C context)
          throws BadJOSEException,
                 JOSEException

Processes the specified JOSE object (unsecured, JWS or JWE).

Parameters:

joseObject - The JOSE object. Must not be null.

context - Optional context of the JOSE object, null if not required.

Returns:

An application-specific object (the payload) on success, or null if no return value is necessary.

Throws:

BadJOSEException - If the JOSE object is rejected.

JOSEException - If an internal processing exception is encountered.

process

T process(PlainObject plainObject,
        C context)
          throws BadJOSEException,
                 JOSEException

Processes the specified unsecured (plain) JOSE object, typically by checking its context.

Parameters:

plainObject - The unsecured (plain) JOSE object. Not null.

context - Optional context of the unsecured JOSE object, null if not required.

Returns:

An application-specific object (the payload) on success, or null if no return value is necessary.

Throws:

BadJOSEException - If the unsecured (plain) JOSE object is rejected.

JOSEException - If an internal processing exception is encountered.

process

T process(JWSObject jwsObject,
        C context)
          throws BadJOSEException,
                 JOSEException

Processes the specified JWS object by verifying its signature. The key candidate(s) are selected by examining the JWS header and / or the message context.

Parameters:

jwsObject - The JWS object. Not null.

context - Optional context of the JWS object, null if not required.

Returns:

An application-specific object (the payload) on success, or null if no return value is necessary.

Throws:

BadJOSEException - If the JWS object is rejected, typically due to a bad signature.

JOSEException - If an internal processing exception is encountered.

process

T process(JWEObject jweObject,
        C context)
          throws BadJOSEException,
                 JOSEException

Processes the specified JWE object by decrypting it. The key candidate(s) are selected by examining the JWS header and / or the message context.

Parameters:

jweObject - The JWE object. Not null.

context - Optional context of the JWE object, null if not required.

Returns:

An application-specific object (the payload) on success, or null if no return value is necessary.

Throws:

BadJOSEException - If the JWE object is rejected, typically due to failed decryption.

JOSEException - If an internal processing exception is encountered.