com.sun.enterprise.config.serverbeans
Interface HttpListener

All Superinterfaces:

org.jvnet.hk2.config.ConfigBeanProxy, org.jvnet.hk2.component.Injectable, org.jvnet.hk2.config.types.PropertyBag

Deprecated.

@Deprecated
public interface HttpListener
extends org.jvnet.hk2.config.ConfigBeanProxy, org.jvnet.hk2.component.Injectable, org.jvnet.hk2.config.types.PropertyBag

Nested Class Summary

Nested classes/interfaces inherited from interface org.jvnet.hk2.config.ConfigBeanProxy

org.jvnet.hk2.config.ConfigBeanProxy.Duck

Nested classes/interfaces inherited from interface org.jvnet.hk2.config.types.PropertyBag

org.jvnet.hk2.config.types.PropertyBag.Duck

Method Summary

String	getAcceptorThreads() Deprecated. Gets the value of the acceptorThreads property.
String	getAddress() Deprecated. Gets the value of the address property.
String	getBlockingEnabled() Deprecated. Gets the value of the blockingEnabled property.
String	getDefaultVirtualServer() Deprecated. Gets the value of the defaultVirtualServer property.
String	getEnabled() Deprecated. Gets the value of the enabled property.
String	getExternalPort() Deprecated. Gets the value of the externalPort property.
String	getFamily() Deprecated. Gets the value of the family property.
String	getId() Deprecated. Gets the value of the id property.
String	getPort() Deprecated. Gets the value of the port property.
List<org.jvnet.hk2.config.types.Property>	getProperty() Deprecated.
String	getRedirectPort() Deprecated. Gets the value of the redirectPort property.
String	getSecurityEnabled() Deprecated. Gets the value of the securityEnabled property.
String	getServerName() Deprecated. Gets the value of the serverName property.
com.sun.grizzly.config.dom.Ssl	getSsl() Deprecated. Gets the value of the ssl property.
String	getXpoweredBy() Deprecated. Gets the value of the xpoweredBy property.
void	setAcceptorThreads(String value) Deprecated. Sets the value of the acceptorThreads property.
void	setAddress(String value) Deprecated. Sets the value of the address property.
void	setBlockingEnabled(String value) Deprecated. Sets the value of the blockingEnabled property.
void	setDefaultVirtualServer(String value) Deprecated. Sets the value of the defaultVirtualServer property.
void	setEnabled(String value) Deprecated. Sets the value of the enabled property.
void	setExternalPort(String value) Deprecated. Sets the value of the externalPort property.
void	setFamily(String value) Deprecated. Sets the value of the family property.
void	setId(String value) Deprecated. Sets the value of the id property.
void	setPort(String value) Deprecated. Sets the value of the port property.
void	setRedirectPort(String value) Deprecated. Sets the value of the redirectPort property.
void	setSecurityEnabled(String value) Deprecated. Sets the value of the securityEnabled property.
void	setServerName(String value) Deprecated. Sets the value of the serverName property.
void	setSsl(com.sun.grizzly.config.dom.Ssl value) Deprecated. Sets the value of the ssl property.
void	setXpoweredBy(String value) Deprecated. Sets the value of the xpoweredBy property.

Methods inherited from interface org.jvnet.hk2.config.ConfigBeanProxy

createChild, deepCopy, getParent, getParent

Methods inherited from interface org.jvnet.hk2.component.Injectable

injectedInto

Methods inherited from interface org.jvnet.hk2.config.types.PropertyBag

getProperty, getPropertyValue, getPropertyValue

Method Detail

getId

@NotNull
@Pattern(regexp="[A-Za-z0-9_][A-Za-z0-9\\-_\\./;#]*")
String getId()

Deprecated.

Gets the value of the id property. Unique identifier for http listener.

Returns:

possible object is String

setId

void setId(String value)
           throws PropertyVetoException

Deprecated.

Sets the value of the id property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getAddress

@NotNull
String getAddress()

Deprecated.

Gets the value of the address property. IP address of the listen socket. Can be in dotted-pair or IPv6 notation. Can also be any for INADDR-ANY. Configuring a listen socket to listen on any is required if more than one http-listener is configured to it.

Returns:

possible object is String

setAddress

void setAddress(String value)
                throws PropertyVetoException

Deprecated.

Sets the value of the address property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getPort

@NotNull
@Max(value=65535L)
@Min(value=1L)
String getPort()

Deprecated.

Gets the value of the port property. Port number to create the listen socket on. Legal values are 1 - 65535. On Unix, creating sockets that listen on ports 1 - 1024 requires superuser privileges. Configuring an SSL listen socket to listen on port 443 is recommended.

Returns:

possible object is String

setPort

void setPort(String value)
             throws PropertyVetoException

Deprecated.

Sets the value of the port property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getExternalPort

@Max(value=65535L)
@Min(value=1L)
String getExternalPort()

Deprecated.

Gets the value of the externalPort property. The port at which the user makes a request, typically a proxy server port

Returns:

possible object is String

setExternalPort

void setExternalPort(String value)
                     throws PropertyVetoException

