NavigationManager.java

/*******************************************************************************
 * Copyright 2012 Christian Ternes and Thorsten Volland
 * 
 * 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 org.businessmanager.web.jsf.helper;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

/**
 * Contains all the path to all jsf pages of the application.
 *
 */
@Component("navigationHelper")
public class NavigationManager {
	
	@Autowired(required=true)
	private FacesContextHelper facesContext;
	
	private String contextPath;
	private boolean isRedirect = true;
	private boolean isWithoutContext = true;
	
	private static final String ADMIN_SECURITYMANAGEMENT 		= "/views/admin/securityManagement.jsf";
	private static final String ADMIN_USER_EDIT					= "/views/admin/editUser.jsf";
	private static final String ADMIN_ASSIGN_GROUPS				= "/views/admin/assignGroups.jsf";
	private static final String ADMIN_ASSIGN_USERS				= "/views/admin/assignUsers.jsf";
	private static final String ADMIN_SETTINGS					= "/views/admin/settings.jsf";
	private static final String ADMIN_COMPANY_SETTINGS			= "/views/admin/companySettings.jsf";
	private static final String CONTACTMANAGEMENT 				= "/views/contact/contactManagement.jsf";
	private static final String CONTACT_EDIT					= "/views/contact/editContact.jsf";
	private static final String CONTACT_VIEW					= "/views/contact/viewContact.jsf";
	private static final String INVOICEMANAGEMENT				= "/views/invoice/invoiceManagement.jsf";
	private static final String INVOICE_EDIT					= "/views/invoice/editInvoice.jsf";
	private static final String USER_PREFERENCES				= "/views/user/userPreferences.jsf";
	private static final String DASHBOARD						= "/views/home/dashboard.jsf";
	

	public String getContextPath() {
		contextPath = facesContext.getCurrentFacesContext().getExternalContext().getRequestContextPath();
		return contextPath;
	}
	
	/**
	 * Retrieves the path to a jsf view. The default behaviour will return the jsf view with the application context as 
	 * prefix e.g. MyApplication/views/admin.jsf.
	 * 
	 * <p/>
	 * 
	 * If {@link NavigationManager#isRedirect} is set to true, the faces redirect string will be added to the path
	 * e.g. MyApplication/views/admin.jsf?faces-redirect=true
	 * 
	 * <p/>
	 * 
	 * If {@link NavigationManager#isWithoutContext} is set to true, the application context will be removed from the path
	 * e.g.  /views/admin.jsf
	 * 
	 * <p/>
	 * {@link NavigationManager#isRedirect}=true and {@link NavigationManager#isWithoutContext}=true is mostly needed by 
	 * jsf components such as <pre><h:commandButton></pre> or <pre><h:commandLink></pre> in order to redirect correctly.
	 * 
	 * 
	 * @param relativePath
	 * @return
	 */
	private String getNavigation(String relativePath) {
		String path = relativePath;
		if(isRedirect) {
			path = appendParamInitiator(path);
			path += "faces-redirect=true";
		}
		if(!isWithoutContext) {
			if(contextPath == null) {
				getContextPath();
			}
			path = contextPath + path;
		}

		return path;
	}

	private String appendParamInitiator(String path) {
		if(path.contains("?")) {
			return path + "&";
		}
		else {
			return path + "?";
		}
	}
	
	public String getEditContact() {
		return getNavigation(CONTACT_EDIT);
	}

	public String getContactmanagement() {
		return getNavigation(CONTACTMANAGEMENT);
	}

	public String getContactView() {
		return getNavigation(CONTACT_VIEW);
	}
	
	public String getAdminSettings() {
		return getNavigation(ADMIN_SETTINGS);
	}
	
	public String getAdminCompanySettings() {
		return getNavigation(ADMIN_COMPANY_SETTINGS);
	}
	
	public String getUserPreferences() {
		return getNavigation(USER_PREFERENCES);
	}
	
	public String getAdminSecuritymanagement() {
		return getNavigation(ADMIN_SECURITYMANAGEMENT);
	}

	public String getAdminUserEdit() {
		return getNavigation(ADMIN_USER_EDIT);
	}

	public String getAdminAssignGroups() {
		return getNavigation(ADMIN_ASSIGN_GROUPS);
	}

	public String getAdminAssignUsers() {
		return getNavigation(ADMIN_ASSIGN_USERS);
	}
	
	public String getInvoicemanagement() {
		return getNavigation(INVOICEMANAGEMENT);
	}

	public String getInvoiceEdit() {
		return getNavigation(INVOICE_EDIT);
	}

	public String getDashboard() {
		return getNavigation(DASHBOARD);
	}
}