P4OAuthConfig (p4oauth 0.1.0 API)

java.lang.Object
- com.perforce.workshop.tjuricek.p4oauth.config.P4OAuthConfig

```
public class P4OAuthConfig
extends java.lang.Object
```
Top level configuration object. The main application configuration file maps to this object.
Configuration objects must be loaded via the static load method.

See Also:

load(String)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object o)`
`java.lang.String`	`getContextRoot()` By default, empty, can be set to a root context path.
`java.lang.String`	`getHostname()`
`long`	`getHttpIdleTimeout()`
`int`	`getHttpPort()` Defaults to 8080, the standard (non-SSL) HTTP port.
`long`	`getHttpsIdleTimeout()`
`int`	`getHttpsPort()` Defaults to 8443, the HTTPS port where almost all real features take place.
`java.lang.String`	`getKeyManagerPassword()`
`java.lang.String`	`getKeyStorePassword()`
`java.lang.String`	`getKeyStorePath()`
`PerforceConfig`	`getPerforce()`
`java.lang.String`	`getRootDirectory()`
`java.lang.String`	`getTemplateDirectory()` If you've set cacheTemplates to false, you'll likely need this set to the resource folder, because otherwise it's likely that the classpath loaders will cache the data of your templates anyway.
`int`	`hashCode()`
`boolean`	`isCacheTemplates()`
`static P4OAuthConfig`	`load(java.lang.String path)` Search rules are: Direct reference (probably a program argument) An xml file indicated by the `P4OAuthConfig` system property A file named P4OAuthConfig.yml in the current working directory Note that you must configure the SSL settings at a minimum.
`void`	`setCacheTemplates(boolean cacheTemplates)`
`void`	`setContextRoot(java.lang.String contextRoot)`
`void`	`setHostname(java.lang.String hostname)`
`void`	`setHttpIdleTimeout(long httpIdleTimeout)`
`void`	`setHttpPort(int httpPort)`
`void`	`setHttpsIdleTimeout(long httpsIdleTimeout)`
`void`	`setHttpsPort(int httpsPort)`
`void`	`setKeyManagerPassword(java.lang.String keyManagerPassword)`
`void`	`setKeyStorePassword(java.lang.String keyStorePassword)`
`void`	`setKeyStorePath(java.lang.String keyStorePath)`
`void`	`setPerforce(PerforceConfig perforce)`
`void`	`setRootDirectory(java.lang.String rootDirectory)`
`void`	`setTemplateDirectory(java.lang.String templateDirectory)`
`java.lang.String`	`toString()`
`boolean`	`validate()` Double checks that the configuration is actually set, and if there's any issues at all, to log them.

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

- Method Detail
  - validate
```
public boolean validate()
```
    Double checks that the configuration is actually set, and if there's any issues at all, to log them.
  - getHostname
```
public java.lang.String getHostname()
```
  - setHostname
```
public void setHostname(java.lang.String hostname)
```
  - getHttpPort
```
public int getHttpPort()
```
    Defaults to 8080, the standard (non-SSL) HTTP port. This may be used by some informative usages, say, for basic help pages.
  - setHttpPort
```
public void setHttpPort(int httpPort)
```
  - getHttpsPort
```
public int getHttpsPort()
```
    Defaults to 8443, the HTTPS port where almost all real features take place.
  - setHttpsPort
```
public void setHttpsPort(int httpsPort)
```
  - getContextRoot
```
public java.lang.String getContextRoot()
```
    By default, empty, can be set to a root context path.
  - setContextRoot
```
public void setContextRoot(java.lang.String contextRoot)
```
  - getHttpIdleTimeout
```
public long getHttpIdleTimeout()
```
  - setHttpIdleTimeout
```
public void setHttpIdleTimeout(long httpIdleTimeout)
```
  - getKeyStorePath
```
public java.lang.String getKeyStorePath()
```
  - setKeyStorePath
```
public void setKeyStorePath(java.lang.String keyStorePath)
```
  - getKeyStorePassword
```
public java.lang.String getKeyStorePassword()
```
  - setKeyStorePassword
```
public void setKeyStorePassword(java.lang.String keyStorePassword)
```
  - getKeyManagerPassword
```
public java.lang.String getKeyManagerPassword()
```
  - setKeyManagerPassword
```
public void setKeyManagerPassword(java.lang.String keyManagerPassword)
```
  - getHttpsIdleTimeout
```
public long getHttpsIdleTimeout()
```
  - setHttpsIdleTimeout
```
public void setHttpsIdleTimeout(long httpsIdleTimeout)
```
  - getRootDirectory
```
public java.lang.String getRootDirectory()
```
  - setRootDirectory
```
public void setRootDirectory(java.lang.String rootDirectory)
```
  - isCacheTemplates
```
public boolean isCacheTemplates()
```
  - setCacheTemplates
```
public void setCacheTemplates(boolean cacheTemplates)
```
  - getTemplateDirectory
```
public java.lang.String getTemplateDirectory()
```
    If you've set cacheTemplates to false, you'll likely need this set to the resource folder, because otherwise it's likely that the classpath loaders will cache the data of your templates anyway.
  - setTemplateDirectory
```
public void setTemplateDirectory(java.lang.String templateDirectory)
```
  - getPerforce
```
public PerforceConfig getPerforce()
```
  - setPerforce
```
public void setPerforce(PerforceConfig perforce)
```
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - load
```
public static P4OAuthConfig load(java.lang.String path)
```
    Search rules are:
    1. Direct reference (probably a program argument)
    2. An xml file indicated by the P4OAuthConfig system property
    3. A file named P4OAuthConfig.yml in the current working directory
    Note that you must configure the SSL settings at a minimum.
    Parameters:
    
    path - Path to a YAML configuration file. Can be null if you expect the file to be configured
    
    Returns:
    
    null in the case of failures, otherwise, the config object. See the log file for the error warning.

Class P4OAuthConfig

Method Summary

Methods inherited from class java.lang.Object

Method Detail

validate

getHostname

setHostname

getHttpPort

setHttpPort

getHttpsPort

setHttpsPort

getContextRoot

setContextRoot

getHttpIdleTimeout

setHttpIdleTimeout

getKeyStorePath

setKeyStorePath

getKeyStorePassword

setKeyStorePassword

getKeyManagerPassword

setKeyManagerPassword

getHttpsIdleTimeout

setHttpsIdleTimeout

getRootDirectory

setRootDirectory

isCacheTemplates

setCacheTemplates

getTemplateDirectory

setTemplateDirectory

getPerforce

setPerforce

equals

hashCode

toString

load