SetupController.java

/*******************************************************************************
 *  Imixs Workflow 
 *  Copyright (C) 2001, 2011 Imixs Software Solutions GmbH,  
 *  http://www.imixs.com
 *  
 *  This program is free software; you can redistribute it and/or 
 *  modify it under the terms of the GNU General Public License 
 *  as published by the Free Software Foundation; either version 2 
 *  of the License, or (at your option) any later version.
 *  
 *  This program 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 
 *  General Public License for more details.
 *  
 *  You can receive a copy of the GNU General Public
 *  License at http://www.gnu.org/licenses/gpl.html
 *  
 *  Project: 
 *  	http://www.imixs.org
 *  	http://java.net/projects/imixs-workflow
 *  
 *  Contributors:  
 *  	Imixs Software Solutions GmbH - initial API and implementation
 *  	Ralph Soika - Software Developer
 *******************************************************************************/

package org.imixs.marty.config;

import java.util.Vector;
import java.util.logging.Logger;

import javax.annotation.PostConstruct;
import javax.annotation.Resource;
import javax.ejb.EJB;
import javax.enterprise.context.ApplicationScoped;
import javax.inject.Inject;
import javax.inject.Named;

import org.imixs.marty.ejb.ProfileService;
import org.imixs.marty.model.ModelController;
import org.imixs.marty.model.ProcessController;
import org.imixs.workflow.WorkflowKernel;
import org.imixs.workflow.engine.DocumentService;
import org.imixs.workflow.engine.ModelService;
import org.imixs.workflow.engine.PropertyService;

/**
 * This Marty SetupController extends the Marty ConfigController and holds the
 * data from the configuration entity 'BASIC'. This is the general configuration
 * entity.
 * 
 * In addition the CDI bean verifies the setup of userDB and system models and
 * calls a init method if the system is not setup and the imixs.property param
 * 'setup.mode' is set to 'auto'.
 * 
 * The bean is triggered in the index.xhtml page
 * 
 * 
 * NOTE: A configuration entity provides a common way to manage application
 * specific complex config data. The configuration entity is database controlled
 * and more flexible as the file based imixs.properties provided by the Imixs
 * Workflow Engine.
 * 
 * 
 * @author rsoika
 * 
 */
@Named
@ApplicationScoped
public class SetupController extends ConfigController {

	private static final long serialVersionUID = 1L;

	public final static String CONFIGURATION_NAME = "BASIC";

	@Resource(lookup = "java:module/ModuleName")
	private String moduleName;

	@Resource(lookup = "java:app/AppName")
	private String appName;

	@Inject
	protected ModelController modelController;

	@Inject
	protected ProcessController processController;

	@EJB
	protected DocumentService documentService;

	@EJB
	protected ModelService modelService;

	@EJB
	protected PropertyService propertyService;

	@EJB
	protected ProfileService profileService;

	private static Logger logger = Logger.getLogger(SetupController.class.getName());

	public SetupController() {
		super();
		// set name
		this.setName(CONFIGURATION_NAME);
	}

	/**
	 * This method loads the config entity. If the entity did not yet exist, the
	 * method creates one.
	 * 
	 *
	 */
	@PostConstruct
	@Override
	public void init() {

		super.init();

		// if the BASIC configuration was not yet saved before we need to
		// Initialize it with a default setup
		if (!getWorkitem().hasItem(WorkflowKernel.UNIQUEID)) {
			Vector<String> v = new Vector<String>();
			v.add("IMIXS-WORKFLOW-Manager");
			v.add("IMIXS-WORKFLOW-Author");
			v.add("IMIXS-WORKFLOW-Reader");
			v.add("IMIXS-WORKFLOW-Editor");

			getWorkitem().replaceItemValue("usergroups", v);
			getWorkitem().replaceItemValue("keyenableuserdb", true);
			this.save();
		}
	}

	/**
	 * Returns the sortBy criteria form the config workitem or the default value
	 * '$modified' if not yet defined.
	 * 
	 * @return
	 */
	public String getSortBy() {
		String result=getWorkitem().getItemValueString("sortby");
		if (result.isEmpty()) {
			return "$modified";
		} else {
			return result;
		}
		
	}

	/**
	 * Returns the sortorder form the config workitem or the default value
	 * 'true' if not yet defined.
	 * 
	 * @return
	 */
	public boolean getSortReverse() {
		String result = getWorkitem().getItemValueString("sortorder");
		if ("0".equals(result)) {
			return true;
		} else {
			return false;
		}
	}

	
	/**
	 * Returns the EAR application name. Useful for JNDI lookups
	 * 
	 * @return
	 */
	public String getAppName() {
		return appName;
	}

	/**
	 * Returns the Web module name. Useful for JNDI lookups
	 * 
	 * @return
	 */
	public String getModuleName() {
		return moduleName;
	}

	/**
	 * This method resets the propertyService and modelController
	 * 
	 * @param event
	 * @throws Exception
	 */
	public void reset() throws Exception {
		// reset services....
		logger.info("Reset application cache...");
		propertyService.reset();
		profileService.reset();
		processController.reset();
	}

	public PropertyService getPropertyService() {
		return propertyService;
	}

}