oracle.ifs.common

Class BaseApp

java.lang.Object

oracle.ifs.common.BaseMain

oracle.ifs.common.BaseApp

All Implemented Interfaces:

Runnable, Logger

Direct Known Subclasses:

AdminManager, CopyToIfs, CreateClass, CreateClasses, ScriptDriver, VerifyMedia

public abstract class BaseApp
extends BaseMain
implements Runnable

The BaseApp class - Base class for iFS protocol servers.

Version:

1.0

Author:

Dave Long

(Unpublished)

Field Summary

Fields

Modifier and Type	Field and Description
protected DirectoryObject	m_currentuser Deprecated. invoke getUser on the session returned from connect methods.
protected LibrarySession	m_session Deprecated. save the session that is returned from connect methods.

Fields inherited from class oracle.ifs.common.BaseMain

m_defaultWriter, m_logWriter, m_parametertable, m_timervalue

Constructor Summary

Constructors

Constructor and Description
BaseApp(String[] args) Construct with commandline arguments.

Method Summary

Modifier and Type	Method and Description
LibrarySession	connect() Create a LibrarySession.
protected void	Connect() Create a LibrarySession.
LibrarySession	connect(Credential credential, ConnectOptions options) Create a LibrarySession, from the specified Credential and ConnectOptions.
protected void	Connect(Credential credential, ConnectOptions options) Create a LibrarySession, from the specified Credential and ConnectOptions.
protected void	Connect(Credential credential, ConnectOptions options, String server) Create a LibrarySession, from the specified Credential and ConnectOptions.
protected void	Connect(Credential credential, ConnectOptions options, String serviceName, String password) Create a LibrarySession, from the specified Credential and ConnectOptions.
LibrarySession	connect(String username, String password, String server) Create a LibrarySession.
protected void	Connect(String username, String password, String server) Create a LibrarySession.
LibrarySession	connect(String username, String password, String server, String serverPassword) Create a LibrarySession.
protected void	Connect(String username, String password, String server, String serverPassword) Create a LibrarySession.
protected void	Disconnect() Disconnect the last session connected with a connect method.
static String	getCachePerformanceString(LibrarySession session) Get the cache performance, as a String.
protected CleartextCredential	getCleartextCredential() create CleartextCredential using username/password information in the Parametertable.
protected CleartextCredential	getCleartextCredential(String username, String password) create CleartextCredential using specified username/password.
static String	getConnectionPoolPerformanceString(LibrarySession session) Get the connection pool performance, as a String.
protected ConnectOptions	getConnectOptions() create ConnectOptions using server information in the Parametertable.
protected ConnectOptions	getConnectOptions(String server) create ConnectOptions using specified server and other information in the Parametertable.
protected ConnectOptions	getConnectOptions(String server, String dbPassword) create ConnectOptions using specified server & server password, and other information in the Parametertable.
protected Locale	getLocale() Gets the the Locale from ParameterTable settings
void	showCachePerformance(LibrarySession session) Display the cache performance.
void	showConnectionPoolPerformance(LibrarySession session) Display the connection pool performance.

Methods inherited from class oracle.ifs.common.BaseMain

getElapsedTime, getParameterTable, initTrace, log, log, logCurrentTimestamp, printStackTrace, setTimer, showElapsedTime

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Runnable

run

Field Detail

m_session

@Deprecated
protected LibrarySession m_session

Deprecated. save the session that is returned from connect methods.

The session object that represents the session you are currently running.

(Unpublished)

m_currentuser

@Deprecated
protected DirectoryObject m_currentuser

Deprecated. invoke getUser on the session returned from connect methods.

The user object that represents the user you are currently logged in as.

(Unpublished)

Constructor Detail

BaseApp

public BaseApp(String[] args)

Construct with commandline arguments.

Parameters:

args - the arguments passed to main.

(Published)

Method Detail

connect

public LibrarySession connect()
                       throws IfsException

Create a LibrarySession. This uses a CleartextCredential from username/password information contained in the Parametertable, and a default ConnectOptions from information contained in the Parametertable.

Throws:

IfsException - if operation fails.

(Published)

connect

public LibrarySession connect(String username,
                              String password,
                              String server)
                       throws IfsException

Create a LibrarySession. Create a LibrarySession. This uses a CleartextCredential from specified username/password information, and a ConnectOptions from the specified server and additional information contained in the Parametertable.

Throws:

IfsException - if operation fails.

(Published)

connect

public LibrarySession connect(String username,
                              String password,
                              String server,
                              String serverPassword)
                       throws IfsException

Create a LibrarySession. This uses a CleartextCredential from specified username/password information, and a ConnectOptions from the specified server & server password, and additional information contained in the Parametertable.

Throws:

IfsException - if operation fails.

(Published)

connect

public LibrarySession connect(Credential credential,
                              ConnectOptions options)
                       throws IfsException

