Package org.pipservices3.container.refer

Class RunReferencesDecorator

java.lang.Object

org.pipservices3.container.refer.ReferencesDecorator

org.pipservices3.container.refer.RunReferencesDecorator

All Implemented Interfaces:

org.pipservices3.commons.refer.IReferences, org.pipservices3.commons.run.IClosable, org.pipservices3.commons.run.IOpenable

public class RunReferencesDecorator
extends ReferencesDecorator
implements org.pipservices3.commons.run.IOpenable

References decorator that automatically opens to newly added components that implement IOpenable interface and closes removed components that implement IClosable interface.

Constructor Summary

Constructors

Constructor	Description
RunReferencesDecorator()	Creates a new instance of the decorator.
RunReferencesDecorator(org.pipservices3.commons.refer.IReferences baseReferences)	Creates a new instance of the decorator.
RunReferencesDecorator(org.pipservices3.commons.refer.IReferences nextReferences, org.pipservices3.commons.refer.IReferences topReferences)	Creates a new instance of the decorator.

Method Summary

Modifier and Type	Method	Description
void	close(String correlationId)	Closes component and frees used resources.
boolean	isOpen()	Checks if the component is opened.
void	open(String correlationId)	Opens the component.
void	put(Object locator, Object component)	Puts a new reference into this reference map.
Object	remove(Object locator)	Removes a previously added reference that matches specified locator.
List<Object>	removeAll(Object locator)	Removes all component references that match the specified locator.

Methods inherited from class org.pipservices3.container.refer.ReferencesDecorator

find, find, getAll, getAllLocators, getNextReferences, getOneOptional, getOneOptional, getOneRequired, getOneRequired, getOptional, getOptional, getRequired, getRequired, getTopReferences, setNextReferences, setTopReferences

Methods inherited from class java.lang.Object

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

Constructor Details

RunReferencesDecorator

public RunReferencesDecorator()

Creates a new instance of the decorator.

RunReferencesDecorator

public RunReferencesDecorator(org.pipservices3.commons.refer.IReferences baseReferences)

Creates a new instance of the decorator.

Parameters:

baseReferences - the next references or decorator in the chain.

RunReferencesDecorator

public RunReferencesDecorator(org.pipservices3.commons.refer.IReferences nextReferences,
 org.pipservices3.commons.refer.IReferences topReferences)

Creates a new instance of the decorator.

Parameters:

nextReferences - the next references or decorator in the chain.

topReferences - the decorator at the top of the chain.

Method Details

isOpen

public boolean isOpen()

Checks if the component is opened.

Specified by:

isOpen in interface org.pipservices3.commons.run.IOpenable

Returns:

true if the component has been opened and false otherwise.

open

public void open(String correlationId)
          throws org.pipservices3.commons.errors.ApplicationException

Opens the component.

Specified by:

open in interface org.pipservices3.commons.run.IOpenable

Parameters:

correlationId - (optional) transaction id to trace execution through call chain.

Throws:

org.pipservices3.commons.errors.ApplicationException - when error occured.

close

public void close(String correlationId)
           throws org.pipservices3.commons.errors.ApplicationException

Closes component and frees used resources.

Specified by:

close in interface org.pipservices3.commons.run.IClosable

Parameters:

correlationId - (optional) transaction id to trace execution through call chain.

Throws:

org.pipservices3.commons.errors.ApplicationException - when error occured.

put

public void put(Object locator,
 Object component)
         throws org.pipservices3.commons.errors.ApplicationException

Puts a new reference into this reference map.

Specified by:

put in interface org.pipservices3.commons.refer.IReferences

Overrides:

put in class ReferencesDecorator

Parameters:

locator - a locator to find the reference by.

component - a component reference to be added.

Throws:

org.pipservices3.commons.errors.ApplicationException - when error occured.

remove

public Object remove(Object locator)
              throws org.pipservices3.commons.errors.ApplicationException

Removes a previously added reference that matches specified locator. If many references match the locator, it removes only the first one. When all references shall be removed, use removeAll() method instead.

Specified by:

remove in interface org.pipservices3.commons.refer.IReferences

Overrides:

remove in class ReferencesDecorator

Parameters:

locator - a locator to remove reference

Returns:

the removed component reference.

Throws:

org.pipservices3.commons.errors.ApplicationException - when error occured.

See Also:

• removeAll(Object)

removeAll

public List<Object> removeAll(Object locator)
                       throws org.pipservices3.commons.errors.ApplicationException

Removes all component references that match the specified locator.

Specified by:

removeAll in interface org.pipservices3.commons.refer.IReferences

Overrides:

removeAll in class ReferencesDecorator

Parameters:

locator - the locator to remove references by.

Returns:

a list, containing all removed references.

Throws:

org.pipservices3.commons.errors.ApplicationException - when error occured.