com.truelayer.signing

Class Signer

java.lang.Object

com.truelayer.signing.Signer

public final class Signer
extends java.lang.Object

Builder to generate a Tl-Signature header value using a private key.

Method Summary

Modifier and Type	Method and Description
Signer	body(byte[] body) Add the full request body.
Signer	body(java.lang.String body) Add the full request body.
static Signer	from(java.lang.String kid, byte[] privateKeyPem) Start building a request Tl-Signature header value using private key RFC 7468 PEM-encoded data and the key's kid.
static Signer	from(java.lang.String kid, java.security.interfaces.ECPrivateKey privateKeyPem) Start building a request Tl-Signature header value using private key RFC 7468 PEM-encoded data and the key's kid.
static Signer	from(java.lang.String kid, java.lang.String privateKeyPem) Start building a request Tl-Signature header value using private key RFC 7468 PEM-encoded data and the key's kid.
Signer	header(java.lang.String name, java.lang.String value) Add a header name and value.
Signer	headers(java.util.Map<java.lang.String,java.lang.String> headers) Add a Map of headers.
Signer	method(java.lang.String method) Add the request method, defaults to `"POST"` if unspecified.
Signer	path(java.lang.String path) Add the request absolute path starting with a leading `/` and without any trailing slashes.
java.lang.String	sign() Produce a JWS `Tl-Signature` v2 header value

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

method

public Signer method(java.lang.String method)

Add the request method, defaults to `"POST"` if unspecified.

Parameters:

method - - the request method must be non null

Returns:

the Signer instance

Throws:

java.lang.IllegalArgumentException - if the provided param is null

path

public Signer path(java.lang.String path)

Add the request absolute path starting with a leading `/` and without any trailing slashes.

Parameters:

path - - the request absolute path must not be null

Returns:

the Signer instance

Throws:

java.lang.IllegalArgumentException - if the provided param is null or invalid

body

public Signer body(byte[] body)

Add the full request body. Note: This *must* be identical to what is sent with the request.

Parameters:

body - - the full request body must not be null

Returns:

the Signer instance

Throws:

java.lang.IllegalArgumentException - if the provided param is null

body

public Signer body(java.lang.String body)

Add the full request body. Note: This *must* be identical to what is sent with the request.

Parameters:

body - - the full request body must not be null

Returns:

the Signer instance

Throws:

java.lang.IllegalArgumentException - if the provided param is null

header

public Signer header(java.lang.String name,
                     java.lang.String value)

Add a header name and value. May be called multiple times to add multiple different headers. Warning: Only a single value per header name is supported.

Parameters:

name - - must not be null

value - - must not be null

Returns:

the Signer instance

Throws:

java.lang.IllegalArgumentException - if the provided params are null

headers

public Signer headers(java.util.Map<java.lang.String,java.lang.String> headers)

Add a Map of headers. Warning: Only a single value per header name is supported.

Parameters:

headers - - must not be null

Returns:

the Signer instance

Throws:

java.lang.IllegalArgumentException - if the provided params are null

from

public static Signer from(java.lang.String kid,
                          byte[] privateKeyPem)

Start building a request Tl-Signature header value using private key RFC 7468 PEM-encoded data and the key's kid.

Parameters:

kid - key identifier of the private key - must not be null

privateKeyPem - the privateKey RFC 7468 PEM-encoded - must not be null

Returns:

the Signer instance

Throws:

KeyException - if the provided key is invalid

java.lang.IllegalArgumentException - if the provided params are null

from

public static Signer from(java.lang.String kid,
                          java.lang.String privateKeyPem)

Start building a request Tl-Signature header value using private key RFC 7468 PEM-encoded data and the key's kid.

Parameters:

kid - key identifier of the private key - must not be null

privateKeyPem - the privateKey RFC 7468 PEM-encoded - must not be null

Returns:

the Signer instance

Throws:

KeyException - if the provided key is invalid

java.lang.IllegalArgumentException - if the provided params are null

from

public static Signer from(java.lang.String kid,
                          java.security.interfaces.ECPrivateKey privateKeyPem)

Start building a request Tl-Signature header value using private key RFC 7468 PEM-encoded data and the key's kid.

Parameters:

kid - key identifier of the private key - must not be null

privateKeyPem - the privateKey RFC 7468 PEM-encoded - must not be null

Returns:

the Signer instance

Throws:

KeyException - if the provided key is invalid

java.lang.IllegalArgumentException - if the provided params are null

sign

public java.lang.String sign()

Produce a JWS `Tl-Signature` v2 header value

Returns:

a JWS `Tl-Signature` v2 header value

Throws:

SignatureException - if signature fails