Package dev.getelements.elements.rt.transact

Class TransactionalResourceService

java.lang.Object

dev.getelements.elements.rt.transact.TransactionalResourceService

All Implemented Interfaces:

ResourceService

public class TransactionalResourceService
extends Object
implements ResourceService

Nested Class Summary

Nested classes/interfaces inherited from interface dev.getelements.elements.rt.ResourceService

ResourceService.Listing, ResourceService.ResourceAcquisition, ResourceService.ResourceTransaction, ResourceService.Unlink

Constructor Summary

Constructors

Constructor	Description
TransactionalResourceService()

Method Summary

Modifier and Type	Method	Description
ResourceService.ResourceAcquisition	acquire(ResourceId resourceId)	Acquires a Resource guaranteeing it will remain in-memory until the resource is released.
ResourceService.ResourceAcquisition	acquire(Path path)	Acquires a Resource guaranteeing it will remain in-memory until the resource is released.
ResourceService.ResourceTransaction	acquireWithTransaction(ResourceId resourceId)	Opens a ResourceService.ResourceTransaction.
ResourceService.ResourceTransaction	acquireWithTransaction(Path path)	Opens a ResourceService.ResourceTransaction.
ResourceService.ResourceAcquisition	addAndAcquireResource(Path path, Resource resource)	Adds an acquires this Resource.
void	addAndReleaseResource(Path path, Resource resource)	Adds a Resource to this resource service.
boolean	exists(ResourceId resourceId)	Without affecting acquisition or releases, this performs a simple check to see if the Resource with the supplied ResourceId exists in this ResourceService.
long	getInMemoryResourceCount()
NodeId	getNodeId()
TransactionalResourceServicePersistence	getPersistence()
ResourceLoader	getResourceLoader()
void	link(ResourceId sourceResourceId, Path destination)	Given the provided ResourceId, this will create an additional alias for the provided destination Path.
void	linkPath(Path source, Path destination)	Given the provided Path, this will create an additional Path alias for the provided source.
Stream<ResourceService.Listing>	listStream(Path path)	Returns a Stream<ResourceId> matching the provided Path.
Stream<Resource>	removeAllResources()	Removes all resources from.
Resource	removeResource(ResourceId resourceId)	Removes a Resource instance from this resource service.
List<ResourceId>	removeResources(Path path, int max, Consumer<Resource> removed)	Removes all Resources linked with the provided Path.
void	setNodeId(NodeId nodeId)
void	setPersistence(TransactionalResourceServicePersistence persistence)
void	setResourceLoader(ResourceLoader resourceLoader)
void	start()	Called on start-up to ensure that the ResourceService has created and started any internal processes that it may need to perform its work.
void	stop()	Releases all memory associated with this ResourceService.
List<ResourceService.Unlink>	unlinkMultiple(Path path, int max, Consumer<Resource> removed)	Unlinks multiple Resources.
ResourceService.Unlink	unlinkPath(Path path, Consumer<Resource> removed)	Unlinks the Resource for the provided Path.

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.getelements.elements.rt.ResourceService

destroy, destroy, destroyResources, removeAndCloseAllResources, removeResource, removeResources, unlinkMultiple, unlinkPath

Constructor Details

TransactionalResourceService

public TransactionalResourceService()

Method Details

start

public void start()

Description copied from interface: ResourceService

Called on start-up to ensure that the ResourceService has created and started any internal processes that it may need to perform its work.

Specified by:

start in interface ResourceService

stop

public void stop()

Description copied from interface: ResourceService

Releases all memory associated with this ResourceService. The actual action that happens here is dependent on the specific implementation. For in-memory implementations, this will simply close all resources and exit. For persistence-backed implementations this should flush all resources to disk before closing all. Once closed this instance may only be used after it has been restarted.

Specified by:

stop in interface ResourceService

exists

public boolean exists(ResourceId resourceId)

Description copied from interface: ResourceService

Without affecting acquisition or releases, this performs a simple check to see if the Resource with the supplied ResourceId exists in this ResourceService.

Specified by:

exists in interface ResourceService

Parameters:

resourceId - the ResourceId

Returns:

true if exists, false otherwise.

acquire

public ResourceService.ResourceAcquisition acquire(Path path)

Description copied from interface: ResourceService

Acquires a Resource guaranteeing it will remain in-memory until the resource is released.

Specified by:

acquire in interface ResourceService

Returns:

the ResourceService.ResourceAcquisition

acquire

public ResourceService.ResourceAcquisition acquire(ResourceId resourceId)

Description copied from interface: ResourceService

Acquires a Resource guaranteeing it will remain in-memory until the resource is released.

Specified by:

acquire in interface ResourceService

Returns:

the ResourceService.ResourceAcquisition

acquireWithTransaction

public ResourceService.ResourceTransaction acquireWithTransaction(Path path)

Description copied from interface: ResourceService

Opens a ResourceService.ResourceTransaction.

Specified by:

acquireWithTransaction in interface ResourceService

Returns:

the ResourceService.ResourceTransaction

acquireWithTransaction

public ResourceService.ResourceTransaction acquireWithTransaction(ResourceId resourceId)

Description copied from interface: ResourceService

Opens a ResourceService.ResourceTransaction.

Specified by:

acquireWithTransaction in interface ResourceService

