com.ibm.wsspi.http

Interface VirtualHost



  • public interface VirtualHost
    Representation of a VirtualHost
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      void addContextRoot(java.lang.String contextRoot, HttpContainer container)
      Add the container as a handler for the specified context root.
      java.util.List<java.lang.String> getAliases() 
      java.util.Collection<java.lang.String> getAllowedFromEndpoints() 
      java.lang.String getHostName(java.lang.String hostAlias) 
      int getHttpPort(java.lang.String hostAlias) 
      java.lang.String getMimeType(java.lang.String extension)
      Retrieve MIME type for extension
      java.lang.String getName()
      The name of the virtual host.
      int getSecureHttpPort(java.lang.String hostAlias) 
      java.lang.String getUrlString(java.lang.String contextRoot, boolean securedPreferred) 
      void removeContextRoot(java.lang.String contextRoot, HttpContainer container)
      Remove the container as a handler for the specified context root.
    • Method Detail

      • getName

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

        java.lang.String getMimeType(java.lang.String extension)
        Retrieve MIME type for extension
        Parameters:
        extension -
        Returns:
        mime type or null
      • addContextRoot

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

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

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

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

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

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

        java.lang.String getUrlString(java.lang.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

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