RadiusServer (TinyRadius Java Radius Library 1.0 API)

java.lang.Object
- org.tinyradius.util.RadiusServer

直接已知子类:

RadiusProxy
```
public abstract class RadiusServer
extends Object
```
Implements a simple Radius server. This class must be subclassed to provide an implementation for getSharedSecret() and getUserPassword(). If the server supports accounting, it must override accountingRequestReceived().

构造器概要

构造器
构造器和说明

RadiusServer()

构造器
构造器和说明
`RadiusServer()`

方法概要

方法
限定符和类型	方法和说明
`RadiusPacket`	`accessRequestReceived(AccessRequest accessRequest, InetSocketAddress client)` Constructs an answer for an Access-Request packet.
`RadiusPacket`	`accountingRequestReceived(AccountingRequest accountingRequest, InetSocketAddress client)` Constructs an answer for an Accounting-Request packet.
`protected void`	`copyProxyState(RadiusPacket request, RadiusPacket answer)` Copies all Proxy-State attributes from the request packet to the response packet.
`int`	`getAcctPort()` Returns the acct port the server will listen on.
`protected DatagramSocket`	`getAcctSocket()` Returns a socket bound to the acct port.
`int`	`getAuthPort()` Returns the auth port the server will listen on.
`protected DatagramSocket`	`getAuthSocket()` Returns a socket bound to the auth port.
`long`	`getDuplicateInterval()` Returns the duplicate interval in ms.
`InetAddress`	`getListenAddress()` Returns the IP address the server listens on.
`abstract String`	`getSharedSecret(InetSocketAddress client)` Returns the shared secret used to communicate with the client with the passed IP address or null if the client is not allowed at this server.
`int`	`getSocketTimeout()` Returns the socket timeout (ms).
`abstract String`	`getUserPassword(String userName)` Returns the password of the passed user.
`protected RadiusPacket`	`handlePacket(InetSocketAddress localAddress, InetSocketAddress remoteAddress, RadiusPacket request, String sharedSecret)` Handles the received Radius packet and constructs a response.
`protected boolean`	`isPacketDuplicate(RadiusPacket packet, InetSocketAddress address)` Checks whether the passed packet is a duplicate.
`protected void`	`listen(DatagramSocket s)` Listens on the passed socket, blocks until stop() is called.
`protected void`	`listenAcct()` Listens on the acct port (blocks the current thread).
`protected void`	`listenAuth()` Listens on the auth port (blocks the current thread).
`protected DatagramPacket`	`makeDatagramPacket(RadiusPacket packet, String secret, InetAddress address, int port, RadiusPacket request)` Creates a Radius response datagram packet from a RadiusPacket to be send.
`protected RadiusPacket`	`makeRadiusPacket(DatagramPacket packet, String sharedSecret)` Creates a RadiusPacket for a Radius request from a received datagram packet.
`void`	`setAcctPort(int acctPort)` Sets the acct port the server will listen on.
`void`	`setAuthPort(int authPort)` Sets the auth port the server will listen on.
`void`	`setDuplicateInterval(long duplicateInterval)` Sets the duplicate interval in ms.
`void`	`setListenAddress(InetAddress listenAddress)` Sets the address the server listens on.
`void`	`setSocketTimeout(int socketTimeout)` Sets the socket timeout.
`void`	`start(boolean listenAuth, boolean listenAcct)` Starts the Radius server.
`void`	`stop()` Stops the server and closes the sockets.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - RadiusServer
```
public RadiusServer()
```
- 方法详细资料
  - getSharedSecret
```
public abstract String getSharedSecret(InetSocketAddress client)
```
    Returns the shared secret used to communicate with the client with the passed IP address or null if the client is not allowed at this server.
    
    参数:
    client - IP address and port number of client
    
    返回:
    shared secret or null
  - getUserPassword
```
public abstract String getUserPassword(String userName)
```
    Returns the password of the passed user. Either this method or accessRequestReceived() should be overriden.
    
    参数:
    userName - user name
    
    返回:
    plain-text password or null if user unknown
  - accessRequestReceived
```
public RadiusPacket accessRequestReceived(AccessRequest accessRequest,
                                 InetSocketAddress client)
                                   throws RadiusException
```
    Constructs an answer for an Access-Request packet. Either this method or isUserAuthenticated should be overriden.
    
    参数:
    accessRequest - Radius request packet
    client - address of Radius client
    
    返回:
    response packet or null if no packet shall be sent
    
    抛出:
    
    RadiusException - malformed request packet; if this exception is thrown, no answer will be sent
  - accountingRequestReceived
```
public RadiusPacket accountingRequestReceived(AccountingRequest accountingRequest,
                                     InetSocketAddress client)
                                       throws RadiusException
```
    Constructs an answer for an Accounting-Request packet. This method should be overriden if accounting is supported.
    
    参数:
    accountingRequest - Radius request packet
    client - address of Radius client
    
    返回:
    response packet or null if no packet shall be sent
    
    抛出:
    
    RadiusException - malformed request packet; if this exception is thrown, no answer will be sent
  - start
```
public void start(boolean listenAuth,
         boolean listenAcct)
```
    Starts the Radius server.
    
    参数:
    listenAuth - open auth port?
    listenAcct - open acct port?
  - stop
```
public void stop()
```
    Stops the server and closes the sockets.
  - getAuthPort
```
public int getAuthPort()
```
    Returns the auth port the server will listen on.
    
    返回:
    auth port
  - setAuthPort
