| Oracle Repository API and Model Reference Guide |
java.lang.Object
|
+--oracle.repos.services.data.DataEventSource
|
+--oracle.repos.services.connection.RepositoryConnection
This is the interface used by clients to manipulate the contents of a structured repository. Once a RepositoryConnection has been connected to a repository instance the client can perform data manipulation, workarea, version, naming and dependency related operations through API service objects obtained within the context of the RepositoryConnection objects
WorkareaService, NamingService, DependencyService,
VersionService| Inner Class Summary | |
static interface |
RepositoryConnection.ConnectionMode |
static interface |
RepositoryConnection.ConnectionState |
static interface |
RepositoryConnection.iStaticStrings |
static interface |
RepositoryConnection.MetaDataLoad |
static interface |
RepositoryConnection.ValidationScope |
| Field Summary | |
protected
MetaDataElement |
m_containingConnection |
Connection |
m_sqlConnection |
| Constructor Summary | |
protected |
RepositoryConnection() |
RepositoryConnection(Connection connection)
Create a new RepositoryConnection, based on an existing JDBC connection. |
|
RepositoryConnection(RepositoryConnectDetails connect)
Create a new RepositoryConnection, creating a new JDBC connection to a database. |
|
RepositoryConnection(String strConnect)
Create a new RepositoryConnection, creating a new JDBC connection to a database with the specified username, password and Net8 service alias. |
|
RepositoryConnection(String strUser,
String strPass, String strNet8) Create a new RepositoryConnection, creating a new JDBC connection to a database with the specified username, password and Net8 service alias. |
|
| Method Summary | |
int |
abortActivity() |
(package private)
void |
addDiagramToSession(RepositoryDiagram deDiag)
remember the diagram used during this connection |
void |
addElementToWorkareasPrivateConfiguration(DataElement de)
addElementToWorkareasPrivateConfiguration |
void |
addExchangeException(Exception e)
During nested calls to doElementDataExchange(), subclass implementations of DataElement may trap explicit exceptions, typically property type, name or range exceptions, and store them against the RepositoryConnection for examination at the end of the load or save operation using getExchangeExceptions. |
void |
addRepositoryListener(RepositoryListener repositoryListener,
int nOperationMask, Vector vecMetaElements) Adds a repository listener to this repository service. |
(package private)
int |
cacheStatement(String strQuery,
PreparedStatement stmt) Change the prepared statement with the SQL statement as a key. |
protected void |
checkCompatibleServer() Checks server compatiblility by comparing server version with the connection's compatible version numbers. |
protected int |
checkValidUser() |
void |
clearMode(int nMode) |
Object |
clone() Clones the object. |
void |
close() Closes this repository connection. |
int |
closeActivity() |
void |
compileWorkarea(oracle.repos.services.GID workareaId)
|
RepositoryDiagram |
createDiagram(DataElement deDiagram)
creates a diagram |
RepositoryDiagram |
createDiagram(String name,
String diagramType, boolean bWriteThrough) |
void |
doPostConnectActions() Requests connection to perform post connect actions. |
Enumeration |
enumerateMetaDataElements()
Returns an enumeration of the MetaDataElements cached in this Connection. |
(package private)
RepositoryDiagram |
findDiagramInSession(RID ridDiag) find the diagram used during this connection |
(package private)
RepositoryDiagram |
findDiagramInSession(String strDiagramName)
|
IdentifiedItem |
getActiveApplicationSystem()
|
IdentifiedItem |
getActiveWorkArea() |
(package private)
PreparedStatement |
getCachedStatement(int nStatementId)
Get the cached statement by ID (int) |
(package private)
PreparedStatement |
getCachedStatement(String strQuery)
Get the cached statement by SQL statement (String) |
String[] |
getCompatibleVersionNumbers()
|
ConfigurationService |
getConfigurationService()
Returns a ConfigurationService object for performing configuration operations on the current repository |
RepositoryConnectDetails |
getConnectDetails() Returns the a class describing the connection. |
Connection |
getConnection() Returns the underlying JDBC connection for this RepositoryConnection. |
int |
getConnectionState() Returns the unique identifier of this repository instance. |
String |
getConnectString() Returns the complete connect string for the connection |
oracle.repos.services.GID |
getCurrentActivityId() Get ID of current activity. |
oracle.repos.services.GID |
getCurrentActivityParentId()
Get ID of current activity's parent. |
int |
getDataElementLoadMode() Get mode of loading data elements Dictates how Data Elements are loaded from database |
int |
getDefaultRowPrefetch() |
DependencyService |
getDependencyService() Returns a NamingService object for performing dependency-specific operations on the current repository |
RepositoryDiagram |
getDiagram(RID id) retrieve a diagram from the repository by its id |
RepositoryDiagram |
getDiagram(String strName)
retrieve a diagram from the repository by its name |
Vector |
getDiagrams(String strDiagType)
returns diagrams of strDiagType. |
Vector |
getDiagrams(String[] arrstrDiagType)
returns diagrams of types defined by arrstrDiagType. |
DataEventSource |
getDynamicContainer() Implemented by DataEventSource subtypes - dynamic the static container (if any) |
DataElement |
getElement(RID ridId) |
String |
getFullPath(oracle.repos.services.GID id, String formatType,
char fileSep) |
String |
getFullPath(oracle.repos.services.GID id, String formatType,
char fileSep, String containerSep) getFullPath |
String |
getFullPathByIVID(oracle.repos.services.GID ivid, String formatType,
char fileSep) |
oracle.repos.services.GID |
getLastContainerID() |
Vector |
getLoadedDiagrams() return the diagram used during this connection |
int |
getMaximumPatchMilestoneNumber()
Gets the highest patch milestone number installed on server. |
int |
getMaximumPatchNumber() Gets the highest patch number installed on server. |
MetaDataElement |
getMetaDataElement(oracle.repos.services.GID gidTypeId) |
MetaDataElement |
getMetaDataElement(MetaDataElementDescriptor descMDE)
Get meta data element from cache or load from database if not in cache |
MetaDataElement |
getMetaDataElement(String strTypeName)
Get meta data element from cache or load from database if not in cache |
MetaDataElement |
getMetaDataElement(String strProductName,
String strTypeName) |
MetaDataElement |
getMetaDataElement(String strProduct,
String strType, int nPrimaryProperty) |
MetaDataElementList |
getMetaDataElements(
MetaDataElementDescriptorList lisMdeDesc, boolean bDefer,
boolean bAddToSession) |
int |
getMetaDataLoadMode() Get mode of loading meta data Dictates how Meta data is loaded from database |
MetaDataService |
getMetaDataService() Returns a MetaDataService object for retrieving meta data information |
int |
getMode() |
NamingService |
getNamingService() Returns a NamingService object for performing naming-specific operations on the current repository |
oracle.repos.services.GID |
getNewIdValue() |
RID |
getNewRID() |
int |
getNumberOfOpenActivities()
|
String |
getOwningUserName() |
PatchService |
getPatchService() Returns a PatchService object for performing patch-specific operations on the current repository |
String |
getRepositoryBroadcastNotifier()
Get Broadcast notifier of repository |
String |
getRepositoryUUID() Get UUID of repository |
DeliverableVersion |
getRepositoryVersion() getRepositoryVersion returns a DeliverableVersion of the Repository |
RID |
getRIDFromFullPath(String strFullPath,
char chSeparator) Returns the RID of an element from its full path |
int |
getState() |
DataEventSource |
getStaticContainer() Implemented by DataEventSource subtypes - returns the static container (if any) |
TransactionService |
getTransactionService() Returns a TransactionService object for performing transaction operations on the current repository |
String |
getUID() Get Repository Unique ID. |
int |
getValidationPolicy() Returns the validation policy mask for this DataSet. |
String |
getValueFromRMInfo(String strName)
RM$INFO holds named value pairs for details of current repository. |
VersionService |
getVersionService() Returns a VersionService object for performing version-specific operations on the current repository |
WorkareaService |
getWorkareaService() Returns a WorkareaService object for performing workarea-specific operations on the current repository. |
boolean |
isDesignerRepository() isDesignerRepository returns a true or false Is Legacy Repository |
(package private)
boolean |
isDiagramInSession(RID ridDiag) is diagram used during this connection |
boolean |
isInMode(int nMode) |
boolean |
isOPSLogin() |
boolean |
isOracleRepository() isOracleRepository returns a true or false Is new Oracle Repository |
protected boolean |
isRepositoryUser() |
boolean |
isVersioningSupported() return true is repoistory supports versioning. |
boolean |
isWorkAreaNull() |
MetaDataElementList |
loadAllMetaDataElements(boolean bDefer,
boolean bAddToSession) |
MetaDataElementList |
loadMetaDataElements(MetaDataElementDescriptorList lisMdeDesc,
boolean bDefer, boolean bAddToSession) |
MetaDataElementList |
loadMetaDataElements(String strProductName,
MetaDataElementDescriptorList lisMdeDesc, boolean bDefer,
boolean bAddToSession) |
Vector |
loadPatches() loadPatches return a Vector of Strings of installed patches on the Repository |
Vector |
loadServerDeliverableVersions()
|
void |
onCWLogSettingsChange() Called by CWLog just after it has changed any aspect of its configuration. |
int |
openActivity() |
AccessRights |
queryAccessRights(DataElement de)
|
AccessRights |
queryAccessRights(DataElement de,
String strGrantee) |
AccessRights |
queryAccessRights(oracle.repos.services.GID containerIRID) |
AccessRights |
queryAccessRights(oracle.repos.services.GID containerIRID,
String strGrantee) |
MetaDataElement |
queryPACType(RID ridId) |
oracle.repos.services.GID |
queryPACTypeId(RID ridId) |
(package private)
int |
readText(oracle.repos.services.GID eid, String txt_type,
String buf, boolean trusted) |
void |
registerMetaElementAPI(String strClassName)
Registers a MetaElementAPI implementation to manipulate a named meta-data type. |
void |
removeDiagramFromSession(RepositoryDiagram repDiag)
remove the diagram from this session |
void |
removeRepositoryListener(RepositoryListener repositoryListener)
Removes the specified RepositoryListener from the set being notified by this RepositoryConnection |
void |
saveDiagram(RepositoryDiagram repDiag,
DataElementDescriptorList lisElements) |
void |
setActiveApplicationSystem(IdentifiedItem appsys)
|
void |
setActiveApplicationSystem(String strName,
RID id) |
void |
setActiveAppSys(oracle.repos.services.GID gidIRID) |
void |
setActiveWorkArea(IdentifiedItem wkArea)
|
void |
setActiveWorkArea(String strName)
|
void |
setActiveWorkArea(String strName,
RID id) |
void |
setCompatibleVersionNumbers(String strCompatibleVersionNumbers)
Sets the array of repository version numbers, of form n.n.n.n.n, that it is compatible to connect to. |
void |
setCompatibleVersionNumbers(String[] strCompatibleVersionNumber)
Sets the array of repository version numbers, of form n.n.n.n.n, that it is compatible to connect to. |
int |
setConnection(Connection connection)
Connects this instance to a repository using an existing JDBC connection. |
int |
setConnection(RepositoryConnectDetails connDetails)
Connects this instance to a repository using the specified username, password and Net8 alias, creating a new JDBC connection in the process. |
int |
setConnection(String strConnect)
Connects this instance to a repository using the specified username, password and Net8 alias, creating a new JDBC connection in the process. |
int |
setConnection(String strUser,
String strPass, String strNet8) Connects this instance to a repository using the specified username, password and Net8 alias, creating a new JDBC connection in the process. |
void |
setDataElementLoadMode(int nType)
Set mode of loading data elements Dictates how Data elements are loaded from database |
static void |
setDefaultDiagnosticsOn()
Deprecated. 24-Feb-00 DON'T DO THIS. |
void |
setDefaultProductforLoadingMetaData(String strProduct)
|
void |
setDefaultRowPrefetch(int nMaxSize)
|
(package private)
void |
setLastContainerID(oracle.repos.services.GID gidLastContainerID)
|
void |
setMetaDataLoadMode(int nType)
Set mode of loading meta data Dictates how Meta data is loaded from database |
void |
setMode(int nMode) |
(package private)
void |
setServerRmTrace(boolean bOn)
|
void |
setValidationPolicy(int nValidationPolicy)
Sets validation policy mask for this DataSet. |
boolean |
usingOracleExtensions() |
protected int |
validateConnection() Static method which returns the last RepositoryConnection instance which has been successfully connected to a repository. |
(package private)
int |
writeText(oracle.repos.services.GID eid, String txt_type,
String buf, boolean trusted) |
| Methods inherited from class oracle.repos.services.data.DataEventSource |
addDataListener, dispatchEvent, enumerateDataListeners, removeDataListener |
| Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait,
wait |
| Field Detail |
public Connection m_sqlConnection
protected MetaDataElement m_containingConnection
| Constructor Detail |
public RepositoryConnection(String strUser,
String strPass,
String strNet8)
throws ReposServiceException
strUser - the usernamestrPass - the passwordstrNet8 - the Net8 service alias
public RepositoryConnection(String strConnect)
throws ReposServiceException
strUser - the usernamestrPass - the passwordstrNet8 - the Net8 service aliasprotected RepositoryConnection()
public RepositoryConnection(Connection connection)
throws ReposServiceException
connection - the existing JDBC connection.
public RepositoryConnection(RepositoryConnectDetails connect)
throws ReposServiceException
RepositoryConnectDetails - | Method Detail |
public Object clone()
public void compileWorkarea(oracle.repos.services.GID workareaId)
throws ReposServiceException
public DataEventSource getStaticContainer()
public DataEventSource getDynamicContainer()
public int setConnection(String strConnect)
throws ConnectionValidationException,
ReposServiceException
strUser - the username/password@Net8 service alias
public int setConnection(String strUser,
String strPass,
String strNet8)
throws ConnectionValidationException,
ReposServiceException
strUser - the usernamestrPass - the passwordstrNet8 - the Net8 service alias
public int setConnection(RepositoryConnectDetails connDetails)
throws ConnectionValidationException,
ReposServiceException
connection - detailsRepositoryConnection.validateConnection()
public void doPostConnectActions()
throws ReposServiceException
public boolean isOPSLogin()
public int setConnection(Connection connection)
throws ReposServiceException
connection - the existing JDBC connection.public Connection getConnection()
public RepositoryConnectDetails getConnectDetails()
public String getConnectString()
public WorkareaService getWorkareaService()
throws ReposServiceException
public VersionService getVersionService()
public PatchService getPatchService()
public MetaDataService getMetaDataService()
public ConfigurationService getConfigurationService()
public TransactionService getTransactionService()
public NamingService getNamingService()
public DependencyService getDependencyService()
public int getConnectionState()
public IdentifiedItem getActiveWorkArea()
public boolean isWorkAreaNull()
public void setActiveWorkArea(IdentifiedItem wkArea)
throws ReposServiceException
public void setActiveWorkArea(String strName,
RID id)
throws ReposServiceException
public void setActiveWorkArea(String strName)
throws ReposServiceException
public IdentifiedItem getActiveApplicationSystem()
public void setActiveApplicationSystem(IdentifiedItem appsys)
throws ReposServiceException
public void setActiveApplicationSystem(String strName,
RID id)
throws ReposServiceException
void setLastContainerID(oracle.repos.services.GID gidLastContainerID)
public oracle.repos.services.GID getLastContainerID()
public int getMetaDataLoadMode()
RepositoryConnection.MetaDataLoadpublic void setMetaDataLoadMode(int nType)
nType - - meta data load mode defined by RepositoryConnection.MetaDataLoadpublic int getDataElementLoadMode()
MetaDataElement.DataElementLoadModepublic void setDataElementLoadMode(int nType)
nType - - data load mode defined by MetaDataElement.DataElementLoadMode
public void registerMetaElementAPI(String strClassName)
throws ReposServiceException
strClassName - the MetaElementAPI class to register.
public void addRepositoryListener(RepositoryListener repositoryListener,
int nOperationMask,
Vector vecMetaElements)
throws ReposServiceException
repositoryListener - the listener instance.nOperationMask - the mask of RepositoryListener.REPOS_ELEMENT_OP_* filter
masks.vecMetaElements - a Vector of java.lang.String meta-element names with
which to filter notifications. May be null.
public void removeRepositoryListener(RepositoryListener repositoryListener)
throws ReposServiceException
public void addExchangeException(Exception e)
e - the exception to add.
public void close()
throws ReposServiceException
protected int validateConnection()
throws ReposServiceException
protected boolean isRepositoryUser()
protected int checkValidUser()
throws ReposServiceException
protected void checkCompatibleServer()
throws ReposServiceException
RepositoryConnection.setCompatibleVersionNumbers()
int cacheStatement(String strQuery,
PreparedStatement stmt)
throws ReposServiceException
strQuery - the SQL select statementPreparedStatement - the prepared statement for the SQLPreparedStatement getCachedStatement(String strQuery)
strQuery - the SQL select statementPreparedStatement getCachedStatement(int nStatementId)
strQuery - the SQL select statement
public oracle.repos.services.GID getNewIdValue()
throws ReposServiceException
public RID getNewRID()
throws ReposServiceException
void setServerRmTrace(boolean bOn)
throws ReposServiceException
int readText(oracle.repos.services.GID eid,
String txt_type,
String buf,
boolean trusted)
int writeText(oracle.repos.services.GID eid,
String txt_type,
String buf,
boolean trusted)
public int openActivity()
throws ReposServiceException
public int getNumberOfOpenActivities()
public oracle.repos.services.GID getCurrentActivityId()
throws ReposServiceException
public oracle.repos.services.GID getCurrentActivityParentId()
throws ReposServiceException
public int closeActivity()
throws ReposServiceException
public int abortActivity()
throws ReposServiceException
public Vector loadServerDeliverableVersions()
throws ReposServiceException
public DeliverableVersion getRepositoryVersion()
throws ReposServiceException
public boolean isDesignerRepository()
throws ReposServiceException
public boolean isOracleRepository()
throws ReposServiceException
public Vector loadPatches()
throws ReposServiceException
public int getMaximumPatchNumber()
throws ReposServiceException
public int getMaximumPatchMilestoneNumber()
throws ReposServiceException
public void setValidationPolicy(int nValidationPolicy)
nValidationPolicy - the new validation policy.public int getValidationPolicy()
public void setActiveAppSys(oracle.repos.services.GID gidIRID)
throws ReposServiceException
public MetaDataElement getMetaDataElement(MetaDataElementDescriptor descMDE)
throws ReposServiceException
- - description of meta data element to loadMetaDataElement, MetaDataElementDescriptor
public MetaDataElementList getMetaDataElements(MetaDataElementDescriptorList lisMdeDesc,
boolean bDefer,
boolean bAddToSession)
throws ReposServiceException
public MetaDataElement getMetaDataElement(String strTypeName)
throws ReposServiceException
- - description of meta data element to loadMetaDataElement, MetaDataElementDescriptor
public MetaDataElement getMetaDataElement(String strProductName,
String strTypeName)
throws ReposServiceException
public MetaDataElement getMetaDataElement(oracle.repos.services.GID gidTypeId)
throws ReposServiceException
public MetaDataElementList loadMetaDataElements(String strProductName,
MetaDataElementDescriptorList lisMdeDesc,
boolean bDefer,
boolean bAddToSession)
throws ReposServiceException
public MetaDataElementList loadMetaDataElements(MetaDataElementDescriptorList lisMdeDesc,
boolean bDefer,
boolean bAddToSession)
throws ReposServiceException
public MetaDataElement getMetaDataElement(String strProduct,
String strType,
int nPrimaryProperty)
throws ReposServiceException
public MetaDataElementList loadAllMetaDataElements(boolean bDefer,
boolean bAddToSession)
throws ReposServiceException
public Enumeration enumerateMetaDataElements()
public DataElement getElement(RID ridId)
throws ReposServiceException,
DanglingReferenceException,
DataElementConsolidateException,
DataElementDeletedException
public String getFullPath(oracle.repos.services.GID id,
String formatType,
char fileSep,
String containerSep)
throws ReposServiceException
id - is the irid of ivid of the objectformatType - is one of "NAME", "BRANCH",
"VLABEL"fileSep - is the desired separator between components. '\0' for default.containerSep - is the desired separator after the container name.
public String getFullPath(oracle.repos.services.GID id,
String formatType,
char fileSep)
throws ReposServiceException
public String getFullPathByIVID(oracle.repos.services.GID ivid,
String formatType,
char fileSep)
throws ReposServiceException
public RepositoryDiagram createDiagram(String name,
String diagramType,
boolean bWriteThrough)
throws ReposServiceException
public RepositoryDiagram createDiagram(DataElement deDiagram)
throws ReposServiceException
deDiagram - - the DataElement for the diagramvoid addDiagramToSession(RepositoryDiagram deDiag)
boolean isDiagramInSession(RID ridDiag)
RepositoryDiagram findDiagramInSession(RID ridDiag)
RepositoryDiagram findDiagramInSession(String strDiagramName)
public void removeDiagramFromSession(RepositoryDiagram repDiag)
public Vector getLoadedDiagrams()
public RepositoryDiagram getDiagram(RID id)
throws ReposServiceException
public RepositoryDiagram getDiagram(String strName)
throws ReposServiceException
public Vector getDiagrams(String strDiagType)
throws ReposServiceException
public Vector getDiagrams(String[] arrstrDiagType)
throws ReposServiceException
public void saveDiagram(RepositoryDiagram repDiag,
DataElementDescriptorList lisElements)
throws ReposServiceException
public String getUID()
throws ReposServiceException
public int getState()
public boolean usingOracleExtensions()
public void setDefaultRowPrefetch(int nMaxSize)
throws ReposServiceException
public int getDefaultRowPrefetch()
public void setMode(int nMode)
public int getMode()
public void clearMode(int nMode)
public boolean isInMode(int nMode)
public AccessRights queryAccessRights(DataElement de)
throws ReposServiceException
public AccessRights queryAccessRights(DataElement de,
String strGrantee)
throws ReposServiceException
public AccessRights queryAccessRights(oracle.repos.services.GID containerIRID)
throws ReposServiceException
public AccessRights queryAccessRights(oracle.repos.services.GID containerIRID,
String strGrantee)
throws ReposServiceException
public String getOwningUserName()
throws ReposServiceException
public RID getRIDFromFullPath(String strFullPath,
char chSeparator)
throws ReposServiceException
strFullPath - the full path of the elementchSeparator - the separator used in the full path if chSeparator is '\0'
then the default is used from the naming service.public void onCWLogSettingsChange()
The implementation should call methods on CWLog to figure out what has changed.
public static final void setDefaultDiagnosticsOn()
public void addElementToWorkareasPrivateConfiguration(DataElement de)
throws ReposServiceException
de - - Data Element to add to private configurations
public oracle.repos.services.GID queryPACTypeId(RID ridId)
throws ReposServiceException
public MetaDataElement queryPACType(RID ridId)
throws ReposServiceException
public boolean isVersioningSupported()
public String getValueFromRMInfo(String strName)
throws ReposServiceException
public String getRepositoryUUID()
throws ReposServiceException
public String getRepositoryBroadcastNotifier()
throws ReposServiceException
public void setDefaultProductforLoadingMetaData(String strProduct)
public void setCompatibleVersionNumbers(String[] strCompatibleVersionNumber)
strCompatibleVersionNumber - where each element is of form n.n.n.n.npublic void setCompatibleVersionNumbers(String strCompatibleVersionNumbers)
strCompatibleVersionNumber - a " " or "," separated
string of compatible version numbers. Each version number has form n.n.n.n.n.public String[] getCompatibleVersionNumbers()
| BM0463 - JR0670 - JDev446 | ||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |