jpl.mipl.mdms.FileService.komodo.api
Class Session

java.lang.Object
  jpl.mipl.mdms.FileService.komodo.api.Session

public class Session
extends Object

Implements the Session session class. The constructor takes a user name and password, security mode, and domain?

Version:

$Id: Session.java,v 1.60 2009/06/15 22:01:23 ntt Exp $

Author:

J. Jacobson

Constructor Summary

Session(String domainFile, int securityModel)
Constructor

Session(String userName, String password, String domainFile, int securityModel)
Constructor

Session(URL domainFile, int securityModel)
Another constructor

Method Summary

int	changePassword(String oldPassword, String newPassword) Change password.
int	close() Close all clients.
void	close(FileType type) Start closing all file types, disconnect from all servers.
void	closeImmediate() close all file types, disconnect from all servers, wait for close to complete and throw away all pending results.
void	closeServerGroup(ServerGroup sg) Close server group instance.
void	dump() Dump Komodo class to stderr, and any interesting has-a classes.
boolean	getAddVFT() Method to check if user has add vft priv
Admin	getAdminConnection(String serverName, boolean useAdminPort) Method to connection to an admin session
static float	getApiVersion() Get the api version.
static String	getApiVersionString() Get the api version string.
LinkedList	getCapabilities() method to return a list of capabilities for all file types
Capability	getCapabilities(String fileType) Method to return capabilities specific to the input file type
LinkedList	getCapabilitiesForGroup(String group) Method to return capabilities specific to the input file type
int	getConnectionTimeout() Returns the value of the connection timeout.
String	getDefaultGroup() Get the default server group.
String	getDir() Get directory associated with this session.
LinkedList	getFileTypeList() Deprecated. does not respect server group namespace!
LinkedList	getFileTypeList(String groupName) Get a sorted list of file types from a server group.
String	getFTServerGroup(String fileTypeName) Deprecated. method not server group namespace aware
LinkedList	getGroupList() Get a sorted list of server group names.
boolean	getOption(int option) Method to return the option value
String	getPassword() Get password for this Komodo session.
String	getRegistry() Get restart directory.
String	getReplicationRoot() Get directory associated with this session.
int	getSecurityModel() Get the type of security for this session, e.g.: Kerberos, SSL, none.
String	getServerGroup(String serverName) Method to get a server group name from a server name.
int	getTcpEndPort() Method to get TCP port end value
int	getTcpStartPort() Method to get TCP port start value
int	getTransactionCount() Get the current transaction count.
int	getTransactionId() Get new transaction id.
int	getUserAccess() Get user access, Session.ADMIN, Session.READALL, Session.WRITEALL.
String	getUserAccessStr() Get user access, Session.ADMIN, Session.READALL, Session.WRITEALL.
String	getUserName() Get user name for this Komodo session.
LinkedList	getVFTCapabilities() getVFTCapabilities
Capability	getVFTCapabilities(String vft) Method to return a capability object specific to the input vft
static void	init() optional initialization Call to get a head start on loading classes.
boolean	isConnected(String fileTypeName) Deprecated. does not respect server group namespace!
boolean	isConnected(String groupName, String typeName) See if a file type already has a server proxy connection.
boolean	isGroupDefined(String groupName) Returns true if servergroup passed in as parameter is defined
boolean	isLoggedOn() Checks if login information is set.
int	makeDomainFile(String domainFilePath, String serverGroup) Make a domain file.
FileType	open(String fileTypeName) Open a file type
FileType	open(String groupName, String typeName) Open a file type
Admin	openAdmin(String serverName) Method to open an admin session
ServerGroup	openServerGroup(String groupName) Opens a server group.
void	postResult(Result result) Method to post a result to the result queue.
Result	result() Get the next profile representing a command result.
Result	result(int timeDelay) Get the next profile representing a command result.
void	setDefaultGroup(String groupName) Set the default server group.
String	setDirectory(String path) setDirectory for the session.
void	setLoginInfo(String userName, String password) Set login information.
boolean	setOption(int option, boolean value) Method to enable/disable an option
String	setReplicationRoot(String path) Sets replication root for the session.
void	setTcpPortRange(int start, int end) Method to set TCP port range