Deprecated.

Sets the value of the externalPort property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getFamily

String getFamily()

Deprecated.

Gets the value of the family property. Specified the family of addresses either inet or ncsa

Returns:

possible object is String

setFamily

void setFamily(String value)
               throws PropertyVetoException

Deprecated.

Sets the value of the family property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getBlockingEnabled

String getBlockingEnabled()

Deprecated.

Gets the value of the blockingEnabled property. Enables blocking for the listen and external ports.

Returns:

possible object is String

setBlockingEnabled

void setBlockingEnabled(String value)
                        throws PropertyVetoException

Deprecated.

Sets the value of the blockingEnabled property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getAcceptorThreads

@Min(value=1L)
@Max(value=2147483647L)
String getAcceptorThreads()

Deprecated.

Gets the value of the acceptorThreads property. Number of acceptor threads for the listen socket. The recommended value is the number of processors in the machine.

Returns:

possible object is String

setAcceptorThreads

void setAcceptorThreads(String value)
                        throws PropertyVetoException

Deprecated.

Sets the value of the acceptorThreads property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getSecurityEnabled

String getSecurityEnabled()

Deprecated.

Gets the value of the securityEnabled property. Determines whether the http listener runs SSL. You can turn SSL2 or SSL3 on or off and set ciphers using an ssl element. The enable-ssl in the protocol element should be set to true for this setting to work.

Returns:

possible object is String

setSecurityEnabled

void setSecurityEnabled(String value)
                        throws PropertyVetoException

Deprecated.

Sets the value of the securityEnabled property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getDefaultVirtualServer

@NotNull
String getDefaultVirtualServer()

Deprecated.

Gets the value of the defaultVirtualServer property. The id attribute of the default virtual server for this particular connection group.

Returns:

possible object is String

setDefaultVirtualServer

void setDefaultVirtualServer(String value)
                             throws PropertyVetoException

Deprecated.

Sets the value of the defaultVirtualServer property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getServerName

@NotNull
String getServerName()

Deprecated.

Gets the value of the serverName property. Tells the server what to put in the host name section of any URLs it sends to client. This affects URLs the server automatically generates; it doesnt affect the URLs for directories and files stored in the server. This name should be the alias name if your server uses an alias. If you append a colon and port number, that port will be used in URLs the server sends to the client.

Returns:

possible object is String

setServerName

void setServerName(String value)
                   throws PropertyVetoException

Deprecated.

Sets the value of the serverName property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getRedirectPort

@Max(value=65535L)
@Min(value=1L)
String getRedirectPort()

Deprecated.

Gets the value of the redirectPort property. If the connector is supporting non-SSL requests and a request is received for which a matching security-constraint requires SSL transport catalina will automatically redirect the request to the port number specified here

Returns:

possible object is String

setRedirectPort

void setRedirectPort(String value)
                     throws PropertyVetoException

Deprecated.

Sets the value of the redirectPort property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getXpoweredBy

String getXpoweredBy()

Deprecated.

Gets the value of the xpoweredBy property. The Servlet 2.4 spec defines a special X-Powered-By: Servlet/2.4 header, which containers may add to servlet-generated responses. This is complemented by the JSP 2.0 spec, which defines a X-Powered-By: JSP/2.0 header to be added (on an optional basis) to responses utilizing JSP technology. The goal of these headers is to aid in gathering statistical data about the use of Servlet and JSP technology. If true, these headers will be added.

Returns:

possible object is String

setXpoweredBy

void setXpoweredBy(String value)
                   throws PropertyVetoException

Deprecated.

Sets the value of the xpoweredBy property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getEnabled

String getEnabled()

Deprecated.

Gets the value of the enabled property.

Returns:

possible object is String

setEnabled

void setEnabled(String value)
                throws PropertyVetoException

Deprecated.

Sets the value of the enabled property.

Parameters:

value - allowed object is String

Throws:

PropertyVetoException

getSsl

com.sun.grizzly.config.dom.Ssl getSsl()

Deprecated.

Gets the value of the ssl property.

Returns:

possible object is Ssl

setSsl

void setSsl(com.sun.grizzly.config.dom.Ssl value)
            throws PropertyVetoException

Deprecated.

Sets the value of the ssl property.

Parameters:

value - allowed object is Ssl

Throws:

PropertyVetoException

getProperty

