gr.uoa.di.madgik.grs.proxy.local

Class LocalReaderProxy

java.lang.Object

gr.uoa.di.madgik.grs.proxy.local.LocalReaderProxy

All Implemented Interfaces:

IProxy, IReaderProxy

Direct Known Subclasses:

LocalStoreReaderProxy

public class LocalReaderProxy
extends Object
implements IReaderProxy

This proxy is an implementation of the IReaderProxy interface available to be used by readers that want to access an IBuffer made available by a writer that is collocated in the same JVM as they are

Author:

gpapanikos

Nested Class Summary

Nested classes/interfaces inherited from interface gr.uoa.di.madgik.grs.proxy.IProxy

IProxy.ProxyType

Field Summary

Fields inherited from interface gr.uoa.di.madgik.grs.proxy.IProxy

ProxyScheme, ProxyStoreScheme

Constructor Summary

Constructors

Constructor and Description
LocalReaderProxy() Creates a new instance

Method Summary

Methods

Modifier and Type	Method and Description
void	fromLocator(URI locator) Populates an instance of the IReaderProxy implementer with the information provided through the specific locator URI
IBuffer	getBuffer() After the proxy has been initialized, through this method, the IBuffer that can be used by the reader to access the writer side IBuffer can be retrieved
static boolean	isOfType(URI locator) Checks if the provided URI is of a type that can be managed by an instance of this class.
void	overrideBufferCapacity(int capacity) After the proxy has been initialized, this method can be used to provide a hint to the IReaderProxy to use a capacity different than that of the producer's buffer.

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalReaderProxy

public LocalReaderProxy()

Creates a new instance

Method Detail

fromLocator

public void fromLocator(URI locator)
                 throws GRS2ProxyInvalidArgumentException,
                        GRS2ProxyInvalidOperationException

Populates an instance of the IReaderProxy implementer with the information provided through the specific locator URI

This method parses the provided URI to retrieve the needed information. An example of the URI this proxy can manage is grs2-proxy://localhost?key=13bc140f-3013-4ce1-83b4-4d57d46863b0#Local

Specified by:

fromLocator in interface IReaderProxy

Throws:

GRS2ProxyInvalidOperationException - if the proxy has already been initialized

GRS2ProxyInvalidArgumentException - if the provided locator is null or empty, or the parsed information is not valid

See Also:

IReaderProxy.fromLocator(java.net.URI)

overrideBufferCapacity

public void overrideBufferCapacity(int capacity)

After the proxy has been initialized, this method can be used to provide a hint to the IReaderProxy to use a capacity different than that of the producer's buffer. Whether or not this hint is taken into account depends on the IReaderProxy implementation. For example, it is highly unlikely that it will be honored in cases when both the producer and the consumer run into the same address space. Performs no action, as the LocalReaderProxy retrieves the IBuffer directly from the local GRSRegistry

Specified by:

overrideBufferCapacity in interface IReaderProxy

See Also:

IReaderProxy.overrideBufferCapacity(int)

getBuffer

public IBuffer getBuffer()
                  throws GRS2ProxyInvalidOperationException

After the proxy has been initialized, through this method, the IBuffer that can be used by the reader to access the writer side IBuffer can be retrieved

Retrieves the IBuffer directly from the local GRSRegistry. If no IBuffer is found associated with the provided key, null is returned

Specified by:

getBuffer in interface IReaderProxy

Returns:

The IBuffer that is serving the reader

Throws:

GRS2ProxyInvalidOperationException - if the provided locator that populated this instance has not set the needed parameters

See Also:

IReaderProxy.getBuffer()

isOfType

public static boolean isOfType(URI locator)

Checks if the provided URI is of a type that can be managed by an instance of this class. It bases its checks on the URI scheme and the fragment type. An example of the URI this proxy can manage is grs2-proxy://localhost?key=13bc140f-3013-4ce1-83b4-4d57d46863b0#Local

Parameters:

locator - the locator URi that needs to be checked

Returns:

true is this proxy class can handle the locator, false otherwise