Enum SystemPaths

java.lang.Object
java.lang.Enum<SystemPaths>
br.com.intersys.systextil.global.SystemPaths
All Implemented Interfaces:
Serializable, Comparable<SystemPaths>, java.lang.constant.Constable

public enum SystemPaths extends Enum<SystemPaths>
Disponibiliza para a aplicação os caminhos de pastas do sistema.

Existem algoritmos para detectar ou deduzir quais são essas pastas, tanto em ambientes Vision quanto Web; mas a maneira preferencial de configurar os caminhos da aplicação é através de um arquivo systextil.properties presente na pasta onde a aplicação ou serviço é iniciado.

Se não for adequado ou possível usar esse arquivo nessa pasta, é possível usar outro arquivo (em outra pasta ou não), bastando para isso fornecer à JVM o caminho desse arquivo definindo a propriedade systextil.properties. Por exemplo:

java -Dsystextil.properties=D:/wherever/systextil.properties etc...

Em instalações Systêxtil Web, o mais comum é usar um arquivo systextil.properties na pasta bin do servidor JBoss.

  • Enum Constant Details

    • APP

      public static final SystemPaths APP
    • REPORTS

      public static final SystemPaths REPORTS
    • IMAGES

      @Deprecated public static final SystemPaths IMAGES
      Deprecated.
      A pasta de imagens depende da aplicação, não da instalação; por isso, quando necessário, deve ser obtida da MDI.
    • TXTS

      public static final SystemPaths TXTS
  • Field Details

    • mimeTypes

      public final String[] mimeTypes
  • Method Details

    • values

      public static SystemPaths[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static SystemPaths valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null
    • toString

      public String toString()
      Overrides:
      toString in class Enum<SystemPaths>
    • getFile

      public Path getFile(String file)
      Obtém a localização do arquivo dentro desta pasta de sistema.

      Retorna o resulado de Path.resolve(String).

      Parameters:
      file - o endereço do arquivo dentro da pasta
      Returns:
      o caminho completo para o arquivo indicado dentro desta pasta
    • getRptFile

      public static Path getRptFile(String scriptRpt, Locale locale)
      Obtém a localização de um arquivo de script RPT na pasta da instalação.
      Parameters:
      scriptRpt - o nome do arquivo do script .rp
      locale - o idioma do usuário; se for nulo, será assumido português.
      Returns:
      a localização do arquivo na pasta da instalação
    • logFolder

      public static File logFolder(String userName)
      Retorna a pasta de log a ser usada pelo Systêxtil 5. Normalmente é a pasta "log" dentro de "App" ou de "Systex5". Se o usuário for informado, cria uma sub-pasta para os logs desse usuário.
    • getImagesFolder

      public static String getImagesFolder(String contextName)
      Centraliza, para o ERP Web, a lógica que determina e obtém qual é a pasta de imagens para determinado contexto.

      Não memoriza a informação. Apenas a retorna, para que seja devidamente memorizada e usada.

      Parameters:
      contextName - o nome do contexto ao qual a pasta de imagens se refere. Pode ser nulo se a pasta de imagens for definida com a propriedade systextil.system.folders.images, que não depende de contexto.
      Returns:
      o caminho da pasta de imagens para o contexto informado
    • loadProperties

      public static void loadProperties(Properties props, String filePath) throws IOException
      Alimenta uma lista de propriedades com o conteúdo de um arquivo de propriedades na instalação do ERP.

      Espera-se que o caminho do arquivo informado seja um caminho relativo na instalação. Se o arquivo não for encontrado na primeira tentativa, será procurado em posição semelhante na pasta bin do servidor JBoss que se supõe esteja presente. Se não for encontrado nessas duas tentativas, então é lançado o erro de arquivo não encontrado.

      Parameters:
      props - a lista a alimentar
      filePath - o caminho do arquivo - geralmente um arquivo na pasta local
      Throws:
      IOException - se o arquivo não for encontrado ou não for acessível