com.smartbear.ready.core

Class ReadyApiPaths

java.lang.Object

com.smartbear.ready.core.ReadyApiPaths

public class ReadyApiPaths
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	READY_API_HOME_DIR

Constructor Summary

Constructors

Constructor and Description
ReadyApiPaths()

Method Summary

Modifier and Type	Method and Description
static String	absolutePath(Path path)
static Path	ensureExists(Path path) Gets a Path which definitely exists.
static Path	ensureExistsAndCanWrite(Path path) Gets a Path which definitely exists and can be written to.
static Path	readyApiDataDir()
static Path	readyApiHomeDir()
static Path	readyApiLogDir()
static Path	readyApiVirtLogDir()
static Path	relativeToReadyApiDataDir(String path, String... paths)
static Path	relativeToReadyApiHomeDir(String path, String... paths)
static Path	serviceVHomeDir()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

READY_API_HOME_DIR

public static final String READY_API_HOME_DIR

See Also:

Constant Field Values

Constructor Detail

ReadyApiPaths

public ReadyApiPaths()

Method Detail

ensureExistsAndCanWrite

public static Path ensureExistsAndCanWrite(Path path)

Gets a Path which definitely exists and can be written to. Attempts to create the Path if necessary.

Parameters:

path -

Returns:

Path if it exists (or can be created) and can be written to.

ensureExists

public static Path ensureExists(Path path)

Gets a Path which definitely exists. Attempts to create the Path if necessary.

Parameters:

path -

Returns:

Path if it exists (or can be created).

readyApiDataDir

public static Path readyApiDataDir()

Returns:

the ReadyAPI data directory. Creates it if necessary.

Throws:

RuntimeException - if cannot get a home directory or write to the resolved directory.

readyApiLogDir

public static Path readyApiLogDir()

Returns:

the ReadyAPI log directory. Creates it if necessary.

Throws:

RuntimeException - if cannot get a home directory or write to the resolved directory.

readyApiVirtLogDir

public static Path readyApiVirtLogDir()

Returns:

the ReadyAPI log directory for virts. Creates it if necessary.

Throws:

RuntimeException - if cannot get a home directory or write to the resolved directory.

relativeToReadyApiDataDir

public static Path relativeToReadyApiDataDir(String path,
                                             String... paths)

Parameters:

path - initial path

paths - sub-paths

Returns:

Path relative to ReadyAPI data directory

readyApiHomeDir

public static Path readyApiHomeDir()

Returns:

the ReadyAPI home directory (installation location). Creates it if necessary.

Throws:

RuntimeException - if cannot get a home directory or write to the resolved directory.

serviceVHomeDir

public static Path serviceVHomeDir()

Returns:

the ServiceV home directory (installation location). Creates it if necessary.

Throws:

RuntimeException - if cannot get a home directory or write to the resolved directory.

relativeToReadyApiHomeDir

public static Path relativeToReadyApiHomeDir(String path,
                                             String... paths)

Parameters:

path - initial path

paths - sub-paths

Returns:

Path relative to ReadyAPI home

absolutePath

public static String absolutePath(Path path)