Package uk.co.westhawk.snmp.stack

Class ListeningContextPool

java.lang.Object

uk.co.westhawk.snmp.stack.ListeningContextPool

All Implemented Interfaces:

ListeningContextFace

public class ListeningContextPool
extends Object
implements ListeningContextFace

This class contains the pool of listening contexts. The usage of this class will prevent more than one ListeningContext trying to listen to the same port.

Since:

4_14

Version:

$Revision: 3.7 $ $Date: 2009/03/05 13:27:41 $

Author:

Birgit Arkesteijn

See Also:

• ListeningContext

Field Summary

Fields inherited from interface uk.co.westhawk.snmp.stack.ListeningContextFace

DEFAULT_TRAP_PORT

Constructor Summary

Constructors

Constructor	Description
ListeningContextPool(int port)	Constructor, using the Standard socket type.
ListeningContextPool(int port, String bindAddress)	Constructor, using the Standard socket type.
ListeningContextPool(int port, String bindAddress, String typeSocket)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addRawPduListener(RawPduListener l)	Adds the specified PDU listener to receive the undecoded PDUs.
void	addUnhandledRawPduListener(RawPduListener l)	Adds the specified PDU listener to receive the undecoded PDUs when it was not handled (i.e. not consumed) by any of the PDU listeners in addRawPduListener().
void	destroy()	Destroys the current context.
void	destroyPool()	Destroys all the contexts in the pool and empties the pool.
void	dumpContexts(String title)	Dumps the pool of contexts.
String	getBindAddress()	Returns the local address the server will bind to When the address is null, the socket accepts connections on any/all local addresses.
String	getHashKey()	Returns the hash key.
int	getMaxRecvSize()	Returns the maximum number of bytes this context will read from the socket.
int	getPort()	Returns the port number.
String	getTypeSocket()	Returns the type of socket.
void	removeRawPduListener(RawPduListener l)	Removes the specified PDU listener.
void	removeRawPduListenerFromPool(RawPduListener l)	Removes the specified PDU listener from all the contexts in the pool.
void	removeUnhandledRawPduListener(RawPduListener l)	Removes the specified unhandled PDU listener.
void	setMaxRecvSize(int no)	Sets the maximum number of bytes this context will read from the socket.
String	toString()	Returns a string representation of the object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ListeningContextPool

public ListeningContextPool(int port)

Constructor, using the Standard socket type.

Parameters:

port - The local port where packets are received

See Also:

• ListeningContextPool(int, String)
• SnmpContextBasisFace.STANDARD_SOCKET

ListeningContextPool

public ListeningContextPool(int port,
 String bindAddress)

Constructor, using the Standard socket type. If bindAddress is null, it will accept connections on any/all local addresses. If you want to listen to

• IPv4 only interfaces, use address "0.0.0.0"
• IPv6 only interfaces, use address "::"

Parameters:

port - The local port where packets are received

bindAddress - The local address the server will bind to

See Also:

• SnmpContextBasisFace.STANDARD_SOCKET

ListeningContextPool

public ListeningContextPool(int port,
 String bindAddress,
 String typeSocket)

Constructor. If bindAddress is null, it will accept connections on any/all local addresses. If you want to listen to

• IPv4 only interfaces, use address "0.0.0.0"
• IPv6 only interfaces, use address "::"

The typeSocket will indicate which type of socket to use. This way different handlers can be provided.

Note, the TCP_SOCKET does not provide functionality to send a response back. Listening on such a socket is only useful when listening for traps.

Parameters:

port - The local port where packets are received

bindAddress - The local address the server will bind to

typeSocket - The type of socket to use.

See Also:

• SnmpContextBasisFace.STANDARD_SOCKET
• SnmpContextBasisFace.TCP_SOCKET

Method Details

getPort

public int getPort()

Description copied from interface: ListeningContextFace

Returns the port number.

Specified by:

getPort in interface ListeningContextFace

Returns:

The port no

getBindAddress

public String getBindAddress()

Description copied from interface: ListeningContextFace

Returns the local address the server will bind to When the address is null, the socket accepts connections on any/all local addresses.

Specified by:

getBindAddress in interface ListeningContextFace

Returns:

The bind address

getTypeSocket

public String getTypeSocket()

Description copied from interface: ListeningContextFace

Returns the type of socket.

Specified by:

getTypeSocket in interface ListeningContextFace

Returns:

The type of socket

See Also:

