org.tinyradius.client

Class RadiusClient<T extends io.netty.channel.socket.DatagramChannel>

java.lang.Object

org.tinyradius.client.RadiusClient<T>

public class RadiusClient<T extends io.netty.channel.socket.DatagramChannel>
extends java.lang.Object

This object represents a simple Radius client which communicates with a specified Radius server. You can use a single instance of this object to authenticate or account different users with the same Radius server as long as you authenticate/account one user after the other.

This object is thread safe, but requires a packet manager to avoid confusion with the mapping of request and result packets.

Constructor Summary

Constructors

Constructor and Description
RadiusClient(io.netty.channel.EventLoopGroup eventLoopGroup, io.netty.channel.ChannelFactory<T> factory, ClientHandler clientHandler, java.net.InetAddress listenAddress, int port)

Method Summary

Modifier and Type	Method and Description
io.netty.util.concurrent.Future<RadiusPacket>	communicate(RadiusPacket packet, RadiusEndpoint endpoint, int maxAttempts)
protected io.netty.channel.ChannelFuture	listen(T channel, java.net.InetSocketAddress listenAddress)
protected io.netty.channel.socket.DatagramPacket	makeDatagramPacket(RadiusPacket packet, RadiusEndpoint endpoint) Creates a datagram packet from a RadiusPacket to be send.
io.netty.channel.ChannelFuture	startChannel() Registers the channel and binds to address.
void	stop() Closes channel socket

Methods inherited from class java.lang.Object

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

Constructor Detail

RadiusClient

public RadiusClient(io.netty.channel.EventLoopGroup eventLoopGroup,
                    io.netty.channel.ChannelFactory<T> factory,
                    ClientHandler clientHandler,
                    java.net.InetAddress listenAddress,
                    int port)

Parameters:

eventLoopGroup - for both channel IO and processing

factory - to create new Channel

clientHandler - to log outgoing packets and handle incoming packets/responses

listenAddress - local address to bind to, will be wildcard address if null

port - port to bind to, or set to 0 to let system choose

Method Detail

stop

public void stop()

Closes channel socket

startChannel

public io.netty.channel.ChannelFuture startChannel()

Registers the channel and binds to address.

Also run implicitly if communicate(RadiusPacket, RadiusEndpoint, int) is called.

Returns:

channelFuture of started channel socket

listen

protected io.netty.channel.ChannelFuture listen(T channel,
                                                java.net.InetSocketAddress listenAddress)

Parameters:

channel - to listen on

listenAddress - the address to bind to

Returns:

channel that resolves after it is bound to address and registered with eventLoopGroup

communicate

public io.netty.util.concurrent.Future<RadiusPacket> communicate(RadiusPacket packet,
                                                                 RadiusEndpoint endpoint,
                                                                 int maxAttempts)

makeDatagramPacket

protected io.netty.channel.socket.DatagramPacket makeDatagramPacket(RadiusPacket packet,
                                                                    RadiusEndpoint endpoint)
                                                             throws java.io.IOException,
                                                                    RadiusException

Creates a datagram packet from a RadiusPacket to be send.

Parameters:

packet - RadiusPacket

endpoint - destination port number

Returns:

new datagram packet

Throws:

java.io.IOException - error when writing packet to output stream

RadiusException - error when encoding RadiusPacket attributes