ConfigurationServiceAdminImpl.java

/*
 * $Id$
 *
 * Copyright 2006, The jCoderZ.org Project. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *    * Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *    * Redistributions in binary form must reproduce the above
 *      copyright notice, this list of conditions and the following
 *      disclaimer in the documentation and/or other materials
 *      provided with the distribution.
 *    * Neither the name of the jCoderZ.org Project nor the names of
 *      its contributors may be used to endorse or promote products
 *      derived from this software without specific prior written
 *      permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.jcoderz.commons.config;

import java.util.HashSet;
import java.util.Iterator;
import java.util.Set;
import java.util.logging.Logger;

import org.jcoderz.commons.ArgumentMalformedException;

/**
 * Implementation of the ConfigurationService business methods of the
 * administration interface.
 *
 * This class holds all business logic of the service related to administrative
 * tasks like getting all configuration keys or single configuration values.
 * On this level only primitve types String, int, long and boolean are used.
 * The wellformed and complex typed interfaces for the specific services are
 * using this more simple interface.
 *
 * Implementing the business interface ConfigurationServiceAdminInterface and
 * thus the ConfigurationServiceCommonInterface.
 *
 * IMPORTANT:
 * Because of XDoclet Bug in current version, we define deligators to the super
 * class with ejb-tags here.
 * These should be deleted if XDoclet is fixed.
 *
 */
public class ConfigurationServiceAdminImpl
      extends ConfigurationServiceCommonImpl
      implements ConfigurationServiceAdminInterface
{
   /** class name for use in logging. */
   private static final String CLASSNAME
         = ConfigurationServiceAdminImpl.class.getName();

   /** Class logger. */
   private static final Logger logger = Logger.getLogger(CLASSNAME);

   /**
    * Name of a parameter in a few get.. methods.
    * This member exists only for checkstyles's sake.
    */
//   private static final transient
//      String PARAM_KEY_OF_GET_METHODS = "key";


   /** {@inheritDoc} 
    *
    * @ejb.interface-method view-type="remote"
    * @ejb.transaction type="Required"
    * @ejb.permission role-name="Admin,Observer"
    */
   public Set getKeys ()
         throws ConfigurationInitializationFailedException
   {
      final Set keys = getConfigurationCacheCurrent().getKeys();
      final Set result = new HashSet();
      for (final Iterator iter = keys.iterator(); iter.hasNext();)
      {
         try
         {
            result.add(ConfigurationKey.fromString((String) iter.next()));
         }
         catch (Exception e)
         {
            throw new ConfigurationInitializationFailedException(e);
         }
      }
      return result;
   }

   // IMPORTANT:
   // Because of XDoclet Bug in current version, we define the deligators
   // here with ejb-tags.
   // Normally the implementation from CommonImpl is already inherited.
   // FIXME: This should be changed when XDoclet BugFix is available.
   //

   /**
    * {@inheritDoc}
    *
    * @ejb.interface-method view-type="remote"
    * @ejb.transaction type="Required"
    * @ejb.permission role-name="Admin,Observer"
    */
   public boolean getBoolean (ConfigurationKey key)
         throws ConfigurationValueNotFoundException,
               ConfigurationTypeConversionFailedException,
               ArgumentMalformedException
   {
      return super.getBoolean(key);
   }


   /**
    * {@inheritDoc}
    *
    * @ejb.interface-method view-type="remote"
    * @ejb.transaction type="Required"
    * @ejb.permission role-name="Admin,Observer"
    */
   public int getInt (ConfigurationKey key)
         throws ConfigurationValueNotFoundException,
               ConfigurationTypeConversionFailedException,
               ArgumentMalformedException
   {
      return super.getInt(key);
   }


   /**
    * {@inheritDoc}
    *
    * @ejb.interface-method view-type="remote"
    * @ejb.transaction type="Required"
    * @ejb.permission role-name="Admin,Observer"
    */
   public long getLong (ConfigurationKey key)
         throws ConfigurationValueNotFoundException,
               ConfigurationTypeConversionFailedException,
               ArgumentMalformedException
   {
      return super.getLong(key);
   }


   /**
    * {@inheritDoc}
    *
    * @ejb.interface-method view-type="remote"
    * @ejb.transaction type="Required"
    * @ejb.permission role-name="Admin,Observer"
    */
   public String getString (ConfigurationKey key)
         throws ConfigurationValueNotFoundException,
                ArgumentMalformedException
   {
      return super.getString(key);
   }
}