SitePaths (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.gerrit.server.config.SitePaths

public final class SitePaths
extends Object

Important paths within a SitePath.

Field Summary

Fields
Modifier and Type	Field and Description
`Path`	`bin_dir`
`static String`	`CSS_FILENAME`
`Path`	`data_dir`
`Path`	`db_dir`
`Path`	`etc_dir`
`static String`	`FOOTER_FILENAME`
`Path`	`gerrit_config`
`Path`	`gerrit_sh`
`Path`	`gerrit_war`
`static String`	`HEADER_FILENAME`
`Path`	`hooks_dir`
`Path`	`index_dir`
`boolean`	`isNew` `true` if `site_path` has not been initialized.
`Path`	`lib_dir`
`Path`	`logs_dir`
`Path`	`mail_dir`
`Path`	`peer_keys`
`Path`	`plugins_dir`
`Path`	`secure_config`
`Path`	`site_css`
`Path`	`site_footer`
`Path`	`site_gitweb`
`Path`	`site_header`
`Path`	`site_path`
`Path`	`ssh_dsa`
`Path`	`ssh_key`
`Path`	`ssh_rsa`
`Path`	`ssl_keystore`
`Path`	`static_dir`
`Path`	`themes_dir`
`Path`	`tmp_dir`

Constructor Summary

Constructors
Constructor and Description

SitePaths(Path sitePath)

Constructors
Constructor and Description
`SitePaths(Path sitePath)`

Method Summary

Methods
Modifier and Type Method and Description

Path resolve(String path)
Resolve an absolute or relative path.
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods
Modifier and Type	Method and Description
`Path`	`resolve(String path)` Resolve an absolute or relative path.

Field Detail

CSS_FILENAME

public static final String CSS_FILENAME

See Also:: Constant Field Values

HEADER_FILENAME

public static final String HEADER_FILENAME

See Also:: Constant Field Values

FOOTER_FILENAME

public static final String FOOTER_FILENAME

See Also:: Constant Field Values

site_path
```
public final Path site_path
```

bin_dir
```
public final Path bin_dir
```

etc_dir
```
public final Path etc_dir
```

lib_dir
```
public final Path lib_dir
```

tmp_dir
```
public final Path tmp_dir
```

logs_dir
```
public final Path logs_dir
```

plugins_dir
```
public final Path plugins_dir
```

db_dir
```
public final Path db_dir
```

data_dir
```
public final Path data_dir
```

mail_dir
```
public final Path mail_dir
```

hooks_dir
```
public final Path hooks_dir
```

static_dir
```
public final Path static_dir
```

themes_dir
```
public final Path themes_dir
```

index_dir
```
public final Path index_dir
```

gerrit_sh
```
public final Path gerrit_sh
```

gerrit_war
```
public final Path gerrit_war
```

gerrit_config
```
public final Path gerrit_config
```

secure_config
```
public final Path secure_config
```

ssl_keystore
```
public final Path ssl_keystore
```

ssh_key
```
public final Path ssh_key
```

ssh_rsa
```
public final Path ssh_rsa
```

ssh_dsa
```
public final Path ssh_dsa
```

peer_keys
```
public final Path peer_keys
```

site_css
```
public final Path site_css
```

site_header
```
public final Path site_header
```

site_footer
```
public final Path site_footer
```

site_gitweb
```
public final Path site_gitweb
```

isNew
```
public final boolean isNew
```
true if site_path has not been initialized.

Constructor Detail

SitePaths

@Inject
public SitePaths(Path sitePath)
          throws IOException

Throws:: IOException

Method Detail
- resolve
```
public Path resolve(String path)
```
  Resolve an absolute or relative path.
  Relative paths are resolved relative to the site_path.
  
  Parameters:
  path - the path string to resolve. May be null.
  
  Returns:
  the resolved path; null if path was null or empty.

Class SitePaths

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CSS_FILENAME

HEADER_FILENAME

FOOTER_FILENAME

site_path

bin_dir

etc_dir

lib_dir

tmp_dir

logs_dir

plugins_dir

db_dir

data_dir

mail_dir

hooks_dir

static_dir

themes_dir

index_dir

gerrit_sh

gerrit_war

gerrit_config

secure_config

ssl_keystore

ssh_key

ssh_rsa

ssh_dsa

peer_keys

site_css

site_header

site_footer

site_gitweb

isNew

Constructor Detail

SitePaths

Method Detail

resolve