Interface IUserPortalInvocationContext

public interface IUserPortalInvocationContext
Context with all data required to make a call to the user portal REST API.

Includes the configured rest client and any authentication information, if available.

Since:
8.2.0
Author:
XIMA MEDIA GmbH

  • Method Details

    • authentication

      UserPortalRestAuthenticator authentication()
      Optional authentication information applied automatically to all requests.
      Returns:
      Authentication information, if available.

    • baseUrl

      String baseUrl()
      Base URL of the user portal REST API.
      Returns:
      Base URL of the user portal REST API.

    • locale

      Locale locale()
      Locale to use for the request. When not set, the default locale English is used.
      Returns:
      Locale to use for the request.

    • publicFormRecordRestClient

      ApiBundle publicFormRecordRestClient()
      Gets the generated REST client for the public form record API.
      Returns:
      Generated REST client for the public form record API.

    • publicFormRestClient

      ApiBundle publicFormRestClient()
      Gets the generated REST client for the public form API.
      Returns:
      Generated REST client for the public form API.

    • publicGenericRestClient

      ApiBundle publicGenericRestClient()
      Gets the generated REST client for the public generic API.
      Returns:
      Generated REST client for the public generic API.

    • publicSecurityRestClient

      ApiBundle publicSecurityRestClient()
      Gets the generated REST client for the public security API.
      Returns:
      Generated REST client for the public security API.

    • publicUserRestClient

      ApiBundle publicUserRestClient()
      Gets the generated REST client for the public user API.
      Returns:
      Generated REST client for the public user API.

    • publicUserPortalRestClient

      ApiBundle publicUserPortalRestClient()
      Gets the generated REST client for the public user portal API.
      Returns:
      Generated REST client for the public user portal API.

    • transport

      EHttpTransportType transport()
      The type of HTTP transport used to send HTTP requests.
      Returns:
      The type of HTTP transport used to send HTTP requests.

    • unauthorizedHandler

      UserPortalUnauthorizedHandler unauthorizedHandler()
      Handler for unauthorized requests. Called when the server returns a 401 Unauthorized.
      Returns:
      Handler for unauthorized requests.