org.marketcetera.client
Class ClientParameters

java.lang.Object
  org.marketcetera.client.ClientParameters

public class ClientParameters
extends Object

The set of parameters needed to initialize the client. These parameters are provided to the following methods.

• ClientManager.init(ClientParameters)
• Client.reconnect(ClientParameters)

Since:

1.0.0

Version:

$Id: ClientParameters.java 16154 2012-07-14 16:34:05Z colin $

Author:

anshul@marketcetera.com

Field Summary

static int

DEFAULT_HEARTBEAT_INTERVAL

Constructor Summary

ClientParameters(String inUsername, char[] inPassword, String inURL, String inHostname, int inPort)
Creates an instance.

ClientParameters(String inUsername, char[] inPassword, String inURL, String inHostname, int inPort, String inIDPrefix)
Creates an instance.

ClientParameters(String inUsername, char[] inPassword, String inURL, String inHostname, int inPort, String inIDPrefix, int inHeartbeatInterval)
Creates an instance.

Method Summary

boolean	equals(Object o)
int	getHeartbeatInterval() The time interval between heartbeats, in ms.
String	getHostname() The server hostname.
String	getIDPrefix() The string to prefix to the orderIDs generated by this class.
char[]	getPassword() The password to use when connecting to the server.
int	getPort() The port number of the server.
String	getURL() The URL of the server.
String	getUsername() Gets the user name to use when connecting to the server.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_HEARTBEAT_INTERVAL

public static final int DEFAULT_HEARTBEAT_INTERVAL

See Also:

Constant Field Values

Constructor Detail

ClientParameters

@ConstructorProperties(value={"username","password","URL","hostname","port","IDPrefix","heartbeatInterval"})
public ClientParameters(String inUsername,
                                                   char[] inPassword,
                                                   String inURL,
                                                   String inHostname,
                                                   int inPort,
                                                   String inIDPrefix,
                                                   int inHeartbeatInterval)

Creates an instance.

Parameters:

inUsername - the user name.

inPassword - the password.

inURL - the URL.

inHostname - the host name

inPort - the port number

inIDPrefix - the string to prefix to the orderIDs generated by the client based on the IDs from the server.

inHeartbeatInterval - time interval between heartbeats, in ms.

ClientParameters

public ClientParameters(String inUsername,
                        char[] inPassword,
                        String inURL,
                        String inHostname,
                        int inPort,
                        String inIDPrefix)

Creates an instance.

Parameters:

inUsername - the user name.

inPassword - the password.

inURL - the URL.

inHostname - the host name

inPort - the port number

inIDPrefix - the string to prefix to the orderIDs generated by the client based on the IDs from the server.

ClientParameters

public ClientParameters(String inUsername,
                        char[] inPassword,
                        String inURL,
                        String inHostname,
                        int inPort)

Creates an instance.

Parameters:

inUsername - the user name.

inPassword - the password.

inURL - the URL.

inHostname - the host name

inPort - the port number

Method Detail

getUsername

public String getUsername()

Gets the user name to use when connecting to the server.

Returns:

the user name.

getPassword

public char[] getPassword()

The password to use when connecting to the server.

Returns:

the password.

getURL

public String getURL()

The URL of the server.

Returns:

the URL of the server.

getPort

public int getPort()

The port number of the server.

Returns:

the server port number.

getHostname

public String getHostname()

The server hostname.

Returns:

the server hostname.

getIDPrefix

public String getIDPrefix()

The string to prefix to the orderIDs generated by this class.

Returns:

the string to prefix to the orderIDs generated by this class.

getHeartbeatInterval

public int getHeartbeatInterval()

The time interval between heartbeats, in ms.

Returns:

the time interval.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object