Paths

java.lang.Object
- org.apache.tomee.installer.Paths

All Implemented Interfaces:

PathsInterface
```
public class Paths
extends java.lang.Object
implements PathsInterface
```
This class is used to verify that all the main directories and files exist.

See Also:

for more details

Constructor Summary

Constructors
Constructor and Description

Paths(java.io.File openejbWarDir)

Constructors
Constructor and Description
`Paths(java.io.File openejbWarDir)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.io.File`	`findOpenEJBJar(java.lang.String namePrefix)`
`java.io.File`	`findOpenEJBWebJar(java.lang.String namePrefix)`
`java.io.File`	`findTomEELibJar(java.lang.String prefix)`
`java.io.File`	`geOpenEJBTomcatCommonJar()`
`java.io.File`	`getCatalinaBaseDir()` Returns the directory represented by the catalina.base system property
`java.io.File`	`getCatalinaBatFile()` Returns the `getCatalinaBinDir()`/catalina.bat file
`java.io.File`	`getCatalinaBinDir()` Returns the directory representing `catalinaHomeDir`/bin
`java.io.File`	`getCatalinaConfDir()` Returns the directory representing `catalinaBaseDir`/conf
`java.io.File`	`getCatalinaHomeDir()` Returns the directory represented by the catalina.home system property
`java.io.File`	`getCatalinaLibDir()` Returns the directory representing `catalinaHomeDir`/lib for Tomcat 6.
`java.io.File`	`getCatalinaShFile()` Returns the `getCatalinaBinDir()`/catalina.sh file
`java.util.List<java.lang.String>`	`getErrors()` Returns a list of verification errors
`java.io.File`	`getHome()`
`java.io.File`	`getJavaEEAPIJar()`
`java.io.File`	`getOpenEJBCoreJar()` Returns the openejb-core.jar file
`java.io.File`	`getOpenEJBJavaagentJar()` Returns the openejb-javaagent.jar file
`java.io.File`	`getOpenEJBLibDir()` Returns the `openejbWarDir`/lib directory.
`java.io.File`	`getOpenEJBTomcatLoaderJar()` Returns the tomee-loader.jar file
`java.io.File`	`getOpenEJBWebLibDir()`
`java.io.File`	`getServerXmlFile()` Returns the file representing <>/conf/server.xml
`java.io.File`	`getSetClasspathBat()`
`java.io.File`	`getSetClasspathSh()`
`java.io.File`	`getTomcatUsersXml()`
`boolean`	`hasErrors()` Checks to see if there are any verification errors
`void`	`reset()` Clears out all verification errors from the underlying list
`void`	`setCatalinaBaseDir(java.io.File catalinaBaseDir)` Sets the catalina base directory
`void`	`setCatalinaBaseDir(java.lang.String catalinaBaseDir)` Sets the catalina base directory
`void`	`setCatalinaHomeDir(java.io.File catalinaHomeDir)` Sets the catalina home directory
`void`	`setCatalinaHomeDir(java.lang.String catalinaHomeDir)` Sets the catalina home directory
`void`	`setServerXmlFile(java.io.File serverXmlFile)` Sets the server.xml file
`void`	`setServerXmlFile(java.lang.String serverXmlFile)` Sets the server.xml file
`boolean`	`verify()` Verifies the following: `openejbWarDir` is unpacked `catalinaHomeDir` is defined `catalinaBaseDir` is defined `catalinaHomeDir` exists, is a directory and is readable `catalinaBaseDir` exists, is a directory and is readable `getCatalinaLibDir()` exists, is a directory , is readable and is writable `getCatalinaConfDir()` exists, is a directory , is readable and is writable `getCatalinaBinDir()` exists, is a directory , is readable `getCatalinaShFile()` exists, is a File , is readable and is writable `getCatalinaBatFile()()` exists, is a File , is readable and is writable `getServerXmlFile()` exists, is a File , is readable and is writable `getOpenEJBLibDir()` exists, is a directory and is readable `getOpenEJBTomcatLoaderJar()` is not null, exists, is a File and is readable `getOpenEJBJavaagentJar()` is not null, exists, is a File and is readable `getOpenEJBCoreJar()` is not null, exists, is a File and is readable `getOpenEJBJavaagentJar()` exists, is a File and is readable

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Paths
```
public Paths(java.io.File openejbWarDir)
```
- Method Detail
  - getCatalinaHomeDir
```
public java.io.File getCatalinaHomeDir()
```
    Returns the directory represented by the catalina.home system property
    
    Specified by:
    
    getCatalinaHomeDir in interface PathsInterface
    
    Returns:
    
    The directory represented by the catalina.home system property
  - setCatalinaHomeDir
