p4pa-organization

This application belong to the entity tier of the Piattaforma Unitaria product.

See PU Microservice Architecture for more details.

🧱 Role

• To handle brokers and api keys;
• To handle broker configurations
• To handle organizations and api keys;
• To handle taxonomies.

🌐 APIs

See OpenAPI, exposed through the following path:

• /swagger-ui/index.html

📌 Relevant APIs

• PUT /brokers/{brokerId}/apiKey: To set broker api keys;
• GET /broker/{brokerId}/apiKey/{keyType}: To get broker api keys;
• PUT /organization/{organizationId}/apiKey: To set organization api keys;
• GET /organization/{organizationId}/apiKey/{keyType}: To retrieve an organization api key;
• GET /taxonomies/sync: To ask to synchronize taxonomies.

📌 Common HTTP status returned:

• 401: Invalid access token provided, thus a new login is required;
• 403: Trying to access a not authorized resource.

🔎 Monitoring

See available actuator endpoints through the following path:

• /actuator

📌 Relevant endpoints

• Health (provide an accessToken to see details): /actuator/health
  • Liveness: /actuator/health/liveness
  • Readiness: /actuator/health/readiness
• Metrics: /actuator/metrics
  • Prometheus: /actuator/prometheus

Further endpoints are exposed through the JMX console.

✏️ Logging

See log configured pattern.

🔗 Dependencies

🗄️ Resources

• PostgreSQL

🧩 Microservices

• p4pa-pagopa-payments:
  • To retrieve taxonomies.

🗃️ Entities handled

• broker
• organization
• org_sil_service
• taxonomy
• broker-configuration

🔧 Configuration

See application.yml for each configurable property.

📌 Relevant configurations

🌐 Application Server

ENV	DESCRIPTION	DEFAULT
SERVER_PORT	Application server listening port	8080

✏️ Logging

ENV	DESCRIPTION	DEFAULT
LOG_LEVEL_ROOT	Base level	INFO
LOG_LEVEL_PAGOPA	Base level of custom classes	INFO
LOG_LEVEL_SPRING	Level applied to Spring framework	INFO
LOG_LEVEL_SPRING_BOOT_AVAILABILITY	To print availability events	DEBUG
LOGGING_LEVEL_API_REQUEST_EXCEPTION	Level applied to APIs exception	INFO
LOG_LEVEL_PERFORMANCE_LOG	Level applied to PerformanceLog	INFO
LOG_LEVEL_PERFORMANCE_LOG_API_REQUEST	Level applied to API Performance Log	INFO
LOG_LEVEL_PERFORMANCE_LOG_REST_INVOKE	Level applied to REST invoke Performance Log	INFO

🔁 Integrations

🗄️ Resources

ENV	DESCRIPTION	DEFAULT
SHOW_SQL	To print SQL statements	false
ORGANIZATION_DB_URL	PostgreSQL connection string (to use in order to customize the entire string)	jdbc:postgresql://${CLASSIFICATION_DB_HOST}:${CLASSIFICATION_DB_PORT}/${CLASSIFICATION_DB_NAME}?currentSchema=debt_positions
ORGANIZATION_DB_HOST	PostgreSQL Host	localhost
ORGANIZATION_DB_PORT	PostgreSQL port	5432
ORGANIZATION_DB_NAME	PostgreSQL Database name	payhub
ORGANIZATION_DB_USER	PostgreSQL username
ORGANIZATION_DB_PASSWORD	PostgreSQL password
ORGANIZATION_DB_CONNECTION_IDLE_TIMEOUT_MILLISECONDS	PostgreSQL connection idle timeout (milliseconds)	600000
ORGANIZATION_DB_CONNECTION_TIMEOUT_MILLISECONDS	PostgreSQL connection timeout (milliseconds)	30000
ORGANIZATION_DB_CONNECTION_KEEPALIVE_TIME_MILLISECONDS	PostgreSQL connection keepalive time (milliseconds)	120000
ORGANIZATION_DB_CONNECTION_MAX_LIFETIME_MILLISECONDS	PostgreSQL connection max lifetime (milliseconds)	1800000
ORGANIZATION_DB_CONNECTION_MAX_POOL_SIZE	PostgreSQL connection max pool size	10
ORGANIZATION_DB_CONNECTION_MIN_IDLE	PostgreSQL connection min idle	10

🔗 REST

ENV	DESCRIPTION	DEFAULT
DEFAULT_REST_CONNECTION_POOL_SIZE	Default connection pool size	10
DEFAULT_REST_CONNECTION_POOL_SIZE_PER_ROUTE	Default connection pool size per route	5
DEFAULT_REST_CONNECTION_POOL_TIME_TO_LIVE_MINUTES	Default connection pool TTL (minutes)	10
DEFAULT_REST_TIMEOUT_CONNECT_MILLIS	Default connection timeout (milliseconds)	120000
DEFAULT_REST_TIMEOUT_READ_MILLIS	Default read timeout (milliseconds)	120000

🧩 Microservices

ENV	DESCRIPTION	DEFAULT
PAGOPA_PAYMENTS_BASE_URL	Organization microservice URL
PAGOPA_PAYMENTS_MAX_ATTEMPTS	Organization API max attempts	3
PAGOPA_PAYMENTS_WAIT_TIME_MILLIS	Organization retry waiting time (milliseconds)	500
PAGOPA_PAYMENTS_PRINT_BODY_WHEN_ERROR	To print body when an error occurs	true
WORKFLOW_HUB_BASE_URL	WorkflowHub microservice URL
WORKFLOW_HUB_MAX_ATTEMPTS	WorkflowHub API max attempts	3
WORKFLOW_HUB_WAIT_TIME_MILLIS	WorkflowHub retry waiting time (milliseconds)	500
WORKFLOW_HUB_PRINT_BODY_WHEN_ERROR	To print body when an error occurs	true

🔑 keys

ENV	DESCRIPTION	DEFAULT
JWT_TOKEN_PUBLIC_KEY	p4pa-auth JWT public key
BROKER_ENCRYPT_PASSWORD	Base64 encoded key (256 bit) used to encrypt broker api keys
ORGANIZATION_ENCRYPT_PASSWORD	Base64 encoded key (256 bit) used to encrypt organization api keys

🛠️ Getting Started

📝 Prerequisites

Ensure the following tools are installed on your machine:

1. Java 21+
2. Gradle (or use the Gradle wrapper included in the repository)
3. Docker (to build and run on an isolated environment, optional)

🔐 Write Locks

./gradlew dependencies --write-locks

⚙️ Build

./gradlew clean build

🧪 Test

📌 JUnit

./gradlew test

🚀 Run local

./gradlew bootRun

🐳 Build & run through Docker

docker build -t <APP_NAME> .
docker run --env-file <ENV_FILE> <APP_NAME>

⚖️ Generate dependencies licenses

./gradlew generateLicenseReport