sapphire.accessor

Class ConnectionProcessor

java.lang.Object

com.labvantage.sapphire.BaseClass

com.labvantage.sapphire.BaseAccessor

sapphire.accessor.ConnectionProcessor

public class ConnectionProcessor
extends com.labvantage.sapphire.BaseAccessor

Supports CCM access and related functions

Field Summary

Fields inherited from class com.labvantage.sapphire.BaseAccessor

jndiPrefix, local, localJNDIPrefix, remoteAccessKey

Fields inherited from class com.labvantage.sapphire.BaseClass

FAILURE, SUCCESS

Constructor Summary

Constructors

Constructor and Description
ConnectionProcessor() Default constructor
ConnectionProcessor(java.io.File rakFile) Constructor for a client application with an existing connection
ConnectionProcessor(java.io.File rakFile, java.lang.String connectionid) Constructor for a client application with an existing connection
ConnectionProcessor(javax.servlet.jsp.PageContext pageContext) Constructor for a client web application with a page Context and existing connectionid
ConnectionProcessor(java.lang.String connectionid) Constructor for creating an accessor from components
ConnectionProcessor(java.lang.String nameserverlist, java.lang.String connectionid) Deprecated. As of version 4.6 replaced by ConnectionProcessor(String) and ConnectionProcessor(File, String)

Method Summary

Modifier and Type	Method and Description
void	changePassword(java.lang.String userid, java.lang.String oldpassword, java.lang.String newpassword) Changes a user's password with remote access
void	changePassword(java.lang.String databaseid, java.lang.String userid, java.lang.String oldpassword, java.lang.String newpassword) Changes a user's password with local access
int	changePassword(java.lang.String nameserverlist, java.lang.String databaseid, java.lang.String userid, java.lang.String oldpassword, java.lang.String newpassword) Deprecated. As of version 4.6 replaced by changePassword(String, String, String, String) and changePassword(String, String, String)
boolean	checkConnection(java.lang.String connectionid) Returns true if the connection is valid
boolean	checkUser(java.lang.String sysuserid, java.lang.String password) Returns true if it is a valid username/password combination
void	clearConnection(java.lang.String connectionid) Returns a connection id
int	clearRSets(java.lang.String rsetlist)
void	disableUser(java.lang.String sysuserid, java.lang.String reason) Disables a user account
void	enableUser(java.lang.String sysuserid) Enables a user account
void	forceChangePassword(java.lang.String sysuserid) Forces a user to change password the next time they log in
java.lang.String	getConfigProperty(java.lang.String propertyid) Returns a system-wide configuration property
java.lang.String	getConfigProperty(java.lang.String propertyid, java.lang.String defaultValue) Returns a system-wide configuration property
java.lang.String	getConnectionid(java.io.File rakFile, java.lang.String userid, java.lang.String password) Returns a connection id
java.lang.String	getConnectionid(java.lang.String userid, java.lang.String password) Generates and returns a new connectionid with RemoteAccess
java.lang.String	getConnectionid(java.lang.String databaseid, java.lang.String userid, java.lang.String password) Returns a connection id
java.lang.String	getConnectionid(java.lang.String databaseid, java.lang.String userid, java.lang.String password, java.util.HashMap options) Returns a connection id
java.lang.String	getConnectionid(java.lang.String nameserverlist, java.lang.String databaseid, java.lang.String userid, java.lang.String password) Deprecated. As of version 4.6 replaced by getConnectionid(String, String, String) and getConnectionid(String, String)
java.lang.String	getConnectionid(java.lang.String nameserverlist, java.lang.String databaseid, java.lang.String userid, java.lang.String password, java.util.HashMap options) Deprecated. As of version 4.6 replaced by getConnectionid(String, String, String) and getConnectionid(String, String)
ConnectionInfo	getConnectionInfo(java.lang.String connectionid) Returns the connectioninformation associated with the current user
java.lang.String[]	getDatabaseList() Returns a list active databases
java.lang.String	getLanguage() Returns the languageid associated with the current user
java.lang.String	getLicenseProperty(java.lang.String propertyid) Returns a CCIDHolder class
java.util.List	getModuleList() Returns a semi-colon separated list of modules the current user has access to
java.lang.String	getProfileProperty(java.lang.String propertyid) Deprecated. As of version R5.1 replaced by methods in the ConfigurationProcessor
java.util.List	getRoleList() Returns a semi-colon separated list of roles for the current user
com.labvantage.sapphire.services.SapphireConnection	getSapphireConnection()
java.lang.String	getSysConfigProperty(java.lang.String propertyid) Returns a system-wide configuration property
java.lang.String	getSysConfigProperty(java.lang.String propertyid, java.lang.String defaultValue) Returns a system-wide configuration property
boolean	isMSS() Returns whether the current connection uses an Microsoft SQLServer
boolean	isOra() Returns whether the current connection uses an Oracle database
boolean	isValidPassword(java.lang.String userid, java.lang.String password) Checks a user's password against the current password policy
boolean	isValidPassword(java.lang.String databaseid, java.lang.String userid, java.lang.String password) Checks a user's password against the current password policy
int	isValidPassword(java.lang.String nameserverlist, java.lang.String databaseid, java.lang.String userid, java.lang.String password) Deprecated. As of version 4.6 replaced by isValidPassword(String, String, String, String) and isValidPassword(String, String, String)
void	prepareToDeleteConnection(java.lang.String connectionid)

