RadiusClient (TinyRadius Java Radius Library 1.0 API)

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

```
public class RadiusClient
extends 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 only opens a single socket so operations using this socket are synchronized to avoid confusion with the mapping of request and result packets.

构造器概要

构造器
构造器和说明
`RadiusClient(RadiusEndpoint client)` Constructs a Radius client for the given Radius endpoint.
`RadiusClient(String hostName, String sharedSecret)` Creates a new Radius client object for a special Radius server.

方法概要

方法
限定符和类型	方法和说明
`RadiusPacket`	`account(AccountingRequest request)` Sends an Accounting-Request packet and receives a response packet.
`RadiusPacket`	`authenticate(AccessRequest request)` Sends an Access-Request packet and receives a response packet.
`boolean`	`authenticate(String userName, String password)` Authenticates a user.
`void`	`close()` Closes the socket of this client.
`static RadiusPacket`	`communicate(RadiusEndpoint remoteServer, RadiusPacket request)` Sends the specified packet to the specified Radius server endpoint.
`RadiusPacket`	`communicate(RadiusPacket request, int port)` Sends a Radius packet to the server and awaits an answer.
`int`	`getAcctPort()` Returns the Radius server accounting port.
`int`	`getAuthPort()` Returns the Radius server auth port.
`String`	`getHostName()` Returns the host name of the Radius server.
`int`	`getRetryCount()` Returns the retry count for failed transmissions.
`String`	`getSharedSecret()` Returns the secret shared between server and client.
`protected DatagramSocket`	`getSocket()` Returns the socket used for the server communication.
`int`	`getSocketTimeout()` Returns the socket timeout.
`protected DatagramPacket`	`makeDatagramPacket(RadiusPacket packet, int port)` Creates a datagram packet from a RadiusPacket to be send.
`protected RadiusPacket`	`makeRadiusPacket(DatagramPacket packet, RadiusPacket request)` Creates a RadiusPacket from a received datagram packet.
`void`	`setAcctPort(int acctPort)` Sets the Radius server accounting port.
`void`	`setAuthPort(int authPort)` Sets the auth port of the Radius server.
`void`	`setHostName(String hostName)` Sets the host name of the Radius server.
`void`	`setRetryCount(int retryCount)` Sets the retry count for failed transmissions.
`void`	`setSharedSecret(String sharedSecret)` Sets the secret shared between server and client.
`void`	`setSocketTimeout(int socketTimeout)` Sets the socket timeout

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

- 构造器详细资料
  - RadiusClient
```
public RadiusClient(String hostName,
            String sharedSecret)
```
    Creates a new Radius client object for a special Radius server.
    
    参数:
    hostName - host name of the Radius server
    sharedSecret - shared secret used to secure the communication
  - RadiusClient
```
public RadiusClient(RadiusEndpoint client)
```
    Constructs a Radius client for the given Radius endpoint.
    
    参数:
    client - Radius endpoint
- 方法详细资料
  - authenticate
```
public boolean authenticate(String userName,
                   String password)
                     throws IOException,
                            RadiusException
```
    Authenticates a user.
    
    参数:
    userName - user name
    password - password
    
    返回:
    true if authentication is successful, false otherwise
    
    抛出:
    
    RadiusException - malformed packet
    
    IOException - communication error (after getRetryCount() retries)
  - authenticate
```
public RadiusPacket authenticate(AccessRequest request)
                          throws IOException,
                                 RadiusException
```
    Sends an Access-Request packet and receives a response packet.
    
    参数:
    request - request packet
    
    返回:
    Radius response packet
    
    抛出:
    
    RadiusException - malformed packet
    
    IOException - communication error (after getRetryCount() retries)
  - account
```
public RadiusPacket account(AccountingRequest request)
                     throws IOException,
                            RadiusException