@PropertiesDesc(systemProperties=false,
                props={@PropertyDesc(name="recycle-objects",defaultValue="true",dataType=java.lang.Boolean.class,description="Recycles internal objects instead of using the VM garbage collector"),@PropertyDesc(name="reader-threads",defaultValue="0",dataType=NonNegativeInteger.class,description="Number of reader threads, which read bytes from the non-blocking socket"),@PropertyDesc(name="acceptor-queue-length",defaultValue="4096",dataType=NonNegativeInteger.class,description="Length of the acceptor thread queue. Once full, connections are rejected"),@PropertyDesc(name="reader-queue-length",defaultValue="4096",dataType=NonNegativeInteger.class,description="Length of the reader thread queue. Once full, connections are rejected"),@PropertyDesc(name="use-nio-direct-bytebuffer",defaultValue="true",dataType=java.lang.Boolean.class,description="Specifies that the NIO direct is used. In a limited resource environment, it might be faster to use non-direct Java\'s ByteBuffer by setting a value of false"),@PropertyDesc(name="authPassthroughEnabled",defaultValue="false",dataType=java.lang.Boolean.class,description="Indicates that this http-listener element receives traffic from an  SSL-terminating proxy server. Overrides the authPassthroughEnabled  property of the parent http-service"),@PropertyDesc(name="proxyHandler",defaultValue="com.sun.enterprise.web.ProxyHandlerImpl",description="Specifies the fully qualified class name of a custom implementation of com.sun.appserv.ProxyHandler.Used if the authPassthroughEnabled property of this http-listener and the parent http-service are both true. Overrides any value in the parent http-service element"),@PropertyDesc(name="proxiedProtocol",values={"ws/tcp","http","https","tls"},description="Comma-separated list of protocols that can use the same port. For example, if you set this property to http,https and set the port to 4567, you can access the port with either http://host:4567/ or https://host:4567/.  Specifying this property at the \u201chttp-service\ufffd? on page 42 level overrides settings at the http-listener level. If this property is not set at either level, this feature is disabled"),@PropertyDesc(name="bufferSize",defaultValue="4096",dataType=NonNegativeInteger.class,description="Size in bytes of the buffer to be provided for input streams created by HTTP listeners"),@PropertyDesc(name="connectionTimeout",defaultValue="30",dataType=NonNegativeInteger.class,description="Number of seconds HTTP listeners wait after accepting a connection for the request URI line to be presented"),@PropertyDesc(name="maxKeepAliveRequests",defaultValue="250",dataType=NonNegativeInteger.class,description="Maximum number of HTTP requests that can be pipelined until the connection is closed by the server. Set this property to 1 to disable HTTP/1.0  keep-alive, as well as HTTP/1.1 keep-alive and pipelining"),@PropertyDesc(name="traceEnabled",defaultValue="true",dataType=java.lang.Boolean.class,description="Enables the TRACE operation. Set this property to false to make the server less susceptible to cross-site scripting attacks"),@PropertyDesc(name="cometSupport",defaultValue="false",dataType=java.lang.Boolean.class,description="Enables Comet support for this listener.  If your servlet/JSP page uses Comet technology, make sure it is initialized by adding the load-on-startup element to web.xml"),@PropertyDesc(name="jkEnabled",defaultValue="false",dataType=java.lang.Boolean.class,description="Enablesd/disables mod_jk support."),@PropertyDesc(name="compression",defaultValue="off",values={"off","on","force"},description="Specifies use of HTTP/1.1 GZIP compression to save server bandwidth. A positive integer specifies the minimum amount of data required before the output is compressed. If the content-length is not known, the output is compressed only if compression is set to \'on\' or \'force\'"),@PropertyDesc(name="compressableMimeType",defaultValue="text/html, text/xml, text/plain",description="Comma-separated list of MIME types for which HTTP compression is used"),@PropertyDesc(name="noCompressionUserAgents",defaultValue="",description="Comma-separated list of regular expressions matching user-agents of HTTP clients for which compression should not be used"),@PropertyDesc(name="compressionMinSize",dataType=NonNegativeInteger.class,description="Minimum size of a file when compression is applied"),@PropertyDesc(name="minCompressionSize",dataType=NonNegativeInteger.class,description="Minimum size of a file when compression is applied"),@PropertyDesc(name="crlFile",description="Location of the Certificate Revocation List (CRL) file to consult during SSL client authentication. Can be an absolute or relative file path. If relative, it is resolved against domain-dir. If unspecified, CRL checking is disabled"),@PropertyDesc(name="trustAlgorithm",values="PKIX",description="Name of the trust management algorithm (for example, PKIX) to use for certification path validation"),@PropertyDesc(name="trustMaxCertLength",defaultValue="5",dataType=java.lang.Integer.class,description="Maximum number of non-self-issued intermediate certificates that can exist in a certification path. Considered only if trustAlgorithm is set to PKIX. A value of zero implies that the path can only contain a single certificate. A value of -1 implies that the path length is unconstrained (no maximum)"),@PropertyDesc(name="disableUploadTimeout",defaultValue="true",dataType=java.lang.Boolean.class,description="When false, the connection for a servlet that reads bytes slowly is closed after the \'connectionUploadTimeout\' is reached"),@PropertyDesc(name="connectionUploadTimeout",defaultValue="5",dataType=NonNegativeInteger.class,description="Specifies the timeout for uploads. Applicable only if \'disableUploadTimeout\' is false"),@PropertyDesc(name="uriEncoding",defaultValue="UTF-8",values="UTF-8",description="Character set used to decode the request URIs received on this HTTP listener. Must be a valid IANA character set name. Overrides the property of the parent http-service")})
List<org.jvnet.hk2.config.types.Property> getProperty()

Deprecated.

Specified by:

getProperty in interface org.jvnet.hk2.config.types.PropertyBag