|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object jpl.mipl.mdms.FileService.komodo.api.Session
Implements the Session session class. The constructor takes a user name and password, security mode, and domain?
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 |
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,
boolean debug)
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 |
String |
getDir()
Get directory associated with this session. |
LinkedList |
getFileTypeList()
Get a sorted list of file types. |
String |
getFTServerGroup(String fileTypeName)
Method to get a server group name from a file type name. |
boolean |
getOption(int option)
Method to return the option value |
String |
getPassword()
Get password for this Komodo session. |
String |
getRegistory()
Get restart directory. |
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)
See if a file type already has a server proxy connection. |
int |
makeDomainFile(String domainFilePath)
Make a domain file. |
FileType |
open(String fileTypeName)
Open a file type |
Admin |
openAdmin(String serverName)
Method to open an admin session |
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. |
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 |
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 |
public Session(String domainFile, int securityModel) throws SessionException
domainFile
- the full path to a domain file.securityModel
- Session.SSL, Session.kerberos, or Session.INSECURE
SessionException
- when session init failurepublic Session(URL domainFile, int securityModel) throws SessionException
domainFile
- URL location of domainFilesecurityModel
- Session.SSL, Session.kerberos, or Session.INSECURE
SessionException
- when session failurepublic Session(String userName, String password, String domainFile, int securityModel) throws SessionException
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
SessionException
- when session failureMethod Detail |
public static void init()
public static final float getApiVersion()
public static final String getApiVersionString()
public String getRegistory()
public final void setLoginInfo(String userName, String password)
userName
- the user namepassword
- the user passwordpublic final int getSecurityModel()
public boolean setOption(int option, boolean value)
option
- the optionvalue
- the on/off flag
public boolean getOption(int option)
option
- the option
public String setDirectory(String path) throws SessionException
path
- the string directory
SessionException
- when session failurepublic String getDir()
public Capability getCapabilities(String fileType) throws SessionException
fileType
- the file type name
SessionException
- when session failurepublic LinkedList getCapabilities() throws SessionException
SessionException
- when session failurepublic LinkedList getVFTCapabilities() throws SessionException
SessionException
- when session failurepublic Capability getVFTCapabilities(String vft) throws SessionException
vft
- the virtual file type
SessionException
- when session failurepublic int getUserAccess() throws SessionException
SessionException
- when session failurepublic boolean getAddVFT() throws SessionException
SessionException
- when session failurepublic String getUserAccessStr()
public int changePassword(String oldPassword, String newPassword) throws SessionException
oldPassword
- the old passwordnewPassword
- the new password
SessionException
- when session failurepublic int makeDomainFile(String domainFilePath) throws SessionException
domainFilePath
- the new domain file path.
SessionException
- when session failurepublic void setTcpPortRange(int start, int end) throws SessionException
start
- the start valueend
- the end value
SessionException
- when session failurepublic int getTcpStartPort()
public int getTcpEndPort()
public FileType open(String fileTypeName) throws SessionException
fileTypeName
- file type to open.
SessionException
- when session failurepublic String getFTServerGroup(String fileTypeName) throws SessionException
fileTypeName
- the name of the filetype
SessionException
- when session failurepublic String getServerGroup(String serverName) throws SessionException
serverName
- the name of the filetype
SessionException
- when session failurepublic Admin openAdmin(String serverName) throws SessionException
serverName
- open a server w/o a file type, enrolls connection into
list.
SessionException
- when session failurepublic Admin getAdminConnection(String serverName, boolean useAdminPort, boolean debug) throws SessionException
serverName
- open a server w/o a file type.useAdminPort
- flag to indicate to use an defined admin portdebug
- the debug flag
SessionException
- when session failure.public void postResult(Result result)
result
- the file profilepublic int getTransactionCount()
public void closeImmediate()
public int close() throws SessionException
SessionException
- when session failurepublic void close(FileType type) throws SessionException
type
- the file type to close. If null, close all file types.
SessionException
- when session failurepublic boolean isConnected(String fileTypeName) throws SessionException
fileTypeName
- the file type name
SessionException
- when session failurepublic Result result() throws SessionException
SessionException
- when session failurepublic Result result(int timeDelay) throws SessionException
timeDelay
- time in seconds.
SessionException
- when session failurepublic int getTransactionId()
public final String getUserName()
public final String getPassword()
public LinkedList getFileTypeList()
public void dump() throws SessionException
SessionExceptin
- when session failure
SessionException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |