Package com.avoka.fc.core.service

Interface IAuthenticationService

  • All Known Implementing Classes:
    AuthenticationServiceImpl
    public interface IAuthenticationService
    Provides an plug-able Authentication service interface.

    • Field Detail

      • SPRING_BEAN_NAME

        static final String SPRING_BEAN_NAME
        The spring bean name for this authentication service.
        See Also:
        Constant Field Values

    • Method Detail

      • isAuthenticated

        boolean isAuthenticated​(HttpServletRequest request)
        Return true if the user request has been authenticated by an external system.
        Parameters:
        request - the user servlet request
        Returns:
        true if the user request has been authenticated by an external system.

      • getUserId

        String getUserId​(HttpServletRequest request)
        Return user identifier for the given request.
        Parameters:
        request - the user servlet request
        Returns:
        user identifier for the given request

      • isUserInGroups

        boolean isUserInGroups​(HttpServletRequest request,
                       Set<String> groupNames)
                throws ApplicationException
        Return true if the user for the given request belongs to one of the specified groups.
        Parameters:
        request - the user servlet request
        groupNames - the set of group name
        Returns:
        true if the user is in one of the specified groups
        Throws:
        ApplicationException - if the user request is not identified

      • isUserInFormGroups

        boolean isUserInFormGroups​(HttpServletRequest request)
                    throws ApplicationException
        Return true if the user is in one or more form group.
        Parameters:
        request - the user servlet request
        Returns:
        true if the user is in one or more form group
        Throws:
        ApplicationException - if the user request is not identified
        Since:
        3.6.0

      • isUserInJobGroups

        boolean isUserInJobGroups​(HttpServletRequest request,
                          Set<String> groupNames)
                   throws ApplicationException
        Return true if the user for the given request belongs to one of the specified job groups.
        Parameters:
        request - the user servlet request
        groupNames - the set of group name
        Returns:
        true if the user is in one or more of the specified job group
        Throws:
        ApplicationException - if the user request is not identified
        Since:
        17.10.0

      • associateRequestUser

        void associateRequestUser​(HttpServletRequest request,
                          RequestLog requestLog)
        Associate the user with the request log.
        Parameters:
        request - the user servlet request
        requestLog - the request log record to update

      • associateSubmissionUser

        void associateSubmissionUser​(HttpServletRequest request,
                             Submission submission)
        Associate the user with the submission.
        Parameters:
        request - the user servlet request
        submission - the submission record to update

      • getUserGroups

        Set<String> getUserGroups​(HttpServletRequest request)
        Gets the user groups.
        Parameters:
        request - the request
        Returns:
        the user groups
        Since:
        3.6.0

      • getUserFormGroups

        List<Group> getUserFormGroups​(HttpServletRequest request)
        Gets the user form groups.
        Parameters:
        request - the request
        Returns:
        the user form groups
        Since:
        4.3.4

      • getUserJobGroups

        List<Group> getUserJobGroups​(HttpServletRequest request)
        Gets the user job groups.
        Parameters:
        request - the request
        Returns:
        the user form groups
        Since:
        17.10.0