com.agiletec.aps.system.services.url.IURLManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of entando-engine Show documentation
Entando Engine: an agile, modern and user-centric open source Portal platform.
There is a newer version: 6.2.27
/*
 * Copyright 2015-Present Entando Inc. (http://www.entando.com) All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 */
package com.agiletec.aps.system.services.url;

import java.util.Map;

import com.agiletec.aps.system.RequestContext;
import com.agiletec.aps.system.exception.ApsSystemException;
import com.agiletec.aps.system.services.lang.Lang;
import com.agiletec.aps.system.services.page.IPage;

import javax.servlet.http.HttpServletRequest;

/**
 * Interfaccia base per i servizi di creazione di URL.
 * @author M.Diana - E.Santoboni
 */
public interface IURLManager {
	
	/**
	 * Crea e restituisce un oggetto PageURL.

	 * N.B.: l'oggetto restituito deve essere utilizzato nell'ambito
	 * della richiesta corrente (non memorizzarlo in modo più persistente, ad
	 * esempio in sessione) in quanto contiene riferimenti ad altri servizi.
	 * @param reqCtx Il contesto della richiesta.
	 * @return L'oggetto creato.
	 */
	public PageURL createURL(RequestContext reqCtx);
	
	/**
	 * Crea l'URL ad una pagina del portale, sulla base 
	 * delle informazioni contenute nell'argomento passato.
	 * @param pageUrl L'oggetto contenente le informazioni sulla destinazione
	 * @param reqCtx Il contesto della richiesta dell'URL.
	 * @return La Stringa contenente l'URL.
	 */
	public String getURLString(PageURL pageUrl, RequestContext reqCtx);
	
	/**
	 * Create and return url by required page, lang and request params.
	 * @param requiredPage The required page.
	 * @param requiredLang The required lang.
	 * @param params A map of params. Could be null.
	 * @return The required url.
	 */
	public String createURL(IPage requiredPage, Lang requiredLang, Map params);
	
    /**
     * Create and return url by required page, lang and request params.
	 * @param requiredPage The required page.
	 * @param requiredLang The required lang.
	 * @param params A map of params. Could be null.
     * @param escapeAmp if true, escape "&" with "&" in the query string
     * @return The required url.
     */
	public String createURL(IPage requiredPage, Lang requiredLang, Map params, boolean escapeAmp);
	
    /**
     * Create and return url by required page, lang and request params.
	 * @param requiredPage The required page.
	 * @param requiredLang The required lang.
	 * @param params A map of params. Could be null.
     * @param escapeAmp if true, escape "&" with "&" in the query string
     * @param request The object that allows extracting the information from baseUrl (based on the configuration of the url style); 
     * if null, the base url will be the one statically inserted by the context configuration
     * @return The required url.
     * @throws ApsSystemException In case of error
     */
	public String createURL(IPage requiredPage, Lang requiredLang, Map params, boolean escapeAmp, HttpServletRequest request) throws ApsSystemException;
	
	public String getApplicationBaseURL(HttpServletRequest request) throws ApsSystemException;
	
	public static final String ENCODING_CHARSET = "UTF-8";
	
}