Create a LibrarySession, from the specified Credential and ConnectOptions.

Parameters:

credential - supplied credential.

options - Connection options.

Throws:

IfsException - if operation fails.

(Published)

Connect

protected void Connect()
                throws IfsException

Create a LibrarySession. This uses a CleartextCredential from username/password information contained in the Parametertable, and a default ConnectOptions from information contained in the Parametertable.

Throws:

IfsException - if operation fails.

(Published)

Connect

protected void Connect(String username,
                       String password,
                       String server)
                throws IfsException

Create a LibrarySession. Create a LibrarySession. This uses a CleartextCredential from specified username/password information, and a ConnectOptions from the specified server and additional information contained in the Parametertable.

Throws:

IfsException - if operation fails.

(Published)

Connect

protected void Connect(String username,
                       String password,
                       String server,
                       String serverPassword)
                throws IfsException

Create a LibrarySession. This uses a CleartextCredential from specified username/password information, and a ConnectOptions from the specified server & server password, and additional information contained in the Parametertable.

Throws:

IfsException - if operation fails.

(Published)

Connect

protected void Connect(Credential credential,
                       ConnectOptions options)
                throws IfsException

Create a LibrarySession, from the specified Credential and ConnectOptions.

Parameters:

credential - supplied credential.

options - Connection options.

Throws:

IfsException - if operation fails.

(Published)

Connect

protected void Connect(Credential credential,
                       ConnectOptions options,
                       String server)
                throws IfsException

Create a LibrarySession, from the specified Credential and ConnectOptions.

Parameters:

credential - supplied credential.

options - Connection options.

server - name of the server

Throws:

IfsException - if operation fails.

(Unpublished)

Connect

protected void Connect(Credential credential,
                       ConnectOptions options,
                       String serviceName,
                       String password)
                throws IfsException

Create a LibrarySession, from the specified Credential and ConnectOptions.

Parameters:

credential - supplied credential.

options - Connection options.

serviceName - service to connect

password - service password

Throws:

IfsException - if operation fails.

(Unpublished)

getCleartextCredential

protected CleartextCredential getCleartextCredential()
                                              throws IfsException

create CleartextCredential using username/password information in the Parametertable.

Returns:

the CleartextCredential corresponding to the username/password.

Throws:

IfsException - if operation fails.

(Published)

getCleartextCredential

protected CleartextCredential getCleartextCredential(String username,
                                                     String password)
                                              throws IfsException

create CleartextCredential using specified username/password.

Parameters:

username - The user name.

password - The user password.

Returns:

the CleartextCredential corresponding to the username/password.

Throws:

IfsException - if operation fails.

(Published)

getConnectOptions

protected ConnectOptions getConnectOptions()
                                    throws IfsException

create ConnectOptions using server information in the Parametertable.

Returns:

the ConnectOptions.

Throws:

IfsException - if operation fails.

(Published)

getConnectOptions

protected ConnectOptions getConnectOptions(String server)
                                    throws IfsException

create ConnectOptions using specified server and other information in the Parametertable.

Parameters:

server - The name of the iFS server.

Returns:

the ConnectOptions.

Throws:

IfsException - if operation fails.

(Published)

getConnectOptions

protected ConnectOptions getConnectOptions(String server,
                                           String dbPassword)
                                    throws IfsException

create ConnectOptions using specified server & server password, and other information in the Parametertable.

Parameters:

server - The name of the iFS server.

dbPassword - The password for the iFS server.

Returns:

the ConnectOptions.

Throws:

IfsException - if operation fails.

(Published)

getLocale

protected Locale getLocale()
                    throws IfsException

Gets the the Locale from ParameterTable settings

Returns:

the Locale

Throws:

IfsException - if the operation fails

(Published)

Disconnect

protected void Disconnect()
                   throws IfsException

Disconnect the last session connected with a connect method.

Throws:

IfsException

(Unpublished)

getCachePerformanceString

public static String getCachePerformanceString(LibrarySession session)
                                        throws IfsException

Get the cache performance, as a String.

Returns:

the performance

Throws:

IfsException - if the operation fails

(Published)

showCachePerformance

public void showCachePerformance(LibrarySession session)
                          throws IfsException

Display the cache performance.

Throws:

IfsException - if the operation fails

(Published)

getConnectionPoolPerformanceString

public static String getConnectionPoolPerformanceString(LibrarySession session)
                                                 throws IfsException

Get the connection pool performance, as a String.

Parameters:

session - the LibrarySession to use

Returns:

the performance

Throws:

IfsException - if the operation fails

(Published)

showConnectionPoolPerformance

public void showConnectionPoolPerformance(LibrarySession session)
                                   throws IfsException

Display the connection pool performance.

Parameters:

session - the LibrarySession to use

Throws:

IfsException - if the operation fails

(Published)