org.ow2.proactive.scheduler.common

Interface ThirdPartyCredentials

All Known Subinterfaces:

ISchedulerClient, Scheduler

All Known Implementing Classes:

AbstractSmartProxy, ClientBase, RestSmartProxyImpl, SchedulerClient, SchedulerNodeClient, SchedulerProxyUserInterface, SmartProxyImpl

public interface ThirdPartyCredentials

Third-party credentials are key-value pairs associated to a particular user and saved in the database. They can be used for instance to authenticate to third-party services in tasks.

Method Summary

Modifier and Type	Method and Description
void	putThirdPartyCredential(String key, String value) Stores a third-party credential key-value pair in the database.
void	removeThirdPartyCredential(String key)
Set<String>	thirdPartyCredentialsKeySet()

Method Detail

putThirdPartyCredential

void putThirdPartyCredential(String key,
                             String value)
                      throws NotConnectedException,
                             PermissionException,
                             KeyException

Stores a third-party credential key-value pair in the database.

Parameters:

key - the third-party credential key to store

value - the third-party credential value to store, it will be encrypted

Throws:

NotConnectedException - if you are not authenticated.

PermissionException - if you can't access this particular method.

KeyException - if encryption of value fails

thirdPartyCredentialsKeySet

Set<String> thirdPartyCredentialsKeySet()
                                 throws NotConnectedException,
                                        PermissionException

Returns:

all third-party credential keys stored for the current user

Throws:

NotConnectedException - if you are not authenticated.

PermissionException - if you can't access this particular method.

removeThirdPartyCredential

void removeThirdPartyCredential(String key)
                         throws NotConnectedException,
                                PermissionException

Parameters:

key - the third-party credential key to remove

Throws:

NotConnectedException - if you are not authenticated.

PermissionException - if you can't access this particular method.