```
    Sends an Accounting-Request packet and receives a response packet.
    
    参数:
    request - request packet
    
    返回:
    Radius response packet
    
    抛出:
    
    RadiusException - malformed packet
    
    IOException - communication error (after getRetryCount() retries)
  - close
```
public void close()
```
    Closes the socket of this client.
  - getAuthPort
```
public int getAuthPort()
```
    Returns the Radius server auth port.
    
    返回:
    auth port
  - setAuthPort
```
public void setAuthPort(int authPort)
```
    Sets the auth port of the Radius server.
    
    参数:
    authPort - auth port, 1-65535
  - getHostName
```
public String getHostName()
```
    Returns the host name of the Radius server.
    
    返回:
    host name
  - setHostName
```
public void setHostName(String hostName)
```
    Sets the host name of the Radius server.
    
    参数:
    hostName - host name
  - getRetryCount
```
public int getRetryCount()
```
    Returns the retry count for failed transmissions.
    
    返回:
    retry count
  - setRetryCount
```
public void setRetryCount(int retryCount)
```
    Sets the retry count for failed transmissions.
    
    参数:
    retryCount - retry count, >0
  - getSharedSecret
```
public String getSharedSecret()
```
    Returns the secret shared between server and client.
    
    返回:
    shared secret
  - setSharedSecret
```
public void setSharedSecret(String sharedSecret)
```
    Sets the secret shared between server and client.
    
    参数:
    sharedSecret - shared secret
  - getSocketTimeout
```
public int getSocketTimeout()
```
    Returns the socket timeout.
    
    返回:
    socket timeout, ms
  - setSocketTimeout
```
public void setSocketTimeout(int socketTimeout)
                      throws SocketException
```
    Sets the socket timeout
    
    参数:
    socketTimeout - timeout, ms, >0
    
    抛出:
    
    SocketException
  - setAcctPort
```
public void setAcctPort(int acctPort)
```
    Sets the Radius server accounting port.
    
    参数:
    acctPort - acct port, 1-65535
  - getAcctPort
```
public int getAcctPort()
```
    Returns the Radius server accounting port.
    
    返回:
    acct port
  - communicate
```
public RadiusPacket communicate(RadiusPacket request,
                       int port)
                         throws IOException,
                                RadiusException
```
    Sends a Radius packet to the server and awaits an answer.
    
    参数:
    request - packet to be sent
    port - server port number
    
    返回:
    response Radius packet
    
    抛出:
    
    RadiusException - malformed packet
    
    IOException - communication error (after getRetryCount() retries)
  - communicate
```
public static RadiusPacket communicate(RadiusEndpoint remoteServer,
                       RadiusPacket request)
                                throws RadiusException,
                                       IOException
```
    Sends the specified packet to the specified Radius server endpoint.
    
    参数:
    remoteServer - Radius endpoint consisting of server address, port number and shared secret
    request - Radius packet to be sent
    
    返回:
    received response packet
    
    抛出:
    
    RadiusException - malformed packet
    
    IOException - error while communication
  - getSocket
```
protected DatagramSocket getSocket()
                            throws SocketException
```
    Returns the socket used for the server communication. It is bound to an arbitrary free local port number.
    
    返回:
    local socket
    
    抛出:
    
    SocketException
  - makeDatagramPacket
```
protected DatagramPacket makeDatagramPacket(RadiusPacket packet,
                                int port)
                                     throws IOException
```
    Creates a datagram packet from a RadiusPacket to be send.
    
    参数:
    packet - RadiusPacket
    port - destination port number
    
    返回:
    new datagram packet
    
    抛出:
    
    IOException
  - makeRadiusPacket
```
protected RadiusPacket makeRadiusPacket(DatagramPacket packet,
                            RadiusPacket request)
                                 throws IOException,
                                        RadiusException
```
    Creates a RadiusPacket from a received datagram packet.
    
    参数:
    packet - received datagram
    request - Radius request packet
    
    返回:
    RadiusPacket object
    
    抛出:
    
    IOException
    
    RadiusException

类 RadiusClient

构造器概要

方法概要

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

构造器详细资料

RadiusClient

RadiusClient

方法详细资料

authenticate

authenticate

account

close

getAuthPort

setAuthPort

getHostName

setHostName

getRetryCount

setRetryCount

getSharedSecret

setSharedSecret

getSocketTimeout

setSocketTimeout

setAcctPort

getAcctPort

communicate

communicate

getSocket

makeDatagramPacket

makeRadiusPacket