org.eclipse.rse.core.subsystems
Class AbstractCredentialsProvider

java.lang.Object
  org.eclipse.rse.core.subsystems.AbstractCredentialsProvider

All Implemented Interfaces:

ICredentialsProvider

Direct Known Subclasses:

StandardCredentialsProvider

public abstract class AbstractCredentialsProvider

extends Object

implements ICredentialsProvider

The AbstractCredentialsProvider provides the base implementation of the ICredentialsProvider interface. It remembers the connector service and suppression state for the provider.

This class is meant to be subclassed.

Constructor Summary

AbstractCredentialsProvider(IConnectorService connectorService)
Create a credentials provider for a particular connector service.

Method Summary

IConnectorService	getConnectorService() Retrieves the connector service associated with this provider.
boolean	isSuppressed() Retrieves the suppression state of the provider.
protected boolean	requiresPassword()
protected boolean	requiresUserId()
void	setSuppressed(boolean suppressed) Sets the suppressed state of the provider.
protected boolean	supportsPassword()
protected boolean	supportsUserId()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.rse.core.subsystems.ICredentialsProvider

acquireCredentials, clearCredentials, clearPassword, getCredentials, getUserId, repairCredentials, setPassword, setUserId

Constructor Detail

AbstractCredentialsProvider

public AbstractCredentialsProvider(IConnectorService connectorService)

Create a credentials provider for a particular connector service. Subclasses should implement their own constuctors but invoke this constructor in them.

Parameters:

connectorService - the associatated connector service.

Method Detail

getConnectorService

public final IConnectorService getConnectorService()

Description copied from interface: ICredentialsProvider

Retrieves the connector service associated with this provider. Each provider has its own connector service. All authenticating connector services have their own provider.

Specified by:

getConnectorService in interface ICredentialsProvider

Returns:

the connector service associated with this provider

isSuppressed

public final boolean isSuppressed()

Description copied from interface: ICredentialsProvider

Retrieves the suppression state of the provider. Acquisition may be suppressed for a period of time after a previous attempt. This is to provide client control of the acquisition policy. If true then ICredentialsProvider.acquireCredentials(boolean) will immediately cancel when invoked.

Specified by:

isSuppressed in interface ICredentialsProvider

Returns:

true if the provider is suppressed.

setSuppressed

public final void setSuppressed(boolean suppressed)

Description copied from interface: ICredentialsProvider

Sets the suppressed state of the provider. Acquisition may be suppressed for a period of time after a previous attempt. This is to provide client control of the acquisition policy. If true then ICredentialsProvider.acquireCredentials(boolean) will immediately cancel when invoked.

Specified by:

setSuppressed in interface ICredentialsProvider

Parameters:

suppressed - true if the provider is to be suppressed.

supportsUserId

protected final boolean supportsUserId()

Returns:

true if the associated connector service supports user ids.

requiresUserId

protected final boolean requiresUserId()

Returns:

true if the associated connector service requires a user id.

supportsPassword

protected final boolean supportsPassword()

Returns:

true if the associated connector service supports a password.

requiresPassword

protected final boolean requiresPassword()

Returns:

true if the associated connector service requires a password.