Package com.sun.enterprise.config.serverbeans

Interface HttpService

All Superinterfaces:
org.jvnet.hk2.config.ConfigBeanProxy, org.glassfish.api.admin.config.ConfigExtension, org.glassfish.api.admin.config.Container, org.jvnet.hk2.config.types.PropertyBag
public interface HttpService extends org.jvnet.hk2.config.ConfigBeanProxy, org.jvnet.hk2.config.types.PropertyBag, org.glassfish.api.admin.config.ConfigExtension

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull AccessLog
    getAccessLog()
    Gets the value of the accessLog property.
    @Pattern(regexp="(false|true|on|off)",message="Valid values: true|false") String
    getAccessLoggingEnabled()
     
    default List<String>
    getNonAdminVirtualServerList()
     
    List<org.jvnet.hk2.config.types.Property>
    getProperty()
     
    @Pattern(regexp="(true|false|on|off)",message="Valid values: true|false") String
    getSsoEnabled()
    If true, single sign-on is enabled by default for all web applications on all virtual servers on this server instance that are configured for the same realm.
    List<VirtualServer>
    getVirtualServer()
    Gets the value of the virtualServer property.
    default VirtualServer
    getVirtualServerByName(String serverName)
     
    void
    setAccessLog(AccessLog accessLog)
    Sets the value of the accessLog property.
    void
    setAccessLoggingEnabled(String enabled)
     
    void
    setSsoEnabled(String ssoEnabled)
    Sets the value of the ssoEnabled property.

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

    createChild, deepCopy, getParent, getParent

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

    addProperty, getProperty, getPropertyValue, getPropertyValue, lookupProperty, removeProperty, removeProperty

  • Method Details

    • getAccessLog

      @NotNull @NotNull AccessLog getAccessLog()
      Gets the value of the accessLog property.
      Returns:
      possible object is AccessLog

    • setAccessLog

      void setAccessLog(AccessLog accessLog) throws PropertyVetoException
      Sets the value of the accessLog property.
      Parameters:
      accessLog - allowed object is AccessLog
      Throws:
      PropertyVetoException

    • getVirtualServer

      List<VirtualServer> getVirtualServer()
      Gets the value of the virtualServer property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the virtualServer property.

      For example, to add a new item, do as follows: 

       getVirtualServer().add(newItem);

      Objects of the following type(s) are allowed in the list VirtualServer

    • getVirtualServerByName

      default VirtualServer getVirtualServerByName(String serverName)

    • getNonAdminVirtualServerList

      default List<String> getNonAdminVirtualServerList()

    • getAccessLoggingEnabled

      @Pattern(regexp="(false|true|on|off)", message="Valid values: true|false") @Pattern(regexp="(false|true|on|off)",message="Valid values: true|false") String getAccessLoggingEnabled()

    • setAccessLoggingEnabled

      void setAccessLoggingEnabled(String enabled)

    • getSsoEnabled

      @Pattern(regexp="(true|false|on|off)", message="Valid values: true|false") @Pattern(regexp="(true|false|on|off)",message="Valid values: true|false") String getSsoEnabled()
      If true, single sign-on is enabled by default for all web applications on all virtual servers on this server instance that are configured for the same realm. If false, single sign-on is disabled by default for all virtual servers, and users must authenticate separately to every application on each virtual server. The sso-enabled property setting of the virtual-server element can override this setting for an individual virtual server or inherit the value by using inherit.
      Returns:
      possible object is String

    • setSsoEnabled

      void setSsoEnabled(String ssoEnabled)
      Sets the value of the ssoEnabled property.
      Parameters:
      ssoEnabled - allowed object is String

    • getProperty

      @PropertyDesc(name="monitoring-cache-enabled",defaultValue="true",dataType=java.lang.Boolean.class,description="Enables the monitoring cache") @PropertyDesc(name="monitoring-cache-refresh-in-millis",defaultValue="5000",dataType=NonNegativeInteger.class,description="Specifies the interval between refreshes of the monitoring cache") @PropertyDesc(name="ssl-cache-entries",defaultValue="10000",dataType=NonNegativeInteger.class,description="Specifies the number of SSL sessions to be cached") @PropertyDesc(name="ssl3-session-timeout",defaultValue="86400",dataType=NonNegativeInteger.class,description="Specifies the interval at which SSL3 sessions are cached") @PropertyDesc(name="ssl-session-timeout",defaultValue="100",dataType=NonNegativeInteger.class,description="Specifies the interval at which SSL2 sessions are cached") @PropertyDesc(name="recycle-objects",defaultValue="true",dataType=java.lang.Boolean.class,description="Whether to recycle internal objects instead of using the VM garbage collector") @PropertyDesc(name="reader-threads",defaultValue="0",dataType=NonNegativeInteger.class,description="Specifies the number of reader threads, which read bytes from the non-blocking socket") @PropertyDesc(name="acceptor-queue-length",defaultValue="4096",dataType=NonNegativeInteger.class,description="Specifies the length of the acceptor thread queue. Once full, connections are rejected") @PropertyDesc(name="reader-queue-length",defaultValue="4096",dataType=NonNegativeInteger.class,description="Specifies the 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="Controls whether the NIO direct ByteBuffer 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 the http-listeners receive traffic from an SSL-terminating proxy server, which is responsible for forwarding any information about the original client request (such as client IP address, SSL keysize, and authenticated client certificate chain) to the HTTP listeners using custom request headers. Each subelement can override this setting for itself") @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. Only used if authPassthroughEnabled is set to true. Each http-listener can override the setting for itself") @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 to false to make the server less susceptible to cross-site scripting attacks") @PropertyDesc(name="accessLoggingEnabled",defaultValue="false",dataType=java.lang.Boolean.class,description="Controls access logging for all virtual-server that do not specify this property") @PropertyDesc(name="disableUploadTimeout",defaultValue="true",dataType=java.lang.Boolean.class,description="If 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 set to false") @PropertyDesc(name="uriEncoding",defaultValue="UTF-8",description="Specifies the character set used to decode the request URIs received on http-listeners that do not define this property. Must be a valid IANA character set name") List<org.jvnet.hk2.config.types.Property> getProperty()
      Specified by:
      getProperty in interface org.jvnet.hk2.config.types.PropertyBag