Package de.xima.fc.proma

Class RequestPromaContexts

  • public final class RequestPromaContexts
extends Object
    Factory for IPublicPromaInvocationContexts. Similar to RequestEntityContext. The factory methods must be called within an active Faces context, but can then be used outside of the UI thread.
    Since:
    8.0.0
    Author:
    XIMA MEDIA GmbH

    • Method Detail

      • publicWebSocketAsync

        public static IPublicAsyncWebSocketContext publicWebSocketAsync()
        Returns:
        A new web socket sync invocation context with the appropriate settings for the current context.

      • publicWebSocketAsync

        public static IPublicAsyncWebSocketContext publicWebSocketAsync​(IUser user)
        Parameters:
        user - The user who initiated the interaction with the PROMA API.
        Returns:
        A new web socket sync invocation context with the appropriate settings for the current context, plus the given user.

      • publicWebSocketAsync

        public static IPublicAsyncWebSocketContext publicWebSocketAsync​(UserContext uc)
        Parameters:
        uc - User context of the user who initiated the interaction with the PROMA API.
        Returns:
        A new web socket sync invocation context with the appropriate settings for the current context, plus the given user context

      • publicWebSocketAsync

        public static IPublicAsyncWebSocketContext publicWebSocketAsync​(IUser user,
                                                                de.xima.ximahttp.jakarta_faces.api.IContextualExecutor executor)
        Parameters:
        user - User who initiated the interaction with the PROMA API.
        executor - Optional executor, when not set, defaults to FacesHttp.facesExecutor().
        Returns:
        A new web socket sync invocation context with the appropriate settings for the current context, plus the given user and executor.

      • publicWebSocketAsync

        public static IPublicAsyncWebSocketContext publicWebSocketAsync​(UserContext uc,
                                                                de.xima.ximahttp.jakarta_faces.api.IContextualExecutor executor)
        Parameters:
        uc - User context of the user who initiated the interaction with the PROMA API.
        executor - Optional executor, when not set, defaults to FacesHttp.facesExecutor().
        Returns:
        A new web socket sync invocation context with the appropriate settings for the current context, plus the given user context and executor

      • publicWebSocketSync

        public static IPublicSyncWebSocketContext publicWebSocketSync()
        Returns:
        A new web socket sync invocation context with the appropriate settings for the current context.

      • publicWebSocketSync

        public static IPublicSyncWebSocketContext publicWebSocketSync​(IUser user)
        Parameters:
        user - The user who initiated the interaction with the PROMA API.
        Returns:
        A new web socket sync invocation context with the appropriate settings for the current context, plus the given user.

      • publicWebSocketSync

        public static IPublicSyncWebSocketContext publicWebSocketSync​(UserContext uc)
        Parameters:
        uc - User context of the user who initiated the interaction with the PROMA API.
        Returns:
        A new web socket sync invocation context with the appropriate settings for the current context, plus the given user context.

      • publicWebSocketSync

        public static IPublicSyncWebSocketContext publicWebSocketSync​(IUser user,
                                                              de.xima.ximahttp.jakarta_faces.api.IContextualExecutor executor)
        Parameters:
        user - The user who initiated the interaction with the PROMA API.
        executor - Optional executor, when not set, defaults to FacesHttp.webSocketContextExecutor().
        Returns:
        A new web socket sync invocation context with the appropriate settings for the current context, plus the given user and executor.

      • publicWebSocketSync

        public static IPublicSyncWebSocketContext publicWebSocketSync​(UserContext uc,
                                                              de.xima.ximahttp.jakarta_faces.api.IContextualExecutor executor)
        Parameters:
        uc - User context of the user who initiated the interaction with the PROMA API.
        executor - Optional executor, when not set, defaults to FacesHttp.webSocketContextExecutor().
        Returns:
        A new web socket sync invocation context with the appropriate settings for the current context, plus the given user context and executor.