com.elasticpath.xpf.connectivity.context

Class XPFPluginInitializationContext

java.lang.Object

com.elasticpath.xpf.connectivity.entity.XPFEntity

com.elasticpath.xpf.connectivity.context.XPFPluginInitializationContext

public class XPFPluginInitializationContext
extends XPFEntity

Plugin initialization context.

Constructor Summary

Constructors

Constructor and Description
XPFPluginInitializationContext(org.slf4j.Logger logger, Map<String,XPFPluginSetting> settings, @NonNull String pluginId, net.sf.ehcache.CacheManager cacheManager)

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(Object other)
<K,V> XPFCache<K,V>	createCache(String cacheName, int timeToLive, int timeToIdle, int maxObjects) Create a cache with the given name and configuration.
boolean	equals(Object o)
net.sf.ehcache.CacheManager	getCacheManager() The cache manager.
org.slf4j.Logger	getLogger() The plugin logger.
@NonNull String	getPluginId() The plugin ID.
Map<String,XPFPluginSetting>	getSettings() The plugin settings.
Optional<XPFPluginSettingValue>	getSingleSettingValue(String settingKey) Retrieve a single setting value for the specified setting key.
int	hashCode()
String	toString()

Methods inherited from class com.elasticpath.xpf.connectivity.entity.XPFEntity

getCustomData

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

XPFPluginInitializationContext

public XPFPluginInitializationContext(org.slf4j.Logger logger,
                                      Map<String,XPFPluginSetting> settings,
                                      @NonNull
                                      @NonNull String pluginId,
                                      net.sf.ehcache.CacheManager cacheManager)

Method Detail

createCache

public <K,V> XPFCache<K,V> createCache(String cacheName,
                                       int timeToLive,
                                       int timeToIdle,
                                       int maxObjects)

Create a cache with the given name and configuration.

Type Parameters:

K - The class implemented by the cache keys

V - The class implemented by the cache values

Parameters:

cacheName - the name of the cache to create

timeToLive - the time to live

timeToIdle - the time to idle

maxObjects - the max amount of the objects

Returns:

the new cache

getSingleSettingValue

public Optional<XPFPluginSettingValue> getSingleSettingValue(String settingKey)

Retrieve a single setting value for the specified setting key. If there are no values set or multiple values set, this method will return Optional.empty.

Parameters:

settingKey - the setting key

Returns:

the setting value

getLogger

public org.slf4j.Logger getLogger()

The plugin logger.

getSettings

public Map<String,XPFPluginSetting> getSettings()

The plugin settings.

getPluginId

@NonNull
public @NonNull String getPluginId()

The plugin ID.

getCacheManager

public net.sf.ehcache.CacheManager getCacheManager()

The cache manager.

equals

public boolean equals(Object o)

Overrides:

equals in class XPFEntity

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class XPFEntity

hashCode

public int hashCode()

Overrides:

hashCode in class XPFEntity

toString

public String toString()

Overrides:

toString in class XPFEntity