org.ow2.wildcat
Interface Context

public interface Context

Public interface through which users perform push/pull operation on context data.

Method Summary

void	attachAttribute(java.lang.String attribute, Attribute attr) Attach Attribute at specified location.
void	attachResource(java.lang.String resource, Resource res) Attach Resource at specified location.
void	createAttribute(java.lang.String attribute, java.lang.Object value) Creates a new attribute.
void	createPeriodicAttributePoller(java.lang.String attribute, long duration, java.util.concurrent.TimeUnit unit) Periodically creates an AttributeChangedEvent where old and new values are equal.
Query	createQuery(java.lang.String query) Creates and starts a query.
void	createResource(java.lang.String resource) Creates Resource along a path.
void	createSymlink(java.lang.String link, java.lang.String target) Creates and attach a Symlink.
void	destroy() Destroy this context.
void	destroyQuery(Query query) Detach all listener and destroy query.
void	detachAttribute(java.lang.String attribute) Detach an attribute.
void	detachResource(java.lang.String resource) Detach a resource.
void	emitEvent(WEvent... events) Emit event(s).
void	export() Allow the context for remote connections.
Attribute	getAttribute(java.lang.String attribute) Return the attribute at specified location.
java.lang.String	getName()
Resource	getResource(java.lang.String resource) Return the resource at specified location.
java.lang.Object	getValue(java.lang.String attribute) Fetch attribute value.
boolean	isRemoteContextAvailable(java.lang.String context)
java.util.Set<java.lang.String>	list(java.lang.String resource) List resources and attributes.
boolean	listen(java.lang.String source) Listen for events coming from the context with the given name.
void	pauseQuery(Query query) Pause Query.
void	registerListeners(Query query, net.esper.client.UpdateListener... listeners) Attach one or more listener to a query.
Query	registerListeners(java.lang.String query, net.esper.client.UpdateListener... listeners) Creates and starts a query and register one or more listener.
void	removeListeners(Query query, net.esper.client.UpdateListener... listeners) Removes one or more listeners associated with a Query.
void	removePeriodicAttributePoller(java.lang.String attribute) Remove an attribute poller.
void	resumeQuery(Query query) Resume Query.
java.lang.Object	setValue(java.lang.String attribute, java.lang.Object value) Set Attribute's value.
void	unexport() Don't allow the context for remote connections.

Method Detail

getName

java.lang.String getName()

Returns:

the name of the context as registered for remote connection

attachAttribute

void attachAttribute(java.lang.String attribute,
                     Attribute attr)
                     throws ContextException

Attach Attribute at specified location.

Parameters:

attribute - path of the Attribute

attr - an Attribute

Throws:

ContextException - if the attribute cannot be attached

createAttribute

void createAttribute(java.lang.String attribute,
                     java.lang.Object value)
                     throws ContextException

Creates a new attribute.

Parameters:

attribute - path of the attribute

value - initial value of the attribute

Throws:

ContextException - if the attribute cannot be created

detachAttribute

void detachAttribute(java.lang.String attribute)
                     throws ContextException

Detach an attribute.

Parameters:

attribute - path of the attribute

Throws:

ContextException - if the attribute cannot be detached

createResource

void createResource(java.lang.String resource)
                    throws ContextException

Creates Resource along a path.

Parameters:

resource - path to create

Throws:

ContextException - if the resource cannot be created

getResource

Resource getResource(java.lang.String resource)
                     throws ContextException

Return the resource at specified location.

Parameters:

resource - path of the Resource

Returns:

the resource at specified location

Throws:

ContextException - if the resource cannot be returned

attachResource

void attachResource(java.lang.String resource,
                    Resource res)
                    throws ContextException

Attach Resource at specified location.

Parameters:

resource - path of the Resource

res - a Resource

Throws:

ContextException - if the resource cannot be attached

detachResource

void detachResource(java.lang.String resource)
                    throws ContextException

Detach a resource.

Parameters:

resource - path of the Resource

Throws:

