Class FileURN

Method Details

• fromExternalFile

  public static FileURN fromExternalFile(String fileName) throws FileNotFoundException, IOException

  Creates an external File URN from a URI.

  Parameters:

  fileName - The file name.

  Throws:

  NullPointerException - If the file is null.

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

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

  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(File file) throws MalformedURLException, FileNotFoundException, IOException

  Creates an external File URN from a URI.

  Parameters:

  file - The file.

  Throws:

  NullPointerException - If the file is null.

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

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

  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.

  MalformedURLException

• fromExternalFile

  public static FileURN fromExternalFile(URI uriFile) throws MalformedURLException

  Creates an external File URN from a URI.

  Parameters:

  uriFile - The file URI.

  Throws:

  NullPointerException - If the uriFile is null.

  IllegalArgumentException - If uriFile as URL is not absolute.

  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, Object id, String fileName) throws 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:

  NullPointerException - If the type or fileName is null.

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

  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(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 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 String getURL() throws 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:

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