Methods inherited from class com.labvantage.sapphire.BaseAccessor

createRemoteAccessKey, getAttachmentManager, getAutomationManager, getConfigurationManager, getConnectionid, getErrorCodeList, getErrorCodeStack, getErrorHandler, getErrorStack, getErrorStack, getErrorString, getInfoErrorString, getLastError, getLastErrorCode, getLastErrorMessage, getLastException, getLocalAccessManager, getNameserverlist, getQueryManager, getRemoteAccessManager, getRequestManager, getStatusManager, getWebAdminManager, hasErrors, hasInfoErrors, parseServiceExceptionMsg, resetConnectionid, resetErrorStack, setConnectionDetails, setConnectionid, setError, setError, setErrorString, setInfoErrorString, setJNDIPrefix, setLocal, setLocalJNDIPrefix, setRakFile

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectionProcessor

public ConnectionProcessor()

Default constructor

ConnectionProcessor

public ConnectionProcessor(java.lang.String connectionid)

Constructor for creating an accessor from components

Parameters:

connectionid - The connection to use for component calls

ConnectionProcessor

public ConnectionProcessor(java.lang.String nameserverlist,
                           java.lang.String connectionid)

Deprecated. As of version 4.6 replaced by ConnectionProcessor(String) and ConnectionProcessor(File, String)

Constructor for a client application with an existing connection

Parameters:

nameserverlist - list of the application sever names

connectionid - A valid connectionid

ConnectionProcessor

public ConnectionProcessor(java.io.File rakFile)
                    throws SapphireException

Constructor for a client application with an existing connection

Parameters:

rakFile - A remote access key file

Throws:

SapphireException

ConnectionProcessor

public ConnectionProcessor(java.io.File rakFile,
                           java.lang.String connectionid)

Constructor for a client application with an existing connection

Parameters:

rakFile - A remote access key file

connectionid - A valid connectionid

ConnectionProcessor

public ConnectionProcessor(javax.servlet.jsp.PageContext pageContext)

Constructor for a client web application with a page Context and existing connectionid

Parameters:

pageContext - The current page context

Method Detail

changePassword

public int changePassword(java.lang.String nameserverlist,
                          java.lang.String databaseid,
                          java.lang.String userid,
                          java.lang.String oldpassword,
                          java.lang.String newpassword)

Deprecated. As of version 4.6 replaced by changePassword(String, String, String, String) and changePassword(String, String, String)

Changes a user's password

Parameters:

nameserverlist - List of name servers

databaseid - Sapphire database to connect to

userid - Sapphire username

oldpassword - Old sapphire password

newpassword - New sapphire password

Returns:

SUCCESS or FAILURE

