Package com.acumenvelocity.ath.controller

Class OkapiController

java.lang.Object

com.acumenvelocity.ath.controller.OkapiController

public class OkapiController
extends Object

REST Controller for handling Okapi framework related operations. Provides endpoints for retrieving language, encoding, and filter information from the Okapi framework with pagination support.

This controller integrates with Swagger/OpenAPI for API documentation and follows RESTful best practices.

Since:

1.0

Version:

1.0

Author:

Acumen Velocity

Constructor Summary

Constructors

Constructor	Description
OkapiController()

Method Summary

Modifier and Type	Method	Description
io.swagger.oas.inflector.models.ResponseContext	getEncodings(io.swagger.oas.inflector.models.RequestContext request, Integer page, Integer pageSize)	Retrieves a paginated list of available encodings from Okapi framework.
io.swagger.oas.inflector.models.ResponseContext	getFilters(io.swagger.oas.inflector.models.RequestContext request, Integer page, Integer pageSize)	Retrieves a paginated list of available filter configurations from Okapi framework.
io.swagger.oas.inflector.models.ResponseContext	getLanguages(io.swagger.oas.inflector.models.RequestContext request, Integer page, Integer pageSize)	Retrieves a paginated list of available languages with 2-character ISO codes only.
io.swagger.oas.inflector.models.ResponseContext	getLocales(io.swagger.oas.inflector.models.RequestContext request, Integer page, Integer pageSize)	Retrieves a paginated list of available languages from Okapi framework.

Methods inherited from class java.lang.Object

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

Constructor Detail

OkapiController

public OkapiController()

Method Detail

getLanguages

public io.swagger.oas.inflector.models.ResponseContext getLanguages(io.swagger.oas.inflector.models.RequestContext request,
                                                                    Integer page,
                                                                    Integer pageSize)

Retrieves a paginated list of available languages with 2-character ISO codes only.

Pagination Details:

• Default page size: 10 items
• Maximum page size: 100 items
• Page numbers start from 1
• Automatically adjusts invalid page numbers

Language Code Filter: Only languages with 2-character ISO 639-1 codes are returned (e.g., "en", "fr", "de"). Languages with 3-character codes or regional variants (e.g., "ace", "en-US") are excluded.

Parameters:

request - the HTTP request context provided by Swagger Inflector

page - the requested page number (1-based, optional)

pageSize - the number of items per page (1-100, optional)

Returns:

ResponseContext containing paginated language list or error details

getLocales

public io.swagger.oas.inflector.models.ResponseContext getLocales(io.swagger.oas.inflector.models.RequestContext request,
                                                                  Integer page,
                                                                  Integer pageSize)

Retrieves a paginated list of available languages from Okapi framework.

Pagination Details:

• Default page size: 10 items
• Maximum page size: 100 items
• Page numbers start from 1
• Automatically adjusts invalid page numbers

Parameters:

request - the HTTP request context provided by Swagger Inflector

page - the requested page number (1-based, optional)

pageSize - the number of items per page (1-100, optional)

Returns:

ResponseContext containing paginated locale list or error details

getEncodings

public io.swagger.oas.inflector.models.ResponseContext getEncodings(io.swagger.oas.inflector.models.RequestContext request,
                                                                    Integer page,
                                                                    Integer pageSize)

Retrieves a paginated list of available encodings from Okapi framework.

Follows the same pagination logic as getLanguages(RequestContext, Integer, Integer).

Parameters:

request - the HTTP request context provided by Swagger Inflector

page - the requested page number (1-based, optional)

pageSize - the number of items per page (1-100, optional)

Returns:

ResponseContext containing paginated encoding list or error details

getFilters

public io.swagger.oas.inflector.models.ResponseContext getFilters(io.swagger.oas.inflector.models.RequestContext request,
                                                                  Integer page,
                                                                  Integer pageSize)

Retrieves a paginated list of available filter configurations from Okapi framework.

Follows the same pagination logic as getLanguages(RequestContext, Integer, Integer).

Parameters:

request - the HTTP request context provided by Swagger Inflector

page - the requested page number (1-based, optional)

pageSize - the number of items per page (1-100, optional)

Returns:

ResponseContext containing paginated filter list or error details