Package com.ibm.wsspi.http

Interface VirtualHost

public interface VirtualHost
Representation of a VirtualHost

  • Method Details

    • getName

      String getName()
      The name of the virtual host. The default virtual host name is "default_host".
      Returns:
      Virtual host name

    • getMimeType

      String getMimeType(String extension)
      Retrieve MIME type for extension
      Parameters:
      extension -
      Returns:
      mime type or null

    • addContextRoot

      void addContextRoot(String contextRoot, HttpContainer container)
      Add the container as a handler for the specified context root.
      Parameters:
      contextRoot -
      container -

    • removeContextRoot

      void removeContextRoot(String contextRoot, HttpContainer container)
      Remove the container as a handler for the specified context root.
      Parameters:
      contextRoot -
      container -

    • getAliases

      List<String> getAliases()
      Returns:
      the list of host:port aliases assigned to this virtual host.

    • getSecureHttpPort

      int getSecureHttpPort(String hostAlias)
      Parameters:
      hostAlias -
      Returns:
      secure https port associated with the given alias (via endpoint configuration), or -1 if unconfigured.

    • getHttpPort

      int getHttpPort(String hostAlias)
      Parameters:
      hostAlias -
      Returns:
      secure http port associated with the given alias (via endpoint configuration), or -1 if unconfigured.

    • getHostName

      String getHostName(String hostAlias)
      Parameters:
      hostAlias -
      Returns:
      configured hostname associated with the given alias (via endpoint configuration).

    • getUrlString

      String getUrlString(String contextRoot, boolean securedPreferred)
      Parameters:
      contextRoot -
      securedPreferred - indicates if the caller prefers to receive a secured URL
      Returns:
      corresponding URL string by combining the given contextRoot and endpoint configuration for this VirtualHost.

    • getAllowedFromEndpoints

      Collection<String> getAllowedFromEndpoints()
      Returns:
      the Collection of allowedFromEndpoints assigned to this virtual host.