MailAttachmentCacheService.java

/*
 * Copyright (c) 2002-2022, City of Paris
 * 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
 *     and the following disclaimer.
 *
 *  2. Redistributions in binary form must reproduce the above copyright notice
 *     and the following disclaimer in the documentation and/or other materials
 *     provided with the distribution.
 *
 *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' 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 COPYRIGHT HOLDERS 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 COPYRIGHT HOLDERS OR 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.
 *
 * License 1.0
 */
package fr.paris.lutece.portal.service.mail;

import fr.paris.lutece.portal.service.cache.AbstractCacheableService;
import fr.paris.lutece.portal.service.cache.ICacheKeyService;

import java.util.HashMap;

/**
 * MailAttachment CacheService
 */
public final class MailAttachmentCacheService extends AbstractCacheableService
{
    private static MailAttachmentCacheService _singleton;
    private static ICacheKeyService _cksMailAttachment = new MailAttachmentCacheKeyService( );
    private static final String SERVICE_NAME = "Mail Attachment Cache Service";

    /**
     * Instantiates a new mail attachment cache service.
     */
    private MailAttachmentCacheService( )
    {
        initCache( );
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getName( )
    {
        return SERVICE_NAME;
    }

    /**
     *
     * @return an instance of MailAttachmentCacheService
     */
    public static synchronized MailAttachmentCacheService getInstance( )
    {
        if ( _singleton == null )
        {
            _singleton = new MailAttachmentCacheService( );
        }

        return _singleton;
    }

    /**
     * return the cache key associated to the url value
     * 
     * @param strValue
     *            the value
     * @return the cache key associated to the url value
     */
    public String getKey( String strValue )
    {
        HashMap<String, String> htParam = new HashMap<>( );
        htParam.put( MailAttachmentCacheKeyService.MARK_URL, strValue );

        return _cksMailAttachment.getKey( htParam, 0, null );
    }
}