org.jbei.ice.lib.net

Class RemoteContact

java.lang.Object

org.jbei.ice.lib.net.RemoteContact

public class RemoteContact
extends Object

Remote communications with other ice instances Any method calls to this class will likely be slow since it requires remote access

Author:

Hector Plahar

Constructor Summary

Constructors

Constructor and Description
RemoteContact()

Method Summary

Modifier and Type	Method and Description
void	addTransferredEntriesToFolder(String url, EntrySelection entrySelection)
void	addTransferredEntriesToFolder(String url, String userId, EntrySelection entrySelection, long folderId, String token, String worToken)
boolean	apiKeyValidates(String myURL, RegistryPartner registryPartner) Contacts the registry partner at the specified url, to ensure that the API key validates.
RegistryPartner	contactPotentialPartner(RegistryPartner thisPartner, String remotePartnerUrl)
boolean	deleteInstanceFromMaster(String thisUrl) Deletes this instance of ICE from the web of registries master list
List<AttachmentInfo>	getAttachmentList(String url, long entryId, String apiKey)
FolderDetails	getFolderEntries(String url, String resourcePath, Map<String,Object> queryParams, String apiKey)
List<RegistryPartner>	getPartners(String url, String token)
PartData	getPublicEntry(String url, String entryId, String apiKey)
FeaturedDNASequence	getPublicEntrySequence(String url, String partId, String apiKey)
PartStatistics	getPublicEntryStatistics(String url, long partId, String apiKey)
PartData	getPublicTooltipDetails(String url, long partId, String apiKey)
FolderDetails	getRemoteContents(String url, String userId, long folderId, String token, PageParameters pageParameters, String worToken)
PartData	getRemoteEntry(String url, String userId, long partId, long folderId, String token, String worToken)
FeaturedDNASequence	getSequence(String url, String userId, String partId, long folderId, String token, String apiKey)
PartData	getToolTipDetails(String url, String userId, long partId, String token, String worToken)
AccountTransfer	getUser(String url, String email, String token)
boolean	handleRemoteRemoveRequest(String worToken, String url)
RegistryPartner	refreshPartnerKey(RegistryPartner partner, String url, String worToken)
AccessPermission	shareFolder(String url, AccessPermission permission, String token)
FolderDetails	transferFolder(String url, FolderDetails folderDetails)
PartData	transferPart(String url, PartData data)
void	transferSequence(String url, String recordId, EntryType entryType, String sequenceString)

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteContact

public RemoteContact()

Method Detail

contactPotentialPartner

public RegistryPartner contactPotentialPartner(RegistryPartner thisPartner,
                                               String remotePartnerUrl)

refreshPartnerKey

public RegistryPartner refreshPartnerKey(RegistryPartner partner,
                                         String url,
                                         String worToken)

apiKeyValidates

public boolean apiKeyValidates(String myURL,
                               RegistryPartner registryPartner)

Contacts the registry partner at the specified url, to ensure that the API key validates.

Parameters:

myURL - the url of this ICE instance

registryPartner - partner infor

Returns:

true if the api key validated successfully with the specified url, false otherwise (including when the instance cannot be contacted)

handleRemoteRemoveRequest

public boolean handleRemoteRemoveRequest(String worToken,
                                         String url)

transferPart

public PartData transferPart(String url,
                             PartData data)

transferSequence

public void transferSequence(String url,
                             String recordId,
                             EntryType entryType,
                             String sequenceString)

transferFolder

public FolderDetails transferFolder(String url,
                                    FolderDetails folderDetails)

addTransferredEntriesToFolder

public void addTransferredEntriesToFolder(String url,
                                          EntrySelection entrySelection)

getPartners

public List<RegistryPartner> getPartners(String url,
                                         String token)

getUser

public AccountTransfer getUser(String url,
                               String email,
                               String token)

shareFolder

public AccessPermission shareFolder(String url,
                                    AccessPermission permission,
                                    String token)

getRemoteContents

public FolderDetails getRemoteContents(String url,
                                       String userId,
                                       long folderId,
                                       String token,
                                       PageParameters pageParameters,
                                       String worToken)

getFolderEntries

public FolderDetails getFolderEntries(String url,
                                      String resourcePath,
                                      Map<String,Object> queryParams,
                                      String apiKey)

getAttachmentList

public List<AttachmentInfo> getAttachmentList(String url,
                                              long entryId,
                                              String apiKey)

addTransferredEntriesToFolder

public void addTransferredEntriesToFolder(String url,
                                          String userId,
                                          EntrySelection entrySelection,
                                          long folderId,
                                          String token,
                                          String worToken)

getToolTipDetails

public PartData getToolTipDetails(String url,
                                  String userId,
                                  long partId,
                                  String token,
                                  String worToken)

getPublicTooltipDetails

public PartData getPublicTooltipDetails(String url,
                                        long partId,
                                        String apiKey)

getPublicEntryStatistics

public PartStatistics getPublicEntryStatistics(String url,
                                               long partId,
                                               String apiKey)

getPublicEntrySequence

public FeaturedDNASequence getPublicEntrySequence(String url,
                                                  String partId,
                                                  String apiKey)

getSequence

public FeaturedDNASequence getSequence(String url,
                                       String userId,
                                       String partId,
                                       long folderId,
                                       String token,
                                       String apiKey)

getRemoteEntry

public PartData getRemoteEntry(String url,
                               String userId,
                               long partId,
                               long folderId,
                               String token,
                               String worToken)

getPublicEntry

public PartData getPublicEntry(String url,
                               String entryId,
                               String apiKey)

deleteInstanceFromMaster

public boolean deleteInstanceFromMaster(String thisUrl)

Deletes this instance of ICE from the web of registries master list

Returns:

true, if the master reports correct execution of the request. false otherwise