```
public void setAuthPort(int authPort)
```
    Sets the auth port the server will listen on.
    
    参数:
    authPort - auth port, 1-65535
  - getSocketTimeout
```
public int getSocketTimeout()
```
    Returns the socket timeout (ms).
    
    返回:
    socket timeout
  - setSocketTimeout
```
public void setSocketTimeout(int socketTimeout)
                      throws SocketException
```
    Sets the socket timeout.
    
    参数:
    socketTimeout - socket timeout, >0 ms
    
    抛出:
    
    SocketException
  - setAcctPort
```
public void setAcctPort(int acctPort)
```
    Sets the acct port the server will listen on.
    
    参数:
    acctPort - acct port 1-65535
  - getAcctPort
```
public int getAcctPort()
```
    Returns the acct port the server will listen on.
    
    返回:
    acct port
  - getDuplicateInterval
```
public long getDuplicateInterval()
```
    Returns the duplicate interval in ms. A packet is discarded as a duplicate if in the duplicate interval there was another packet with the same identifier originating from the same address.
    
    返回:
    duplicate interval (ms)
  - setDuplicateInterval
```
public void setDuplicateInterval(long duplicateInterval)
```
    Sets the duplicate interval in ms. A packet is discarded as a duplicate if in the duplicate interval there was another packet with the same identifier originating from the same address.
    
    参数:
    duplicateInterval - duplicate interval (ms), >0
  - getListenAddress
```
public InetAddress getListenAddress()
```
    Returns the IP address the server listens on. Returns null if listening on the wildcard address.
    
    返回:
    listen address or null
  - setListenAddress
```
public void setListenAddress(InetAddress listenAddress)
```
    Sets the address the server listens on. Must be called before start(). Defaults to null, meaning listen on every local address (wildcard address).
    
    参数:
    listenAddress - listen address or null
  - copyProxyState
```
protected void copyProxyState(RadiusPacket request,
                  RadiusPacket answer)
```
    Copies all Proxy-State attributes from the request packet to the response packet.
    
    参数:
    request - request packet
    answer - response packet
  - listenAuth
```
protected void listenAuth()
                   throws SocketException
```
    Listens on the auth port (blocks the current thread). Returns when stop() is called.
    
    抛出:
    
    SocketException
    
    InterruptedException
  - listenAcct
```
protected void listenAcct()
                   throws SocketException
```
    Listens on the acct port (blocks the current thread). Returns when stop() is called.
    
    抛出:
    
    SocketException
    
    InterruptedException
  - listen
```
protected void listen(DatagramSocket s)
```
    Listens on the passed socket, blocks until stop() is called.
    
    参数:
    s - socket to listen on
  - handlePacket
```
protected RadiusPacket handlePacket(InetSocketAddress localAddress,
                        InetSocketAddress remoteAddress,
                        RadiusPacket request,
                        String sharedSecret)
                             throws RadiusException,
                                    IOException
```
    Handles the received Radius packet and constructs a response.
    
    参数:
    localAddress - local address the packet was received on
    remoteAddress - remote address the packet was sent by
    request - the packet
    
    返回:
    response packet or null for no response
    
    抛出:
    
    RadiusException
    
    IOException
  - getAuthSocket
```
protected DatagramSocket getAuthSocket()
                                throws SocketException
```
    Returns a socket bound to the auth port.
    
    返回:
    socket
    
    抛出:
    
    SocketException
  - getAcctSocket
```
protected DatagramSocket getAcctSocket()
                                throws SocketException
```
    Returns a socket bound to the acct port.
    
    返回:
    socket
    
    抛出:
    
    SocketException
  - makeDatagramPacket
```
protected DatagramPacket makeDatagramPacket(RadiusPacket packet,
                                String secret,
                                InetAddress address,
                                int port,
                                RadiusPacket request)
                                     throws IOException
```
    Creates a Radius response datagram packet from a RadiusPacket to be send.
    
    参数:
    packet - RadiusPacket
    secret - shared secret to encode packet
    address - where to send the packet
    port - destination port
    request - request packet
    
    返回:
    new datagram packet
    
    抛出:
    
    IOException
  - makeRadiusPacket
```
protected RadiusPacket makeRadiusPacket(DatagramPacket packet,
                            String sharedSecret)
                                 throws IOException,
                                        RadiusException
```
    Creates a RadiusPacket for a Radius request from a received datagram packet.
    
    参数:
    packet - received datagram
    
    返回:
    RadiusPacket object
    
    抛出:
    
    RadiusException - malformed packet
    
    IOException - communication error (after getRetryCount() retries)
  - isPacketDuplicate
```
protected boolean isPacketDuplicate(RadiusPacket packet,
                        InetSocketAddress address)
```
    Checks whether the passed packet is a duplicate. A packet is duplicate if another packet with the same identifier has been sent from the same host in the last time.
    
    参数:
    packet - packet in question
    address - client address
    
    返回:
    true if it is duplicate

类 RadiusServer

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

RadiusServer

方法详细资料

getSharedSecret

getUserPassword

accessRequestReceived

accountingRequestReceived

start

stop

getAuthPort

setAuthPort

getSocketTimeout

setSocketTimeout

setAcctPort

getAcctPort

getDuplicateInterval

setDuplicateInterval

getListenAddress

setListenAddress

copyProxyState

listenAuth

listenAcct

listen

handlePacket

getAuthSocket

getAcctSocket

makeDatagramPacket

makeRadiusPacket

isPacketDuplicate