/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * Copyright (c) 2007-2011, Red Hat Inc. or third-party contributors as
 * indicated by the @author tags or express copyright attribution
 * statements applied by the authors.  All third-party contributions are
 * distributed under license by Red Hat Inc.
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 *
 * 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 Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 */
package org.hibernate.cache.ehcache;

import static org.jboss.logging.Logger.Level.WARN;

import org.hibernate.internal.CoreMessageLogger;

import org.jboss.logging.LogMessage;
import org.jboss.logging.Message;
import org.jboss.logging.MessageLogger;

/**
 * The jboss-logging {@link MessageLogger} for the hibernate-ehcache module.  It reserves message ids ranging from
 * 20001 to 25000 inclusively.
 * <p/>
 * New messages must be added after the last message defined to ensure message codes are unique.
 */
@MessageLogger( projectCode = "HHH" )
public interface EhCacheMessageLogger extends CoreMessageLogger {

    @LogMessage( level = WARN )
    @Message( value = "Attempt to restart an already started EhCacheProvider. Use sessionFactory.close() between repeated calls to "
                      + "buildSessionFactory. Using previously created EhCacheProvider. If this behaviour is required, consider "
                      + "using net.sf.ehcache.hibernate.SingletonEhCacheProvider.", id = 20001 )
    void attemptToRestartAlreadyStartedEhCacheProvider();

    @LogMessage( level = WARN )
    @Message( value = "Could not find configuration [%s]; using defaults.", id = 20002 )
    void unableToFindConfiguration( String name );

    @LogMessage( level = WARN )
    @Message( value = "Could not find a specific ehcache configuration for cache named [%s]; using defaults.", id = 20003 )
    void unableToFindEhCacheConfiguration( String name );

    @LogMessage( level = WARN )
    @Message( value = "A configurationResourceName was set to %s but the resource could not be loaded from the classpath. Ehcache will configure itself using defaults.", id = 20004 )
    void unableToLoadConfiguration( String configurationResourceName );

    @LogMessage( level = WARN )
    @Message( value = "The default cache value mode for this Ehcache configuration is \"identity\". This is incompatible with clustered "
								+ "Hibernate caching - the value mode has therefore been switched to \"serialization\"", id = 20005 )
    void incompatibleCacheValueMode( );

    @LogMessage( level = WARN )
    @Message( value = "The value mode for the cache[%s] is \"identity\". This is incompatible with clustered Hibernate caching - "
									+ "the value mode has therefore been switched to \"serialization\"", id = 20006 )
    void incompatibleCacheValueModePerCache( String cacheName );
    @LogMessage( level = WARN )
    @Message( value = "read-only cache configured for mutable entity [%s]", id = 20007 )
    void readOnlyCacheConfiguredForMutableEntity( String entityName );

    @LogMessage( level = WARN )
    @Message( value = "Cache[%s] Key[%s] Lockable[%s]\n"
                        + "A soft-locked cache entry was expired by the underlying Ehcache. "
                        + "If this happens regularly you should consider increasing the cache timeouts and/or capacity limits", id = 20008 )
    void softLockedCacheExpired( String regionName, Object key, String lock);


}