|
Project: stp | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CcProvider
CcProvider is a ClearCase-specific extension of the generic javax.wvcm.Provider interface and the Rational-specific com.ibm.rational.wvcm.stp.StpProvider interface.
A CcProvider instance represents an individual user session with ClearCase on a particular remote CCRC WAN server or with ClearCase on the local machine.
In addition to the methods defined by its superinterfaces, the CcProvider
interface defines:
getClientViewList(javax.wvcm.PropertyRequestItem.PropertyRequest)
.
NOTE: Starting in the 8.0 release, CM API providers can no longer support both CC and CQ operations in the same provider instance. In 7.1.x releases, a unified CM Server processed both CC and CQ operations. In 8.0, there are separate CC and CQ servers, and so you must instantiate a CqProvider to perform CQ operations and a CcProvider for CC operations.
Nested Class Summary | |
---|---|
static interface |
CcProvider.CcAuthentication
An extension of ProviderFactory.Callback that client call-backs can return to provide a Primary Group or Group List for a ClearCase login |
Nested classes/interfaces inherited from interface com.ibm.rational.wvcm.stp.StpProvider |
---|
StpProvider.Domain, StpProvider.NotifyAuthenticatedOption, StpProvider.NotifyBusyOption, StpProvider.StpCallback, StpProvider.StpProductInfo |
Field Summary | |
---|---|
static String |
LOCAL_PROVIDER_CLASS
The name of a CcProvider class whose instances support direct acess to ClearCase installed on the local machine. |
static String |
NETWORK_PROVIDER_CLASS
The name of a CcProvider class whose instances support ClearCase access via an HTTP connection to a remote CCRC WAN server. |
Fields inherited from interface com.ibm.rational.wvcm.stp.StpProvider |
---|
IS_DISCONNECTED_KEY, IS_DISCONNECTED_VALUE, NOT_DISCONNECTED_VALUE, PROVIDER_CLASS, SERVER_URL_KEY, USER_COUNTRY_KEY, USER_LANGUAGE_KEY, USER_VARIANT_KEY |
Fields inherited from interface javax.wvcm.WorkspaceProvider |
---|
IA_CR_HAS_ONE_PARENT, IA_ROOT_LOCATION, IA_STREAM_FORGETS_UNBOUND_VERSIONS, IA_VERSION_KNOWS_PARENT, IA_WORKSPACE_PATH |
Method Summary | |
---|---|
CcActivity |
ccActivity(StpLocation location)
Create a proxy for a ClearCase UCM activity. |
CcAttributeType |
ccAttributeType(StpLocation loc)
Construct a attribute type proxy for the given location. |
CcBaseline |
ccBaseline(StpLocation location)
Create a proxy for a ClearCase UCM baseline. |
CcBranch |
ccBranch(StpLocation location)
Create a proxy for a ClearCase branch. |
CcBranchType |
ccBranchType(StpLocation loc)
Construct a branch type proxy for the given location. |
CcComponent |
ccComponent(StpLocation location)
Create a proxy for a ClearCase UCM component. |
CcDirectory |
ccDirectory(StpLocation loc)
Construct a proxy for the CcDirectory (directory in a ClearCase view) specified by the given location. |
CcDirectoryVersion |
ccDirectoryVersion(StpLocation loc)
Construct a directory version proxy for the given location. |
CcElement |
ccElement(StpLocation loc)
Construct a element proxy for the given location. |
CcElementType |
ccElementType(StpLocation loc)
Construct a element type proxy for the given location. |
CcFile |
ccFile(StpLocation loc)
Construct a proxy for the CcFile (file in a ClearCase view) specified by the given location. |
CcHyperlinkType |
ccHyperlinkType(StpLocation loc)
Construct a hyperlink type proxy for the given location. |
CcLabelType |
ccLabelType(StpLocation loc)
Construct a label type proxy for the given location. |
CcLockInfo |
CcLockInfo()
Construct an empty CcLockInfo object for using as a property to set on a CcVobResource. |
CcProject |
ccProject(StpLocation location)
Create a proxy for a ClearCase UCM project. |
CcProjectFolder |
ccProjectFolder(StpLocation location)
Create a proxy for a ClearCase UCM project folder. |
CcRegistryRegion |
ccRegistryRegion(StpLocation loc)
Construct a registry region proxy for the given location. |
CcReplica |
ccReplica(StpLocation loc)
Construct a replica proxy for the given location. |
CcStorageLocation |
ccStorageLocation(StpLocation loc)
Construct a storage location proxy for the given location. |
CcStream |
ccStream(StpLocation location)
Create a proxy for a ClearCase UCM stream. |
CcSymlink |
ccSymlink(StpLocation loc)
Construct a symbolic link proxy for the given location. |
CcTask |
ccTask(StpLocation loc)
Construct a reference to a task. |
CcTask |
ccTask(String uri)
Deprecated. |
CcTriggerType |
ccTriggerType(StpLocation loc)
Construct a trigger type proxy for the given location. |
CcVersion |
ccVersion(StpLocation loc)
Construct a version proxy for the given location. |
CcView |
ccView(StpLocation loc)
Construct a view proxy for the given location. |
CcViewTag |
ccViewTag(StpLocation loc)
Construct a view tag proxy for the given location. |
CcVob |
ccVob(StpLocation loc)
Construct a VOB proxy for the given location. |
CcVobTag |
ccVobTag(StpLocation loc)
Construct a VOB tag proxy for the given location. |
CcRegistryRegion |
doGetDefaultCcRegistryRegion(PropertyRequestItem.PropertyRequest wantedProps)
Get the server's default ClearCase registry region. |
CcView.TextMode |
doGetDefaultViewTextMode()
Get the default text mode for web views. |
String |
doGetServerVersionString()
|
void |
doLogout()
Performs a server logout and invalidates this provider's current session. |
ResourceList<CcView> |
getClientViewList(PropertyRequestItem.PropertyRequest wantedProps)
Get the list of views that are accessible on the local machine. |
CcMergeHandlingCallback.CheckinMergeHandling |
handleManualMerge(CcFile file,
CcVersion fromVersion,
CcVersion toVersion)
Handle the manual merge using the provider's callback. |
boolean |
isLocalProvider()
Is this a local provider, as opposed to a network provider? |
boolean |
isMVFSInstalledLocally()
Is ClearCase with MVFS version 8.0.0.0 or greater installed on this client? |
CcFileAreaLockedCallback |
registerCcFileAreaLockedCallback(CcFileAreaLockedCallback callback)
Register a callback to handle a FileAreaLockedException. |
void |
registerClearPromptCallback(CcClearPromptCallback callback)
Register a callback to process ClearPrompt interaction requests. |
CqRecordAutoTransitionCallback |
registerCqRecordAutoTransitionCallback(CqRecordAutoTransitionCallback callback)
Register a callback to handle state transitions of ClearQuest records. |
CcMergeHandlingCallback |
registerMergeHandlingCallback(CcMergeHandlingCallback callback)
Register a callback to handling manual merges. |
CcProviderManagerCallback |
registerProviderManagerCallback(CcProviderManagerCallback callback)
Register a provider manager callback. |
void |
registerTrustManagerCallback(CcTrustManagerCallback callback)
Register a callback to handle SSL certificate conflicts. |
Methods inherited from interface javax.wvcm.WorkspaceProvider |
---|
activity, baseline, component, configuration, controllableFolder, controllableResource, controllableSymbolicLink, folderVersion, stream, task, version, versionHistory, workspace |
Methods inherited from interface javax.wvcm.Provider |
---|
buildProxy, folder, initArgs, initialize, location, relativeRootLocation, resource, resourceList, rootLocation |
Field Detail |
---|
static final String LOCAL_PROVIDER_CLASS
The name of a CcProvider class whose instances support direct acess to ClearCase installed on the local machine. Use this "local provider" to work with ClearCase dynamic views on the local machine.
Pass this name to ProviderFactory.createProvider()
and cast
the resulting Provider
instance to CcProvider
to access ClearCase-specific methods:
CcProvider provider = (CcProvider) ProviderFactory.createProvider( CcProvider.LOCAL_PROVIDER_CLASS, ...);
ProviderFactory.createProvider(String, javax.wvcm.ProviderFactory.Callback)
,
Constant Field Valuesstatic final String NETWORK_PROVIDER_CLASS
The name of a CcProvider class whose instances support ClearCase access via an HTTP connection to a remote CCRC WAN server. Use this "network provider" to work with ClearCase web views hosted on a particular server.
Pass this name to ProviderFactory.createProvider()
and cast
the resulting Provider
instance to CcProvider
to access ClearCase-specific methods:
CcProvider provider = (CcProvider) ProviderFactory.createProvider( CcProvider.NETWORK_PROVIDER_CLASS, ...);
ProviderFactory.createProvider(String, javax.wvcm.ProviderFactory.Callback)
,
Constant Field ValuesMethod Detail |
---|
CcActivity ccActivity(StpLocation location)
location
- Location for UCM activity.
CcAttributeType ccAttributeType(StpLocation loc)
loc
- the location of the attribute type.
CcBaseline ccBaseline(StpLocation location)
location
- Location for UCM baseline.
CcBranch ccBranch(StpLocation location)
location
- Location for branch.
CcBranchType ccBranchType(StpLocation loc)
loc
- the location of the branch type.
CcComponent ccComponent(StpLocation location)
location
- Location for UCM component.
CcDirectory ccDirectory(StpLocation loc)
loc
- the location of the directory
CcDirectoryVersion ccDirectoryVersion(StpLocation loc)
loc
- the location of the directory version.
CcElement ccElement(StpLocation loc)
loc
- the location of the element.
CcElementType ccElementType(StpLocation loc)
loc
- the location of the element type.
CcFile ccFile(StpLocation loc)
loc
- the location of the file.
CcHyperlinkType ccHyperlinkType(StpLocation loc)
loc
- the location of the hyperlink type.
CcLabelType ccLabelType(StpLocation loc)
loc
- the location of the label type.
CcLockInfo CcLockInfo()
CcProject ccProject(StpLocation location)
location
- Location for UCM project.
CcProjectFolder ccProjectFolder(StpLocation location)
location
- Location for UCM project folder.
CcRegistryRegion ccRegistryRegion(StpLocation loc)
loc
- the location of the registry region
CcReplica ccReplica(StpLocation loc)
loc
- the location of the replica.
CcStorageLocation ccStorageLocation(StpLocation loc)
loc
- the location of the storage location.
CcStream ccStream(StpLocation location)
location
- Location for UCM stream.
CcSymlink ccSymlink(StpLocation loc)
loc
- the location of the symbolic link.
CcTask ccTask(StpLocation loc)
loc
- the location of the task
@Deprecated CcTask ccTask(String uri)
uri
- Full URI of the task.
CcTriggerType ccTriggerType(StpLocation loc)
loc
- the location of the trigger type.
CcVersion ccVersion(StpLocation loc)
loc
- the location of the version.
CcView ccView(StpLocation loc)
loc
- the location of the view.
CcViewTag ccViewTag(StpLocation loc)
loc
- the location of the view tag.
CcVob ccVob(StpLocation loc)
loc
- the location of the VOB.
CcVobTag ccVobTag(StpLocation loc)
loc
- the location of the VOB tag.
CcRegistryRegion doGetDefaultCcRegistryRegion(PropertyRequestItem.PropertyRequest wantedProps) throws WvcmException
wantedProps
- list of properties to be returned with registry region proxy
WvcmException
CcView.TextMode doGetDefaultViewTextMode() throws WvcmException
Get the default text mode for web views. This depends on two pieces of information: the CCRC WAN server's default VOB line termination setting and the client OS. It is defined as follows:
server default VOB line term | client OS | web view default text mode | LF (UNIX) | UNIX | CcView.TextMode.TRANSPARENT |
---|---|---|
LF (UNIX) | Windows | CcView.TextMode.INSERT_CR |
CR-LF (MSDOS) | UNIX | CcView.TextMode.STRIP_CR |
CR-LF (MSDOS) | Windows | CcView.TextMode.TRANSPARENT |
No default set | Both UNIX and Windows | CcView.TextMode.TRANSPARENT |
WvcmException
String doGetServerVersionString() throws WvcmException
WvcmException
void doLogout() throws WvcmException
WvcmException
ResourceList<CcView> getClientViewList(PropertyRequestItem.PropertyRequest wantedProps) throws WvcmException
If the caller has registered a ProviderMangerCallback on this provider, that callback will be invoked for each view. Because these views may be hosted on different CCRC WAN servers, this gives the caller an opportunity to specify which provider should be used for each view.
wantedProps
- list of properties to retrieve for each view proxy.
WvcmException
CcProviderManagerCallback
,
registerProviderManagerCallback(CcProviderManagerCallback)
CcMergeHandlingCallback.CheckinMergeHandling handleManualMerge(CcFile file, CcVersion fromVersion, CcVersion toVersion) throws WvcmException
WvcmException
boolean isLocalProvider()
LOCAL_PROVIDER_CLASS
,
NETWORK_PROVIDER_CLASS
boolean isMVFSInstalledLocally()
CcFileAreaLockedCallback registerCcFileAreaLockedCallback(CcFileAreaLockedCallback callback) throws WvcmException
callback
- The new callback
WvcmException
void registerClearPromptCallback(CcClearPromptCallback callback)
callback
- callbackCqRecordAutoTransitionCallback registerCqRecordAutoTransitionCallback(CqRecordAutoTransitionCallback callback) throws WvcmException
callback
- the callback we're registering
WvcmException
CcMergeHandlingCallback registerMergeHandlingCallback(CcMergeHandlingCallback callback) throws WvcmException
callback
- The new callback
WvcmException
CcProviderManagerCallback registerProviderManagerCallback(CcProviderManagerCallback callback)
Various CM API operations invoke this callback in situations where a new
provider may be required to complete an operation. For instance, if you
have local web views hosted on different CCRC WAN servers, the
getClientViewList(javax.wvcm.PropertyRequestItem.PropertyRequest)
method will invoke this callback for each view
to allow your application to associate the correct provider for that view.
Various ClearQuest/UCM Integration operations may also invoke this callback to obtain a ClearQuest provider (CqProvider) instance.
The CM API uses a default implementation of this callback if the caller does not register another one.
This callback is shared among all CcProvider instances, so it only needs to be set once.
callback
- callback
getClientViewList(javax.wvcm.PropertyRequestItem.PropertyRequest)
void registerTrustManagerCallback(CcTrustManagerCallback callback) throws WvcmException
This callback is shared among all CcProvider instances, so it only needs to be set once.
callback
- Trust Manager callback to handle certificate
WvcmException
|
Generated Wed 28-Nov-2012 10:22 AM | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |