Class WebsiteProcessActionHandler.BaseURL

  • All Implemented Interfaces:
    IWebsiteBaseURL
    Enclosing class:
    WebsiteProcessActionHandler

    public static class WebsiteProcessActionHandler.BaseURL
    extends java.lang.Object
    implements IWebsiteBaseURL
    Since:
    7.0.0
    Version:
    $Revision: 23785 $ $Date: 2020-05-06 18:46:13 -0300 (Wed, 06 May 2020) $
    • Constructor Summary

      Constructors 
      Constructor Description
      BaseURL​(java.lang.String id, java.lang.String domain, java.lang.Integer port, java.lang.String path)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDomain()
      Returns the domain of this website base URL.
      java.lang.String getId()  
      java.lang.String getPath()
      Returns the path part of this website base URL.
      int getPort()
      Returns the port of this website base URL.
      IWebsite getWebsite()
      Returns the website this base URL belongs to.
      boolean matches​(HttpServletRequest request)
      Returns whether a HttpServletRequest destination matches this base URL.
      void setDomain​(java.lang.String domain)  
      void setId​(java.lang.String id)  
      void setPath​(java.lang.String path)  
      void setPort​(java.lang.Integer port)  
      java.lang.String toString()
      Returns a string representation of this base URL.
      java.lang.String toString​(boolean includePort)  
      java.net.URI toURI​(boolean secure)
      Returns this base URL as a URI object.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • BaseURL

        public BaseURL​(java.lang.String id,
                       java.lang.String domain,
                       java.lang.Integer port,
                       java.lang.String path)
    • Method Detail

      • setId

        public void setId​(java.lang.String id)
      • getId

        public java.lang.String getId()
      • setDomain

        public void setDomain​(java.lang.String domain)
      • getDomain

        public java.lang.String getDomain()
        Description copied from interface: IWebsiteBaseURL
        Returns the domain of this website base URL.
        Specified by:
        getDomain in interface IWebsiteBaseURL
        Returns:
        the domain. Example: my.site.com
      • setPort

        public void setPort​(java.lang.Integer port)
      • getPort

        public int getPort()
        Description copied from interface: IWebsiteBaseURL
        Returns the port of this website base URL.
        Specified by:
        getPort in interface IWebsiteBaseURL
        Returns:
        the port of this website base URL.
      • setPath

        public void setPath​(java.lang.String path)
      • getPath

        public java.lang.String getPath()
        Description copied from interface: IWebsiteBaseURL
        Returns the path part of this website base URL.
        Specified by:
        getPath in interface IWebsiteBaseURL
        Returns:
        the path path of this website base URL, or an empty string if it has no path. Never returns null.
      • toString

        public java.lang.String toString()
        Description copied from interface: IWebsiteBaseURL
        Returns a string representation of this base URL.

        The purpose of the returned string is for simple display of this base URL and may not be compatible to any format.

        Specified by:
        toString in interface IWebsiteBaseURL
        Overrides:
        toString in class java.lang.Object
        Returns:
        this base URL as a string.
      • toString

        public java.lang.String toString​(boolean includePort)
      • getWebsite

        public IWebsite getWebsite()
        Description copied from interface: IWebsiteBaseURL
        Returns the website this base URL belongs to.
        Specified by:
        getWebsite in interface IWebsiteBaseURL
        Returns:
        the website this base URL belongs to.
      • matches

        public boolean matches​(HttpServletRequest request)
        Description copied from interface: IWebsiteBaseURL
        Returns whether a HttpServletRequest destination matches this base URL.

        The request is considered as matching this base URL if its destination corresponds to any resource inside it.

        Specified by:
        matches in interface IWebsiteBaseURL
        Parameters:
        request - the request.
        Returns:
        true if the request matches this base URL, false otherwise.
      • toURI

        public java.net.URI toURI​(boolean secure)
        Description copied from interface: IWebsiteBaseURL
        Returns this base URL as a URI object.
        Specified by:
        toURI in interface IWebsiteBaseURL
        Parameters:
        secure - whether the URI returned is to use a secure schema or not.
        Returns:
        the URI.