public class RMDriverManager
extends java.lang.Object
You can instantiate an RMDriverManager
object by calling the default constructor.
You can register an RMConnector
implementation for a custom application by calling the
registerConnector
method
on an RMDriverManager
object. This method generates and returns a unique registration ID
for the specified connector implementation.
The RMConnector
implementation is then bound to the unique registration ID.
For example, the RMDriverManager
class instantiates respective implementations
of Content Engine, Content Services, or Image Service according to the corresponding registration ID.
Constructor and Description |
---|
RMDriverManager()
Creates a new
RMDriverManager object. |
Modifier and Type | Method and Description |
---|---|
RMAutoName |
getAutoName()
Returns the auto-namining implementation that is registered for this object.
|
RMConnector |
getConnector(RMObjectStore aoRMObjectStore,
java.lang.String asRegistration_id)
Returns the connector implementation that is to be invoked for a specified
ConnectorRegistration
object. |
RMConnector |
getConnector(RMObjectStore aoRMObjectStore,
java.lang.String asRegistration_id,
com.filenet.wcm.api.Session aoSession)
Returns the connector implementation that is to be invoked for a specified
ConnectorRegistration
object. |
boolean |
isAlreadyRegistered(RMObjectStore aoObjectStore,
java.lang.String asRepositoryType)
Indicates whether a connector implementation is registered in the specified object store.
|
void |
registerAutoName(RMAutoName aoAutoNameImpl)
Registers the specified auto-naming implementation for use by a custom application.
|
java.lang.String |
registerConnector(RMObjectStore aoObjectStore,
java.lang.String asRepositoryType,
java.lang.String asServerName,
java.lang.String asRepositoryName,
java.lang.String asImplementationclass)
Registers the connector implementation that is to be invoked for the specified combination of
repository type, server name and repository name.
|
public java.lang.String registerConnector(RMObjectStore aoObjectStore, java.lang.String asRepositoryType, java.lang.String asServerName, java.lang.String asRepositoryName, java.lang.String asImplementationclass) throws RMException
The registerConnector
method creates a ConnectorRegistration
object that is used to store registration-related in Content Engine. The method returns
the a String containing the GUID for this object, which represents the registration ID.
If the specified combination of repository type, server name and repository name is already registered, this method throws an exception. If the specified combination is not registered, In case there exists no registration for the combination of repository type, the following two scenarios can happen:
1) If there exists an entry for the custom object with the given Repository type and with star (*) value for the server and repository name and a new custom object will be created.
2) If there exists no entry for the custom object with the given Repository type and with star (*) value for the server and repository name and two custom objects will be created.
The First object will have a star (*) entry for the server name and the repository name, and the other object will have all the values as specified in input parameters.
The return value will be the GUID of the custom object created. If an error occurs, an RMException is thrown.
asImplementationclass
- The fully qualified name of implementation class that will be invoked. Note that the classes for implementation must be available in the classpath,
such as,com.connector.api.Implementation. In additon, null or empty values are not allowed.aoObjectStore
- The RMObjectStore to which this registration applies.
The null value is not allowed.asRepositoryType
- Specifies the type of repository, such as CE, CS or IS.
Null or empty values are not allowed.asServerName
- The server name or the IP address of the repository server, such ashttp://fn-atlantic:8008/ApplicationEngine/xcmisasoap.dll.
Star(*), null or empty values for the parameter will not be allowed.asRepositoryName
- Specifies the repository name including the domain name.
In case of CE, it will be ObjectStore and domain name. In case of IS or CS, you must specify fully qualified name of the library (including domain name).
Star(*), null, or empty values for the parameter will not be allowed.RMException
- In case of any error, an RMException will be thrown.public boolean isAlreadyRegistered(RMObjectStore aoObjectStore, java.lang.String asRepositoryType)
aoObjectStore
- An RMObjectStore
object that represents the object store
to be checked for registration.asRepositoryType
- A String
that represents the repository type such as
CE
for Content Engine or IS
for Image Services.true
if a ConnectorRegistration
object exists in the specified object store; otherwise, returns false
.public RMConnector getConnector(RMObjectStore aoRMObjectStore, java.lang.String asRegistration_id) throws RMException
ConnectorRegistration
object.aoRMObjectStore
- An RMObjectStore
object specifying the object store in
which the ConnectorRegistration
object is located. This parameter cannot be null
.asRegistration_id
- A String
Containing the registration ID
(GUID) of the ConnectorRegistration
object. This String
cannot be null
or empty.RMConnector
object representing the connector implementation that is registered
in the Records Manager application for the specified for a specified ConnectorRegistration
object.RMException
- If a Records Manager error occurs.public RMConnector getConnector(RMObjectStore aoRMObjectStore, java.lang.String asRegistration_id, com.filenet.wcm.api.Session aoSession) throws RMException
ConnectorRegistration
object.aoRMObjectStore
- An RMObjectStore
object specifying the object store in
which the ConnectorRegistration
object is located. This parameter cannot be null
.asRegistration_id
- A String
Containing the registration ID
(GUID) of the ConnectorRegistration
object. This String
cannot be null
or empty.aoSession
- A Session
object specifying the session to be set for the
RMConnector
object.RMConnector
object representing the connector implementation that is registered
in the Records Manager application for the specified for a specified ConnectorRegistration
object.RMException
- If a Records Manager error occurs.public void registerAutoName(RMAutoName aoAutoNameImpl)
aoAutoNameImpl
- The RMAutoName
object that contains the auto-naming implementation to
be registered. If this parameter is null
, no auto-naming implementation is
registered and, as a result, subsequent calls to the getAutoName
method
cause an exception to be thrown.public RMAutoName getAutoName() throws RMException
RMAutoName
object that is registered for this object. the registerAutoName method.RMException
- If no RMAutoName
object is registered for this object or if a Record Manager
error occurs.© Copyright IBM Corp. 2003, 2013. All Rights Reserved.