|
Project: stp | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface CqDb
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. |
String |
getMasterPropertyValue(String propertyName,
String dbName,
String replicaName,
Feedback feedback)
Get the value of a property from the ClearQuest master property table. |
String |
getMasterPropertyValueFromUserSession(String propertyName,
String dbName,
String replicaName,
Feedback feedback)
Get the value of a property from the ClearQuest master property table using a user-session. |
void |
setDiagInfo(String[] info)
Defines a new value for the DIAG_INFO property of this
proxy. |
void |
setMasterPropertyValue(String propertyName,
String propertyValue,
String dbName,
String replicaName,
Feedback feedback)
Set the value of a property in the ClearQuest master property table to the given value. |
void |
unsetMasterPropertyValue(String propertyName,
String dbName,
String replicaName,
Feedback feedback)
Unset the value of a property in the ClearQuest master property table. |
| 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 |
|---|
static final PropertyNameList.PropertyName<ResourceList<CqGroup>> ALL_GROUPS
static final PropertyNameList.PropertyName<ResourceList<CqUser>> ALL_USERS
static final PropertyNameList.PropertyName<String> AUTHENTICATION_LOGIN_NAME
static final PropertyNameList.PropertyName<CqUser> CURRENT_USER
static final PropertyNameList.PropertyName<String[]> DIAG_INFO
static final PropertyNameList.PropertyName<String> EVERYONE_GROUP_NAME
static final PropertyNameList.PropertyName<PropertyNameList.PropertyName<String>> LDAP_PROPERTY
static final PropertyNameList.PropertyName<CqReplica> LOCAL_REPLICA
| Method Detail |
|---|
CqUser doValidateUserCredentials(String loginName,
String password,
Feedback feedback)
throws WvcmException
loginName - The user's login namepassword - The password associated with the loginNamefeedback - A Feedback object in which may be specified the CqUser
properties to be returned in the result proxy.
WvcmException
ResourceList<CqGroup> getAllGroups()
throws WvcmException
ALL_GROUPS property as
defined by this proxy.
WvcmException - if this proxy does not define a value for the
ALL_GROUPS property.
ResourceList<CqUser> getAllUsers()
throws WvcmException
ALL_USERS property as
defined by this proxy.
WvcmException - if this proxy does not define a value for the
ALL_USERS property.
String getAuthenticationLoginName()
throws WvcmException
AUTHENTICATION_LOGIN_NAME property as
defined by this proxy.
WvcmException - if this proxy does not define a value for the
AUTHENTICATION_LOGIN_NAME
property.
CqUser getCurrentUser()
throws WvcmException
CURRENT_USER property as
defined by this proxy.
WvcmException - if this proxy does not define a value for the
CURRENT_USER property.
String[] getDiagInfo()
throws WvcmException
DIAG_INFO property as defined
by this proxy.
WvcmException - if this proxy does not define a value for the
DIAG_INFO property.
String getEveryoneGroupName()
throws WvcmException
EVERYONE_GROUP_NAME property as defined
by this proxy.
WvcmException - if this proxy does not define a value for the
EVERYONE_GROUP_NAME
property.
PropertyNameList.PropertyName<String> getLDAPProperty()
throws WvcmException
LDAP_PROPERTY property as
defined by this proxy.
WvcmException - if this proxy does not define a value for the
LDAP_PROPERTY property.
CqReplica getLocalReplica()
throws WvcmException
LOCAL_REPLICA property as
defined by this proxy.
WvcmException - if this proxy does not define a value for the
LOCAL_REPLICA property.
String getMasterPropertyValue(String propertyName,
String dbName,
String replicaName,
Feedback feedback)
throws WvcmException
propertyName - - the property name as it is defined in the ClearQuest master property tabledbName - - the ClearQuest user database name; can be empty if this is a global propertyreplicaName - - the ClearQuest replica name; can be empty if this is a global propertyfeedback - - the Feedback object for prograss and additional parameters
WvcmException
String getMasterPropertyValueFromUserSession(String propertyName,
String dbName,
String replicaName,
Feedback feedback)
throws WvcmException
propertyName - - the property name as it is defined in the ClearQuest master property tabledbName - - the ClearQuest user database name; can be empty if this is a global propertyreplicaName - - the ClearQuest replica name; can be empty if this is a global propertyfeedback - - the Feedback object for prograss and additional parameters
WvcmExceptionvoid setDiagInfo(String[] info)
DIAG_INFO property of this
proxy.
info - A String[] containing the new diagnostic settings.
void setMasterPropertyValue(String propertyName,
String propertyValue,
String dbName,
String replicaName,
Feedback feedback)
throws WvcmException
propertyName - - the property name as it is defined in the ClearQuest master property databasepropertyValue - - the value to which the property to be set todbName - - the ClearQuest user database name; can be empty if this is a global propertyreplicaName - - the ClearQuest replica name; can be empty if this is a global property
WvcmException
void unsetMasterPropertyValue(String propertyName,
String dbName,
String replicaName,
Feedback feedback)
throws WvcmException
propertyName - - The property name as it is defined in the ClearQuest master property databasedbName - - The ClearQuest user database name; can be empty if this is a global propertyreplicaName - - The ClearQuest replica name; can be empty if this is a global property
WvcmException
|
Generated Fri 13-Jun-2014 11:11 PM | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||