net.myrrix.client

Class MyrrixClientConfiguration

java.lang.Object

net.myrrix.client.MyrrixClientConfiguration

public final class MyrrixClientConfiguration
extends Object

Encapsulates all configuration for a ClientRecommender.

Since:

1.0

Author:

Sean Owen

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
MyrrixClientConfiguration()

Method Summary

Methods

Modifier and Type	Method and Description
String	getAllPartitionsSpecification()
String	getContextPath()
String	getHost()
File	getKeystoreFile()
String	getKeystorePassword()
List<List<com.google.common.net.HostAndPort>>	getPartitions()
String	getPassword()
int	getPort()
String	getUserName()
boolean	isSecure()
void	setAllPartitionsSpecification(String allPartitionsSpecification)
void	setContextPath(String contextPath)
void	setHost(String host)
void	setKeystoreFile(File keystoreFile)
void	setKeystorePassword(String keystorePassword)
void	setPassword(String password)
void	setPort(int port) Cannot be set if setAllPartitionsSpecification(String) is set
void	setSecure(boolean secure)
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_HOST

public static final String DEFAULT_HOST

See Also:

Constant Field Values

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:

Constant Field Values

AUTO_PARTITION_SPEC

public static final String AUTO_PARTITION_SPEC

See Also:

Constant Field Values

Constructor Detail

MyrrixClientConfiguration

public MyrrixClientConfiguration()

Method Detail

getHost

public String getHost()

Returns:

host containing the Serving Layer, if not in distributed mode

setHost

public void setHost(String host)

Parameters:

host - Serving Layer host to communicate with. Defaults to DEFAULT_PORT.

getPort

public int getPort()

Returns:

port on which to access the Serving Layer, if not in distributed mode. Defaults to DEFAULT_PORT.

setPort

public void setPort(int port)

Cannot be set if setAllPartitionsSpecification(String) is set

Parameters:

port - Serving Layer port to communicate with

isSecure

public boolean isSecure()

Returns:

if true, this client is accessing the Serving Layer over HTTPS, not HTTP

setSecure

public void setSecure(boolean secure)

Parameters:

secure - if true, this client is accessing the Serving Layer over HTTPS, not HTTP

getContextPath

public String getContextPath()

Returns:

the context path under which the target Serving Layer app is deployed (e.g. http://example.org/contextPath/...), or null if the default root context should be used.

setContextPath

public void setContextPath(String contextPath)

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()

setKeystorePassword

public void setKeystorePassword(String keystorePassword)

getUserName

public String getUserName()

Returns:

user name needed to access the Serving Layer, if any

setUserName

public void setUserName(String userName)

getPassword

public String getPassword()

Returns:

password needed to access the Serving Layer, if any

setPassword

public void setPassword(String password)

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 which case getHost() and getPort() must be valid, since this host will be queried for partition details. 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"

setAllPartitionsSpecification

public void setAllPartitionsSpecification(String allPartitionsSpecification)

Parameters:

allPartitionsSpecification - see getAllPartitionsSpecification()

getPartitions

public List<List<com.google.common.net.HostAndPort>> getPartitions()

Returns:

a description of all partitions. This is a parsing of getAllPartitionsSpecification() if set, or a description of a 1-partition, 1-replica system containing the host:port specified by getHost() and getPort() if not