ORG.oclc.access
Class AccessConnectInfo

java.lang.Object
  |
  +--ORG.oclc.access.AccessConnectInfo

public class AccessConnectInfo

extends Object

implements AccessServerConnect

The AccessConnectInfo class maintains configuration for connecting to a SiteSearch Access Server. It reads in the input configuration file and provides methods to retrieve the information.

Field Summary

protected String	anotherIniFile String containing an additional configuration file
protected boolean	authorizationRequired Boolean data type indicating whether any type of authorization is required.
protected int	authorizationRetries Integer data type indicating how many authorization retries are allowed.
protected String	clientClassName String data type containing the AccessClient class to use for remote authentication
protected int	connectionRetries Integer data type indicating how many connection retries to the Access Server are allowed.
protected boolean	dNSFlag Boolean data type indicating whether to perform authorization based on Domain name.
protected String	hostName String data type containing the hostname for client connections.
protected boolean	iPFlag Boolean data type indicating whether to perform authorization based on IP address.
protected String	login String data type containing the login for remote access
protected boolean	nameFlag Boolean data type indicating whether to perform authorization by name.
protected String	opsConfigDir String data type containing the directory where operations files are.
protected String	password String data type containing the password for remote access
protected String	protocol String data type containing the protocol (i.e.
protected String	serverName String data type containing the name of the server.
protected int	serverPort integer data type containing port number for client connections.
protected String	serverType String data type containing the type of server = "Access".
protected String	systemName String data type containing the system name
protected int	timeoutValue Integer data type containing how many seconds to wait for a response from the Access Server.
protected String	URLString String data type containing the URL for secure socket connection
protected boolean	useLowerCase Boolean data type indicating whether to change autho and password to all lower case.

Constructor Summary

AccessConnectInfo()
Constructs an AccessConnectInfo object.

AccessConnectInfo(String name, IniFile ini)
Constructs an AccessConnectInfo object using the configuration information from the input IniFile object.

AccessConnectInfo(String name, String host, int port)
Constructs an AccessConnectInfo object for the input server name, on the input host and port.

AccessConnectInfo(String name, String host, int port, String protocol, String URLString, String login, String password)
Constructs an AccessConnectInfo object for the input server name, on the input host and port.

Method Summary

boolean	authorizationByDNSRequired() Returns a boolean indicating whether name Authorization by IP is required.
boolean	authorizationByIPRequired() Returns a boolean indicating whether name Authorization by IP is required.
boolean	authorizationByNameRequired() Returns a boolean indicating whether name Authorization by Name is required.
int	authorizationRetries() Returns an integer containing the number of times a user may try to log on.
String	clientClassName() Retrieves a String containing the name of the AccessClient class that is loaded for the accessing the AccessServer.
int	connectionRetries() Returns an integer containing the number of times to try connecting to the Access Server before returning a connection failure.
String	getAnotherIniFile() Returns a String containing the name of the additional ini file
String	getLogin() Returns a String containing the login for connecting to the remote server.
String	getPassword() Returns a String containing the password for connecting to the remote server.
String	getProtocol() Returns a String containing the protocol for connecting to the remote server.
ServerLocation	getServerLocation(OpsClient opsClient, String sessionId) Retrieves a ServerLocation object containing a port and host to connect to for this server from the SiteSearch OpServe process which provides load balancing among servers.
String	getSystemName() Returns a String containing the system name for this access server.
String	getURLString() Returns a String containing the URL for connecting to the remote server.
String	hostName() Returns a String containing the host name for the access server.
void	init(String name, IniFile ini) Initialzes the Access Server by name using the configuration information contained in the IniFile object.
int	readTimeout() Returns an integer containing the number of seconds to wait for the AccessServer to return a response.
String	serverName() Returns a String containing the name of the access server.
int	serverPort() Returns an integer containing the server port for connecting to the access server.
String	serverType() Returns a String containing the type classification of the server.
String	toString() Generates a String representation of the object.
boolean	useLowerCase() Returns a boolean indicating whether to change autho and password to all lower case.

Methods inherited from class java.lang.Object

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

Field Detail

serverName

protected String serverName

String data type containing the name of the server.

serverPort

protected int serverPort

integer data type containing port number for client connections. A port # of 0 indicates to use the OpServe to locate the server.

hostName

protected String hostName

String data type containing the hostname for client connections.

serverType

protected String serverType

String data type containing the type of server = "Access".

protocol

protected String protocol

String data type containing the protocol (i.e. telnet vs sockets)

URLString

protected String URLString

String data type containing the URL for secure socket connection

login

protected String login

String data type containing the login for remote access

password

protected String password

String data type containing the password for remote access

opsConfigDir

protected String opsConfigDir

String data type containing the directory where operations files are.

authorizationRequired

protected boolean authorizationRequired

Boolean data type indicating whether any type of authorization is required.

iPFlag

protected boolean iPFlag

Boolean data type indicating whether to perform authorization based on IP address.

dNSFlag

protected boolean dNSFlag

Boolean data type indicating whether to perform authorization based on Domain name.

nameFlag

protected boolean nameFlag

Boolean data type indicating whether to perform authorization by name.

timeoutValue

protected int timeoutValue

Integer data type containing how many seconds to wait for a response from the Access Server.

authorizationRetries

protected int authorizationRetries

Integer data type indicating how many authorization retries are allowed.

connectionRetries

protected int connectionRetries

Integer data type indicating how many connection retries to the Access Server are allowed.

useLowerCase

protected boolean useLowerCase

Boolean data type indicating whether to change autho and password to all lower case. Defaults to false.

clientClassName

protected String clientClassName

String data type containing the AccessClient class to use for remote authentication

systemName

protected String systemName

String data type containing the system name

anotherIniFile

protected String anotherIniFile

String containing an additional configuration file

Constructor Detail

AccessConnectInfo

public AccessConnectInfo()

Constructs an AccessConnectInfo object.

AccessConnectInfo

public AccessConnectInfo(String name,
                         String host,
                         int port)

Constructs an AccessConnectInfo object for the input server name, on the input host and port.

Parameters:

name - the name of the Access Server

host - the hostname to connect to

port - the port to connect to

AccessConnectInfo

public AccessConnectInfo(String name,
                         IniFile ini)

Constructs an AccessConnectInfo object using the configuration information from the input IniFile object. information from the input iniFile.

Parameters:

name - the name of the Server

ini - the configuration ini file

AccessConnectInfo

public AccessConnectInfo(String name,
                         String host,
                         int port,
                         String protocol,
                         String URLString,
                         String login,
                         String password)

Constructs an AccessConnectInfo object for the input server name, on the input host and port. Includes protocol, URL, login and password.

Parameters:

name - the name of the Access Server

host - the hostname to connect to

port - the port to connect to

protocol - for connecting to the remote server

URLString - for connecting to the remote server

login - for connecting to the remote server

password - for connecting to the remote server

Method Detail

init

public void init(String name,
                 IniFile ini)

Initialzes the Access Server by name using the configuration information contained in the IniFile object.

Parameters:

name - the name of the server.

ini - the IniFile object containing the server specific configuration information.

getServerLocation

public ServerLocation getServerLocation(OpsClient opsClient,
                                        String sessionId)

Retrieves a ServerLocation object containing a port and host to connect to for this server from the SiteSearch OpServe process which provides load balancing among servers.

Parameters:

opsClient -

sessionId -

Returns:

ServerLocation

getSystemName

public String getSystemName()

Returns a String containing the system name for this access server.

Returns:

String

hostName

public String hostName()

Returns a String containing the host name for the access server.

Returns:

String

serverName

public String serverName()

Returns a String containing the name of the access server.

Returns:

String

serverPort

public int serverPort()

Returns an integer containing the server port for connecting to the access server.

Returns:

int

serverType

public String serverType()

Returns a String containing the type classification of the server.

Returns:

String

getProtocol

public String getProtocol()

Returns a String containing the protocol for connecting to the remote server.

Returns:

String

getURLString

public String getURLString()

Returns a String containing the URL for connecting to the remote server.

Returns:

String

getLogin

public String getLogin()

Returns a String containing the login for connecting to the remote server.

Returns:

String

getPassword

public String getPassword()

Returns a String containing the password for connecting to the remote server.

Returns:

String

useLowerCase

public boolean useLowerCase()

Returns a boolean indicating whether to change autho and password to all lower case.

Returns:

boolean

authorizationByNameRequired

public boolean authorizationByNameRequired()

Returns a boolean indicating whether name Authorization by Name is required.

Specified by:

authorizationByNameRequired in interface AccessServerConnect

Returns:

boolean

authorizationByIPRequired

public boolean authorizationByIPRequired()

Returns a boolean indicating whether name Authorization by IP is required.

Specified by:

authorizationByIPRequired in interface AccessServerConnect

Returns:

boolean

authorizationByDNSRequired

public boolean authorizationByDNSRequired()

Returns a boolean indicating whether name Authorization by IP is required.

Specified by:

authorizationByDNSRequired in interface AccessServerConnect

Returns:

boolean

clientClassName

public String clientClassName()

Retrieves a String containing the name of the AccessClient class that is loaded for the accessing the AccessServer.

Specified by:

clientClassName in interface AccessServerConnect

Returns:

String

readTimeout

public int readTimeout()

Returns an integer containing the number of seconds to wait for the AccessServer to return a response.

Returns:

int

authorizationRetries

public int authorizationRetries()

Returns an integer containing the number of times a user may try to log on.

Returns:

int

connectionRetries

public int connectionRetries()

Returns an integer containing the number of times to try connecting to the Access Server before returning a connection failure.

Returns:

int

getAnotherIniFile

public String getAnotherIniFile()

Returns a String containing the name of the additional ini file

toString

public String toString()

Generates a String representation of the object.

Returns:

String

Overrides:

toString in class Object