Project: stp

com.ibm.rational.wvcm.stp.cc
Interface CcProvider

All Superinterfaces:
Provider, StpProvider, WorkspaceProvider

public interface CcProvider
extends StpProvider, WorkspaceProvider

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 com.ibm.rational.wvcm.stp.StpProvider
    buildAccessControlEntry, buildProxy, buildProxy, callback, ccProvider, cqProvider, decodeSegment, encodeSegment, filePathLocation, filePathLocation, getAuthentication, getDefaultDomain, getDefaultRepository, getDefaultRepository, getHttpProxyHost, getHttpProxyPort, getInstantiationErrors, getIsDisconnected, getPropertyValueClass, getServerUrl, getUserLocale, getUserTimeZone, isSupported, pathLocation, proxyType, raise, raise, raise, setAuthentication, setDefaultDomain, setDefaultRepository, setDefaultRepository, setHttpProxy, setIsDisconnected, setServerUrl, setUserLocale, setUserTimeZone, stableSelector, stpLocation, stpLocation, stpProductInfo, stpProvider, stpRepository, terminate, userFriendlySelector
     
    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

    CC_ONLY_PROVIDER_CLASS

    static final String CC_ONLY_PROVIDER_CLASS
    The name of a CcProvider class whose instances provide only support for ClearCase via a server. Pass this name to ProviderFactory.createProvider to obtain an object that implements just this interface.

    See Also:
    Constant Field Values
    Method Detail

    ccActivity

    CcActivity ccActivity(StpLocation location)
    Create a proxy for a ClearCase UCM activity.

    Parameters:
    location - Location for UCM activity.
    Returns:
    UCM activity proxy.

    ccAttributeType

    CcAttributeType ccAttributeType(StpLocation loc)
    Construct a attribute type proxy for the given location.

    Parameters:
    loc - the location of the attribute type.
    Returns:
    a new proxy for a attribute type at this Location.

    ccBaseline

    CcBaseline ccBaseline(StpLocation location)
    Create a proxy for a ClearCase UCM baseline.

    Parameters:
    location - Location for UCM baseline.
    Returns:
    UCM baseline proxy.

    ccBranch

    CcBranch ccBranch(StpLocation location)
    Create a proxy for a ClearCase branch.

    Parameters:
    location - Location for branch.
    Returns:
    branch proxy.

    ccBranchType

    CcBranchType ccBranchType(StpLocation loc)
    Construct a branch type proxy for the given location.

    Parameters:
    loc - the location of the branch type.
    Returns:
    a new proxy for a branch type at this Location.

    ccComponent

    CcComponent ccComponent(StpLocation location)
    Create a proxy for a ClearCase UCM component.

    Parameters:
    location - Location for UCM component.
    Returns:
    UCM component proxy.

    ccDirectory

    CcDirectory ccDirectory(StpLocation loc)
    Construct a proxy for the CcDirectory (directory in a ClearCase view) specified by the given location.

    Parameters:
    loc - the location of the directory
    Returns:
    a new CcDirectory proxy for a directory at this Location.

    ccDirectoryVersion

    CcDirectoryVersion ccDirectoryVersion(StpLocation loc)
    Construct a directory version proxy for the given location.

    Parameters:
    loc - the location of the directory version.
    Returns:
    a new proxy for a directory version at this Location.

    ccElement

    CcElement ccElement(StpLocation loc)
    Construct a element proxy for the given location.

    Parameters:
    loc - the location of the element.
    Returns:
    a new proxy for a element at this Location.

    ccElementType

    CcElementType ccElementType(StpLocation loc)
    Construct a element type proxy for the given location.

    Parameters:
    loc - the location of the element type.
    Returns:
    a new proxy for a element type at this Location.

    ccFile

    CcFile ccFile(StpLocation loc)
    Construct a proxy for the CcFile (file in a ClearCase view) specified by the given location.

    Parameters:
    loc - the location of the file.
    Returns:
    a new CcFile proxy for a file at this Location.

    ccHyperlinkType

    CcHyperlinkType ccHyperlinkType(StpLocation loc)
    Construct a hyperlink type proxy for the given location.

    Parameters:
    loc - the location of the hyperlink type.
    Returns:
    a new proxy for a hyperlink type at this Location.

    ccLabelType

    CcLabelType ccLabelType(StpLocation loc)
    Construct a label type proxy for the given location.

    Parameters:
    loc - the location of the label type.
    Returns:
    a new proxy for a label type at this Location.

    CcLockInfo

    CcLockInfo CcLockInfo()
    Construct an empty CcLockInfo object for using as a property to set on a CcVobResource.

    Returns:
    a new lock information object

    ccProject

    CcProject ccProject(StpLocation location)
    Create a proxy for a ClearCase UCM project.

    Parameters:
    location - Location for UCM project.
    Returns:
    UCM project proxy.

    ccProjectFolder

    CcProjectFolder ccProjectFolder(StpLocation location)
    Create a proxy for a ClearCase UCM project folder.

    Parameters:
    location - Location for UCM project folder.
    Returns:
    UCM project folder proxy.

    ccRegistryRegion

    CcRegistryRegion ccRegistryRegion(StpLocation loc)
    Construct a registry region proxy for the given location.

    Parameters:
    loc - the location of the registry region
    Returns:
    a new proxy for the registry region at this location

    ccReplica

    CcReplica ccReplica(StpLocation loc)
    Construct a replica proxy for the given location.

    Parameters:
    loc - the location of the replica.
    Returns:
    a new proxy for a replica at this Location.

    ccStream

    CcStream ccStream(StpLocation location)
    Create a proxy for a ClearCase UCM stream.

    Parameters:
    location - Location for UCM stream.
    Returns:
    UCM stream proxy.

    ccSymlink

    CcSymlink ccSymlink(StpLocation loc)
    Construct a symbolic link proxy for the given location.

    Parameters:
    loc - the location of the symbolic link.
    Returns:
    a new proxy for a symbolic link at this Location.

    ccTriggerType

    CcTriggerType ccTriggerType(StpLocation loc)
    Construct a trigger type proxy for the given location.

    Parameters:
    loc - the location of the trigger type.
    Returns:
    a new proxy for a trigger type at this Location.

    ccVersion

    CcVersion ccVersion(StpLocation loc)
    Construct a version proxy for the given location.

    Parameters:
    loc - the location of the version.
    Returns:
    a new proxy for a version at this Location.

    ccView

    CcView ccView(StpLocation loc)
    Construct a view proxy for the given location.

    Parameters:
    loc - the location of the view.
    Returns:
    a new proxy for a view at this Location.

    ccViewTag

    CcViewTag ccViewTag(StpLocation loc)
    Construct a view tag proxy for the given location.

    Parameters:
    loc - the location of the view tag.
    Returns:
    a new proxy for a view tag at this Location.

    ccVob

    CcVob ccVob(StpLocation loc)
    Construct a VOB proxy for the given location.

    Parameters:
    loc - the location of the VOB.
    Returns:
    a new proxy for a VOB at this Location.

    ccVobTag

    CcVobTag ccVobTag(StpLocation loc)
    Construct a VOB tag proxy for the given location.

    Parameters:
    loc - the location of the VOB tag.
    Returns:
    a new proxy for a VOB tag at this Location.

    doGetDefaultCcRegistryRegion

    CcRegistryRegion doGetDefaultCcRegistryRegion(PropertyRequestItem.PropertyRequest wantedProps)
                                                  throws WvcmException
    Get the server's default ClearCase registry region.

    Parameters:
    wantedProps - list of properties to be returned with registry region proxy
    Returns:
    proxy for server's default registry region.
    Throws:
    WvcmException

    doGetDefaultViewTextMode

    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

    Returns:
    enumeration representing the view's default text mode
    Throws:
    WvcmException

    doGetServerVersionString

    String doGetServerVersionString()
                                    throws WvcmException
    Returns:
    server's version, as a string.
    Throws:
    WvcmException

    getClientViewList

    ResourceList<CcView> getClientViewList(PropertyRequestItem.PropertyRequest wantedProps)
                                           throws WvcmException
    Get the list of web views belonging to the current user, and whose file areas reside on the local machine.

    Parameters:
    wantedProps - list of properties to retrieve for each web view proxy.
    Returns:
    list of local web views as a list of CcView proxies
    Throws:
    WvcmException

    handleManualMerge

    CcMergeHandlingCallback.CheckinMergeHandling handleManualMerge(CcFile file,
                                                                   CcVersion fromVersion,
                                                                   CcVersion toVersion)
                                                                   throws WvcmException
    Handle the manual merge using the provider's callback.

    Returns:
    CheckinMergeHandling specifying how the checkin is to be handled after the merge
    Throws:
    WvcmException

    registerCcFileAreaLockedCallback

    CcFileAreaLockedCallback registerCcFileAreaLockedCallback(CcFileAreaLockedCallback callback)
                                                              throws WvcmException
    Register a callback to handle a FileAreaLockedException.

    Parameters:
    callback - The new callback
    Returns:
    The previous callback
    Throws:
    WvcmException

    registerClearPromptCallback

    void registerClearPromptCallback(CcClearPromptCallback callback)
    Register a callback to process ClearPrompt interaction requests.

    Parameters:
    callback - callback

    registerCqRecordAutoTransitionCallback

    CqRecordAutoTransitionCallback registerCqRecordAutoTransitionCallback(CqRecordAutoTransitionCallback callback)
                                                                          throws WvcmException
    Register a callback to handle state transitions of ClearQuest records. The callback is invoked if the transition involves required fields that the user needs to provide.

    Parameters:
    callback - the callback we're registering
    Returns:
    the previous registered callback
    Throws:
    WvcmException

    registerMergeHandlingCallback

    CcMergeHandlingCallback registerMergeHandlingCallback(CcMergeHandlingCallback callback)
                                                          throws WvcmException
    Register a callback to handling manual merges.

    Parameters:
    callback - The new callback
    Returns:
    The previous callback
    Throws:
    WvcmException

    Generated Wed 16-Apr-2014 05:20 PM

    Copyright © IBM 2014. All rights reserved.