Package uk.num.numlib.internal.util

Class URLUtils

  • public class URLUtils
extends java.lang.Object
    Transform a URL to a format suitable for various NUM Protocol queries.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static URLUtils instance()
      Static accessor for the Singleton instance - lazy init.
      java.lang.String toIndependentRecordQuery​(java.net.URL url, java.lang.String moduleId)
      Convert a URL to a query format suitable for use in an independent query.
      java.lang.String toManagedRecordQuery​(java.net.URL url, java.lang.String moduleId)
      Convert a URL to a query format suitable for use in a managed record query.
      java.lang.String toPopulatorQuery​(java.net.URL url, java.lang.String moduleId)
      Convert a URL to a query format suitable for use in a populator query.
      java.lang.String toPrePopulatedRecordQuery​(java.net.URL url, java.lang.String moduleId)
      Convert a URL to a query format suitable for use in a pre-populated record query.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • instance

        public static URLUtils instance()
        Static accessor for the Singleton instance - lazy init.
        Returns:
        URLUtils

      • toIndependentRecordQuery

        public java.lang.String toIndependentRecordQuery​(java.net.URL url,
                                                 java.lang.String moduleId)
                                          throws NumInvalidParameterException,
                                                 NumBadURLException
        Convert a URL to a query format suitable for use in an independent query.
        Parameters:
        url - java.net.URL The URL to be converted.
        moduleId - java.lang.String the module number/id as a String
        Returns:
        java.lang.String The converted URL result.
        Throws:
        NumInvalidParameterException - on error
        NumBadURLException - on error

      • toManagedRecordQuery

        public java.lang.String toManagedRecordQuery​(java.net.URL url,
                                             java.lang.String moduleId)
                                      throws NumInvalidParameterException,
                                             NumBadURLException
        Convert a URL to a query format suitable for use in a managed record query.
        Parameters:
        url - java.net.URL The URL to be converted.
        moduleId - java.lang.String the module number/id as a String
        Returns:
        java.lang.String The converted URL result.
        Throws:
        NumInvalidParameterException - on error
        NumBadURLException - on error

      • toPrePopulatedRecordQuery

        public java.lang.String toPrePopulatedRecordQuery​(java.net.URL url,
                                                  java.lang.String moduleId)
                                           throws NumInvalidParameterException,
                                                  NumBadURLException
        Convert a URL to a query format suitable for use in a pre-populated record query.
        Parameters:
        url - java.net.URL The URL to be converted.
        moduleId - java.lang.String the module number/id as a String
        Returns:
        java.lang.String The converted URL result.
        Throws:
        NumInvalidParameterException - on error
        NumBadURLException - on error

      • toPopulatorQuery

        public java.lang.String toPopulatorQuery​(java.net.URL url,
                                         java.lang.String moduleId)
                                  throws NumInvalidParameterException,
                                         NumBadURLException
        Convert a URL to a query format suitable for use in a populator query.
        Parameters:
        url - java.net.URL The URL to be converted.
        moduleId - java.lang.String the module number/id as a String
        Returns:
        java.lang.String The converted URL result.
        Throws:
        NumInvalidParameterException - on error
        NumBadURLException - on error