com.ibm.ecm.extension
Class PluginRepositoryType
- java.lang.Object
- com.ibm.ecm.extension.PluginRepositoryType
- public abstract class PluginRepositoryType
- extends java.lang.Object
For enterprise content servers providing Content Management Interoperability Services (CMIS), the CMIS repository type can be used to access the server. A plug-in provided repository type can be used to extend IBM Content Navigator to support access other data sources not traditionally considered enterprise content servers.
Note that additional configuration is needed by the Content Navigator administrator to define the actual repository of the plug-in provided repository type and add it to a desktop.
Constructor Summary
Constructor and Description |
---|
PluginRepositoryType()
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
getConfigurationDijitClass()
Returns the name of a Dojo
dijit class that provides a configuration interface widget for this
repository type.
|
|
getConnectedConfigurationDijitClass()
Returns the name of a Dojo
dijit class that provides a configuration interface widget for this
repository type.
|
|
getGroupNamesForUser(PluginServiceCallbacks callbacks,javax.servlet.http.HttpServletRequest request,PluginRepositoryConnection connection,java.lang.String userid)
Obtain the group membership list for a given user.
|
|
getIconClass()
Returns the style class to use to display an icon for this repository type.
|
|
getId()
Returns a unique identifier for the repository type.
|
|
getName(java.util.Locale locale)
Returns a descriptive label for this repository type that is displayed in the IBM Content Navigator
administration tool.
|
|
getPluginId()
Returns the identifier of the plug-in that contains this respository type.
|
|
getRepositoryModelClass()
Returns the name of a Dojo class that extends ecm.model.Repository and represents this repository on the client.
|
getRepositoryPrivileges(PluginServiceCallbacks callbacks,javax.servlet.http.HttpServletRequest request,PluginRepositoryConnection connection)
Obtain privileges for the repository.
|
|
|
logoff(PluginServiceCallbacks callbacks,javax.servlet.http.HttpSession session,PluginRepositoryConnection connection)
Logoff the repository.
|
|
logon(PluginServiceCallbacks callbacks,javax.servlet.http.HttpServletRequest request,java.lang.String userid,java.lang.String password,RepositoryConfig repositoryConfig)
Perform logon to the repository.
|
|
performAction(PluginServiceCallbacks callbacks,RepositoryConfig repositoryConfig,java.lang.String action,javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)
Performs a repository specific action.
|
|
setPluginId(java.lang.String pluginId)
For Internal Use Only.
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail
PluginRepositoryType
- public PluginRepositoryType()
Method Detail
getId
- public abstract java.lang.String getId( )
String
that is used to identify the repository type. getName
- public abstract java.lang.String getName( java.util.Locale locale)
String
containing the short description of the repository type. getIconClass
- public java.lang.String getIconClass( )
String
containing the style class to use. logon
- public abstract PluginRepositoryConnection logon( PluginServiceCallbacks callbacks,
- javax.servlet.http.HttpServletRequest request,
- java.lang.String userid,
- java.lang.String password,
- RepositoryConfig repositoryConfig)
- throws java.lang.Exception
callbacks
- request
- userid
- password
- repositoryConfig
- java.lang.Exception
getGroupNamesForUser
- public java.lang.String[] getGroupNamesForUser( PluginServiceCallbacks callbacks,
- javax.servlet.http.HttpServletRequest request,
- PluginRepositoryConnection connection,
- java.lang.String userid)
- throws java.lang.Exception
callbacks
- request
- connection
- java.lang.Exception
getRepositoryPrivileges
- public JSONObject getRepositoryPrivileges( PluginServiceCallbacks callbacks,
- javax.servlet.http.HttpServletRequest request,
- PluginRepositoryConnection connection)
- throws PluginRepositoryLogonException
callbacks
- request
- connection
- - priv_foldering -- indicates foldering is supported. The default is true.
- priv_addItem -- indicates items (folders, docs, other items) can be added. The default is false.
- priv_addDoc -- indicates that documents can be added. The default is false.
- searchTemplateSupported -- indicates that searching with search templates is supported. The default is true.
- priv_addSearch -- indicates search templates can be created and added. The default is false.
- priv_addTeamspace -- indicates that teamspaces can be created. The default is false.
- priv_addTeamspaceTemplate -- indicates that teamspace templates can be created. The default is false.
PluginRepositoryLogonException
- for any situation where the logon is not successful logoff
- public abstract void logoff(PluginServiceCallbacks callbacks,
- javax.servlet.http.HttpSession session,
- PluginRepositoryConnection connection)
- throws java.lang.Exception
callbacks
- An instance of the PluginServiceCallbacks
class that contains several functions that can
be used by the service. These functions provide access to the plug-in configuration and content server
APIs. session
- The HttpSession for the user. (Since logoff can be called as part of session invalidation, a request
may not exist.) connection
- The instance of PluginRepositoryConnection that was originally returned from
PluginRepositoryType.logon. java.lang.Exception
performAction
- public abstract void performAction( PluginServiceCallbacks callbacks,
- RepositoryConfig repositoryConfig,
- java.lang.String action,
- javax.servlet.http.HttpServletRequest request,
- javax.servlet.http.HttpServletResponse response)
- throws java.lang.Exception
callbacks
- An instance of the PluginServiceCallbacks
class that contains several functions that can
be used by the service. These functions provide access to the plug-in configuration and content server
APIs. request
- The HttpServletRequest
object that provides the request. The service can access the
invocation parameters from the request. response
- The HttpServletResponse
object for the request. The service can get the output stream and
write the response. In most cases the response will be in JSON format. Use the
PluginServiceCallbacks.writeJSONResponse
method to send the response back in such cases
as this will allow other plug-ins such as EDSPlugin to process the response. java.lang.Exception
- For exceptions that occur when the service is running. If the logging level is high enough to log
errors, information about the exception is logged by IBM Content Navigator. getConfigurationDijitClass
- public java.lang.String getConfigurationDijitClass( )
dijit
class that provides a configuration interface widget for this
repository type. The widget must extend the ecm.widget.admin.PluginRepositoryConfigurationPane
widget. An instance of the widget is created and displayed in the IBM Content Navigator administration tool for
the general repository configuration. General repository configuration does not require connection to the
repository and typically provides a URL and other parameters needed to successfully connect to the repository,
with the user only needing to provide userid and password.
Refer to the documentation on PluginRepositoryConfigurationPane
for more information on what is required for a plug-in repository
configuration user interface.
getConnectedConfigurationDijitClass
- public java.lang.String getConnectedConfigurationDijitClass( )
dijit
class that provides a configuration interface widget for this
repository type. The widget must extend the ecm.widget.admin.PluginRepositoryConfigurationPane
widget. An instance of the widget is created and displayed in the IBM Content Navigator administration tool for
the configuration parameters tab of the repository configuration. This tab is enabled after the administrator has
filled in the general configuration and logged into the repository.
Refer to the documentation on PluginRepositoryConfigurationPane
for more information on what is required for a plug-in repository
configuration user interface.
getRepositoryModelClass
- public java.lang.String getRepositoryModelClass( )
getPluginId
- public final java.lang.String getPluginId( )
Important: This method is implemented by IBM Content Navigator and must not be overridden.
Plugin
class for the plug-in. setPluginId
- public final void setPluginId(java.lang.String pluginId)
Important: This identifier is used in URLs so it must contain only alphanumeric characters.