com.vmware.vapi.protocol.server.rpc.http.impl

Class HttpEndpoint

java.lang.Object

com.vmware.vapi.protocol.server.rpc.http.impl.HttpEndpoint

All Implemented Interfaces:

Endpoint

Direct Known Subclasses:

HttpsEndpoint

public class HttpEndpoint
extends Object
implements Endpoint

Implementation of an HTTP server endpoint.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vapi.protocol.server.rpc.http.Endpoint

Endpoint.EndpointType, Endpoint.Protocol

Field Summary

Fields

Modifier and Type	Field and Description
protected int	_acceptQueueSize
protected String	_host
protected int	_maxIdleTime
protected int	_numAcceptors
protected int	_port
protected Endpoint.Protocol	_protocol
protected Endpoint.EndpointType	_type

Constructor Summary

Constructors

Constructor and Description
HttpEndpoint(int port) Construct an HTTP endpoint that listens on all interfaces.
HttpEndpoint(String host, int port) Construct an HTTP endpoint for a particular host and port.
HttpEndpoint(String host, int port, Endpoint.Protocol protocol) Construct an HTTP endpoint for a particular host, port, and protocol.

Method Summary

Modifier and Type	Method and Description
int	getAcceptQueueSize() Get number of connection requests that can be queued up before the operating system starts to send rejections.
Endpoint.EndpointType	getEndpointType() Get the endpoint connector I/O type.
String	getHost() Returns the endpoint's host.
int	getMaxIdleTime() Default valule is 200000 ms
int	getNumAcceptors() Get the number of thread dedicated to accepting incoming connections.
int	getPort() Returns the endpoint's port number.
Endpoint.Protocol	getProtocol() Returns the endpoint's protocol.
void	setAcceptQueueSize(int acceptQueueSize) Set number of connection requests that can be queued up before the operating system starts to send rejections.
void	setEndpointType(Endpoint.EndpointType type) Set the endpoint connector I/O type (like blocking or NIO).
void	setMaxIdleTime(int maxIdleTime) Set the maximum Idle time for a connection, which roughly translates to the Socket.setSoTimeout(int) call but depends on the application server used and how it is configured.
void	setNumAcceptors(int acceptors) Set the number of thread dedicated to accepting incoming connections.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

_host

protected String _host

_port

protected int _port

_protocol

protected Endpoint.Protocol _protocol

_numAcceptors

protected int _numAcceptors

_acceptQueueSize

protected int _acceptQueueSize

_maxIdleTime

protected int _maxIdleTime

_type

protected Endpoint.EndpointType _type

Constructor Detail

HttpEndpoint

public HttpEndpoint(String host,
                    int port,
                    Endpoint.Protocol protocol)

Construct an HTTP endpoint for a particular host, port, and protocol.

Parameters:

host - The listening interface.

port - The listening port.

protocol - The listening protocol.

HttpEndpoint

public HttpEndpoint(int port)

Construct an HTTP endpoint that listens on all interfaces.

Parameters:

port - The listening port.

HttpEndpoint

public HttpEndpoint(String host,
                    int port)

Construct an HTTP endpoint for a particular host and port.

Parameters:

host - The listening interface.

port - The listening port.

Method Detail

getPort

public int getPort()

Description copied from interface: Endpoint

Returns the endpoint's port number.

Specified by:

getPort in interface Endpoint

Returns:

The endpoint's port number.

getHost

public String getHost()

Description copied from interface: Endpoint

Returns the endpoint's host.

Specified by:

getHost in interface Endpoint

Returns:

The endpoint's host.

getProtocol

public Endpoint.Protocol getProtocol()

Description copied from interface: Endpoint

Returns the endpoint's protocol.

Specified by:

getProtocol in interface Endpoint

Returns:

The endpoint's protocol.

toString

public String toString()

Overrides:

toString in class Object

getAcceptQueueSize

public int getAcceptQueueSize()

Description copied from interface: Endpoint

Get number of connection requests that can be queued up before the operating system starts to send rejections.

Specified by:

getAcceptQueueSize in interface Endpoint

Returns:

max number of queued requests

getNumAcceptors

public int getNumAcceptors()

Description copied from interface: Endpoint

Get the number of thread dedicated to accepting incoming connections.

Specified by:

getNumAcceptors in interface Endpoint

Returns:

thread number

setAcceptQueueSize

public void setAcceptQueueSize(int acceptQueueSize)

Description copied from interface: Endpoint

Set number of connection requests that can be queued up before the operating system starts to send rejections.

Specified by:

setAcceptQueueSize in interface Endpoint

Parameters:

acceptQueueSize - max number of queued requests. Defaults to 0. For the semantics see backlog parameter in ServerSocket.bind(java.net.SocketAddress, int)

setNumAcceptors

public void setNumAcceptors(int acceptors)

Description copied from interface: Endpoint

Set the number of thread dedicated to accepting incoming connections.

Specified by:

setNumAcceptors in interface Endpoint

Parameters:

acceptors - thread number. Defaults to 1

getMaxIdleTime

public int getMaxIdleTime()

Description copied from interface: Endpoint

Default valule is 200000 ms

Specified by:

getMaxIdleTime in interface Endpoint

Returns:

Returns the maxIdleTime.

setMaxIdleTime

public void setMaxIdleTime(int maxIdleTime)

Description copied from interface: Endpoint

Set the maximum Idle time for a connection, which roughly translates to the Socket.setSoTimeout(int) call but depends on the application server used and how it is configured. The max idle time is applied:

• When waiting for a new request to be received on a connection
• When reading the headers and content of a request
• When writing the headers and content of a response

This value MUST be bigger than the keep alive period on the client.

Default value is 200000 ms

Specified by:

setMaxIdleTime in interface Endpoint

Parameters:

maxIdleTime - The maxIdleTime to set.

getEndpointType

public Endpoint.EndpointType getEndpointType()

Description copied from interface: Endpoint

Get the endpoint connector I/O type.

Specified by:

getEndpointType in interface Endpoint

Returns:

EndpointType representing the type

setEndpointType

public void setEndpointType(Endpoint.EndpointType type)

Description copied from interface: Endpoint

Set the endpoint connector I/O type (like blocking or NIO). Default is Endpoint.EndpointType.BLOCKING.

Specified by:

setEndpointType in interface Endpoint

Parameters:

type - the I/O type to use