Package org.eclipse.emf.cdo.util
Class CDOURIData
- java.lang.Object
- 
- org.eclipse.emf.cdo.util.CDOURIData
 
- 
 public final class CDOURIData extends java.lang.ObjectRepresents a CDO-specificURIin connection-aware format.CDO URIs are in one of two different formats, either canonical or connection-aware. The connection-aware format is: cdo.net4j. ConnectorType :// [User [: Password] @] ConnectorSpecificAuthority / RepositoryName / ResourcePath [? Param=Value (& Param=Value)*] The non-terminals being:- ConnectorType: one of tcp | ssl | jvm | http
- User/Password: to be provided if the repository is configured with an
 IUserManagerand, hence, triggers authentication on the client. Note: the password may be stored in resources in clear text!
- ConnectorSpecificAuthority: examples are
 - Host [: Port] (if ConnectorType is tcp)
- AcceptorName (if ConnectorType is jvm)
 
- RepositoryName: the nameof the repository (not theUUID!).
- ResourcePath: the full path of the resourcewithin the repository, segments separated by slashes, no leading slash.
- Param: one of the following
 - branch: the value must be a branch path, the full path of the branch in the branch tree, segments separated by slashes, no leading slash, defaults to MAIN.
- time: the value must be the time at which the resource is supposed to be valid, parseable by SimpleDateFormat. The special value HEAD indicates a floating view/transaction that always shows the latest state in the chosen branch, the default if no Time parameter is specified.
- transactional: a boolean value. The value true forces a the resource to be opened in a transaction rather than in a read-only view. This can not be combined with a Time other than HEAD.
- prefetch: a boolean value. The value true attempts to load all objects contained by the resource in a single server-round trip and cache the results.
 
- branch: the value must be a 
 Note: With the current design and implementation of connection-aware URI (mainly CDONet4jViewProvider) it is still unclear when and how the allocated "resources" (aka IConnector, CDOSession, CDOView, etc) are supposed to be freed! For a description of the canonical URI format refer to CDOURIUtil.- Since:
- 4.0
- Author:
- Eike Stepper
 
- 
- 
Field SummaryFields Modifier and Type Field Description static java.lang.StringBRANCH_PARAMETERstatic java.lang.StringTIME_PARAMETERstatic java.lang.StringTRANSACTIONAL_PARAMETERstatic java.lang.StringVIEW_ID_PARAMETER
 - 
Constructor SummaryConstructors Constructor Description CDOURIData()CDOURIData(java.lang.String uri)CDOURIData(org.eclipse.emf.common.util.URI uri)
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.StringgetAuthority()IPathgetBranchPath()java.util.Map<java.lang.String,java.lang.String>getExtraParameters()java.lang.StringgetPassWord()java.lang.StringgetRepositoryName()IPathgetResourcePath()java.lang.StringgetScheme()longgetTimeStamp()java.lang.StringgetUserName()java.lang.StringgetViewID()booleanisTransactional()voidsetAuthority(java.lang.String authority)voidsetBranchPath(IPath branchPath)voidsetExtraParameters(java.util.Map<java.lang.String,java.lang.String> extraParameters)voidsetPassWord(java.lang.String passWord)voidsetRepositoryName(java.lang.String repositoryName)voidsetResourcePath(IPath resourcePath)voidsetScheme(java.lang.String scheme)voidsetTimeStamp(long timeStamp)voidsetTransactional(boolean transactional)voidsetUserName(java.lang.String userName)voidsetViewID(java.lang.String viewID)java.lang.StringtoString()org.eclipse.emf.common.util.URItoURI()
 
- 
- 
- 
Field Detail- 
BRANCH_PARAMETERpublic static final java.lang.String BRANCH_PARAMETER - See Also:
- Constant Field Values
 
 - 
TIME_PARAMETERpublic static final java.lang.String TIME_PARAMETER - See Also:
- Constant Field Values
 
 - 
VIEW_ID_PARAMETERpublic static final java.lang.String VIEW_ID_PARAMETER - Since:
- 4.1
- See Also:
- Constant Field Values
 
 - 
TRANSACTIONAL_PARAMETERpublic static final java.lang.String TRANSACTIONAL_PARAMETER - See Also:
- Constant Field Values
 
 
- 
 - 
Constructor Detail- 
CDOURIDatapublic CDOURIData() 
 - 
CDOURIDatapublic CDOURIData(java.lang.String uri) throws InvalidURIException- Throws:
- InvalidURIException
 
 - 
CDOURIDatapublic CDOURIData(org.eclipse.emf.common.util.URI uri) throws InvalidURIException- Throws:
- InvalidURIException
 
 
- 
 - 
Method Detail- 
getSchemepublic java.lang.String getScheme() 
 - 
setSchemepublic void setScheme(java.lang.String scheme) 
 - 
getUserNamepublic java.lang.String getUserName() 
 - 
setUserNamepublic void setUserName(java.lang.String userName) 
 - 
getPassWordpublic java.lang.String getPassWord() 
 - 
setPassWordpublic void setPassWord(java.lang.String passWord) 
 - 
getAuthoritypublic java.lang.String getAuthority() 
 - 
setAuthoritypublic void setAuthority(java.lang.String authority) 
 - 
getRepositoryNamepublic java.lang.String getRepositoryName() 
 - 
setRepositoryNamepublic void setRepositoryName(java.lang.String repositoryName) 
 - 
getResourcePathpublic IPath getResourcePath() 
 - 
setResourcePathpublic void setResourcePath(IPath resourcePath) 
 - 
getBranchPathpublic IPath getBranchPath() 
 - 
setBranchPathpublic void setBranchPath(IPath branchPath) 
 - 
getTimeStamppublic long getTimeStamp() 
 - 
setTimeStamppublic void setTimeStamp(long timeStamp) 
 - 
getViewIDpublic java.lang.String getViewID() - Since:
- 4.1
 
 - 
setViewIDpublic void setViewID(java.lang.String viewID) - Since:
- 4.1
 
 - 
isTransactionalpublic boolean isTransactional() 
 - 
setTransactionalpublic void setTransactional(boolean transactional) 
 - 
getExtraParameterspublic java.util.Map<java.lang.String,java.lang.String> getExtraParameters() - Since:
- 4.1
 
 - 
setExtraParameterspublic void setExtraParameters(java.util.Map<java.lang.String,java.lang.String> extraParameters) - Since:
- 4.4
 
 - 
toURIpublic org.eclipse.emf.common.util.URI toURI() 
 - 
toStringpublic java.lang.String toString() - Overrides:
- toStringin class- java.lang.Object
 
 
- 
 
-