Field Detail

• public static final String ATTACHMENT_LOCATION_KEY

Property Detail

• GrailsApplication grailsApplication

• ResourceLoader resourceLoader

• String resourcesConfigRootKey

  The path to resources config root. eg "nine.resources"

Method Detail

• @CompileStatic String buildResourceKey(String subKey)

• @SuppressWarnings("ReturnsNullInsteadOfEmptyCollection") Map createAttachmentFile(Long attachmentId, String name, String extension, Object data, String location = null)

  Creates (or move) file relative to the MonthDirectory. If the data param is a File then its the temp file, rename and move. If data is a byte[] or a String then write to the new file

  Parameters:

  attachmentId - the ID of the Attachment record this file is going into.

  name - optional name of the file

  extension - The file extension to use.

  kind - The "kind" of file from AttachmentKind.name if desired

  data - The contents of the file as a File(temp file), String, byte array or null. If its null then returns null

  Returns:

  A map location:(string of the location relative to rootLocation), file: the File instace that we put in that directory

• @SuppressWarnings("FileCreateTempFile") File createTempFile(String originalFileName, Object data)

  Creates a temp file inside the tempDir and, optionally, populates it with data. The file is guaranteed to not have a colliding name. If the originalFileName has a dot in the name, then the final file short name will be . For example, "readme.txt" would turn out something like "readme12a35c23.txt"

  Parameters:

  originalFileName - the name of the file that was uploaded

  data - is the file contents, and can be String, byte[], or null.

  Returns:

  a non-null File instance, which has a unique name within the tempDir, and if data is non-null will exist and will contain the data specified.

• void deleteTempUploadedFiles(String attachmentListJson)

  Deletes any files in the temp directory which are in the list.

• void deleteTempUploadedFiles(List attachmentList)

• void forceMkdir(String path)

• String getAttachmentsRelativePath(File file)

  returns the path relative to the the attachments directory

• ClassLoader getClassLoader()

• @SuppressWarnings("NoDef") def getCurrentTenant()

• File getFile(String location)

  Shorthand way to get the attachment file with nothing but the location column contents.

• File getLocation(String key, Map args = [:], boolean create = true)

  Get a configured directory location from a nine.resources key.

  Parameters:

  key - The name of the key within the 'nine.resources' construct.

  env - The map of substitutions allowed

  create - True if the directory should be created if missing.

  Returns:

  one of: a File which references a directory. The directory exists. a List of File, each entry of which is a directory which exists.

• File getMonthDirectory(String configKey, boolean create = true)

  Gets a month directory for a configuration key.

  Parameters:

  configKey - the dot notation path from the rousources base ex: "attachments.location"

  create - If true, create the directory if it's missing.

  Returns:

  a File object which references the month directory, or null on error.

• File getProperFile(String fileName, String key, boolean create = true)

  getProperFile builds a File from a name and ensures it exists, or throws an error. If the name is absolute then it builds based on just that name. If the name is relative then it is built relative to rootLocation.

  Returns:

  the canonical File which exists.

• String getRelativePath(String key = 'rootLocation', File child)

  gets the path relative to some configured directory. This is a shallow wrapper around getRelativePath(File,File).

  Parameters:

  child - The file to get the relative path of.

  key - The key name in RallyDefaultConfig.groovy, for example 'attachments.location'

  Returns:

  a String containing the location of child relative to the directory described by key

• String getRelativePath(File parent, File child)

  gets the relative path of the child with respect to the parent The child must be inside of the parent or the resulting string is null.

• String getRelativeTempPath(File file)

  returns the path relative to the the temporary resource directory

• Resource getResource(String location)

  if location starts with a / then it realtive to the war (web-app). For example, '/WEB-INF/invoice/greenbar.ftl if it does not start with a / then its considered relative to the rootLocation For example, '2010-11/23452.pdf' would look for file://myroot/2010-11/23452.pdf if that what was set in nine.attachments.directory

• @CompileStatic @SuppressWarnings("NoDef") def getResourceConfig(String subKey)

• Resource getResourceDirFromKey(String key)

  get resource dir relative to the config key if key is null then it return the root location

• Resource getResourceRelative(String locationBase, String location)

  gets a resource with a locationBase and a relative location - if relative location starts with "/" just pass it to getResource() and ignore locationBase (will look in war (web-app in dev)) - if locationBase is null then we will use a default getLocation('attachments.location') - if relative location starts with URL like classpath:,file:, http: it be passed directly to resourceLoader - if locationBase starts with config: then it will use whatever key comes after to find the location (ex- config:reports.location)

  Parameters:

  locationBase - if null uses the default key of 'attachments.location'

  location - the relative location to use

• File getRootLocation()

  Gets the rootLocation which is the base for all the app-related directories. This must be a Closure in the config, it must return a string which will act like a GString and which refers to a directory which exists. You can use code inside the Closure to substitute values there, and also you can use: - ${tenantId} (Client.id) - ${tenantSubDomain} (Client.num)

  throws:

  FileNotFoundException , IllegalArgumentException

  Returns:

  a File object referencing the directory.

• List getScripts(Map args = [:])

  Get a list of script locations as absolute files.

• File getSubDirectory(String key, String relativePath, boolean create = true, Map args = [:])

• @SuppressWarnings(['NoDef']) File getTempDir()

• @SuppressWarnings("NoDef") String getTenantUniqueKey()

• @PostConstruct void init()

• @SuppressWarnings(["NoDef"]) Map mergeClientValues(Map args = [:])

  If the service which wants this directory offers some additional values for substitution they can be passed in with an args map. Any tentantId or tenantSubDomain which is passed in should override the default values. At the time this was written there were no services offering additional values, but tenantId and tenantSubDomain are used. The returned map is a shallow-cloned map. This means that if the map passed in did not have tenantId or tenantSubDomain then it will not have those values after the call, but if some existing value is changed in the destination map then it will be changed in the original as well.

  Parameters:

  args - A Map of values to be passed to the configuration Closure, if it's a Closure.

• @Override void setConfiguration(Config co)

• File verifyOrCreateLocation(File dir, String key, boolean create, boolean wasAbsolute = false)

  verifyOrCreateLocation checks for validity of the directory before it's returned.

  Parameters:

  dir - (File) The File object to be tested.

  key - (String) The key name in RallyDefaultConfig.groovy for example 'autocash.importDir'

  create - (boolean) true to create the directory if absent, false to throw an error.

  wasAbsolute - (boolean) True if the file was defined in the configuration as an absolute file.