org.jbei.ice.lib.net

Class WebPartners

java.lang.Object

org.jbei.ice.lib.net.WebPartners

public class WebPartners
extends Object

Partners for web of registries

Author:

Hector Plahar

Constructor Summary

Constructors

Constructor and Description
WebPartners()
WebPartners(RemoteContact remoteContact)

Method Summary

Modifier and Type	Method and Description
RegistryPartner	addNewPartner(String userId, RegistryPartner partner, String thisUrl) Adds the registry instance specified by the url to the list of existing partners (if not already in there) and sends a request to the remote instance that includes a security token that the remote instance can use to communicate with this instance.
protected RegistryPartner	createRemotePartnerObject(RegistryPartner newPartner, String token)
RegistryPartner	get(String partnerId)
RegistryPartner	get(String token, String url) Retrieve a partner based on partner token and unique identifier This is mostly intended to validate the token associated with url
List<RegistryPartner>	getPartners() Retrieves list of partners for this instance
protected RegistryPartner	getThisInstanceWithNewApiKey() Generates a new partner object representing this ICE instance with a new API key
protected String	getThisUri()
protected RegistryPartner	handleRemoteAddRequest(RegistryPartner request) Handles requests from remote ice instances that will like to be in a WoR config with this instance Serves the dual purpose of: please add me as a partner to your list with token add accepted; use this as the authorization token
protected boolean	isInWebOfRegistries() Checks if the web of registries admin config value has been set to enable this ICE instance to join the web of registries configuration
protected boolean	isValidUrl(String url) Validates the url by pre-pending "https://" as the scheme
RegistryPartner	processRemoteWebPartnerAdd(RegistryPartner newPartner) Process a web partner add request from a remote instance
boolean	remove(String userId, long id)
boolean	removeRemotePartner(long id, String url) Delete the partner information specified by the url in the param
RegistryPartner	update(String userId, long id, RegistryPartner partner)
RegistryPartner	updateAPIKey(String userId, long id) Refreshes the API key for the referenced partner
RegistryPartner	updateRemoteAPIKey(String url, RegistryPartner remotePartner) Updates the api token of a remote partner using information sent by that partner

Methods inherited from class java.lang.Object

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

Constructor Detail

WebPartners

public WebPartners()

WebPartners

public WebPartners(RemoteContact remoteContact)

Method Detail

get

public RegistryPartner get(String partnerId)

getPartners

public List<RegistryPartner> getPartners()

Retrieves list of partners for this instance

Returns:

list of partners available for this ICE instance or an empty list if this instance is not in web of registries

get

public RegistryPartner get(String token,
                           String url)

Retrieve a partner based on partner token and unique identifier This is mostly intended to validate the token associated with url

Parameters:

token - partner token generated by this ICE instance and sent to other instance

url - unique identifier for partner instance

Returns:

found partner

processRemoteWebPartnerAdd

public RegistryPartner processRemoteWebPartnerAdd(RegistryPartner newPartner)

Process a web partner add request from a remote instance

Parameters:

newPartner - information about partner that should include an api token to be used when contacting that partner

Returns:

information about this ICE instance (name, url) with a token that is to be sent as a response

handleRemoteAddRequest

protected RegistryPartner handleRemoteAddRequest(RegistryPartner request)

Handles requests from remote ice instances that will like to be in a WoR config with this instance Serves the dual purpose of:

• please add me as a partner to your list with token
• add accepted; use this as the authorization token

Note that the request is rejected if this ICE instance has not opted to be a member of web of registries

Parameters:

request - partner request object containing all information needed with a validated url

Returns:

information about this instance to be sent to the remote

isValidUrl

protected boolean isValidUrl(String url)

Validates the url by pre-pending "https://" as the scheme

Parameters:

url - without scheme

Returns:

true if url validates successfully, false otherwise

remove

public boolean remove(String userId,
                      long id)

removeRemotePartner

public boolean removeRemotePartner(long id,
                                   String url)

Delete the partner information specified by the url in the param

Parameters:

id - unique local identifier of the partner making request.

url - url of partner being deleted

Returns:

true if specified partner is successfully removed, false otherwise

getThisUri

protected String getThisUri()

updateAPIKey

public RegistryPartner updateAPIKey(String userId,
                                    long id)

Refreshes the API key for the referenced partner

Parameters:

userId - identifier for user making request. Must have administrative privileges

id - unique (local) identifier for remote partner whose API key is being refreshed

Returns:

null if this instance is not in web of registries

Throws:

PermissionException - if user making request does not have administrative privileges

IllegalArgumentException - if the partner identifier is invalid (cannot be used to retrieve a valid partner)

updateRemoteAPIKey

public RegistryPartner updateRemoteAPIKey(String url,
                                          RegistryPartner remotePartner)

Updates the api token of a remote partner using information sent by that partner

Parameters:

url - URL of partner making request. This is obtained from the old api key

remotePartner - information sent by remote partner

Returns:

information about this partner including a new api token

update

public RegistryPartner update(String userId,
                              long id,
                              RegistryPartner partner)

addNewPartner

public RegistryPartner addNewPartner(String userId,
                                     RegistryPartner partner,
                                     String thisUrl)

Adds the registry instance specified by the url to the list of existing partners (if not already in there) and sends a request to the remote instance that includes a security token that the remote instance can use to communicate with this instance.

Information about the remote instance is still saved even when it cannot be communicated with. This allows a future communication attempt.

Parameters:

userId - id of user performing action (must have admin privileges)

partner - registry partner object that contains unique uniform resource identifier & name for the registry

Returns:

add partner ofr

getThisInstanceWithNewApiKey

protected RegistryPartner getThisInstanceWithNewApiKey()

Generates a new partner object representing this ICE instance with a new API key

Returns:

null if the URL for this partner is invalid (e.g. localhost) RegistryPartner object otherwise

isInWebOfRegistries

protected boolean isInWebOfRegistries()

Checks if the web of registries admin config value has been set to enable this ICE instance to join the web of registries configuration

Returns:

true if value has been set to the affirmative, false otherwise

createRemotePartnerObject

protected RegistryPartner createRemotePartnerObject(RegistryPartner newPartner,
                                                    String token)