Package de.xima.fc.user_portal.api.context

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 Detail

      • 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.

      • publicGenericRestClient

        de.xima.fc.api.rest.pub.client.generic.ApiBundle publicGenericRestClient()
        Gets the generated REST client for the public generic API.
        Returns:
        Generated REST client for the public generic 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.

      • publicUserPortalRestClient

        de.xima.fc.api.rest.pub.client.user_portal.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.