org.norther.tammi.root.db
Interface MultiRepositoryClient

All Superinterfaces:
RepositoryClient
All Known Subinterfaces:
BeanRepositoryClient, BeanRepositoryFilter, MultiRepositoryFilter, RepositoryRealm
All Known Implementing Classes:
DefaultBeanRepositoryClient, DefaultBeanRepositoryFilter, DefaultMultiRepositoryClient, DefaultMultiRepositoryFilter, DefaultRepositoryRealm

public interface MultiRepositoryClient
extends RepositoryClient

Extends RepositoryClient by supporting multiple connections.

Version:
$Id: MultiRepositoryClient.java,v 1.15 2010-04-21 17:56:00 cvsimp Exp $
Author:
Ilkka Priha

Method Summary
 void clearConnections()
          Clears all connections.
 Set<String> connectionAliasSet()
          Returns a read-only set of defined connection aliases.
 boolean containsConnection(String alias)
          Checks the specified connection.
 String getAuthenticatedPasswordKey(String alias)
          Gets the authenticated password key of the specified connection.
 String getAuthenticatedUsernameKey(String alias)
          Gets the authenticated username key of the specified connection.
 String getAuthenticationConnectionAlias(String alias)
          Gets the authentication connection alias of the specified connection.
 String getConnectionAlias(String alias)
          Gets the specified connection of an alias.
 String getConnectionUsername(String alias)
          Gets the user's login name of the specified connection.
 String getPersisterClassName(String alias)
          Gets the class name of the persister implementation of the specified connection.
 boolean isConnectionAuthenticated(String alias)
          Checks whether authentication is configured for the specified connection.
 void removeConnection(String alias)
          Removes the specified connection.
 void setAuthenticationConnection(String alias, String auth, String userKey, String pswdKey)
          Sets authentication connection of the specified connection.
 void setConnectionAlias(String alias, String other)
          Sets an alias for the specified connection.
 void setConnectionAuthenticated(String alias, boolean authenticated)
          Sets whether authentication is configured for the specified connection.
 void setConnectionPassword(String alias, String password)
          Sets the user's credentials of the specified connection.
 void setConnectionUsername(String alias, String username)
          Sets the user's login name of the specified connection.
 void setPersisterClassName(String alias, String className)
          Sets the class name of the persister implementation of the specified connection.
 
Methods inherited from interface org.norther.tammi.root.db.RepositoryClient
acquirePersister, acquirePersister, acquirePersister, acquirePersister, acquirePersister, acquirePersister, createPermissionCriteria, createUserPermissionCriteria, createUserPermissionCriteria, createUserPermissionCriteria, getAuthenticatedPasswordKey, getAuthenticatedUsernameKey, getAuthenticationConnectionAlias, getConnection, getConnection, getConnectionAlias, getConnectionUsername, getPersisterClassName, isConnectionAuthenticated, setAuthenticationConnection, setConnectionAlias, setConnectionAuthenticated, setConnectionPassword, setConnectionUsername, setPersisterClassName
 

Method Detail

getConnectionAlias

String getConnectionAlias(String alias)
Gets the specified connection of an alias.

Parameters:
alias - the connection alias.
Returns:
the specified connection alias.

setConnectionAlias

void setConnectionAlias(String alias,
                        String other)
Sets an alias for the specified connection.

Parameters:
alias - the connection alias.
other - the specified connection alias.

getPersisterClassName

String getPersisterClassName(String alias)
Gets the class name of the persister implementation of the specified connection.

Parameters:
alias - the connection alias.
Returns:
the class name.

setPersisterClassName

void setPersisterClassName(String alias,
                           String className)
Sets the class name of the persister implementation of the specified connection.

Parameters:
alias - the connection alias.
className - the class name.

getConnectionUsername

String getConnectionUsername(String alias)
Gets the user's login name of the specified connection.

Parameters:
alias - the connection alias.
Returns:
the user's repository connection login name.

setConnectionUsername

void setConnectionUsername(String alias,
                           String username)
Sets the user's login name of the specified connection.

Parameters:
alias - the connection alias.
username - the user's repository connection login name.

setConnectionPassword

void setConnectionPassword(String alias,
                           String password)
Sets the user's credentials of the specified connection.

Parameters:
alias - the connection alias.
password - the user's repository connection credentials.

isConnectionAuthenticated

boolean isConnectionAuthenticated(String alias)
Checks whether authentication is configured for the specified connection. If username and password are not configured separately, the values passed to the client are used for the connection.

Parameters:
alias - the connection alias.
Returns:
the class name.

setConnectionAuthenticated

void setConnectionAuthenticated(String alias,
                                boolean authenticated)
Sets whether authentication is configured for the specified connection. If username and password are not configured separately, the values passed to the client are used for the connection.

Parameters:
alias - the connection alias.
authenticated - true if the connection is to be authenticated.

getAuthenticationConnectionAlias

String getAuthenticationConnectionAlias(String alias)
Gets the authentication connection alias of the specified connection.

Parameters:
alias - the connection alias.
Returns:
the authentication connection alias or null.

getAuthenticatedUsernameKey

String getAuthenticatedUsernameKey(String alias)
Gets the authenticated username key of the specified connection.

Parameters:
alias - the connection alias.
Returns:
the authenticated username key or null.

getAuthenticatedPasswordKey

String getAuthenticatedPasswordKey(String alias)
Gets the authenticated password key of the specified connection.

Parameters:
alias - the connection alias.
Returns:
the authenticated password key or null.

setAuthenticationConnection

void setAuthenticationConnection(String alias,
                                 String auth,
                                 String userKey,
                                 String pswdKey)
Sets authentication connection of the specified connection.

Parameters:
alias - the connection alias.
auth - the authentication alias.
userKey - the username key.
pswdKey - the password key.

containsConnection

boolean containsConnection(String alias)
Checks the specified connection.

Parameters:
alias - the connection alias.
Returns:
true if available, false otherwise.

removeConnection

void removeConnection(String alias)
Removes the specified connection.

Parameters:
alias - the connection alias.

clearConnections

void clearConnections()
Clears all connections.


connectionAliasSet

Set<String> connectionAliasSet()
Returns a read-only set of defined connection aliases.

Returns:
a set of connections aliases.


Copyright © 2004 The Norther Organization. All rights reserved.