Package org.apache.fulcrum.security.torque.peer

Interface PeerManager

All Superinterfaces:

Serializable

All Known Implementing Classes:

PeerManagerDefaultImpl

public interface PeerManager
extends Serializable

Use this manager in role-list, if you want to swap default peer classes. It gets automatically registered in TorqueTurbine<Type>ManagerImpl classes. <Types> are: <User>, <Group>, <Permission>, <Role>. You have to register your <Type>PeerImpl classes by adding the TorqueTurbinePeer interface. If generating your ORM-classes from a Torque schema, you may have to delete or provide your own baseClasses in the schema.

Version:

$Id$

Author:

Georg Kallidis

See Also:

Torque 4.0 Schema, TorqueTurbineTypeManagerImpl referencing manager classes.

Field Summary

Fields

Modifier and Type	Field	Description
static String	ROLE

Method Summary

Modifier and Type	Method	Description
<P extends Peer> P	getPeerInstance(String peerClassName)	Expects the class name of a Torque Peer class, which could be instantiated.
<P extends Peer> P	getPeerInstance(String peerClassName, Class<? extends Peer> class1, String className)	This method is provided to get more helpful exception messages.

Field Detail

ROLE

static final String ROLE

Method Detail

getPeerInstance

<P extends Peer> P getPeerInstance(String peerClassName)
                            throws DataBackendException

Expects the class name of a Torque Peer class, which could be instantiated. AbstractEntityManager.getClassName()

Parameters:

peerClassName - the peerClassName

Returns:

a cached peer class instance

Throws:

DataBackendException - data backend exception

getPeerInstance

<P extends Peer> P getPeerInstance(String peerClassName,
                                   Class<? extends Peer> class1,
                                   String className)
                            throws DataBackendException

This method is provided to get more helpful exception messages.

Parameters:

peerClassName - the peerClassName

class1 - expected class the peers should implement

className - target class, i.e. the data object class type of the Peer object. The data object for which the peer is provided.

Returns:

peer instance

Throws:

DataBackendException - data backend exception