com.ibm.ecm.extension

Class PluginRepositoryConnection

java.lang.Object

com.ibm.ecm.extension.PluginRepositoryConnection

public class PluginRepositoryConnection
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

Constructors

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
JSONObject	getOnConnectedJSON() Returns a JSONObject instance that will be returned on connection to the repository.
java.lang.String	getType() Returns the type of repository associated with this connection.
java.lang.String	getUserDisplayName() Returns the user display name for this connection.
java.lang.String	getUserId() Returns the user identifier for this connection.
boolean	hasAdminAccess() Determines if the user has admin access to the desktop
void	setHasAdminAccess(boolean hasAdminAccess) Sets if the user has admin access to the desktop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PluginRepositoryConnection

public PluginRepositoryConnection(java.lang.String type,
                                  java.lang.String userId,
                                  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

public java.lang.String getType()

Returns the type of repository associated with this connection. Corresponds to PluginRepositoryType.getId

getUserId

public java.lang.String getUserId()

Returns the user identifier for this connection.

getUserDisplayName

public java.lang.String getUserDisplayName()

Returns the user display name for this connection.

getOnConnectedJSON

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.

hasAdminAccess

public boolean hasAdminAccess()

Determines if the user has admin access to the desktop

Returns:

setHasAdminAccess

public void setHasAdminAccess(boolean hasAdminAccess)

Sets if the user has admin access to the desktop

Parameters:

hasAdminAccess -