net.e6tech.elements.common.resources

Class Resources

java.lang.Object

net.e6tech.elements.common.resources.Resources

All Implemented Interfaces:

java.lang.AutoCloseable, ResourcePool

public class Resources
extends java.lang.Object
implements java.lang.AutoCloseable, ResourcePool

A Resources instance is use to manage resource level injection and resources. Rules for injection. Only configure injection for instances that are configured during program start up. During runtime, it is better to store resources via put. This prevents a overly complicated dependency wiring. For dynamically created instances, really the only needed injected resource is the Resources instance and resources provided by ResourceProviders. Created by futeh.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map	configuration
protected net.e6tech.elements.common.resources.ResourcesState	state

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Resources()

Method Summary

Modifier and Type	Method and Description
void	abort()
void	addConfiguration(java.util.Map configuration)
void	addConfiguration(java.lang.String key, java.lang.Object object)
void	addModule(InjectionModule module)
void	addResourceProvider(ResourceProvider resourceProvider)
void	afterCommit(AfterCommit afterCommit)
void	afterCommit(java.lang.Runnable runnable)
<T> T	bind(java.lang.Class<T> cls, T resource)
void	bindClass(java.lang.Class cls, java.lang.Class service) This method is mostly used for unit testing.
<T> T	bindNamedInstance(java.lang.String name, java.lang.Class<T> cls, T resource)
void	close()
<R> R	commit()
<T> T	computeIfAbsent(java.lang.Class<T> key, java.util.function.Function<java.lang.String,T> mappingFunction)
<T> T	computeIfAbsent(java.lang.String key, java.util.function.Function<java.lang.String,T> mappingFunction)
<T> T	get(java.lang.Class<T> cls)
<T> T	get(java.lang.Enum value)
<T> T	get(java.lang.String name)
<T> Binding<T>	getBinding(java.lang.Class<T> cls)
<T> T	getBoundNamedInstance(java.lang.String name)
protected java.util.Map<java.lang.String,java.lang.Object>	getConfiguration()
<T> T	getConfiguration(java.lang.Class<T> key)
<T> T	getConfiguration(java.lang.Class<T> key, T defaultValue)
<T> T	getConfiguration(java.lang.String key)
<T> T	getConfiguration(java.lang.String key, T defaultValue)
<T> T	getInstance(java.lang.Class<T> cls)
InjectionModule	getModule()
<T extends Pluggable> T	getPlugin(java.lang.Class c1, java.lang.String n1, java.lang.Class c2, java.lang.Object... args) Plugins are identified by class, a name and then a particular plugin class.
<T extends Pluggable> T	getPlugin(java.lang.Class c1, java.lang.String n1, java.lang.Class c2, java.lang.String n2, java.lang.Class c3, java.lang.Object... args)
<T extends Pluggable> T	getPlugin(Path<T> path, java.lang.Object... args)
ResourceManager	getResourceManager()
long	getTimeout()
long	getTimeoutExtension()
<T> T	getVariable(java.lang.String variable)
boolean	hasInstance(java.lang.Class cls)
<T> T	inject(T object)
boolean	isAborted()
<T> boolean	isBound(java.lang.Class<T> cls)
boolean	isClosed()
boolean	isCommitted()
boolean	isDiscarded()
boolean	isOpened()
void	onAbort(OnAbort onAbort)
void	onAbort(java.lang.Runnable runnable)
void	onClosed(OnClosed onClosed)
void	onClosed(java.lang.Runnable runnable)
void	onCommit(OnCommit onCommit)
void	onCommit(java.lang.Runnable runnable)
void	onOpen()
void	onOpen(OnOpen onOpen)
void	onOpen(java.lang.Runnable runnable)
<T extends Provision> T	provision()
<T> Resources	put(java.lang.Class<T> cls, T obj)
<T> Resources	put(java.lang.Enum value)
<T> Resources	put(java.lang.String name, T obj)
<T> T	rebind(java.lang.Class<T> cls, T resource)
<T> T	rebindNamedInstance(java.lang.String name, java.lang.Class<T> cls, T resource)
boolean	remove(ResourceProvider provider)
protected <Res extends Resources,R> R	replay(java.lang.Throwable th, net.e6tech.elements.common.resources.Resources.Replay<Res,R> replay)
void	setTimeout(long timeout)
void	setTimeoutExtension(long timeout)
<Res extends Resources> void	submit(Transactional.ConsumerWithException<Res> work)
<Res extends Resources,R> R	submit(Transactional.FunctionWithException<Res,R> work)
<T> T	tryBind(java.lang.Class<T> cls, java.util.concurrent.Callable<T> callable)
<T> T	unbind(java.lang.Class<T> cls)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.e6tech.elements.common.resources.ResourcePool

findById, getBean, getBean, getNotificationCenter, mapById, newInstance

Field Detail

state

protected net.e6tech.elements.common.resources.ResourcesState state

configuration

protected java.util.Map configuration

Constructor Detail

Resources

protected Resources()

Method Detail

getTimeout

public long getTimeout()

setTimeout

public void setTimeout(long timeout)

getTimeoutExtension

public long getTimeoutExtension()

setTimeoutExtension

public void setTimeoutExtension(long timeout)

isCommitted

public boolean isCommitted()

isOpened

public boolean isOpened()

isAborted

public boolean isAborted()

isClosed

public boolean isClosed()

isDiscarded

public boolean isDiscarded()

addResourceProvider

public void addResourceProvider(ResourceProvider resourceProvider)

