|
Project: stp | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CcProvider
A ClearCase-specific extension of the javax.wvcm.Provider interface.
The CcProvider interface contains factory methods for constructing proxies for various ClearCase-specific resources. Note that there are many resource types where a ClearCase-specific interface exists for a standard WVCM interface. For instance, CcFile is the ClearCase specialization of javax.wvcm.ControllableResource.
The CcProvider interface also contains methods for listing client-side
and server-side ClearCase resources:
getClientViewList(javax.wvcm.PropertyRequestItem.PropertyRequest)
lists the web views
available on the local machine
doGetDefaultCcRegistryRegion(javax.wvcm.PropertyRequestItem.PropertyRequest)
gets the default
ClearCase registry region, which in turn has properties representing the
ClearCase VOBs and views in that region.
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 |
CC_ONLY_PROVIDER_CLASS
The name of a CcProvider class whose instances provide only support for ClearCase via a 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. |
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. |
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()
|
ResourceList<CcView> |
getClientViewList(PropertyRequestItem.PropertyRequest wantedProps)
Get the list of web views belonging to the current user, and whose file areas reside on the local machine. |
CcMergeHandlingCallback.CheckinMergeHandling |
handleManualMerge(CcFile file,
CcVersion fromVersion,
CcVersion toVersion)
Handle the manual merge using the provider's callback. |
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. |
Methods inherited from interface javax.wvcm.Provider |
---|
buildProxy, folder, initArgs, initialize, location, relativeRootLocation, resource, resourceList, rootLocation |
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 CC_ONLY_PROVIDER_CLASS
Method 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.
CcStream ccStream(StpLocation location)
location
- Location for UCM stream.
CcSymlink ccSymlink(StpLocation loc)
loc
- the location of the symbolic link.
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 CcExServer.DEFAULT_VOB_LINE_TERM
property
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
ResourceList<CcView> getClientViewList(PropertyRequestItem.PropertyRequest wantedProps) throws WvcmException
wantedProps
- list of properties to retrieve for each web view
proxy.
WvcmException
CcMergeHandlingCallback.CheckinMergeHandling handleManualMerge(CcFile file, CcVersion fromVersion, CcVersion toVersion) throws WvcmException
WvcmException
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
|
Generated Tue 17-Jun-2014 01:15 AM | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |