Constructor Detail

• FileURN

  protected FileURN​(java.lang.String urnString,
                    URNResourceType type,
                    java.lang.Object id,
                    java.lang.String fileName)

  Constructor for a File URN.

  Parameters:

  urnString - The full URN String.

  type - The URN resource type.

  id - The URN resource ID for the type: a Long or a String depending of the type, null for none.

  fileName - The file name.

Method Detail

• fromExternalFile

  public static FileURN fromExternalFile​(java.lang.String fileName)
                                  throws java.io.FileNotFoundException,
                                         java.io.IOException

  Creates an external File URN from a URI.

  Parameters:

  fileName - The file name.

  Throws:

  java.lang.NullPointerException - If the file is null.

  java.io.FileNotFoundException - If the file is not found or is a directory.

  java.io.IOException - If an I/O error occurs, which is possible because the construction of the canonical pathname may require filesystem queries.

  java.lang.SecurityException - If a required system property value cannot be accessed, or if a security manager exists and its SecurityManager.checkRead(java.io.FileDescriptor) method denies read access to the file.

• fromExternalFile

  public static FileURN fromExternalFile​(java.io.File file)
                                  throws java.net.MalformedURLException,
                                         java.io.FileNotFoundException,
                                         java.io.IOException

  Creates an external File URN from a URI.

  Parameters:

  file - The file.

  Throws:

  java.lang.NullPointerException - If the file is null.

  java.io.FileNotFoundException - If the file is not found or is a directory.

  java.io.IOException - If an I/O error occurs, which is possible because the construction of the canonical pathname may require filesystem queries.

  java.lang.SecurityException - If a required system property value cannot be accessed, or if a security manager exists and its SecurityManager.checkRead(java.io.FileDescriptor) method denies read access to the file.

  java.net.MalformedURLException

• fromExternalFile

  public static FileURN fromExternalFile​(java.net.URI uriFile)
                                  throws java.net.MalformedURLException

  Creates an external File URN from a URI.

  Parameters:

  uriFile - The file URI.

  Throws:

  java.lang.NullPointerException - If the uriFile is null.

  java.lang.IllegalArgumentException - If uriFile as URL is not absolute.

  java.net.MalformedURLException - If uriFile as URL protocol handler could not be found, or if some other error occurred while constructing the URL.

• fromFileResource

  public static FileURN fromFileResource​(URNResourceType type,
                                         java.lang.Object id,
                                         java.lang.String fileName)
                                  throws java.net.MalformedURLException,
                                         MalformedURNException

  Creates a File URN from a string.

  Parameters:

  type - The URN resource type.

  id - The ID used for database identification, Long or String, null when database is not used.

  This value depends on the URNResourceType. The types are:

  • Long  : URNResourceType.COMMON_DATABASE_PERSISTENT: Common database persistent files.
  • String: URNResourceType.APPLICATION_DATABASE_PERSISTENT: Application ID database persistent files.
  • Long : URNResourceType.GROUP_DATABASE_FILES: Group ID database persistent files.
  • Long : URNResourceType.USER_DATABASE_FILES: User ID database persistent files.
  • null For all other {@link URNResourceType}'s.

  fileName - The file name.

  Throws:

  java.lang.NullPointerException - If the type or fileName is null.

  IllegalArgumentExecption - If the class of the id parameter does not match the type URNResourceType parameter. Currently, only {code Long} and {code String} values are allowed.

  java.net.MalformedURLException - If the url is malformed.

  MalformedURNException - If the url is malformed for an iizi URN URL.

• hashCode

  public int hashCode()

  Gets the hash code of the instance. The original URN string is not used for this hash code, rather the URN 'NID' and the parameters.

  Overrides:

  hashCode in class URNResource

  Returns:

  A hash code value.

• equals

  public boolean equals​(java.lang.Object obj)

  Checks if another URN is equal to this one. The original URN string is not used for this comparison, rather the URN 'NID' and the parameters.

  Overrides:

  equals in class URNResource

  Parameters:

  obj - The other object to compare with.

  Returns:

  true if the URN's are equal, false otherwise.

• getParamString

  public java.lang.String getParamString()

  Gets the parameter string for the URN.toString() method.

  Overrides:

  getParamString in class URNResource

  Returns:

  The parameter string, always non-null.

• getURL

  public java.lang.String getURL()
                          throws java.io.IOException

  Gets the URL of this resource relative the current web server.

  Overrides:

  getURL in class URNResource

  Returns:

  The URL relative the current server, if based on the current server.

  Throws:

  java.io.IOException - If there was a problem retrieving the file or an SQL error.