• SnmpContextBasisFace.STANDARD_SOCKET
• SnmpContextBasisFace.TCP_SOCKET

getMaxRecvSize

public int getMaxRecvSize()

Description copied from interface: ListeningContextFace

Returns the maximum number of bytes this context will read from the socket. By default this will be set to MSS (i.e. 1300).

Specified by:

getMaxRecvSize in interface ListeningContextFace

Returns:

The number

See Also:

• SnmpContextBasisFace.MSS
• ListeningContextFace.setMaxRecvSize(int)
• AbstractSnmpContext.setMaxRecvSize(int)

setMaxRecvSize

public void setMaxRecvSize(int no)

Sets the maximum number of bytes this context will read from the socket. By default this will be set to MSS (i.e. 1300). Only the current context will be affected, not to all the contexts in the pool.

Specified by:

setMaxRecvSize in interface ListeningContextFace

Parameters:

no - The new size

See Also:

• SnmpContextBasisFace.MSS
• AbstractSnmpContext.getMaxRecvSize()

destroy

public void destroy()

Destroys the current context.

Note that by calling this method the whole stack will stop listening for packets on the port this context was listening on! The listeners added via the SnmpContext classes are affected as well.

Specified by:

destroy in interface ListeningContextFace

See Also:

• destroyPool()
• destroy()

destroyPool

public void destroyPool()

Destroys all the contexts in the pool and empties the pool.

Note that by calling this method the whole stack will stop listening for any packets! The listeners added via the SnmpContext classes are affected as well.

See Also:

• destroy()

dumpContexts

public void dumpContexts(String title)

Dumps the pool of contexts. This is for debug purposes.

Parameters:

title - The title of the dump

getHashKey

public String getHashKey()

Returns the hash key. This key is built out of all properties. It serves as key for the pool of contexts.

Returns:

The hash key

addRawPduListener

public void addRawPduListener(RawPduListener l)
                       throws IOException

Description copied from interface: ListeningContextFace

Adds the specified PDU listener to receive the undecoded PDUs. When a PDU is received the PDU received event is fired to all listeners, until one of them consumes it.

All the SnmpContext objects use this method to listen for PDUs. When a SnmpContext object decodes the PDU succesfully, it will consume it.

Only when a listener is added will this context create a listening socket.

Specified by:

addRawPduListener in interface ListeningContextFace

Parameters:

l - The listener object

Throws:

IOException - Thrown when creating a listening socket fails

See Also:

• RawPduReceivedSupport.fireRawPduReceived(int, java.lang.String, int, byte[])
• AbstractSnmpContext.addTrapListener(uk.co.westhawk.snmp.event.TrapListener)
• AbstractSnmpContext.addRequestPduListener(uk.co.westhawk.snmp.event.RequestPduListener)
• ListeningContextFace.addUnhandledRawPduListener(RawPduListener)

removeRawPduListener

public void removeRawPduListener(RawPduListener l)

Description copied from interface: ListeningContextFace

Removes the specified PDU listener. When there are no more listeners, calls destroy().

Specified by:

removeRawPduListener in interface ListeningContextFace

Parameters:

l - The listener object

removeRawPduListenerFromPool

public void removeRawPduListenerFromPool(RawPduListener l)

Removes the specified PDU listener from all the contexts in the pool.

See Also:

• ListeningContext.removeRawPduListener(uk.co.westhawk.snmp.event.RawPduListener)

addUnhandledRawPduListener

public void addUnhandledRawPduListener(RawPduListener l)
                                throws IOException

Description copied from interface: ListeningContextFace

Adds the specified PDU listener to receive the undecoded PDUs when it was not handled (i.e. not consumed) by any of the PDU listeners in addRawPduListener().

Only when a listener is added will this context create a listening socket.

Specified by:

addUnhandledRawPduListener in interface ListeningContextFace

Parameters:

l - The listener object

Throws:

IOException - Thrown when creating a listening socket fails

See Also:

• ListeningContextFace.addRawPduListener(RawPduListener)

removeUnhandledRawPduListener

public void removeUnhandledRawPduListener(RawPduListener l)

Description copied from interface: ListeningContextFace

Removes the specified unhandled PDU listener. When there are no more listeners, calls destroy().

Specified by:

removeUnhandledRawPduListener in interface ListeningContextFace

Parameters:

l - The listener object

toString

public String toString()

Returns a string representation of the object.

Overrides:

toString in class Object

Returns:

The string