net.myrrix.web

Class RunnerConfiguration

java.lang.Object

net.myrrix.web.RunnerConfiguration

public final class RunnerConfiguration
extends Object

Configuration for a Runner. This configures the Serving Layer server instance that it runs.

Author:

Sean Owen

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTO_PARTITION_SPEC
static int	DEFAULT_PORT
static int	DEFAULT_SECURE_PORT

Constructor Summary

Constructors

Constructor and Description
RunnerConfiguration()

Method Summary

Methods

Modifier and Type	Method and Description
String	getAllPartitionsSpecification()
String	getBucket()
String	getClientThreadClassName()
String	getContextPath()
Integer	getHostRequestLimit()
String	getInstanceID()
File	getKeystoreFile()
String	getKeystorePassword()
File	getLicenseFile()
File	getLocalInputDir()
Integer	getPartition()
String	getPassword()
int	getPort()
String	getRescorerProviderClassName()
int	getSecurePort()
String	getUserName()
boolean	isConsoleOnlyPassword()
boolean	isReadOnly()
void	setAllPartitionsSpecification(String allPartitionsSpecification)
void	setBucket(String bucket)
void	setClientThreadClassName(String clientThreadClassName)
void	setConsoleOnlyPassword(boolean consoleOnlyPassword)
void	setContextPath(String contextPath)
void	setHostRequestLimit(Integer hostRequestLimit)
void	setInstanceID(String instanceID)
void	setKeystoreFile(File keystoreFile)
void	setKeystorePassword(String keystorePassword)
void	setLicenseFile(File licenseFile)
void	setLocalInputDir(File localInputDir)
void	setPartition(Integer partition)
void	setPassword(String password)
void	setPort(int port)
void	setReadOnly(boolean readOnly)
void	setRescorerProviderClassName(String rescorerProviderClassName)
void	setSecurePort(int securePort)
void	setUserName(String userName)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:

Constant Field Values

DEFAULT_SECURE_PORT

public static final int DEFAULT_SECURE_PORT

See Also:

Constant Field Values

AUTO_PARTITION_SPEC

public static final String AUTO_PARTITION_SPEC

See Also:

Constant Field Values

Constructor Detail

RunnerConfiguration

public RunnerConfiguration()

Method Detail

getBucket

public String getBucket()

Returns:

bucket name under which to locate Computation Layer data in distributed mode. Used with getInstanceID().

setBucket

public void setBucket(String bucket)

getInstanceID

public String getInstanceID()

Returns:

instance ID that the Serving Layer will use, when interacting with a Computation Layer in distributed mode. Used with getBucket().

setInstanceID

public void setInstanceID(String instanceID)

getPort

public int getPort()

Returns:

port on which the Serving Layer listens for non-secure HTTP connections

setPort

public void setPort(int port)

getSecurePort

public int getSecurePort()

Returns:

port on which the Serving Layer listens for secure HTTPS connections, if applicable

setSecurePort

public void setSecurePort(int securePort)

getContextPath

public String getContextPath()

Returns:

the context path under which to deploy endpoints, or null for default/root

setContextPath

public void setContextPath(String contextPath)

isReadOnly

public boolean isReadOnly()

Returns:

if true, disable API methods that add or change data

setReadOnly

public void setReadOnly(boolean readOnly)

getKeystoreFile

public File getKeystoreFile()

Returns:

the keystore file containing the server's SSL keys. Only necessary when accessing a server with a temporary self-signed key, which is not by default trusted by the Java SSL implementation

setKeystoreFile

public void setKeystoreFile(File keystoreFile)

getKeystorePassword

public String getKeystorePassword()

Returns:

password for getKeystoreFile(), if applicable

setKeystorePassword

public void setKeystorePassword(String keystorePassword)

getLocalInputDir

public File getLocalInputDir()

Returns:

local directory from which input is read, to which output is written, and in which intermediate model files are stored

setLocalInputDir

public void setLocalInputDir(File localInputDir)

getUserName

public String getUserName()

Returns:

user name which must be supplied to access the Serving Layer with HTTP DIGEST authentication, if applicable; none is required if this is not specified

setUserName

public void setUserName(String userName)

getPassword

public String getPassword()

Returns:

password which must be supplied to access the Serving Layer with HTTP DIGEST authentication, if applicable; none is required if this is not specified

setPassword

public void setPassword(String password)

isConsoleOnlyPassword

public boolean isConsoleOnlyPassword()

Returns:

true if username and password only apply to admin / console resources

setConsoleOnlyPassword

public void setConsoleOnlyPassword(boolean consoleOnlyPassword)

getHostRequestLimit

public Integer getHostRequestLimit()

Returns:

max number of requests per minute from a host before it is temporarily blocked or null for no limit. This provides only a basic attempt to deny requests and is not guaranteed to block any DoS attack.

setHostRequestLimit

public void setHostRequestLimit(Integer hostRequestLimit)

getRescorerProviderClassName

public String getRescorerProviderClassName()

Returns:

the name of an implementation of RescorerProvider, if one should be used to modify the results of the recommendations and similarity computations, or null if none is to be used. The class must be made available on the server's classpath. This may also be specified as a comma-separated list of class names, in which case all will be applied, in the given order.

setRescorerProviderClassName

public void setRescorerProviderClassName(String rescorerProviderClassName)

getClientThreadClassName

public String getClientThreadClassName()

Returns:

the name of an implementation of ClientThread which is intended to be run in the Serving Layer in its own thread as an in-process "client" of external services. This may be used to poll/pull updates from some external service and push directly into the recommender, or perform any other service that a caller needs. The thread will be started with the web container and closed with the web container.

setClientThreadClassName

public void setClientThreadClassName(String clientThreadClassName)

getPartition

public Integer getPartition()

Returns:

the partition number of this Serving Layer server, among all partitions. Only applicable in distributed mode, and returns null otherwise.

See Also:

getAllPartitionsSpecification()

setPartition

public void setPartition(Integer partition)

getAllPartitionsSpecification

public String getAllPartitionsSpecification()

Returns:

specification for all servers that have partitions. Only applicable in distributed mode and returns null otherwise. May be specified as "auto", in distributed mode only, in which case it will attempt to discover partitions automatically. Note that this further only works with Amazon AWS / S3 Otherwise, Serving Layers are specified explicitly as "host:port" pairs. Replicas are specified as many Serving Layers, separated by commas, like "rep1:port1,rep2:port2,...". Finally, partitions are specified as multiple replicas separated by semicolon, like "part1rep1:port11,part1rep2:port12;part2rep1:port21,part2rep2:port22;...". Example: "foo:80,foo2:8080;bar:8080;baz2:80,baz3:80"

See Also:

getPartition()

setAllPartitionsSpecification

public void setAllPartitionsSpecification(String allPartitionsSpecification)

getLicenseFile

public File getLicenseFile()

Returns:

(Optional in standalone mode). location of a license file named [subject].lic, where [subject] is the subject name authorized in the license. The license file should be valid at the time the app is run, and contain authorization to use the amount of parallelism (max simultaneous Hadoop workers) requested.

setLicenseFile

public void setLicenseFile(File licenseFile)