|
|||||||||
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
public class Session
Implements the Session session class. The constructor takes a user name and password, security mode, and domain?
Constructor Summary | |
---|---|
Session(java.lang.String domainFile,
int securityModel)
Constructor |
|
Session(java.lang.String userName,
java.lang.String password,
java.lang.String domainFile,
int securityModel)
Constructor |
|
Session(java.net.URL domainFile,
int securityModel)
Another constructor |
Method Summary | |
---|---|
int |
changePassword(java.lang.String oldPassword,
java.lang.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(java.lang.String serverName,
boolean useAdminPort)
Method to connection to an admin session |
static float |
getApiVersion()
Get the api version. |
static java.lang.String |
getApiVersionString()
Get the api version string. |
java.util.LinkedList |
getCapabilities()
method to return a list of capabilities for all file types |
Capability |
getCapabilities(java.lang.String fileType)
Method to return capabilities specific to the input file type |
java.util.LinkedList |
getCapabilitiesForGroup(java.lang.String group)
Method to return capabilities specific to the input file type |
int |
getConnectionTimeout()
Returns the value of the connection timeout. |
java.lang.String |
getDefaultGroup()
Get the default server group. |
java.lang.String |
getDir()
Get directory associated with this session. |
java.util.LinkedList |
getFileTypeList()
Deprecated. does not respect server group namespace! |
java.util.LinkedList |
getFileTypeList(java.lang.String groupName)
Get a sorted list of file types from a server group. |
java.lang.String |
getFTServerGroup(java.lang.String fileTypeName)
Deprecated. method not server group namespace aware |
java.util.LinkedList |
getGroupList()
Get a sorted list of server group names. |
boolean |
getOption(int option)
Method to return the option value |
java.lang.String |
getPassword()
Get password for this Komodo session. |
java.lang.String |
getRegistry()
Get restart directory. |
java.lang.String |
getReplicationRoot()
Get directory associated with this session. |
int |
getSecurityModel()
Get the type of security for this session, e.g.: Kerberos, SSL, none. |
java.lang.String |
getServerGroup(java.lang.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. |
java.lang.String |
getUserAccessStr()
Get user access, Session.ADMIN, Session.READALL, Session.WRITEALL. |
java.lang.String |
getUserName()
Get user name for this Komodo session. |
java.util.LinkedList |
getVFTCapabilities()
getVFTCapabilities |
Capability |
getVFTCapabilities(java.lang.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(java.lang.String fileTypeName)
Deprecated. does not respect server group namespace! |
boolean |
isConnected(java.lang.String groupName,
java.lang.String typeName)
See if a file type already has a server proxy connection. |
boolean |
isLoggedOn()
Checks if login information is set. |
int |
makeDomainFile(java.lang.String domainFilePath,
java.lang.String serverGroup)
Make a domain file. |
FileType |
open(java.lang.String fileTypeName)
Open a file type |
FileType |
open(java.lang.String groupName,
java.lang.String typeName)
Open a file type |
Admin |
openAdmin(java.lang.String serverName)
Method to open an admin session |
ServerGroup |
openServerGroup(java.lang.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(java.lang.String groupName)
Set the default server group. |
java.lang.String |
setDirectory(java.lang.String path)
setDirectory for the session. |
void |
setLoginInfo(java.lang.String userName,
java.lang.String password)
Set login information. |
boolean |
setOption(int option,
boolean value)
Method to enable/disable an option |
java.lang.String |
setReplicationRoot(java.lang.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 |
---|
public Session(java.lang.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(java.net.URL domainFile, int securityModel) throws SessionException
domainFile
- URL location of domainFilesecurityModel
- Session.SSL, Session.kerberos, or Session.INSECURE
SessionException
- when session failurepublic Session(java.lang.String userName, java.lang.String password, java.lang.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 java.lang.String getApiVersionString()
public java.lang.String getRegistry()
public final void setLoginInfo(java.lang.String userName, java.lang.String password)
userName
- the user namepassword
- the user passwordpublic boolean isLoggedOn()
public 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 java.lang.String setDirectory(java.lang.String path) throws SessionException
path
- the string directory
SessionException
- when session failurepublic java.lang.String getDir()
public java.lang.String setReplicationRoot(java.lang.String path) throws SessionException
path
- the string directory
SessionException
- when session failurepublic java.lang.String getReplicationRoot()
public Capability getCapabilities(java.lang.String fileType) throws SessionException
fileType
- the file type name
SessionException
- when session failurepublic java.util.LinkedList getCapabilitiesForGroup(java.lang.String group) throws SessionException
fileType
- the file type name
SessionException
- when session failurepublic java.util.LinkedList getCapabilities() throws SessionException
SessionException
- when session failurepublic java.util.LinkedList getVFTCapabilities() throws SessionException
SessionException
- when session failurepublic Capability getVFTCapabilities(java.lang.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 java.lang.String getUserAccessStr()
public int changePassword(java.lang.String oldPassword, java.lang.String newPassword) throws SessionException
oldPassword
- the old passwordnewPassword
- the new password
SessionException
- when session failurepublic int makeDomainFile(java.lang.String domainFilePath, java.lang.String serverGroup) throws SessionException
domainFilePath
- the new domain file path.serverGroup
- Name of server group to be written to domain file
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(java.lang.String fileTypeName) throws SessionException
fileTypeName
- file type to open.
SessionException
- when session failurepublic FileType open(java.lang.String groupName, java.lang.String typeName) throws SessionException
groupName
- the server group nametypeName
- the file type name
SessionException
- when session failurepublic ServerGroup openServerGroup(java.lang.String groupName) throws SessionException
groupName
- Name of the server group to open
SessionException
- if error occurs.public java.lang.String getFTServerGroup(java.lang.String fileTypeName) throws SessionException
fileTypeName
- the name of the filetype
SessionException
- when session failurepublic java.lang.String getServerGroup(java.lang.String serverName) throws SessionException
serverName
- the name of the filetype
SessionException
- when session failurepublic Admin openAdmin(java.lang.String serverName) throws SessionException
serverName
- open a server w/o a file type, enrolls connection into
list.
SessionException
- when session failurepublic Admin getAdminConnection(java.lang.String serverName, boolean useAdminPort) throws SessionException
serverName
- open a server w/o a file type.useAdminPort
- flag to indicate to use an defined admin port
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 void closeServerGroup(ServerGroup sg)
sg
- ServerGroup instance to close. If null, method returns
immediately.public boolean isConnected(java.lang.String fileTypeName) throws SessionException
fileTypeName
- the file type name
SessionException
- when session failurepublic boolean isConnected(java.lang.String groupName, java.lang.String typeName) 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 java.lang.String getUserName()
public final java.lang.String getPassword()
public java.util.LinkedList getFileTypeList() throws SessionException
SessionException
- when operation failspublic java.util.LinkedList getFileTypeList(java.lang.String groupName) throws SessionException
groupName
- the server group name
SessionException
- when operation failspublic java.util.LinkedList getGroupList()
public java.lang.String getDefaultGroup()
public void setDefaultGroup(java.lang.String groupName) throws SessionException
groupName
- the server group name
SessionException
- when groupName not defined in domainpublic void dump() throws SessionException
SessionException
- when session failurepublic int getConnectionTimeout()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |