/*
* $Header: /home/cvs/jakarta-slide/src/share/org/apache/slide/common/AbstractServiceBase.java,v 1.4 2001/07/26 21:29:39 dirkv Exp $
* $Revision: 1.4 $
* $Date: 2001/07/26 21:29:39 $
*
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 1999 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. 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.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED 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 APACHE SOFTWARE FOUNDATION OR
* ITS 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.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
* [Additional notices, if required by prior licensing conditions]
*
*/
package org.apache.slide.common;
import java.util.Hashtable;
import java.util.Enumeration;
import java.util.Vector;
import org.apache.slide.util.logger.Logger;
/**
* Slide Service abstract implementation.
*
* @author <a href="mailto:remm@apache.org">Remy Maucherat</a>
* @version $Revision: 1.4 $
*/
public abstract class AbstractServiceBase implements Service {
// -------------------------------------------------------------- Constants
protected String LOG_CHANNEL = this.getClass().getName();
// ----------------------------------------------------- Instance Variables
/**
* Namespace.
*/
protected Namespace namespace;
// the scope of this store as specified in domain.xml
protected Scope scope;
// -------------------------------------------------------- Service Methods
/**
* Set the scope of the store as specified in domain.xml.
*/
public void setScope(Scope scope) {
this.scope = scope;
}
/**
* Namespace setter.
*/
public void setNamespace(Namespace namespace) {
this.namespace = namespace;
}
/**
* Logger accessor.
*/
public Logger getLogger() {
Logger logger = this.namespace.getLogger();
if (logger == null)
logger = Domain.getLogger();
return logger;
}
/**
* Initializes the service with a set of parameters. Those could be :
* <li>User name, login info
* <li>Host name on which to connect
* <li>Remote port
* <li>JDBC driver whoich is to be used :-)
* <li>Anything else ...
*
* @param parameters Hashtable containing the parameters' names
* and associated values
* @exception ServiceParameterErrorException Incorrect service parameter
* @exception ServiceParameterMissingException Service parameter missing
*/
public abstract void setParameters(Hashtable parameters)
throws ServiceParameterErrorException,
ServiceParameterMissingException;
/**
* Connects to the underlying data source (if any is needed).
*
* @exception ServiceConnectionFailedException Connection failed
*/
public abstract void connect()
throws ServiceConnectionFailedException;
/**
* Disconnects from the underlying data source.
*
* @exception ServiceDisconnectionFailedException Disconnection failed
*/
public abstract void disconnect()
throws ServiceDisconnectionFailedException;
/**
* Initializes service.
*
* @param token Namespace access token, needed if the service needs to
* access objects or data within the namespace during its initialization
* @exception ServiceInitializationFailedException May throw an exception
* if the service has already been initialized before
*/
public void initialize(NamespaceAccessToken token)
throws ServiceInitializationFailedException {
}
/**
* Deletes service underlying data source, if possible (and meaningful).
*
* @exception ServiceResetFailedException Reset failed
*/
public abstract void reset()
throws ServiceResetFailedException;
/**
* This function tells whether or not the service is connected.
*
* @return boolean true if we are connected
* @exception ServiceAccessException Service access error
*/
public abstract boolean isConnected()
throws ServiceAccessException;
/**
* Connects to the service, if we were not previously connected.
*
* @return boolean true if we were not already connected
* @exception ServiceAccessException Unspecified service access error
* @exception ServiceConnectionFailedException Connection failed
*/
public boolean connectIfNeeded()
throws ServiceConnectionFailedException, ServiceAccessException {
boolean result = true;
try {
result = !isConnected();
} catch (ServiceAccessException e) {
// Ignore : Will try to reconnect
}
if (result) {
connect();
}
return result;
}
/**
* Indicates whether or not the objects managed by this service should be
* cached. Caching is enabled by default.
*
* @return boolean True if results should be cached
*/
public boolean cacheResults() {
return true;
}
// ----------------------------------------------------- XAResource Mathods
}