Project: stp

com.ibm.rational.wvcm.stp.cq
Interface CqDb

All Superinterfaces:
CqResource, Resource, StpResource
All Known Subinterfaces:
CqDbSet, CqUserDb

public interface CqDb
extends CqResource

An interface for accessing administrative information regarding a login to a ClearQuest database; common to both db-sets and user databases.


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.ibm.rational.wvcm.stp.StpResource
StpResource.UnsupportedProperty
 
Nested classes/interfaces inherited from interface javax.wvcm.Resource
Resource.CopyFlag
 
Field Summary
static PropertyNameList.PropertyName<ResourceList<CqGroup>> ALL_GROUPS
          A list of all groups known to this database.
static PropertyNameList.PropertyName<ResourceList<CqUser>> ALL_USERS
          A list of all users known to this database.
static PropertyNameList.PropertyName<String> AUTHENTICATION_LOGIN_NAME
          Returns the string that the current user enters as the login name when authenticating.
static PropertyNameList.PropertyName<CqUser> CURRENT_USER
          Returns the CqUser structure in this database that corresponds to the logged-in user identified by the host provider.
static PropertyNameList.PropertyName<String[]> DIAG_INFO
           
static PropertyNameList.PropertyName<String> EVERYONE_GROUP_NAME
          The name of the distinguished group to which every user implicitly belongs.
static PropertyNameList.PropertyName<PropertyNameList.PropertyName<String>> LDAP_PROPERTY
          The name of the CqUser property that is used for correlating LDAP user records to Rational ClearQuest user records; null if the mapping is not configured.
static PropertyNameList.PropertyName<CqReplica> LOCAL_REPLICA
          Returns the name of the replica hosting this database.
 
Fields inherited from interface com.ibm.rational.wvcm.stp.StpResource
ALL_PROPERTIES, AUTHENTICATION_REALM, CREATOR_GROUP_NAME, CREATOR_LOGIN_NAME, EFFICIENT_LOCATION, INVALID_PROPERTIES, REPOSITORY, STABLE_LOCATION, USER_FRIENDLY_LOCATION
 
Fields inherited from interface javax.wvcm.Resource
ALL_CUSTOM_PROPERTIES, COMMENT, CONTENT_CHARACTER_SET, CONTENT_IDENTIFIER, CONTENT_LANGUAGE, CONTENT_LENGTH, CONTENT_TYPE, CREATION_DATE, CREATOR_DISPLAY_NAME, DISPLAY_NAME, IS_EXECUTABLE, LAST_MODIFIED, PARENT_LIST, PATHNAME_LOCATION, PROVIDER_LIST, RESOURCE_IDENTIFIER, WORKSPACE_FOLDER_LIST
 
Method Summary
 CqUser doValidateUserCredentials(String loginName, String password, Feedback feedback)
          Verifies that the provided login name and password are valid and map to the current user.
 ResourceList<CqGroup> getAllGroups()
          Returns the value of the ALL_GROUPS property as defined by this proxy.
 ResourceList<CqUser> getAllUsers()
          Returns the value of the ALL_USERS property as defined by this proxy.
 String getAuthenticationLoginName()
          Returns the value of the AUTHENTICATION_LOGIN_NAME property as defined by this proxy.
 CqUser getCurrentUser()
          Returns the value of the CURRENT_USER property as defined by this proxy.
 String[] getDiagInfo()
          Returns the value of the DIAG_INFO property as defined by this proxy.
 String getEveryoneGroupName()
          Returns the value of the EVERYONE_GROUP_NAME property as defined by this proxy.
 PropertyNameList.PropertyName<String> getLDAPProperty()
          Returns the value of the LDAP_PROPERTY property as defined by this proxy.
 CqReplica getLocalReplica()
          Returns the value of the LOCAL_REPLICA property as defined by this proxy.
 void setDiagInfo(String[] info)
          Defines a new value for the DIAG_INFO property of this proxy.
 
Methods inherited from interface CqResource
cqProvider, getComment, getContentCharacterSet, getContentIdentifier, getContentLanguage, getContentLength, getContentType, getCreationDate, getCreatorDisplayName, getCreatorGroupName, getCreatorLoginName, getIsExecutable, getLastModified, getProviderList, getWorkspaceFolderList, setComment, setContentCharacterSet, setContentLanguage, setContentType, setCreatorDisplayName, setIsExecutable
 
Methods inherited from interface com.ibm.rational.wvcm.stp.StpResource
doReadProperties, equals, getAllProperties, getAuthenticationRealm, getCustomProperties, getEfficientLocation, getInvalidProperties, getMetaProperties, getPropertyException, getRepository, getResourceError, getResourceIdentifier, getStableLocation, getUserFriendlyLocation, hashCode, hasProperties, initMetaProperty, proxyType, setPropertyClean, stpLocation, stpProvider
 
Methods inherited from interface javax.wvcm.Resource
doCopy, doFind, doFindAll, doGetPropertyNameList, doGetPropertyNameList, doReadContent, doReadProperties, doUnbindAll, doWriteContent, doWriteProperties, forgetProperty, getDisplayName, getParentList, getPathnameLocation, getProperty, initProperty, location, lookupProperty, modifyLocation, propertyNameList, provider, removeProperty, setDisplayName, setProperty, setProperty, updatedPropertyNameList
 

Field Detail

ALL_GROUPS

static final PropertyNameList.PropertyName<ResourceList<CqGroup>> ALL_GROUPS
A list of all groups known to this database.


ALL_USERS

static final PropertyNameList.PropertyName<ResourceList<CqUser>> ALL_USERS
A list of all users known to this database.


AUTHENTICATION_LOGIN_NAME

