Package com.iizix.server.weblogos

Class WebLogos

java.lang.Object
com.iizix.server.weblogos.WebLogos
public class WebLogos extends Object
Class holding all Website logos together and requesting only the ones needed.
Author:
Christopher Mindus

  • Field Details

    • DEBUG

      public static final boolean DEBUG
      The debug flag.
      See Also:

    • FILE_EXTS

      public static final String[] FILE_EXTS
      Supported file extensions: ".png", ".jpg", ".jpeg", ".gif", ".bmp", ... (".svg" later on).

  • Constructor Details

    • WebLogos

      public WebLogos(ServerShell server) throws IOException
      Constructor. This constructor should NOT be called directly, it is handled from the Server itself.
      Parameters:
      server - The server instance.
      Throws:
      IOException - If the COMMON_PERSISTENT file provider could not
      IllegalStateException - If constructor is called outside of the server itself.

  • Method Details

    • siteToFileName

      public static String siteToFileName(String site, int width, int height, int quality)
      Gets the file name to use in the file provider for a Website logo.
      Parameters:
      site - The Website name, e.g. "oracle.com" or "www.oracle.com".
      width - The requested width of the image, range 10-1000.
      height - The requested height of the image, range 10-1000.
      quality - The quality of the image (0=pixel-perfect as PNG, otherwise 1-100 for JPG quality).
      Returns:
      File file name to use as below. File name ends with ".jpg" when quality is 1-100, or ".png" when quality is zero (loss-less). "website-"+site.toLowerCase()+"-logo-"+width+'x'+height+".jpg".
      Throws:
      IllegalArgumentException - If width is not in range of 10-1000, height is not in range of 10-1000, or quality is not in range of 0-100.

    • siteToFileName

      public static File siteToFileName(File root, String site)
      Gets the file name to use in the file provider for a Website logo.
      Parameters:
      root - The root of the file provider that contains the Website logos. The lastest updated file will be returned with the file name supported.
      site - The Website name, e.g. "oracle.com" or "www.oracle.com".
      Returns:
      File use as "website-"+site.toLowerCase()+"-logo.[png|jpg|...]". The root will be searched for file names that matches the file extensions (.png, .jpg, ...). The one with the latest date is returned. If none is found, null is returned. If a valid file is returned, it is canonical.

    • siteToFileName

      public static String siteToFileName(String site)
      Gets the file name to use in the file provider for a Website logo.
      Parameters:
      site - The Website name, e.g. "oracle.com" or "www.oracle.com".
      Returns:
      File file name to use as "website-"+site.toLowerCase()+"-logo.[png|jpg|...]". The default is to return the "png" file extension, although that may not be the one actually used (it is very common though).

    • fileNameToSite

      public static String fileNameToSite(String fileName)
      Converts a logo file name into a potential Website name.
      Parameters:
      fileName - The file name.
      Returns:
      The site name, or null is doesn't follow the rule "website-"+site.toLowerCase()+"-logo.[png|jpg|...]".

    • urlToSite

      public static String urlToSite(URL url) throws MalformedURLException
      Converts a URL into a potential Website name.
      Parameters:
      url - The URL.
      Returns:
      The site name, or null it cannot be established properly. The protocol is not specified (http/https).
      Throws:
      MalformedURLException - If the address cannot be turned into a Website "URL".

    • urlToSite

      public static String urlToSite(InternetAddress address) throws MalformedURLException
      Converts an email address into a potential Website name.
      Parameters:
      address - The mail address.
      Returns:
      The site name, or null it cannot be established properly. The protocol is not specified (http/https).
      Throws:
      MalformedURLException - If the address cannot be turned into a Website "URL".

    • stringToSite

      public static String stringToSite(String site) throws MalformedURLException
      Converts an URL or email to a potential Website.
      Parameters:
      site - The string as a potential site.
      Returns:
      The Website name, never null. The protocol is not specified (http/https).
      Throws:
      MalformedURLException

    • getFileProvider

      public WSFileProvider getFileProvider()
      Gets the file provider for logos that are persistent.
      Returns:
      The file provider.

    • requestWebLogo

      public WebLogo requestWebLogo(String site) throws MalformedURLException, IllegalStateException
      Requests a new logo for a Website. If already present, it will be returned directly, otherwise you might have to wait for it using the WebLogo.waitForCompletion(Runnable).
      Parameters:
      site - A URL string where the protocol will be stripped.
      Returns:
      The instance of a WebThumbnail.
      Throws:
      MalformedURLException - If the protocol in invalid.
      IllegalStateException - If the WebThumbs instance is disposed of or was not initialized with a proper API key.