Returns:

the ResourceService.ResourceTransaction

addAndAcquireResource

public ResourceService.ResourceAcquisition addAndAcquireResource(Path path,
 Resource resource)

Description copied from interface: ResourceService

Adds an acquires this Resource. This is used for the initial insert into the ResourceService. If linking to an additional Path is necessary, then the methods ResourceService.linkPath(Path, Path) or ResourceService.link(ResourceId, Path) must be used to perform additional aliasing operations. It is strongly recommended that newly inserted Resource instances be given a globally unique path initially, which can be thought of as the primary path, and then subsequent aliases or links be maintained, even if those particular Paths may collide. This is only safe to use with freshly created Resource instances whose ResourceId has never before been seen by the system.

Specified by:

addAndAcquireResource in interface ResourceService

Parameters:

path -

resource -

Returns:

the managed version of the supplied Resource

addAndReleaseResource

public void addAndReleaseResource(Path path,
 Resource resource)

Description copied from interface: ResourceService

Adds a Resource to this resource service. This is used for the initial insert into the ResourceService. If linking to an additional Path is necessary, then the methods ResourceService.linkPath(Path, Path) or ResourceService.link(ResourceId, Path) must be used to perform additional aliasing operations. It is strongly recommended that newly inserted Resource instances be given a globally unique path initially, which can be thought of as the primary path, and then subsequent aliases or links be maintained, even if those particular Paths may collide. Once a Resource is passed ot this method, this ResourceService will take ownership of it. This means the the Resource may be closed after this call. Therefore, subsequent operations may require the Resource be fetched from serialization later for subsequent operations.

Specified by:

addAndReleaseResource in interface ResourceService

Parameters:

path - the initial path for the Resource

resource - the resource to insert

listStream

public Stream<ResourceService.Listing> listStream(Path path)

Description copied from interface: ResourceService

Returns a Stream<ResourceId> matching the provided Path.

Specified by:

listStream in interface ResourceService

Parameters:

path - the Path to match

Returns:

a Stream<ResourceId>

link

public void link(ResourceId sourceResourceId,
 Path destination)

Description copied from interface: ResourceService

Given the provided ResourceId, this will create an additional alias for the provided destination Path.

Specified by:

link in interface ResourceService

Parameters:

sourceResourceId -

destination -

linkPath

public void linkPath(Path source,
 Path destination)

Description copied from interface: ResourceService

Given the provided Path, this will create an additional Path alias for the provided source.

Specified by:

linkPath in interface ResourceService

Parameters:

source - the source Path

destination - the destination Path

unlinkPath

public ResourceService.Unlink unlinkPath(Path path,
 Consumer<Resource> removed)

Description copied from interface: ResourceService

Unlinks the Resource for the provided Path. If the unlinked Path is the final path, then this will remove the Path from the ResourceService. If this Path is the last alias for the associated Resource, then the removed ResourceId will be passed to the supplied Consumer. The supplied Consumer will not be called if there still exist aliases for the associated Resource. Only one Resource may be unlinked at a time. Therefore, the supplied, Path most not be a wildcard path.

Specified by:

unlinkPath in interface ResourceService

Parameters:

path - a Path to unlink

removed - a Consumer which will receive the removed Resource

Returns:

true if the Resource associated with the Path was removed, false otherwise

unlinkMultiple

public List<ResourceService.Unlink> unlinkMultiple(Path path,
 int max,
 Consumer<Resource> removed)

Description copied from interface: ResourceService

Unlinks multiple Resources. This accepts a Path, which may be a wildcard.

Specified by:

unlinkMultiple in interface ResourceService

Parameters:

path - the path to remove

max - the maximum count to remove

removed - a Consumer<Resource> to process each removal

Returns:

the final ResourceService.Unlink operations

removeResource

public Resource removeResource(ResourceId resourceId)

Description copied from interface: ResourceService

Removes a Resource instance from this resource service.

Specified by:

removeResource in interface ResourceService

Parameters:

resourceId - the resourceId to the resource

removeResources

public List<ResourceId> removeResources(Path path,
 int max,
 Consumer<Resource> removed)

Description copied from interface: ResourceService

Removes all Resources linked with the provided Path.

Specified by:

removeResources in interface ResourceService

Parameters:

path - the the Path for the resource.

max -

removed - a Consumer<Resource> which accepts the removed resource

removeAllResources

public Stream<Resource> removeAllResources()

Description copied from interface: ResourceService

Removes all resources from. The returned Stream<Resource> returns any Resources that are still occupying memory and must be closed. The returned stream may be empty if all have been persisted. This operation may lock the whole ResourceService to accomplish its task.

Specified by:

removeAllResources in interface ResourceService

getInMemoryResourceCount

public long getInMemoryResourceCount()

Specified by:

getInMemoryResourceCount in interface ResourceService

getNodeId

public NodeId getNodeId()

setNodeId

@Inject
public void setNodeId(NodeId nodeId)

getResourceLoader

public ResourceLoader getResourceLoader()

setResourceLoader

@Inject
public void setResourceLoader(ResourceLoader resourceLoader)

getPersistence

public TransactionalResourceServicePersistence getPersistence()

setPersistence

@Inject
public void setPersistence(TransactionalResourceServicePersistence persistence)