Project: stp

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

All Superinterfaces:
CqDb, CqResource, Resource, StpRepository, StpResource

public interface CqDbSet
extends CqDb, StpRepository

A collection of user database resources. The user databases are known by simple names within a CqDbSet, and thus the CqDbSet is fundamentally useful for enumerating those database names.

The user-friendly specification for the location of a db-set has the form

  cq.dbset:<db-set-name>
 


Nested Class Summary
static class CqDbSet.AuthenticationAlgorithm
          AuthenticationAlgorithm constants specify which authentication search strategy is selected when a Rational ClearQuest user logs on.
 
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<CqUserDb>> ACCESSIBLE_DATABASES
          A list of the user databases to which the current user has access.
static PropertyNameList.PropertyName<CqDbSet.AuthenticationAlgorithm> AUTHENTICATION_ALGORITHM
          Indicates whether the current authentication algorithm is ClearQuest first (then LDAP) or ClearQuest only (no LDAP).
static PropertyNameList.PropertyName<Boolean> IS_USER_ADMIN_ENABLED
          Answers whether or not this database set, using the CqProvider of this proxy, provides user and group administration functions such as the creation of new users and groups and the modification of user and group properties.
static PropertyNameList.PropertyName<ResourceList<CqUserDb>> USER_DATABASES
          A list of the user databases that are in this DbSet
 
Fields inherited from interface CqDb
ALL_GROUPS, ALL_USERS, AUTHENTICATION_LOGIN_NAME, CURRENT_USER, DIAG_INFO, EVERYONE_GROUP_NAME, LDAP_PROPERTY, LOCAL_REPLICA
 
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
 
Fields inherited from interface com.ibm.rational.wvcm.stp.StpRepository
PRODUCT_INFO
 
Method Summary
 ResourceList<CqUserDb> getAccessibleDatabases()
          Returns the value of the ACCESSIBLE_DATABASES property as defined by this proxy.
 CqDbSet.AuthenticationAlgorithm getAuthenticationAlgorithm()
          Returns the value of the AUTHENTICATION_ALGORITHM property as defined by this proxy.
 boolean getIsUserAdminEnabled()
          Returns the value of the IS_USER_ADMIN_ENABLED property as defined by this proxy.
 ResourceList<CqUserDb> getUserDatabases()
          Returns the value of the USER_DATABASES property as defined by this proxy.
 void setAuthenticationAlgorithm(CqDbSet.AuthenticationAlgorithm value)
          Defines a new value for the AUTHENTICATION_ALGORITHM property of this proxy.
 
Methods inherited from interface CqDb
doValidateUserCredentials, getAllGroups, getAllUsers, getAuthenticationLoginName, getCurrentUser, getDiagInfo, getEveryoneGroupName, getLDAPProperty, getLocalReplica, setDiagInfo
 
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
 
Methods inherited from interface com.ibm.rational.wvcm.stp.StpRepository
getProductInfo
 

Field Detail

ACCESSIBLE_DATABASES

static final PropertyNameList.PropertyName<ResourceList<CqUserDb>> ACCESSIBLE_DATABASES
A list of the user databases to which the current user has access. The list is the same as that returned by getCurrentUser().getSubscribedDatabases(), but can be computed much more efficiently.


AUTHENTICATION_ALGORITHM

static final PropertyNameList.PropertyName<CqDbSet.AuthenticationAlgorithm> AUTHENTICATION_ALGORITHM
Indicates whether the current authentication algorithm is ClearQuest first (then LDAP) or ClearQuest only (no LDAP).


IS_USER_ADMIN_ENABLED

static final PropertyNameList.PropertyName<Boolean> IS_USER_ADMIN_ENABLED
Answers whether or not this database set, using the CqProvider of this proxy, provides user and group administration functions such as the creation of new users and groups and the modification of user and group properties.


USER_DATABASES

static final PropertyNameList.PropertyName<ResourceList<CqUserDb>> USER_DATABASES
A list of the user databases that are in this DbSet

Method Detail

getAccessibleDatabases

ResourceList<CqUserDb> getAccessibleDatabases()
                                              throws WvcmException
Returns the value of the ACCESSIBLE_DATABASES property as defined by this proxy.

Returns:
A list of the user databases that are in this DbSet. Will never be null, but may be empty.
Throws:
WvcmException - if this proxy does not define a value for the ACCESSIBLE_DATABASES property.

getAuthenticationAlgorithm

CqDbSet.AuthenticationAlgorithm getAuthenticationAlgorithm()
                                                           throws WvcmException
Returns the value of the AUTHENTICATION_ALGORITHM property as defined by this proxy.

Returns:
The AuthenticationAlgorithm value. Will never be null.
Throws:
WvcmException - if this proxy does not define a value for the AUTHENTICATION_ALGORITHM property.

getIsUserAdminEnabled

boolean getIsUserAdminEnabled()
                              throws WvcmException
Returns the value of the IS_USER_ADMIN_ENABLED property as defined by this proxy.

Returns:
true if user and group administration is supported by this database through this proxy's CqProvider; false otherwise.
Throws:
WvcmException - if this proxy does not define a value for the IS_USER_ADMIN_ENABLED property.

getUserDatabases

ResourceList<CqUserDb> getUserDatabases()
                                        throws WvcmException
Returns the value of the USER_DATABASES property as defined by this proxy.

Returns:
A list of the user databases that are in this DbSet. Will never be null, but may be empty.
Throws:
WvcmException - if this proxy does not define a value for the USER_DATABASES property.

setAuthenticationAlgorithm

void setAuthenticationAlgorithm(CqDbSet.AuthenticationAlgorithm value)
Defines a new value for the AUTHENTICATION_ALGORITHM property of this proxy.

Parameters:
value - An AuthenticationAlgorithm object specifying the new value of the property. Must not be null.

Generated Fri 15-Nov-2013 12:48 AM

Copyright © IBM 2013. All rights reserved.