|
RSE Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ICredentialsProvider
A credentials provider provides credentials to a connector service. Every authenticating connector service has its own credentials provider, usually created when that connector service is created.
Credentials will usually consist of a user id and password but may be something else in which case implementers are free change the user id and password methods to something that makes sense for their case.
A provider may be in a suppressed state, in which case it will prohibit the acquisition of credentials.
ICredentials
,
IConnectorService
,
AuthenticatingConnectorService
Method Summary | |
---|---|
void |
acquireCredentials(boolean reacquire)
Causes the provider to create a set of credentials for use by a connector service in order to connect to a target host system. |
void |
clearCredentials()
Clears the credentials known by this credentials provider. |
void |
clearPassword()
If the credentials include a password or equivalent then clears only that that portion of the credentials. |
IConnectorService |
getConnectorService()
Retrieves the connector service associated with this provider. |
ICredentials |
getCredentials()
Retrieves the credentials known to this credentials provider. |
String |
getUserId()
If the credentials include a user id then retrieve that user id. |
boolean |
isSuppressed()
Retrieves the suppression state of the provider. |
void |
repairCredentials(SystemMessage message)
The connector service using this provider may find the credentials provided are incorrector or expired. |
void |
setPassword(String password)
If the credentials include a password or equivalent then set that password to the new value. |
void |
setSuppressed(boolean suppressed)
Sets the suppressed state of the provider. |
void |
setUserId(String userId)
If the credentials include a user id then set that user id to the new value. |
Method Detail |
---|
void acquireCredentials(boolean reacquire) throws OperationCanceledException
reacquire
- true if the provider should refresh any remembered
credentials. Typically used to force the showing of a dialog containing
remembered credentials.
OperationCanceledException
- if the acquisition of credentials is
cancelled by the user, if the provider is in suppressed state,
a resource (such as the workbench) not being available,
or interrupted by some other means.void repairCredentials(SystemMessage message) throws OperationCanceledException
message
- the message indicating the nature of the damage that must
be repaired. For example, indicating expiration of a password.
OperationCanceledException
- if the repair is cancelled for some reason. This could
include the inability of a credentials provider to open a dialog or a dialog being
cancelled.void clearCredentials()
ICredentials getCredentials()
acquireCredentials(boolean)
to retrieve credentials.
void clearPassword()
void setPassword(String password)
password
- the new value of the password in the credentials held by this providervoid setUserId(String userId)
userId
- the user id to place into the credentials held by this providerString getUserId()
boolean isSuppressed()
acquireCredentials(boolean)
will immediately cancel when invoked.
void setSuppressed(boolean suppressed)
acquireCredentials(boolean)
will immediately cancel when invoked.
suppressed
- true if the provider is to be suppressed.IConnectorService getConnectorService()
|
RSE Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |