/* ====================================================================
* Limited Evaluation License:
*
* This software is open source, but licensed. The license with this package
* is an evaluation license, which may not be used for productive systems. If
* you want a full license, please contact us.
*
* The exclusive owner of this work is the OpenRate project.
* This work, including all associated documents and components
* is Copyright of the OpenRate project 2006-2015.
*
* The following restrictions apply unless they are expressly relaxed in a
* contractual agreement between the license holder or one of its officially
* assigned agents and you or your organisation:
*
* 1) This work may not be disclosed, either in full or in part, in any form
* electronic or physical, to any third party. This includes both in the
* form of source code and compiled modules.
* 2) This work contains trade secrets in the form of architecture, algorithms
* methods and technologies. These trade secrets may not be disclosed to
* third parties in any form, either directly or in summary or paraphrased
* form, nor may these trade secrets be used to construct products of a
* similar or competing nature either by you or third parties.
* 3) This work may not be included in full or in part in any application.
* 4) You may not remove or alter any proprietary legends or notices contained
* in or on this work.
* 5) This software may not be reverse-engineered or otherwise decompiled, if
* you received this work in a compiled form.
* 6) This work is licensed, not sold. Possession of this software does not
* imply or grant any right to you.
* 7) You agree to disclose any changes to this work to the copyright holder
* and that the copyright holder may include any such changes at its own
* discretion into the work
* 8) You agree not to derive other works from the trade secrets in this work,
* and that any such derivation may make you liable to pay damages to the
* copyright holder
* 9) You agree to use this software exclusively for evaluation purposes, and
* that you shall not use this software to derive commercial profit or
* support your business or personal activities.
*
* This software is provided "as is" and any expressed or impled warranties,
* including, but not limited to, the impled warranties of merchantability
* and fitness for a particular purpose are disclaimed. In no event shall
* The OpenRate Project or its officially assigned agents be liable to 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 any business interruption) however caused
* and on 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 contains portions by The Apache Software Foundation, Robert
* Half International.
* ====================================================================
*/
package OpenRate.resource;
import OpenRate.buffer.IBuffer;
import OpenRate.buffer.IConsumer;
import OpenRate.buffer.ISupplier;
import OpenRate.exception.InitializationException;
import java.util.HashMap;
/**
* The ConversionCache provides access to conversion objects, with the aim of
* making record objects lighter by re-use of shared conversion objects. The
* conversion object is particularly heavy during creation, and is used often.
* This cache therefore gives a reasonable increase in performance.
*/
public class LinkedBufferCache implements IResource
{
/**
* This is the key name we will use for referencing this object from the
* Resource context
*/
public static final String RESOURCE_KEY = "LinkedBufferCache";
// This is the symbolic name of the resource
private String symbolicName;
// cache Categories
private static HashMap<String, IBuffer> BufferList = new HashMap<>();
/**
* default constructor - protected
*/
public LinkedBufferCache()
{
super();
}
/**
* Perform whatever initialization is required of the resource.
* This method should only be called once per application instance.
*
* @param ResourceName The name of the resource in the properties
*/
@Override
public void init(String ResourceName) throws InitializationException
{
// Set the symbolic name
symbolicName = ResourceName;
if (ResourceName.equals(RESOURCE_KEY) == false)
{
throw new InitializationException("The linked buffer cache must be called " + RESOURCE_KEY,getSymbolicName());
}
}
/**
* Perform any required cleanup.
*/
@Override
public void close()
{
BufferList.clear();
}
/**
* Get the buffer supplier name
*
* @param name The name to get the buffer for
* @return The supplier for the name
* @throws ConfigurationException
*/
public ISupplier getSupplier(String name) throws InitializationException
{
if (BufferList.containsKey(name))
{
// just return it
return BufferList.get(name);
}
else
{
throw new InitializationException("Tried to get supplier <"+name+">, but this has not been stored",getSymbolicName());
}
}
/**
* Get the consumer for the given buffer name
*
* @param name The name to get the consumer for
* @return The consumer
* @throws ConfigurationException
*/
public IConsumer getConsumer(String name) throws InitializationException
{
if (BufferList.containsKey(name))
{
// just return it
return BufferList.get(name);
}
else
{
throw new InitializationException("Tried to get Consumer <"+name+">, but this has not been stored",getSymbolicName());
}
}
/**
* Put the buffer into the cache, indexing it under the given name
*
* @param name The name to store with
* @param buffer The buffer to store
* @throws ConfigurationException
*/
public void putBuffer(String name, IBuffer buffer) throws InitializationException
{
if (BufferList.containsKey(name))
{
throw new InitializationException("Buffer <"+name+"> has already been stored",getSymbolicName());
}
else
{
BufferList.put(name,buffer);
}
}
/**
* Return the resource symbolic name
*/
@Override
public String getSymbolicName()
{
return symbolicName;
}
}