Methods inherited from class java.lang.Object

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

Constructor Detail

Session

public Session(String domainFile,
               int securityModel)
        throws SessionException

Constructor

Parameters:

domainFile - the full path to a domain file.

securityModel - Session.SSL, Session.kerberos, or Session.INSECURE

Throws:

SessionException - when session init failure

Session

public Session(URL domainFile,
               int securityModel)
        throws SessionException

Another constructor

Parameters:

domainFile - URL location of domainFile

securityModel - Session.SSL, Session.kerberos, or Session.INSECURE

Throws:

SessionException - when session failure

Session

public Session(String userName,
               String password,
               String domainFile,
               int securityModel)
        throws SessionException

Constructor

Parameters:

userName - the user name to connect to the service.

password - the user password to connect to the service.

domainFile - the full path to a domain file.

securityModel - Session.SSL, Session.kerberos, or Session.INSECURE

Throws:

SessionException - when session failure

Method Detail

init

public static void init()

optional initialization
Call to get a head start on loading classes. This is because just loading the classes needed by SSLSecureSocket factory takes ~20 seconds.

getApiVersion

public static final float getApiVersion()

Get the api version.

Returns:

apiVersion The current vervsion represented as a decimal number.

getApiVersionString

public static final String getApiVersionString()

Get the api version string.

Returns:

apiVersionString current version represented as a decimal number.

getRegistry

public String getRegistry()

Get restart directory.

Returns:

restart file directory location.

setLoginInfo

public final void setLoginInfo(String userName,
                               String password)

Set login information. Used to reset login name and password. This is used for invalid login recovery.

Parameters:

userName - the user name

password - the user password

isLoggedOn

public boolean isLoggedOn()

Checks if login information is set. Returns true if set, false otherwise.

Returns:

true if login info is set, false otherwise

getSecurityModel

public final int getSecurityModel()

Get the type of security for this session, e.g.: Kerberos, SSL, none.

Returns:

an integer value, represting the type of security.

setOption

public boolean setOption(int option,
                         boolean value)

Method to enable/disable an option

Parameters:

option - the option

value - the on/off flag

Returns:

previous values of option

getOption

public boolean getOption(int option)

Method to return the option value

Parameters:

option - the option

Returns:

boolean value for option.

setDirectory

public String setDirectory(String path)
                    throws SessionException

setDirectory for the session. This applies to functions, like getChecksum (), that operate on file independent of file type.

Parameters:

path - the string directory

Returns:

the string old directory

Throws:

SessionException - when session failure

getDir

public String getDir()

Get directory associated with this session.

Returns:

String directory.

setReplicationRoot

public String setReplicationRoot(String path)
                          throws SessionException

Sets replication root for the session.

Parameters:

path - the string directory

Returns:

the string old directory

Throws:

SessionException - when session failure

getReplicationRoot

public String getReplicationRoot()

Get directory associated with this session.

Returns:

String directory.

getCapabilities

public Capability getCapabilities(String fileType)
                           throws SessionException

Method to return capabilities specific to the input file type

Parameters:

fileType - the file type name

Returns:

Capabilities for a specific file type.

Throws:

SessionException - when session failure

getCapabilitiesForGroup

public LinkedList getCapabilitiesForGroup(String group)
                                   throws SessionException

Method to return capabilities specific to the input file type

Parameters:

fileType - the file type name

Returns:

Capabilities for a specific file type.

Throws:

SessionException - when session failure

getCapabilities

public LinkedList getCapabilities()
                           throws SessionException

method to return a list of capabilities for all file types

Returns:

a list of Capabilities for all file types where a user has capabilities.

Throws:

SessionException - when session failure

