com.mindoo.remote.api
Interface IRemoteEclipseConnection

public interface IRemoteEclipseConnection

This class is the central communication channel to invoke Remote Eclipse API methods

Method Summary

void	addDisposeListener(IDisposeConnectionListener listener) Registers a new listener that gets notified when the connection is about to be disposed
void	authenticateConnection(java.lang.String submittedToken) Method to authenticate the connection.
void	dispose() Disposes this connection and flushes all internal caches
java.lang.Object	getAdapter(java.lang.String clazzName) Generic adapter method to get access to API functions
java.lang.String	getAuthenticationTokenHolderUrl(java.lang.String type) Returns a URL of a piece of data that is used to exchange a secret token between the Remote API plugin and consumers of the API, for example to a Notes document
java.lang.String	getEclipseObjClassname(java.lang.Object o) Deprecated.
java.lang.Long	getId() Returns the internal connection ID
java.util.Set<java.lang.String>	getOwners() Returns a list of persons that are registered as owners for this connection.
java.lang.String	getUser() Returns the abbreviated Notes name of the user that is currently accessing the remote api
boolean	isDisposed() Method to check whether this connection is disposed
void	removeDisposeListener(IDisposeConnectionListener listener) Removes a registered IDisposeConnectionListener

Method Detail

getId

java.lang.Long getId()
                     throws RemoteEclipseAPIException

Returns the internal connection ID

Returns:

ID

Throws:

RemoteEclipseAPIException

dispose

void dispose()
             throws RemoteEclipseAPIException

Disposes this connection and flushes all internal caches

Throws:

RemoteEclipseAPIException

isDisposed

boolean isDisposed()
                   throws RemoteEclipseAPIException

Method to check whether this connection is disposed

Returns:

true if disposed

Throws:

RemoteEclipseAPIException

getAdapter

java.lang.Object getAdapter(java.lang.String clazzName)
                            throws RemoteEclipseAPIException

Generic adapter method to get access to API functions

Parameters:

clazzName - classname of API function

Returns:

implementation or null if not found

Throws:

RemoteEclipseAPIException

authenticateConnection

void authenticateConnection(java.lang.String submittedToken)
                            throws RemoteEclipseAPIException

Method to authenticate the connection. The connection must be authenticated before any connection API method can be invoked

Parameters:

submittedToken - secure token that was written at the location returned by #getAuthenticationTokenHolderUrl(IRemoteEclipseConnection)

Throws:

RemoteEclipseAPIException

getAuthenticationTokenHolderUrl

java.lang.String getAuthenticationTokenHolderUrl(java.lang.String type)
                                                 throws RemoteEclipseAPIException

Returns a URL of a piece of data that is used to exchange a secret token between the Remote API plugin and consumers of the API, for example to a Notes document

Parameters:

type - preferred type of token holder

Returns:

URL of token holder

Throws:

RemoteEclipseAPIException

getOwners

java.util.Set<java.lang.String> getOwners()
                                          throws RemoteEclipseAPIException

Returns a list of persons that are registered as owners for this connection. for XPages context, the list contains the signer of the XPages design elements. For JavaScript execution, the list contains the signers of all JavaScript elements that have been parsed (base script and includes)

Returns:

owners

Throws:

RemoteEclipseAPIException

getUser

java.lang.String getUser()
                         throws RemoteEclipseAPIException

Returns the abbreviated Notes name of the user that is currently accessing the remote api

Returns:

username

Throws:

RemoteEclipseAPIException

getEclipseObjClassname

@Deprecated
java.lang.String getEclipseObjClassname(java.lang.Object o)
                                        throws RemoteEclipseAPIException

Deprecated.

Throws:

RemoteEclipseAPIException

addDisposeListener

void addDisposeListener(IDisposeConnectionListener listener)
                        throws RemoteEclipseAPIException

Registers a new listener that gets notified when the connection is about to be disposed

Parameters:

listener - listener

Throws:

RemoteEclipseAPIException

removeDisposeListener

void removeDisposeListener(IDisposeConnectionListener listener)
                           throws RemoteEclipseAPIException

Removes a registered IDisposeConnectionListener

Parameters:

listener - listener

Throws:

RemoteEclipseAPIException