```
public void setCatalinaHomeDir(java.lang.String catalinaHomeDir)
```
    Sets the catalina home directory
    
    Specified by:
    
    setCatalinaHomeDir in interface PathsInterface
    
    Parameters:
    
    catalinaHomeDir - the absolute path of the catalina home directory
  - setCatalinaHomeDir
```
public void setCatalinaHomeDir(java.io.File catalinaHomeDir)
```
    Sets the catalina home directory
    
    Specified by:
    
    setCatalinaHomeDir in interface PathsInterface
    
    Parameters:
    
    catalinaHomeDir - the file representing the absolute path of the catalina home directory
  - getCatalinaBaseDir
```
public java.io.File getCatalinaBaseDir()
```
    Returns the directory represented by the catalina.base system property
    
    Specified by:
    
    getCatalinaBaseDir in interface PathsInterface
    
    Returns:
    
    The directory represented by the catalina.base system property
  - setCatalinaBaseDir
```
public void setCatalinaBaseDir(java.lang.String catalinaBaseDir)
```
    Sets the catalina base directory
    
    Specified by:
    
    setCatalinaBaseDir in interface PathsInterface
    
    Parameters:
    
    catalinaBaseDir - the absolute path of the catalina base directory
  - setCatalinaBaseDir
```
public void setCatalinaBaseDir(java.io.File catalinaBaseDir)
```
    Sets the catalina base directory
    
    Specified by:
    
    setCatalinaBaseDir in interface PathsInterface
    
    Parameters:
    
    catalinaBaseDir - the file representing the absolute path of the catalina base directory
  - getServerXmlFile
```
public java.io.File getServerXmlFile()
```
    Returns the file representing <>/conf/server.xml
    
    Specified by:
    
    getServerXmlFile in interface PathsInterface
    
    Returns:
    
    the file representing <>/conf/server.xml
  - getHome
```
public java.io.File getHome()
```
    Specified by:
    
    getHome in interface PathsInterface
  - setServerXmlFile
```
public void setServerXmlFile(java.lang.String serverXmlFile)
```
    Sets the server.xml file
    
    Specified by:
    
    setServerXmlFile in interface PathsInterface
    
    Parameters:
    
    serverXmlFile - the absolute path of the server.xml file
  - setServerXmlFile
```
public void setServerXmlFile(java.io.File serverXmlFile)
```
    Sets the server.xml file
    
    Specified by:
    
    setServerXmlFile in interface PathsInterface
    
    Parameters:
    
    serverXmlFile - the file representing the absolute path of the server.xml file
  - getCatalinaLibDir
```
public java.io.File getCatalinaLibDir()
```
    Returns the directory representing catalinaHomeDir/lib for Tomcat 6. For Tomcat 5.x it returns catalinaHomeDir/server/lib
    
    Specified by:
    
    getCatalinaLibDir in interface PathsInterface
    
    Returns:
    
    the directory representing catalinaHomeDir/lib
  - getCatalinaConfDir
```
public java.io.File getCatalinaConfDir()
```
    Returns the directory representing catalinaBaseDir/conf
    
    Specified by:
    
    getCatalinaConfDir in interface PathsInterface
    
    Returns:
    
    the directory representing catalinaBaseDir/conf
  - getCatalinaBinDir
```
public java.io.File getCatalinaBinDir()
```
    Returns the directory representing catalinaHomeDir/bin
    
    Specified by:
    
    getCatalinaBinDir in interface PathsInterface
    
    Returns:
    
    the directory representing catalinaHomeDir/bin
  - getCatalinaShFile
```
public java.io.File getCatalinaShFile()
```
    Returns the getCatalinaBinDir()/catalina.sh file
    
    Specified by:
    
    getCatalinaShFile in interface PathsInterface
    
    Returns:
    
    the getCatalinaBinDir()/catalina.sh file
  - getCatalinaBatFile
```
public java.io.File getCatalinaBatFile()
```
    Returns the getCatalinaBinDir()/catalina.bat file
    
    Specified by:
    
    getCatalinaBatFile in interface PathsInterface
    
    Returns:
    
    the getCatalinaBinDir()/catalina.bat file
  - getOpenEJBLibDir
```
public java.io.File getOpenEJBLibDir()
```
    Returns the openejbWarDir/lib directory. Returns null if openejbWarDir is null
    
    Specified by:
    
    getOpenEJBLibDir in interface PathsInterface
    
    Returns:
    
    the openejbWarDir/lib directory
  - getOpenEJBTomcatLoaderJar
```
public java.io.File getOpenEJBTomcatLoaderJar()
```
    Returns the tomee-loader.jar file
    
    Specified by:
    
    getOpenEJBTomcatLoaderJar in interface PathsInterface
    
    Returns:
    
    the tomee-loader.jar file
  - getJavaEEAPIJar
