net.java.sip.communicator.service.protocol
Interface AccountManager

All Known Implementing Classes:

AccountManagerImpl

public interface AccountManager

Represents a manager of accounts which contains the details about the format in which the accounts in question are stored (i.e. knows how to store and load them) and takes care of loading them on start-up.

Author:

Lubomir Marinov, Yana Stamcheva

Method Summary

void	addListener(AccountManagerListener listener) Registers a specific listener to be notified about events fired by this AccountManager.
Collection<AccountID>	getStoredAccounts() Returns an Iterator over a list of all stored AccountIDs.
boolean	hasStoredAccounts(String protocolName, boolean includeHidden) Determines whether the account store represented by this manager contains stored accounts.
boolean	isAccountLoaded(AccountID accountID) Checks if the account corresponding to the given accountID is loaded.
void	loadAccount(AccountID accountID) Loads the account corresponding to the given AccountID.
void	removeListener(AccountManagerListener listener) Unregisters a specific listener from this AccountManager so that it no longer received notifications about events fired by this manager.
boolean	removeStoredAccount(ProtocolProviderFactory factory, AccountID accountID) Removes the account with accountID from the set of accounts that are persistently stored inside the configuration service.
void	storeAccount(ProtocolProviderFactory factory, AccountID accountID) Stores an account represented in the form of an AccountID created by a specific ProtocolProviderFactory.
void	unloadAccount(AccountID accountID) Unloads the account corresponding to the given AccountID.

Method Detail

addListener

void addListener(AccountManagerListener listener)

Registers a specific listener to be notified about events fired by this AccountManager. If the listener is already registered, it will not be registered again.

Parameters:

listener - the listener to be registered for notification events fired by this AccountManager

hasStoredAccounts

boolean hasStoredAccounts(String protocolName,
                          boolean includeHidden)

Determines whether the account store represented by this manager contains stored accounts.

Parameters:

protocolName - the name of the protocol for which the stored accounts are to be checked or null for all protocols

includeHidden - true to take into account both non-hidden and hidden stored accounts; false for non-hidden only

Returns:

true if the account store represented by this manager contains stored accounts; false, otherwise

removeListener

void removeListener(AccountManagerListener listener)

Unregisters a specific listener from this AccountManager so that it no longer received notifications about events fired by this manager.

Parameters:

listener - the listener to be unregistered from this AccountManager so that it no longer receives notifications about events fired by this manager

storeAccount

void storeAccount(ProtocolProviderFactory factory,
                  AccountID accountID)
                  throws OperationFailedException

Stores an account represented in the form of an AccountID created by a specific ProtocolProviderFactory.

Parameters:

factory - the ProtocolProviderFactory which created the account to be stored

accountID - the account in the form of AccountID to be stored

Throws:

OperationFailedException - if anything goes wrong while storing the specified account

removeStoredAccount

boolean removeStoredAccount(ProtocolProviderFactory factory,
                            AccountID accountID)

Removes the account with accountID from the set of accounts that are persistently stored inside the configuration service.

Parameters:

factory - the ProtocolProviderFactory which created the account to be stored

accountID - the AccountID of the account to remove.

Returns:

true if an account has been removed and false otherwise.

getStoredAccounts

Collection<AccountID> getStoredAccounts()

Returns an Iterator over a list of all stored AccountIDs. The list of stored accounts include all registered accounts and all disabled accounts. In other words in this list we could find accounts that aren't loaded.

In order to check if an account is already loaded please use the #isAccountLoaded(AccountID accountID) method. To load an account use the #loadAccount(AccountID accountID) method.

Returns:

a Collection of all stored AccountIDs

loadAccount

void loadAccount(AccountID accountID)
                 throws OperationFailedException

Loads the account corresponding to the given AccountID. An account is loaded when its ProtocolProviderService is registered in the bundle context. This method is meant to load the account through the corresponding ProtocolProviderFactory.

Parameters:

accountID - the identifier of the account to load

Throws:

OperationFailedException - if anything goes wrong while loading the account corresponding to the specified accountID

unloadAccount

void unloadAccount(AccountID accountID)
                   throws OperationFailedException

Unloads the account corresponding to the given AccountID. An account is unloaded when its ProtocolProviderService is unregistered in the bundle context. This method is meant to unload the account through the corresponding ProtocolProviderFactory.

Parameters:

accountID - the identifier of the account to load

Throws:

OperationFailedException - if anything goes wrong while unloading the account corresponding to the specified accountID

isAccountLoaded

boolean isAccountLoaded(AccountID accountID)

Checks if the account corresponding to the given accountID is loaded. An account is loaded if its ProtocolProviderService is registered in the bundle context. By default all accounts are loaded. However the user could manually unload an account, which would be unregistered from the bundle context, but would remain in the configuration file.

Parameters:

accountID - the identifier of the account to load

Returns:

true to indicate that the account with the given accountID is loaded, false - otherwise