getVFTCapabilities

public LinkedList getVFTCapabilities()
                              throws SessionException

getVFTCapabilities

Returns:

a list of Capabilities all VFT where a user has capabilities.

Throws:

SessionException - when session failure

getVFTCapabilities

public Capability getVFTCapabilities(String vft)
                              throws SessionException

Method to return a capability object specific to the input vft

Parameters:

vft - the virtual file type

Returns:

Capabilities for a specific VFT

Throws:

SessionException - when session failure

getUserAccess

public int getUserAccess()
                  throws SessionException

Get user access, Session.ADMIN, Session.READALL, Session.WRITEALL. Returns Session.NOT_SET if not initialized.

Returns:

user access value

Throws:

SessionException - when session failure

getAddVFT

public boolean getAddVFT()
                  throws SessionException

Method to check if user has add vft priv

Returns:

true if user has the ability to add VFT.

Throws:

SessionException - when session failure

getUserAccessStr

public String getUserAccessStr()

Get user access, Session.ADMIN, Session.READALL, Session.WRITEALL.

Returns:

user access string value

changePassword

public int changePassword(String oldPassword,
                          String newPassword)
                   throws SessionException

Change password. To be safe, only let the user to change passwords when there are no outstanding transactions. This way, we can avoid problems tracking down the correct result before closing our utility connection.

Parameters:

oldPassword - the old password

newPassword - the new password

Returns:

Transaction id.

Throws:

SessionException - when session failure

makeDomainFile

public int makeDomainFile(String domainFilePath,
                          String serverGroup)
                   throws SessionException

Make a domain file.

Parameters:

domainFilePath - the new domain file path.

serverGroup - Name of server group to be written to domain file

Returns:

Transaction id.

Throws:

SessionException - when session failure

setTcpPortRange

public void setTcpPortRange(int start,
                            int end)
                     throws SessionException

Method to set TCP port range

Parameters:

start - the start value

end - the end value

Throws:

SessionException - when session failure

getTcpStartPort

public int getTcpStartPort()

Method to get TCP port start value

Returns:

tcp lower port limit for client side port

getTcpEndPort

public int getTcpEndPort()

Method to get TCP port end value

Returns:

tcp upper port limit for client side port

open

public FileType open(String fileTypeName)
              throws SessionException

Open a file type

Parameters:

fileTypeName - file type to open.

Returns:

a file type object reference

Throws:

SessionException - when session failure

open

public FileType open(String groupName,
                     String typeName)
              throws SessionException

Open a file type

Parameters:

groupName - the server group name

typeName - the file type name

Returns:

a file type object reference

Throws:

SessionException - when session failure

openServerGroup

public ServerGroup openServerGroup(String groupName)
                            throws SessionException

Opens a server group.

Parameters:

groupName - Name of the server group to open

Returns:

ServerGroup instance

Throws:

SessionException - if error occurs.

getFTServerGroup

public String getFTServerGroup(String fileTypeName)
                        throws SessionException

Deprecated. method not server group namespace aware

Method to get a server group name from a file type name.

Parameters:

fileTypeName - the name of the filetype

Returns:

The server group name

Throws:

SessionException - when session failure

getServerGroup

public String getServerGroup(String serverName)
                      throws SessionException

Method to get a server group name from a server name.

Parameters:

serverName - the name of the filetype

Returns:

The server group name

Throws:

SessionException - when session failure

openAdmin

public Admin openAdmin(String serverName)
                throws SessionException

Method to open an admin session

Parameters:

serverName - open a server w/o a file type, enrolls connection into list.

Returns:

an admin object reference

Throws:

SessionException - when session failure

getAdminConnection

public Admin getAdminConnection(String serverName,
                                boolean useAdminPort)
                         throws SessionException

Method to connection to an admin session

Parameters:

serverName - open a server w/o a file type.

useAdminPort - flag to indicate to use an defined admin port

Returns:

an admin object reference

Throws:

