## Architecture Patterns

### Action (Controller)
- Hierarchy: `TypicalAction` → `FessBaseAction` → `FessAdminAction`/`FessSearchAction`
- `@Execute` marks web endpoints
- `@Resource` for DI
- `@Secured({ "role", "role-view" })` for authorization
- Return `HtmlResponse` for JSP, `JsonResponse` for APIs

### Service
- Inject behaviors (Bhv) for data access
- Use `OptionalEntity<T>` for nullable returns

    @Override
    protected String getActionRole() {
        return ROLE;
    }

    // ===================================================================================
    //

    /**
     * Displays the general settings index page.
     *
     * @return HTML response for the general settings page
     */
    @Execute
    @Secured({ ROLE, ROLE + VIEW })
    public HtmlResponse index() {
        saveToken();

     */
    @Execute
    @Secured({ ROLE, ROLE + VIEW })
    public HtmlResponse index() {
        return asListHtml();
    }

    /**
     * Show the list page.
     * @param pageNumber The page number.
     * @param form The search form.
     * @return The HTML response.
     */
    @Execute
    @Secured({ ROLE, ROLE + VIEW })

    /**
     * Redirects an authenticated user to the appropriate admin interface based on their roles.
     * Users with admin roles are redirected to the dashboard, while other users are redirected
     * to their designated admin action class or to the root if no specific action is available.
     *
     * @param user the authenticated user bean containing role information
     * @return HTML response redirecting to the appropriate admin interface
     */

        final CreateForm form = new CreateForm();
        form.roles = new String[] { "admin", "user" };
        form.groups = new String[] { "group1", "group2" };

        assertNotNull(form.roles);
        assertEquals(2, form.roles.length);
        assertEquals("admin", form.roles[0]);
        assertEquals("user", form.roles[1]);

        assertNotNull(form.groups);
        assertEquals(2, form.groups.length);

            }
        }
    }

    /**
     * Builds role-based query filters using the provided role set.
     * This method adds should clauses for allowed roles and must-not clauses for denied roles.
     *
     * @param roleSet the set of roles to use for filtering
     * @param boolQuery the boolean query builder to add role filters to
     */

         * @param groups The groups.
         * @param roles The roles.
         */
        public SamlUser(final String nameId, final String sessionIndex, final String nameIdFormat, final String nameidNameQualifier,
                final String nameidSPNameQualifier, final String[] groups, final String[] roles) {
            this.nameId = nameId;
            this.sessionIndex = sessionIndex;

            return entity;
        });
    }

    /**
     * Registers available roles and labels for use in web config forms.
     * Includes role types, label types, and label setting configuration.
     *
     * @param data the render data to register the roles and labels with
     */
    protected void registerRolesAndLabels(final RenderData data) {

    }

    @Override
    protected String getActionRole() {
        return ROLE;
    }

    /**
     * Show the index page.
     * @return The HTML response.
     */
    @Execute
    @Secured({ ROLE, ROLE + VIEW })
    public HtmlResponse index() {
        saveToken();
        return asListHtml();
    }

    /**

    /** OpenID Connect default roles. */
    @Size(max = 1000)
    public String oicDefaultRoles;

    /** SAML service provider base URL. */
    @Size(max = 1000)
    public String samlSpBaseUrl;

    /** SAML attribute name for group membership. */
    @Size(max = 1000)
    public String samlAttributeGroupName;

    /** SAML attribute name for role membership. */
    @Size(max = 1000)