onCommit

public void onCommit(OnCommit onCommit)

onCommit

public void onCommit(java.lang.Runnable runnable)

afterCommit

public void afterCommit(AfterCommit afterCommit)

afterCommit

public void afterCommit(java.lang.Runnable runnable)

onOpen

public void onOpen(OnOpen onOpen)

onOpen

public void onOpen(java.lang.Runnable runnable)

onAbort

public void onAbort(OnAbort onAbort)

onAbort

public void onAbort(java.lang.Runnable runnable)

onClosed

public void onClosed(OnClosed onClosed)

onClosed

public void onClosed(java.lang.Runnable runnable)

remove

public boolean remove(ResourceProvider provider)

getResourceManager

public ResourceManager getResourceManager()

Specified by:

getResourceManager in interface ResourcePool

getPlugin

public <T extends Pluggable> T getPlugin(java.lang.Class c1,
                                         java.lang.String n1,
                                         java.lang.Class c2,
                                         java.lang.Object... args)

Plugins are identified by class, a name and then a particular plugin class. The argument are injected into the plugin. For example, let say there is a class called Partner and it may be associated with several plugin types. Furthermore, the plugins associated with a Partner may vary based on the partner. To create the plugin, one may search based on Partner.class, partner name, plugin class and a list of arguments to be injected into the plugin.

Type Parameters:

T -

Parameters:

c1 -

n1 -

c2 -

args -

Returns:

getPlugin

public <T extends Pluggable> T getPlugin(java.lang.Class c1,
                                         java.lang.String n1,
                                         java.lang.Class c2,
                                         java.lang.String n2,
                                         java.lang.Class c3,
                                         java.lang.Object... args)

getPlugin

public <T extends Pluggable> T getPlugin(Path<T> path,
                                         java.lang.Object... args)

put

public <T> Resources put(java.lang.Class<T> cls,
                         T obj)

put

public <T> Resources put(java.lang.String name,
                         T obj)

put

public <T> Resources put(java.lang.Enum value)

computeIfAbsent

public <T> T computeIfAbsent(java.lang.String key,
                             java.util.function.Function<java.lang.String,T> mappingFunction)

computeIfAbsent

public <T> T computeIfAbsent(java.lang.Class<T> key,
                             java.util.function.Function<java.lang.String,T> mappingFunction)

getVariable

public <T> T getVariable(java.lang.String variable)

get

public <T> T get(java.lang.Class<T> cls)

get

public <T> T get(java.lang.String name)

get

public <T> T get(java.lang.Enum value)

getModule

public InjectionModule getModule()

addModule

public void addModule(InjectionModule module)

getBinding

public <T> Binding<T> getBinding(java.lang.Class<T> cls)

tryBind

public <T> T tryBind(java.lang.Class<T> cls,
                     java.util.concurrent.Callable<T> callable)

isBound

public <T> boolean isBound(java.lang.Class<T> cls)

bind

public <T> T bind(java.lang.Class<T> cls,
                  T resource)

Specified by:

bind in interface ResourcePool

rebind

public <T> T rebind(java.lang.Class<T> cls,
                    T resource)

Specified by:

rebind in interface ResourcePool

unbind

public <T> T unbind(java.lang.Class<T> cls)

Specified by:

unbind in interface ResourcePool

bindClass

public void bindClass(java.lang.Class cls,
                      java.lang.Class service)

This method is mostly used for unit testing. the bound class disappear once resources is closed. Unless you know what you are doing, please don't use.

Specified by:

bindClass in interface ResourcePool

Parameters:

cls - Class to bind to

service - service class

bindNamedInstance

public <T> T bindNamedInstance(java.lang.String name,
                               java.lang.Class<T> cls,
                               T resource)

Specified by:

bindNamedInstance in interface ResourcePool

rebindNamedInstance

public <T> T rebindNamedInstance(java.lang.String name,
                                 java.lang.Class<T> cls,
                                 T resource)

Specified by:

rebindNamedInstance in interface ResourcePool

getBoundNamedInstance

public <T> T getBoundNamedInstance(java.lang.String name)

inject

public <T> T inject(T object)

Specified by:

inject in interface ResourcePool

hasInstance

public boolean hasInstance(java.lang.Class cls)

getInstance

public <T> T getInstance(java.lang.Class<T> cls)
                  throws InstanceNotFoundException

Throws:

InstanceNotFoundException

getConfiguration

protected java.util.Map<java.lang.String,java.lang.Object> getConfiguration()

getConfiguration

public <T> T getConfiguration(java.lang.String key)

getConfiguration

public <T> T getConfiguration(java.lang.String key,
                              T defaultValue)

getConfiguration

public <T> T getConfiguration(java.lang.Class<T> key)

getConfiguration

public <T> T getConfiguration(java.lang.Class<T> key,
                              T defaultValue)

addConfiguration

public void addConfiguration(java.lang.String key,
                             java.lang.Object object)

addConfiguration

public void addConfiguration(java.util.Map configuration)

onOpen

public void onOpen()

replay

protected <Res extends Resources,R> R replay(java.lang.Throwable th,
                                             net.e6tech.elements.common.resources.Resources.Replay<Res,R> replay)

submit

public <Res extends Resources> void submit(Transactional.ConsumerWithException<Res> work)

submit

public <Res extends Resources,R> R submit(Transactional.FunctionWithException<Res,R> work)

commit

public <R> R commit()

abort

public void abort()

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception

provision

public <T extends Provision> T provision()