Package com.authlete.common.util

Class FapiUtils

java.lang.Object

com.authlete.common.util.FapiUtils

public class FapiUtils
extends Object

Utilities for Financial-grade API (FAPI).

Since:

2.94

See Also:

Financial-grade API Security Profile 1.0 - Part 1: Baseline, Financial-grade API Security Profile 1.0 - Part 2: Advanced

Field Summary

Fields

Modifier and Type	Field	Description
static String	X_FAPI_AUTH_DATE	x-fapi-auth-date
static String	X_FAPI_CUSTOMER_IP_ADDRESS	x-fapi-customer-ip-address
static String	X_FAPI_INTERACTION_ID	x-fapi-interaction-id

Constructor Summary

Constructors

Constructor	Description
FapiUtils()

Method Summary

Modifier and Type	Method	Description
static String	computeOutgoingInteractionId(String incomingInteractionId)	Compute the value suitable for the x-fapi-interaction-id HTTP response header.
static String	generateInteractionId()	Generate a value suitable for the x-fapi-interaction-id HTTP header.

Methods inherited from class java.lang.Object

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

Field Detail

X_FAPI_AUTH_DATE

public static final String X_FAPI_AUTH_DATE

x-fapi-auth-date

From 6.2.2. Client provisions of Financial-grade API Security Profile 1.0 - Part 1: Baseline:

3. may send the last time the customer logged into the client in the x-fapi-auth-date header where the value is supplied as a HTTP-date as in Section 7.1.1.1 of RFC7231, e.g., x-fapi-auth-date: Tue, 11 Sep 2012 19:43:31 GMT;

See Also:

Financial-grade API Security Profile 1.0 - Part 1: Baseline, 6.2.2. Client provisions, Constant Field Values

X_FAPI_CUSTOMER_IP_ADDRESS

public static final String X_FAPI_CUSTOMER_IP_ADDRESS

x-fapi-customer-ip-address

From 6.2.1. Protected resources provisions of Financial-grade API Security Profile 1.0 - Part 1: Baseline:

13. shall not reject requests with a x-fapi-customer-ip-address header containing a valid IPv4 or IPv6 address.

From 6.2.2. Client provisions of Financial-grade API Security Profile 1.0 - Part 1: Baseline:

4. may send the customer’s IP address if this data is available in the x-fapi-customer-ip-address header, e.g., x-fapi-customer-ip-address: 2001:DB8::1893:25c8:1946 or x-fapi-customer-ip-address: 198.51.100.119; and

See Also:

Financial-grade API Security Profile 1.0 - Part 1: Baseline, 6.2.1. Protected resources provisions, Financial-grade API Security Profile 1.0 - Part 1: Baseline, 6.2.2. Client provisions, Constant Field Values

X_FAPI_INTERACTION_ID

public static final String X_FAPI_INTERACTION_ID

x-fapi-interaction-id

From 6.2.1. Protected resources provisions of Financial-grade API Security Profile 1.0 - Part 1: Baseline:

11. shall set the response header x-fapi-interaction-id to the value received from the corresponding FAPI client request header or to a RFC4122 UUID value if the request header was not provided to track the interaction, e.g., x-fapi-interaction-id: c770aef3-6784-41f7-8e0e-ff5f97bddb3a;
12. shall log the value of x-fapi-interaction-id in the log entry; and

From 6.2.2. Client provisions of Financial-grade API Security Profile 1.0 - Part 1: Baseline:

5. may send the x-fapi-interaction-id request header, in which case the value shall be a RFC4122 UUID to the server to help correlate log entries between client and server, e.g., x-fapi-interaction-id: c770aef3-6784-41f7-8e0e-ff5f97bddb3a.

See Also:

Financial-grade API Security Profile 1.0 - Part 1: Baseline, 6.2.1. Protected resources provisions, Financial-grade API Security Profile 1.0 - Part 1: Baseline, 6.2.2. Client provisions, Constant Field Values

Constructor Detail

FapiUtils

public FapiUtils()

Method Detail

computeOutgoingInteractionId

public static String computeOutgoingInteractionId(String incomingInteractionId)
                                           throws IllegalArgumentException

Compute the value suitable for the x-fapi-interaction-id HTTP response header.

Parameters:

incomingInteractionId - The value of the x-fapi-interaction-id HTTP request header. This may be null.

Returns:

If incomingInteractionId is given, the same value is returned. Otherwise, a new value generated by generateInteractionId() is returned.

Throws:

IllegalArgumentException - incomingInteractionId is not a valid UUID.

generateInteractionId

public static String generateInteractionId()

Generate a value suitable for the x-fapi-interaction-id HTTP header.

Returns:

A value suitable for the x-fapi-interaction-id HTTP header.