org.activeio
Class FilterSyncChannelServer

java.lang.Object
  org.activeio.FilterSyncChannelServer

All Implemented Interfaces:

Channel, ChannelServer, Disposable, Service, SyncChannelServer

public class FilterSyncChannelServer
extends Object
implements SyncChannelServer

A SynchChannelFilter can be used as a filter another org.activeio.SynchChannel Most org.activeio.SynchChannel that are not directly accessing the network will extends the SynchChannelFilter since they act as a filter between the client and the network.

Version:

$Revision$

Field Summary

Fields inherited from interface org.activeio.SyncChannelServer

NO_WAIT_TIMEOUT, WAIT_FOREVER_TIMEOUT

Constructor Summary

FilterSyncChannelServer(SyncChannelServer next)

Method Summary

Channel	accept(long timeout)
void	dispose() This method should not throw any exceptions.
URI	getBindURI() The URI that was used when the channel was bound.
URI	getConnectURI() Once bound, the channel may be able to construct a URI that is more sutible for when a client needs to connect to the server.
SyncChannelServer	getNext()
Object	narrow(Class target) Since a Channel may be composed from a chain of other Channel obejcts, this method allows you to query the chain for the specified interface.
void	start() Starts the channel.
void	stop(long timeout) Stops the channel.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterSyncChannelServer

public FilterSyncChannelServer(SyncChannelServer next)

Method Detail

dispose

public void dispose()

Description copied from interface: Disposable

This method should not throw any exceptions. Cleaning up a Disposable object should be easy of an end user therefore do not make him have to handle an Exception.

Specified by:

dispose in interface Disposable

See Also:

Disposable.dispose()

start

public void start()
           throws IOException

Description copied from interface: Service

Starts the channel. Once started, the channel is in the running state.

Specified by:

start in interface Service

Throws:

IOException

See Also:

Service.start()

stop

public void stop(long timeout)
          throws IOException

Description copied from interface: Service

Stops the channel. Once stopped, the channel is in the stopped state.

Specified by:

stop in interface Service

Parameters:

timeout - The amount of time the channel is allowed to take to gracefully stop. If the timeout is exceeded, the channel should do a forcefull stop.

Throws:

IOException

See Also:

Service.stop(long)

getNext

public SyncChannelServer getNext()

Returns:

Returns the next.

accept

public Channel accept(long timeout)
               throws IOException

Specified by:

accept in interface SyncChannelServer

Throws:

IOException

See Also:

SyncChannelServer.accept(long)

getBindURI

public URI getBindURI()

Description copied from interface: ChannelServer

The URI that was used when the channel was bound. This could be different than what is used by a client to connect to the ChannelServer. For example, the bind URI might be tcp://localhost:0 which means the channel should bind to an anonymous port.

Specified by:

getBindURI in interface ChannelServer

Returns:

The URI that was used when the channel was bound

See Also:

ChannelServer.getBindURI()

getConnectURI

public URI getConnectURI()

Description copied from interface: ChannelServer

Once bound, the channel may be able to construct a URI that is more sutible for when a client needs to connect to the server. For examle the port of the URI may be updated to reflect the actual local port that the channel server is listening on.

Specified by:

getConnectURI in interface ChannelServer

Returns:

a URI that a client can use to connect to the server or null if the channel cannot construct the URI.

See Also:

ChannelServer.getConnectURI()

narrow

public Object narrow(Class target)

Description copied from interface: Channel

Since a Channel may be composed from a chain of other Channel obejcts, this method allows you to query the chain for the specified interface. The first Channel in the chain the implments the requested interface will be return an implementing object. If no Channel in the chain implements the requested class, then null is returned.

Specified by:

narrow in interface Channel

toString

public String toString()

Overrides:

toString in class Object