com.ibm.ecm.extension

Class PluginRepositoryConnection

  1. java.lang.Object
  2. extended bycom.ibm.ecm.extension.PluginRepositoryConnection
  1. public class PluginRepositoryConnection
  2. extends java.lang.Object
This class represents a single connection to a repository provided by a plug-in. The class can be subclassed to maintain unique information on the connection for the user session.
Since:
2.0.3

Constructor Summary

Constructor and Description
PluginRepositoryConnection(java.lang.String type,java.lang.String userId,java.lang.String userDisplayName)
Constructs the connection

Method Summary

Modifier and Type Method and Description
  1. JSONObject
 getOnConnectedJSON()
Returns a JSONObject instance that will be returned on connection to the repository.
  1. java.lang.String
 getType()
Returns the type of repository associated with this connection.
  1. java.lang.String
 getUserDisplayName()
Returns the user display name for this connection.
  1. java.lang.String
 getUserId()
Returns the user identifier for this connection.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PluginRepositoryConnection

  1. public PluginRepositoryConnection( java.lang.String type,
  2. java.lang.String userId,
  3. java.lang.String userDisplayName)
Constructs the connection
Parameters:
type - the type of the connection (should be the same as used on PluginRepositoryType.getId.
userId - the user identifier
userDisplayName - the display version of the user name, if any. If there is no user display name, use the same string as userId.

Method Detail

getType

  1. public java.lang.String getType( )
Returns the type of repository associated with this connection. Corresponds to PluginRepositoryType.getId

getUserId

  1. public java.lang.String getUserId( )
Returns the user identifier for this connection.

getUserDisplayName

  1. public java.lang.String getUserDisplayName( )
Returns the user display name for this connection.

getOnConnectedJSON

  1. public JSONObject getOnConnectedJSON( )
Returns a JSONObject instance that will be returned on connection to the repository. The corresponding onConnected method of the ecm.model.Repository object will be passed an instance of a JavaScript object represented by this JSON. This allows a plug-in to provide additional information that is needed on the client for the connected repository.