Package org.pipservices3.container.refer

Class ManagedReferences

java.lang.Object

org.pipservices3.container.refer.ReferencesDecorator

org.pipservices3.container.refer.ManagedReferences

All Implemented Interfaces:

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

Direct Known Subclasses:

ContainerReferences

public class ManagedReferences
extends ReferencesDecorator
implements org.pipservices3.commons.run.IOpenable, org.pipservices3.commons.run.IClosable

Managed references that in addition to keeping and locating references can also manage their lifecycle.

• Auto-creation of missing component using available factories
• Auto-linking newly added components
• Auto-opening newly added components
• Auto-closing removed components

See Also:

• RunReferencesDecorator
• LinkReferencesDecorator
• BuildReferencesDecorator
• References

Field Summary

Fields

Modifier and Type	Field	Description
protected BuildReferencesDecorator	_builder
protected LinkReferencesDecorator	_linker
protected org.pipservices3.commons.refer.References	_references
protected RunReferencesDecorator	_runner

Constructor Summary

Constructors

Constructor	Description
ManagedReferences()	Creates a new instance of the references
ManagedReferences(Object[] tuples)	Creates a new instance of the references

Method Summary

Modifier and Type	Method	Description
void	close(String correlationId)	Closes component and frees used resources.
static ManagedReferences	fromTuples(Object... tuples)	Creates a new ManagedReferences object filled with provided key-value pairs called tuples.
boolean	isOpen()	Checks if the component is opened.
void	open(String correlationId)	Opens the component.

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

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

Methods inherited from class java.lang.Object

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

Field Details

_references

protected org.pipservices3.commons.refer.References _references

_builder

protected BuildReferencesDecorator _builder

_linker

protected LinkReferencesDecorator _linker

_runner

protected RunReferencesDecorator _runner

Constructor Details

ManagedReferences

public ManagedReferences()

Creates a new instance of the references

ManagedReferences

public ManagedReferences(Object[] tuples)

Creates a new instance of the references

Parameters:

tuples - tuples where odd values are component locators (descriptors) and even values are component references

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.

fromTuples

public static ManagedReferences fromTuples(Object... tuples)
                                    throws org.pipservices3.commons.refer.ReferenceException

Creates a new ManagedReferences object filled with provided key-value pairs called tuples. Tuples parameters contain a sequence of locator1, component1, locator2, component2, ... pairs.

Parameters:

tuples - the tuples to fill a new ManagedReferences object.

Returns:

a new ManagedReferences object.

Throws:

org.pipservices3.commons.refer.ReferenceException - when no found references.