```
public java.io.File getJavaEEAPIJar()
```
    Specified by:
    
    getJavaEEAPIJar in interface PathsInterface
  - getOpenEJBJavaagentJar
```
public java.io.File getOpenEJBJavaagentJar()
```
    Returns the openejb-javaagent.jar file
    
    Specified by:
    
    getOpenEJBJavaagentJar in interface PathsInterface
    
    Returns:
    
    the openejb-javaagent.jar file
  - getOpenEJBCoreJar
```
public java.io.File getOpenEJBCoreJar()
```
    Returns the openejb-core.jar file
    
    Specified by:
    
    getOpenEJBCoreJar in interface PathsInterface
    
    Returns:
    
    the openejb-core.jar file
  - geOpenEJBTomcatCommonJar
```
public java.io.File geOpenEJBTomcatCommonJar()
```
    Specified by:
    
    geOpenEJBTomcatCommonJar in interface PathsInterface
  - findOpenEJBJar
```
public java.io.File findOpenEJBJar(java.lang.String namePrefix)
```
    Specified by:
    
    findOpenEJBJar in interface PathsInterface
  - findOpenEJBWebJar
```
public java.io.File findOpenEJBWebJar(java.lang.String namePrefix)
```
    Specified by:
    
    findOpenEJBWebJar in interface PathsInterface
  - findTomEELibJar
```
public java.io.File findTomEELibJar(java.lang.String prefix)
```
    Specified by:
    
    findTomEELibJar in interface PathsInterface
  - verify
```
public boolean verify()
```
    Verifies the following:
    - openejbWarDir is unpacked
    - catalinaHomeDir is defined
    - catalinaBaseDir is defined
    - catalinaHomeDir exists, is a directory and is readable
    - catalinaBaseDir exists, is a directory and is readable
    - getCatalinaLibDir() exists, is a directory , is readable and is writable
    - getCatalinaConfDir() exists, is a directory , is readable and is writable
    - getCatalinaBinDir() exists, is a directory , is readable
    - getCatalinaShFile() exists, is a File , is readable and is writable
    - getCatalinaBatFile()() exists, is a File , is readable and is writable
    - getServerXmlFile() exists, is a File , is readable and is writable
    - getOpenEJBLibDir() exists, is a directory and is readable
    - getOpenEJBTomcatLoaderJar() is not null, exists, is a File and is readable
    - getOpenEJBJavaagentJar() is not null, exists, is a File and is readable
    - getOpenEJBCoreJar() is not null, exists, is a File and is readable
    - getOpenEJBJavaagentJar() exists, is a File and is readable
    Specified by:
    
    verify in interface PathsInterface
    
    Returns:
    
    true if verification succeeds
  - reset
```
public void reset()
```
    Clears out all verification errors from the underlying list
    
    Specified by:
    
    reset in interface PathsInterface
  - hasErrors
```
public boolean hasErrors()
```
    Checks to see if there are any verification errors
    
    Specified by:
    
    hasErrors in interface PathsInterface
    
    Returns:
    
    true if there are verification errors
  - getErrors
```
public java.util.List<java.lang.String> getErrors()
```
    Returns a list of verification errors
    
    Specified by:
    
    getErrors in interface PathsInterface
    
    Returns:
    
    a list of verification errors
  - getOpenEJBWebLibDir
```
public java.io.File getOpenEJBWebLibDir()
```
    Specified by:
    
    getOpenEJBWebLibDir in interface PathsInterface
  - getTomcatUsersXml
```
public java.io.File getTomcatUsersXml()
```
    Specified by:
    
    getTomcatUsersXml in interface PathsInterface
  - getSetClasspathSh
```
public java.io.File getSetClasspathSh()
```
    Specified by:
    
    getSetClasspathSh in interface PathsInterface
  - getSetClasspathBat
```
public java.io.File getSetClasspathBat()
```
    Specified by:
    
    getSetClasspathBat in interface PathsInterface

Class Paths

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Paths

Method Detail

getCatalinaHomeDir

setCatalinaHomeDir

setCatalinaHomeDir

getCatalinaBaseDir

setCatalinaBaseDir

setCatalinaBaseDir

getServerXmlFile

getHome

setServerXmlFile

setServerXmlFile

getCatalinaLibDir

getCatalinaConfDir

getCatalinaBinDir

getCatalinaShFile

getCatalinaBatFile

getOpenEJBLibDir

getOpenEJBTomcatLoaderJar

getJavaEEAPIJar

getOpenEJBJavaagentJar

getOpenEJBCoreJar

geOpenEJBTomcatCommonJar

findOpenEJBJar

findOpenEJBWebJar

findTomEELibJar

verify

reset

hasErrors

getErrors

getOpenEJBWebLibDir

getTomcatUsersXml

getSetClasspathSh

getSetClasspathBat