changePassword

public void changePassword(java.lang.String databaseid,
                           java.lang.String userid,
                           java.lang.String oldpassword,
                           java.lang.String newpassword)
                    throws SapphireException

Changes a user's password with local access

Parameters:

databaseid - Sapphire database to connect to

userid - Sapphire username

oldpassword - Old sapphire password

newpassword - New sapphire password

Throws:

SapphireException

changePassword

public void changePassword(java.lang.String userid,
                           java.lang.String oldpassword,
                           java.lang.String newpassword)
                    throws SapphireException

Changes a user's password with remote access

Parameters:

userid - Sapphire username

oldpassword - Old sapphire password

newpassword - New sapphire password

Throws:

SapphireException

isValidPassword

public int isValidPassword(java.lang.String nameserverlist,
                           java.lang.String databaseid,
                           java.lang.String userid,
                           java.lang.String password)

Deprecated. As of version 4.6 replaced by isValidPassword(String, String, String, String) and isValidPassword(String, String, String)

Checks a user's password against the current password policy

Parameters:

nameserverlist - List of name servers

databaseid - Sapphire database to connect to

userid - Sapphire username

password - Sapphire password

Returns:

SUCCESS or FAILURE

isValidPassword

public boolean isValidPassword(java.lang.String databaseid,
                               java.lang.String userid,
                               java.lang.String password)
                        throws SapphireException

Checks a user's password against the current password policy

Parameters:

databaseid - Sapphire database to connect to

userid - Sapphire username

password - Sapphire password

Returns:

true or false

Throws:

SapphireException

isValidPassword

public boolean isValidPassword(java.lang.String userid,
                               java.lang.String password)
                        throws SapphireException

Checks a user's password against the current password policy

Parameters:

userid - Sapphire username

password - Sapphire password

Returns:

true or false

Throws:

SapphireException

getConnectionid

public java.lang.String getConnectionid(java.lang.String userid,
                                        java.lang.String password)
                                 throws SapphireException

Generates and returns a new connectionid with RemoteAccess

Parameters:

userid - Sapphire username

password - Sapphire password

Returns:

Connectionid or zero length string

Throws:

SapphireException

getConnectionid

public java.lang.String getConnectionid(java.lang.String nameserverlist,
                                        java.lang.String databaseid,
                                        java.lang.String userid,
                                        java.lang.String password)

Deprecated. As of version 4.6 replaced by getConnectionid(String, String, String) and getConnectionid(String, String)

Returns a connection id

Parameters:

nameserverlist - List of name servers

databaseid - Sapphire database to connect to

userid - Sapphire username

password - Sapphire password

Returns:

Connectionid or zero length string

getConnectionid

public java.lang.String getConnectionid(java.io.File rakFile,
                                        java.lang.String userid,
                                        java.lang.String password)
                                 throws SapphireException

Returns a connection id

Parameters:

rakFile - A remote access key file

userid - Sapphire username

password - Sapphire password

Returns:

Connectionid or zero length string

Throws:

SapphireException

getConnectionid

public java.lang.String getConnectionid(java.lang.String nameserverlist,
                                        java.lang.String databaseid,
                                        java.lang.String userid,
                                        java.lang.String password,
                                        java.util.HashMap options)

Deprecated. As of version 4.6 replaced by getConnectionid(String, String, String) and getConnectionid(String, String)

Returns a connection id

Parameters:

nameserverlist - List of name servers

databaseid - Sapphire database to connect to

userid - Sapphire username

password - Sapphire password

options - Extended options for connecting

Returns:

Connectionid or zero length string

getConnectionid

public java.lang.String getConnectionid(java.lang.String databaseid,
                                        java.lang.String userid,
                                        java.lang.String password)

Returns a connection id

Parameters:

databaseid - Sapphire database to connect to

userid - Sapphire username

password - Sapphire password

Returns:

Connectionid or zero length string

getConnectionid

public java.lang.String getConnectionid(java.lang.String databaseid,
                                        java.lang.String userid,
                                        java.lang.String password,
                                        java.util.HashMap options)

