Interface UrlAware

  • All Implemented Interfaces:

    
    public interface UrlAware
    
                        

    UrlAware encapsulates a URL along with additional specifications defining its loading behavior.

    A URL represents a Uniform Resource Locator, a pointer to a "resource" on the World Wide Web. A resource can be something as simple as a file or a directory, or it can be a reference to a more complicated object, such as a query to a database or to a search engine.

    In java, a URL object represents a URL. In PulsarRPA, a UrlAware object represents a URL with extra information telling the system how to fetch it.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Field Summary

      Fields 
      Modifier and Type Field Description
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      abstract String getUrl() The url specification, can be followed by load arguments.
      abstract Unit setUrl(String url) The url specification, can be followed by load arguments.
      abstract String getArgs() The explicitly specified load arguments
      abstract Unit setArgs(String args) The explicitly specified load arguments
      abstract String getHref() The hypertext reference, it defines the address of the document, which this time is linked from.
      abstract Unit setHref(String href) The hypertext reference, it defines the address of the document, which this time is linked from.
      abstract String getReferrer() The referrer url, it is the url of the webpage that contains the hyperlink.
      abstract Unit setReferrer(String referrer) The referrer url, it is the url of the webpage that contains the hyperlink.
      abstract Integer getPriority() The priority of the url, the higher the priority, the earlier the url will be loaded.
      abstract Unit setPriority(Integer priority) The priority of the url, the higher the priority, the earlier the url will be loaded.
      abstract String getConfiguredUrl() The configured url, always be "$url $args"
      abstract Boolean isStandard() If true, the url is standard and can be converted to a java.net.URL
      abstract URL getToURL() Converted to a java.net.URL
      abstract URL getToURLOrNull() Converted to a java.net.URL, if the url is invalid, return null
      abstract Boolean isNil() An url is Nil if it equals to AppConstants.
      abstract Boolean isPersistable() If true, the url is persistable, it can be saved to the database.
      abstract String getText() The text of the url, it can be the text of the hyperlink.
      abstract Unit setText(String text) The text of the url, it can be the text of the hyperlink.
      abstract Integer getOrder() The order of the url.
      abstract Unit setOrder(Integer order) The order of the url.
      abstract String getLabel() The url label, it should be a shortcut for -label option in load options
      abstract Instant getDeadline() The deadline, it should be a shortcut for -deadline option in load options
      abstract String getLang() Required website language, reserved for future use
      abstract String getCountry() Required website country, reserved for future use
      abstract String getDistrict() Required website district, reserved for future use
      abstract Integer getNMaxRetry() The maximum retry times
      abstract Integer getDepth() The depth of the url
      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • getUrl

         abstract String getUrl()

        The url specification, can be followed by load arguments.

      • setUrl

         abstract Unit setUrl(String url)

        The url specification, can be followed by load arguments.

      • getArgs

         abstract String getArgs()

        The explicitly specified load arguments

      • setArgs

         abstract Unit setArgs(String args)

        The explicitly specified load arguments

      • getHref

         abstract String getHref()

        The hypertext reference, it defines the address of the document, which this time is linked from. The href is usually extracted from the webpage and serves as the browser's primary choice for navigation.

      • setHref

         abstract Unit setHref(String href)

        The hypertext reference, it defines the address of the document, which this time is linked from. The href is usually extracted from the webpage and serves as the browser's primary choice for navigation.

      • getReferrer

         abstract String getReferrer()

        The referrer url, it is the url of the webpage that contains the hyperlink.

      • setReferrer

         abstract Unit setReferrer(String referrer)

        The referrer url, it is the url of the webpage that contains the hyperlink.

      • getPriority

         abstract Integer getPriority()

        The priority of the url, the higher the priority, the earlier the url will be loaded. Priority is a numerical value, where smaller numbers indicate higher priority.

      • setPriority

         abstract Unit setPriority(Integer priority)

        The priority of the url, the higher the priority, the earlier the url will be loaded. Priority is a numerical value, where smaller numbers indicate higher priority.

      • isNil

         abstract Boolean isNil()

        An url is Nil if it equals to AppConstants.NIL_PAGE_URL

      • isPersistable

         abstract Boolean isPersistable()

        If true, the url is persistable, it can be saved to the database. Not all urls are persistable, for example, a ListenableHyperlink with events is not persistable.

      • getText

         abstract String getText()

        The text of the url, it can be the text of the hyperlink.

      • setText

         abstract Unit setText(String text)

        The text of the url, it can be the text of the hyperlink.

      • getLabel

         abstract String getLabel()

        The url label, it should be a shortcut for -label option in load options

      • getDeadline

         abstract Instant getDeadline()

        The deadline, it should be a shortcut for -deadline option in load options

      • getLang

         abstract String getLang()

        Required website language, reserved for future use

      • getCountry

         abstract String getCountry()

        Required website country, reserved for future use

      • getDistrict

         abstract String getDistrict()

        Required website district, reserved for future use