ICApplicationBindingBusinessBean.java

/*
 * $Id: ICApplicationBindingBusinessBean.java,v 1.10 2009/05/21 12:47:47 laddi Exp $
 * Created on Oct 7, 2005
 *
 * Copyright (C) 2005 Idega Software hf. All Rights Reserved.
 *
 * This software is the proprietary information of Idega hf.
 * Use is subject to license terms.
 */
package com.idega.core.business;

import java.io.IOException;
import java.util.Collection;
import java.util.Iterator;
import java.util.Set;
import java.util.TreeSet;
import javax.ejb.CreateException;
import javax.ejb.FinderException;
import javax.ejb.RemoveException;
import com.idega.business.IBOServiceBean;
import com.idega.core.data.ICApplicationBinding;
import com.idega.core.data.ICApplicationBindingBMPBean;
import com.idega.core.data.ICApplicationBindingHome;
import com.idega.data.IDOLookup;
import com.idega.data.IDOLookupException;
import com.idega.util.StringHandler;

/**
 * 
 * Do not use this class directly, use IWMainApplicationSettings.
 * 
 */



public class ICApplicationBindingBusinessBean extends IBOServiceBean  implements ICApplicationBindingBusiness{

	private static final int MAX_KEY_LENGTH = ICApplicationBindingBMPBean.MAX_KEY_LENGTH; 
	
	private ICApplicationBindingHome applicationBindingHome = null;
	
	/**
	 * 
	 * Do not use this method, use IWMainApplicationSettings.
	 * 
	 * Returns the corresponding value to the specified key elso null if the key is not found.
	 * 
	 * Checks first if there is an entry in the application binding table. 
	 * If not the application settings are looked up: 
	 * If a value is found a corresponding application binding is created.
	 */
	public String get(String key) throws IOException {
		try {
			return getKey(key);
		}
		catch (IDOLookupException ex) {
			throw new IOException(ex.getMessage());
		}	
	}

	/**
	 * 
	 * Do not use this method, use IWMainApplicationSettings.
	 * 
	 * Puts an entry into the application binding table.
	 * If the value is null an existing entry is removed.
	 * 
	 * @return the old value or null if there was no entry
	 * 
	 */
	public String put(String key, String value) throws IOException {
		return put(key, value, null);
	}
	
	public String put(String key, String value, String type) throws IOException {
		try {
			return putKeyValue(key, value, type);
		}
		catch (IDOLookupException ex) {
			throw new IOException(ex.getMessage());
		}
		catch (CreateException ex) {
			throw new IOException(ex.getMessage());
		}
		catch (RemoveException ex) {
			throw new IOException(ex.getMessage());
		}
	}
	
	/**
	 * 
	 * Do not use this method, use IWMainApplicationSettings.
	 * 
	 */
	public String remove(String key) throws IOException {
		return put(key, null);
	}
	
	
	/**
	 * 
	 * Do not use this method, use IWMainApplicationSettings.
	 *  
	 * Returns a set of the keys, elements are string objects
	 */
	public Set keySet() throws IOException {
		try {
			Collection coll = getICApplicationBindingHome().findAll();
			if (coll == null) {
				return new TreeSet();
			}
			// we are keeping things simple, the list is not very large
			Set keyList = new TreeSet();
			Iterator iterator = coll.iterator();
			while (iterator.hasNext()) {
				ICApplicationBinding binding = (ICApplicationBinding) iterator.next();
				keyList.add(binding.getKey());
			}
			return keyList;
		}
		catch (IDOLookupException ex) {
			throw new IOException(ex.getMessage());
		}
		catch (FinderException ex) {
			throw new IOException(ex.getMessage());
		}
	}
	
	
	private String getKey(String key) throws IDOLookupException {
		String shortKey = StringHandler.shortenToLength(key, MAX_KEY_LENGTH);
		try {
			// fetch the value
			return getICApplicationBinding(shortKey).getValue();
		}
		catch (FinderException ex) {
			// failed?
			return null;
		}
	}
	
	private String putKeyValue(String key, String value, String type) throws CreateException, IDOLookupException, RemoveException {
		key = StringHandler.shortenToLength(key, MAX_KEY_LENGTH);
		ICApplicationBinding applicationBinding = null;
		String oldValue = null;
		// find an existing entry
		try {
			applicationBinding = getICApplicationBinding(key);
			oldValue = applicationBinding.getValue();
		} 
		catch (FinderException finderException) {
			// not found?
			// create a new entry (does not create an entry if the value is null)
			createApplicationBindingCheckValue(key, value, type);
			return null;
		}
		// set the value of the existing entry
		if (value == null) {
			// remove the entry if the value is set to null
			applicationBinding.remove();
			return oldValue;
		}
		// set the value
		applicationBinding.setValue(value);
		applicationBinding.store();
		return oldValue;
	}
	
	private ICApplicationBinding createApplicationBindingCheckValue(String key, String value, String type) throws IDOLookupException, CreateException {
		// do not create an application binding without a value
		if (value == null) {
			return null;
		}
		ICApplicationBinding applicationBinding = getICApplicationBindingHome().create();
		applicationBinding.setKey(key);
		applicationBinding.setValue(value);
		applicationBinding.setBindingType(type);
		applicationBinding.store();
		return applicationBinding;
	}
	
	private ICApplicationBindingHome getICApplicationBindingHome() throws IDOLookupException {
		if (this.applicationBindingHome == null) {
			this.applicationBindingHome = (ICApplicationBindingHome) IDOLookup.getHome(ICApplicationBinding.class);
		}
		return this.applicationBindingHome;
	}
	
	private ICApplicationBinding getICApplicationBinding(String key) throws IDOLookupException, FinderException {
		return getICApplicationBindingHome().findByPrimaryKey(key);
	}
		
}