Returns a connection id

Parameters:

databaseid - Sapphire database to connect to

userid - Sapphire username

password - Sapphire password

options - Extended options for connecting

Returns:

Connectionid or zero length string

clearConnection

public void clearConnection(java.lang.String connectionid)

Returns a connection id

Parameters:

connectionid - Sapphire connectionid

prepareToDeleteConnection

public void prepareToDeleteConnection(java.lang.String connectionid)

getDatabaseList

public java.lang.String[] getDatabaseList()

Returns a list active databases

Returns:

list of active databases

checkUser

public boolean checkUser(java.lang.String sysuserid,
                         java.lang.String password)

Returns true if it is a valid username/password combination

Parameters:

sysuserid - Sapphire user

password - The password for the user

Returns:

true if it is a valid username/password combinaition, false otherwise

checkConnection

public boolean checkConnection(java.lang.String connectionid)

Returns true if the connection is valid

Parameters:

connectionid - Sapphire connectionid

Returns:

true if the connection identified by the connectionid is valid, false otherwise

clearRSets

public int clearRSets(java.lang.String rsetlist)

Parameters:

rsetlist -

Returns:

SUCCESS or FAILURE

getLicenseProperty

public java.lang.String getLicenseProperty(java.lang.String propertyid)

Returns a CCIDHolder class

Parameters:

propertyid - Sapphire connectionid

Returns:

the requested property value

disableUser

public void disableUser(java.lang.String sysuserid,
                        java.lang.String reason)

Disables a user account

Parameters:

sysuserid - User to disable

reason - Reason for user being disabled

enableUser

public void enableUser(java.lang.String sysuserid)

Enables a user account

Parameters:

sysuserid - User to disable

forceChangePassword

public void forceChangePassword(java.lang.String sysuserid)

Forces a user to change password the next time they log in

Parameters:

sysuserid - User to request password change for

getProfileProperty

public java.lang.String getProfileProperty(java.lang.String propertyid)

Deprecated. As of version R5.1 replaced by methods in the ConfigurationProcessor

Return a profiile property for the current user.

Parameters:

propertyid - Profile property to look for

Returns:

The profile property value

isOra

public boolean isOra()

Returns whether the current connection uses an Oracle database

Returns:

true if using Oracle

isMSS

public boolean isMSS()

Returns whether the current connection uses an Microsoft SQLServer

Returns:

true if using Microsoft SQLServer

getRoleList

public java.util.List getRoleList()

Returns a semi-colon separated list of roles for the current user

Returns:

java.util.List of roles

getModuleList

public java.util.List getModuleList()

Returns a semi-colon separated list of modules the current user has access to

Returns:

java.util.List of modules

getLanguage

public java.lang.String getLanguage()

Returns the languageid associated with the current user

Returns:

the language id

getSapphireConnection

public com.labvantage.sapphire.services.SapphireConnection getSapphireConnection()

getConnectionInfo

public ConnectionInfo getConnectionInfo(java.lang.String connectionid)

Returns the connectioninformation associated with the current user

Parameters:

connectionid - Conenctionid

Returns:

the connectionInfo

getConfigProperty

public java.lang.String getConfigProperty(java.lang.String propertyid)

Returns a system-wide configuration property

Parameters:

propertyid - the propertyid

Returns:

the configuration value

getConfigProperty

public java.lang.String getConfigProperty(java.lang.String propertyid,
                                          java.lang.String defaultValue)

Returns a system-wide configuration property

Parameters:

propertyid - the propertyid

defaultValue - the default value

Returns:

the configuration value

getSysConfigProperty

public java.lang.String getSysConfigProperty(java.lang.String propertyid)

Returns a system-wide configuration property

Parameters:

propertyid - the propertyid

Returns:

the configuration value

getSysConfigProperty

public java.lang.String getSysConfigProperty(java.lang.String propertyid,
                                             java.lang.String defaultValue)

Returns a system-wide configuration property

Parameters:

propertyid - the propertyid

defaultValue - the default value

Returns:

the configuration value