ContextException - if the resource cannot be detached

createSymlink

void createSymlink(java.lang.String link,
                   java.lang.String target)
                   throws ContextException

Creates and attach a Symlink.

Parameters:

link - attach point

target - target path of the symbolic link

Throws:

ContextException - if the Symlink cannot be created

getAttribute

Attribute getAttribute(java.lang.String attribute)
                       throws ContextException

Return the attribute at specified location.

Parameters:

attribute - the path of the attribute

Returns:

an attribute

Throws:

ContextException - if the attribute cannot be retrieved

getValue

java.lang.Object getValue(java.lang.String attribute)
                          throws ContextException

Fetch attribute value.

Parameters:

attribute - the path of the attribute

Returns:

the value of the attribute, or null if attribute does not exist

Throws:

ContextException - if the attribute cannot be accessed

setValue

java.lang.Object setValue(java.lang.String attribute,
                          java.lang.Object value)
                          throws ContextException

Set Attribute's value.

Parameters:

attribute - path of the Attribute

value - new value of the Attribute

Returns:

previous value of the Attribute

Throws:

ContextException - if the attribute cannot be accessed

list

java.util.Set<java.lang.String> list(java.lang.String resource)
                                     throws ContextException

List resources and attributes.

Parameters:

resource - the resource to inspect

Returns:

A set of String, attribute's names preceded with '#'

Throws:

ContextException - if the resource cannot be accessed

emitEvent

void emitEvent(WEvent... events)

Emit event(s).

Parameters:

events - one or more event to emit

createPeriodicAttributePoller

void createPeriodicAttributePoller(java.lang.String attribute,
                                   long duration,
                                   java.util.concurrent.TimeUnit unit)
                                   throws ContextException

Periodically creates an AttributeChangedEvent where old and new values are equal.

Parameters:

attribute - the location of the attribute to poll

duration - the period

unit - the period unit

Throws:

ContextException - if the attribute poller cannot be created

removePeriodicAttributePoller

void removePeriodicAttributePoller(java.lang.String attribute)
                                   throws ContextException

Remove an attribute poller.

Parameters:

attribute - the location of the attribute to poll

Throws:

ContextException - if the attribute poller cannot be deleted

createQuery

Query createQuery(java.lang.String query)

Creates and starts a query.

Parameters:

query - the query

Returns:

a reference to the query

pauseQuery

void pauseQuery(Query query)

Pause Query.

Parameters:

query - query's reference

resumeQuery

void resumeQuery(Query query)

Resume Query.

Parameters:

query - query's reference

destroyQuery

void destroyQuery(Query query)

Detach all listener and destroy query.

Parameters:

query - the reference of the query

registerListeners

Query registerListeners(java.lang.String query,
                        net.esper.client.UpdateListener... listeners)

Creates and starts a query and register one or more listener.

Parameters:

query - the query

listeners - 0 or more listeners

Returns:

a reference to the query

registerListeners

void registerListeners(Query query,
                       net.esper.client.UpdateListener... listeners)

Attach one or more listener to a query.

Parameters:

query - query reference

listeners - one or more listener to attach

removeListeners

void removeListeners(Query query,
                     net.esper.client.UpdateListener... listeners)

Removes one or more listeners associated with a Query.

Parameters:

query - the query from which to detach

listeners - the listeners to detach

export

void export()
            throws ContextException

Allow the context for remote connections.

Throws:

ContextException - if this context cannot be exported

unexport

void unexport()
              throws ContextException

Don't allow the context for remote connections.

Throws:

ContextException - if this context cannot be unexported

listen

boolean listen(java.lang.String source)

Listen for events coming from the context with the given name.

Parameters:

source - a context name

Returns:

true if this context listens

isRemoteContextAvailable

boolean isRemoteContextAvailable(java.lang.String context)

Parameters:

context - a context name

Returns:

true if a remote context with the given name is available

destroy

void destroy()
             throws ContextException

Destroy this context.

Throws:

ContextException - if it cannot be destroyed