static final PropertyNameList.PropertyName<String> AUTHENTICATION_LOGIN_NAME
Returns the string that the current user enters as the login name when authenticating. The return value may be different from a Rational ClearQuest user name if the user is LDAP authenticated. Use the CURRENT_USER property to get the Rational ClearQuest name of the user stored in the user profile record for the user. Returns the authenticating name used to access this database resource. The value returned is the name used to authenticate the user, not the Rational ClearQuest user login field name that is stored in the user profile record for the user. The return value may be an LDAP login name (for example, myname@us.ibm.com) and not a Rational ClearQuest user name (for example, mycqname).


CURRENT_USER

static final PropertyNameList.PropertyName<CqUser> CURRENT_USER
Returns the CqUser structure in this database that corresponds to the logged-in user identified by the host provider.


DIAG_INFO

static final PropertyNameList.PropertyName<String[]> DIAG_INFO

EVERYONE_GROUP_NAME

static final PropertyNameList.PropertyName<String> EVERYONE_GROUP_NAME
The name of the distinguished group to which every user implicitly belongs.


LDAP_PROPERTY

static final PropertyNameList.PropertyName<PropertyNameList.PropertyName<String>> LDAP_PROPERTY
The name of the CqUser property that is used for correlating LDAP user records to Rational ClearQuest user records; null if the mapping is not configured. May return an exception if there is an error connecting to the db-set associated with this database (that is, the master database or schema repository). In a MultiSite environment, Rational ClearQuest enforces that the same LDAP_PROPERTY is used for all sites (that is, the same Rational ClearQuest User field), but allows that the LDAP attribute that is mapped may be site specific. This allows you to have different LDAP schemas at different sites, but allows Rational ClearQuest to enforce the uniqueness of the Rational ClearQuest mapping field values across an entire database set. LDAP_PROPERTY is null if the database set has not been configured for LDAP use.


LOCAL_REPLICA

static final PropertyNameList.PropertyName<CqReplica> LOCAL_REPLICA
Returns the name of the replica hosting this database.

Method Detail

doValidateUserCredentials

CqUser doValidateUserCredentials(String loginName,
                                 String password,
                                 Feedback feedback)
                                 throws WvcmException
Verifies that the provided login name and password are valid and map to the current user.

Parameters:
loginName - The user's login name
password - The password associated with the loginName
feedback - A Feedback object in which may be specified the CqUser properties to be returned in the result proxy.
Returns:
The CqUser to which the specified credentials map if the user is successfully validated; null otherwise.
Throws:
WvcmException

getAllGroups

ResourceList<CqGroup> getAllGroups()
                                   throws WvcmException
Returns the value of the ALL_GROUPS property as defined by this proxy.

Returns:
The value. A list of CqGroup proxies identifying all the groups known to the database. Will never be null but the list may be empty.
Throws:
WvcmException - if this proxy does not define a value for the ALL_GROUPS property.

getAllUsers

ResourceList<CqUser> getAllUsers()
                                 throws WvcmException
Returns the value of the ALL_USERS property as defined by this proxy.

Returns:
The value. A list of CqUser proxies identifying all the users known to this database. Will never be null.
Throws:
WvcmException - if this proxy does not define a value for the ALL_USERS property.

getAuthenticationLoginName

String getAuthenticationLoginName()
                                  throws WvcmException
Returns the value of the AUTHENTICATION_LOGIN_NAME property as defined by this proxy.

Returns:
The authentication login name. Will never be null.
Throws:
WvcmException - if this proxy does not define a value for the AUTHENTICATION_LOGIN_NAME property.

getCurrentUser

CqUser getCurrentUser()
                      throws WvcmException
Returns the value of the CURRENT_USER property as defined by this proxy.

Returns:
The CqUser object for the user identified by this proxy's provider. Will never be null.
Throws:
WvcmException - if this proxy does not define a value for the CURRENT_USER property.

getDiagInfo

String[] getDiagInfo()
                     throws WvcmException
Returns the value of the DIAG_INFO property as defined by this proxy.

Returns:
A String[] containing the current settings for the generation of diagnostic information by the ClearQuest application. Will never be null.
Throws:
WvcmException - if this proxy does not define a value for the DIAG_INFO property.

getEveryoneGroupName

String getEveryoneGroupName()
                            throws WvcmException
Returns the value of the EVERYONE_GROUP_NAME property as defined by this proxy.

Returns:
The name of the group of which every user is implicitly a member. Will never be null.
Throws:
WvcmException - if this proxy does not define a value for the EVERYONE_GROUP_NAME property.

getLDAPProperty

PropertyNameList.PropertyName<String> getLDAPProperty()
                                                      throws WvcmException
Returns the value of the LDAP_PROPERTY property as defined by this proxy.

Returns:
A PropertyName identifying the property of CqUser resources that is used for LDAP authentication or null if LDAP mapping has not been configured for this database. The possible PropertyName values are: CqUser.PHONE, CqUser.FULL_NAME, CqUser.EMAIL, CqUser.MISCELLANEOUS_INFORMATION, and CqUser.LOGIN_NAME.
Throws:
WvcmException - if this proxy does not define a value for the LDAP_PROPERTY property.

getLocalReplica

CqReplica getLocalReplica()
                          throws WvcmException
Returns the value of the LOCAL_REPLICA property as defined by this proxy.

Returns:
A CqReplica proxy for the local replica. Will never be null.
Throws:
WvcmException - if this proxy does not define a value for the LOCAL_REPLICA property.

setDiagInfo

void setDiagInfo(String[] info)
Defines a new value for the DIAG_INFO property of this proxy.

Parameters:
info - A String[] containing the new diagnostic settings.

Generated Thu 6-Nov-2014 09:05 PM

Copyright © IBM 2014. All rights reserved.