SessionException - when session failure.

postResult

public void postResult(Result result)

Method to post a result to the result queue.

Parameters:

result - the file profile

getTransactionCount

public int getTransactionCount()

Get the current transaction count.

Returns:

transaction count

closeImmediate

public void closeImmediate()

close all file types, disconnect from all servers, wait for close to complete and throw away all pending results.

close

public int close()
          throws SessionException

Close all clients. If the application program wants to synch-up on this close, then wait on the Komodo result queue for the close command result. The close request goes into the queue as a transaction. The result of the close will appear on the results queue.

Returns:

transaction id.

Throws:

SessionException - when session failure

close

public void close(FileType type)
           throws SessionException

Start closing all file types, disconnect from all servers. The application may then synch up by calling result until the transaction count goes to zero. If flushResults is true, wait for close to complete and throw away all pending results. Also, close all admin clients.

Parameters:

type - the file type to close. If null, close all file types.

Throws:

SessionException - when session failure

closeServerGroup

public void closeServerGroup(ServerGroup sg)

Close server group instance.

Parameters:

sg - ServerGroup instance to close. If null, method returns immediately.

isConnected

public boolean isConnected(String fileTypeName)
                    throws SessionException

Deprecated. does not respect server group namespace!

See if a file type already has a server proxy connection.

Parameters:

fileTypeName - the file type name

Returns:

true if is connected

Throws:

SessionException - when session failure

isConnected

public boolean isConnected(String groupName,
                           String typeName)
                    throws SessionException

See if a file type already has a server proxy connection.

Parameters:

fileTypeName - the file type name

Returns:

true if is connected

Throws:

SessionException - when session failure

result

public Result result()
              throws SessionException

Get the next profile representing a command result. Wait forever for the result. Decrements transaction count on EoT. Returns the EoT profile on some commands (add, for example). On commands that can return multiple results, such as get file by regular expression, do not return the EoT profile.

Returns:

a result object. null profile if the transaction count is already zero.

Throws:

SessionException - when session failure

result

public Result result(int timeDelay)
              throws SessionException

Get the next profile representing a command result. Block until a specified number of milleseconds for a result.

Parameters:

timeDelay - time in seconds.

Returns:

the result object

Throws:

SessionException - when session failure

getTransactionId

public int getTransactionId()

Get new transaction id. Also increments the transaction count.

Returns:

the transaction id

getUserName

public final String getUserName()

Get user name for this Komodo session.

Returns:

user name

getPassword

public final String getPassword()

Get password for this Komodo session.

Returns:

the password

getFileTypeList

public LinkedList getFileTypeList()
                           throws SessionException

Deprecated. does not respect server group namespace!

Get a hashed list of file type names, indexed by server groups

Returns:

the hashed list of file type names

Throws:

SessionException - when operation fails

getFileTypeList

public LinkedList getFileTypeList(String groupName)
                           throws SessionException

Get a sorted list of file types from a server group.

Parameters:

groupName - the server group name

Returns:

the list of file types

Throws:

SessionException - when operation fails

getGroupList

public LinkedList getGroupList()

Get a sorted list of server group names.

Returns:

the list of file types

isGroupDefined

public boolean isGroupDefined(String groupName)

Returns true if servergroup passed in as parameter is defined

Parameters:

servergroup - Name of server group to query

Returns:

True if servergroup exists, false otherwise

getDefaultGroup

public String getDefaultGroup()

Get the default server group. Returns an empty string if default server group is not defined in domain file.

Returns:

default server group name

setDefaultGroup

public void setDefaultGroup(String groupName)
                     throws SessionException

Set the default server group.

Parameters:

groupName - the server group name

Throws:

SessionException - when groupName not defined in domain

dump

public void dump()
          throws SessionException

Dump Komodo class to stderr, and any interesting has-a classes.

Throws:

SessionException - when session failure

getConnectionTimeout

public int getConnectionTimeout()

Returns the value of the connection timeout.