Class SocksProxyRequest
- java.lang.Object
-
- org.apache.mina.proxy.handlers.ProxyRequest
-
- org.apache.mina.proxy.handlers.socks.SocksProxyRequest
-
public class SocksProxyRequest extends ProxyRequest
SocksProxyRequest.java - Wrapper class for SOCKS requests.- Since:
- MINA 2.0.0-M3
- Author:
- Apache MINA Project
-
-
Constructor Summary
Constructors Constructor Description SocksProxyRequest(byte protocolVersion, byte commandCode, InetSocketAddress endpointAddress, String userName)
Constructor used when building a SOCKS4 request.SocksProxyRequest(byte commandCode, String host, int port, String userName)
Constructor used when building a SOCKS4a request.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description byte
getCommandCode()
Return the command code.String
getHost()
Return the server host name.byte[]
getIpAddress()
String
getPassword()
Return the user password.byte[]
getPort()
Return the server port as a byte array.byte
getProtocolVersion()
Return the protocol version.String
getServiceKerberosName()
Return the Kerberos service name.String
getUserName()
Return the user name.void
setPassword(String password)
Set the user passwordvoid
setServiceKerberosName(String serviceKerberosName)
Set the Kerberos service name.-
Methods inherited from class org.apache.mina.proxy.handlers.ProxyRequest
getEndpointAddress
-
-
-
-
Constructor Detail
-
SocksProxyRequest
public SocksProxyRequest(byte protocolVersion, byte commandCode, InetSocketAddress endpointAddress, String userName)
Constructor used when building a SOCKS4 request.- Parameters:
protocolVersion
- the protocol versioncommandCode
- the command codeendpointAddress
- the endpoint addressuserName
- the user name
-
-
Method Detail
-
getIpAddress
public byte[] getIpAddress()
- Returns:
- the endpoint address resulting from the
ProxyRequest.getEndpointAddress()
. If not set, it will return theSocksProxyConstants.FAKE_IP
constant value which will be ignored in a SOCKS v4 request.
-
getPort
public byte[] getPort()
Return the server port as a byte array.- Returns:
- the server port
-
getCommandCode
public byte getCommandCode()
Return the command code.- Returns:
- the command code
-
getProtocolVersion
public byte getProtocolVersion()
Return the protocol version.- Returns:
- the protocol version
-
getUserName
public String getUserName()
Return the user name.- Returns:
- the user name
-
getHost
public final String getHost()
Return the server host name.- Returns:
- the server host name
-
getPassword
public String getPassword()
Return the user password.- Returns:
- the user password
-
setPassword
public void setPassword(String password)
Set the user password- Parameters:
password
- the user password value
-
getServiceKerberosName
public String getServiceKerberosName()
Return the Kerberos service name.- Returns:
- the Kerberos service name
-
setServiceKerberosName
public void setServiceKerberosName(String serviceKerberosName)
Set the Kerberos service name.- Parameters:
serviceKerberosName
- the Kerberos service name
-
-