com.tcdng.unify.web.ui.UIControllerUtil Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2018-2023 The Code Department.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package com.tcdng.unify.web.ui;

import java.util.Map;

import com.tcdng.unify.core.UnifyComponent;
import com.tcdng.unify.core.UnifyException;
import com.tcdng.unify.web.ControllerPathParts;
import com.tcdng.unify.web.ui.widget.Page;

/**
 * UI controller utilities object.
 * 
 * @author The Code Department
 * @since 1.0
 */
public interface UIControllerUtil extends UnifyComponent {

    /**
     * Indicates if content security policy (CSP) with nonce should be applied to requests
     * 
     * @return the CSP nonce flag
     * @throws UnifyException
     *                        if an error occurs
     */
    boolean isCSPNonce() throws UnifyException;

    /**
     * Indicates UI controller should hide error trace.
     * 
     * @return the hide error trace flag
     * @throws UnifyException
     *                        if an error occurs
     */
    boolean isHideErrorTrace() throws UnifyException;

    /**
     * Gets container additional response headers.
     * 
     * @return the response headers
     * @throws UnifyException
     *                        if an error occurs
     */
    Map getAdditionalResponseHeaders() throws UnifyException;
    
    /**
     * Returns a page controller information.
     * 
     * @param controllerName
     *            the controller name
     * @return the page controller information
     * @throws UnifyException
     *             if bean with name does not exist. If controller with name is not
     *             a page-controller. if an error occurs
     */
    PageControllerInfo getPageControllerInfo(String controllerName) throws UnifyException;

    /**
     * Updates page controller info with stand alone panel information
     * 
     * @param controllerName
     *            the controller name
     * @param standalonePanelName
     *            the stand alone panel
     * @throws UnifyException
     *             if an error occurs
     */
    void updatePageControllerInfo(String controllerName, String standalonePanelName) throws UnifyException;

    /**
     * Returns a resource controller information.
     * 
     * @param controllerName
     *            the controller name
     * @return the resource controller information
     * @throws UnifyException
     *             if bean with name does not exist. If controller with name is not
     *             a resource-controller. if an error occurs
     */
    ResourceControllerInfo getResourceControllerInfo(String controllerName) throws UnifyException;

    /**
     * Executes a page controller action.
     * 
     * @param fullActionPath
     *            the full action path
     * @return the response mapping string
     * @throws UnifyException
     *             if an error occurs
     */
    String executePageController(String fullActionPath) throws UnifyException;

    /**
     * Populates the property of a page controller page bean.
     * 
     * @param controllerName
     *            the controller name
     * @param propertyName
     *            the property to set
     * @param value
     *            the value to set
     * @throws UnifyException
     *             if an error occurs
     */
    void populatePageBean(String controllerName, String propertyName, Object value) throws UnifyException;
    
    /**
     * Gets common utilities controller name
     * 
     * @return the controller name
     */
    String getCommonUtilitiesControllerName();
    
    /**
     * Loads a request page.
     * @param controllerPathParts the controller path parts.
     * @return the loaded page
     * @throws UnifyException if an error occurs
     */
    Page loadRequestPage(ControllerPathParts controllerPathParts) throws UnifyException;
}