Interface IUrlAccess

  • All Known Subinterfaces:
    IApplicationPublication, IInfobaseApplication, IServerApplication

    public interface IUrlAccess
    The abstraction for the application itself or application related entities (such as endpoints) to allow to provide available application endpoint URL.

    The interface may be extended by applications or be provided with IUrlAccessProvider.

    • Method Detail

      • getId

        String getId()
        Returns the application URL access unique id.
        Returns:
        the application URL access unique id, never null
      • getApplication

        IApplication getApplication()
        Returns the context application.
        Returns:
        the context application, never null
      • getUrl

        Optional<URL> getUrl()
                      throws ApplicationException
        Returns the optional available url access URL. This method may return nothing if an application or application related entity does not have a valid configuration or if it is not running.
        Returns:
        the optional available accessible URL
        Throws:
        ApplicationException - if endpoint URL get error occurred