Package org.apache.directory.fortress.core

Class AdminMgrFactory

java.lang.Object

org.apache.directory.fortress.core.AdminMgrFactory

public final class AdminMgrFactory
extends Object

Creates an instance of the AdminMgr object. The factory allows deployments of Fortress override the default AdminMgrImpl component with another.

The default class is specified as AdminMgrImpl but can be overridden by adding the GlobalIds.ADMIN_IMPLEMENTATION config property.

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor	Description
AdminMgrFactory()

Method Summary

Modifier and Type	Method	Description
static AdminMgr	createInstance()	Create and return a reference to AdminMgr object using HOME context.
static AdminMgr	createInstance(String contextId)	Create and return a reference to AdminMgr object.
static AdminMgr	createInstance(String contextId, Session adminSess)	Create and return a reference to AdminMgr object.
static AdminMgr	createInstance(Session adminSess)	Create and return a reference to AdminMgr object using HOME context.

Methods inherited from class java.lang.Object

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

Constructor Detail

AdminMgrFactory

public AdminMgrFactory()

Method Detail

createInstance

public static AdminMgr createInstance()
                               throws SecurityException

Create and return a reference to AdminMgr object using HOME context.

Returns:

instance of AdminMgr.

Throws:

SecurityException - in the event of failure during instantiation.

createInstance

public static AdminMgr createInstance(String contextId)
                               throws SecurityException

Create and return a reference to AdminMgr object.

Parameters:

contextId - maps to sub-tree in DIT, e.g. ou=contextId, dc=example, dc=com.

Returns:

instance of AdminMgr.

Throws:

SecurityException - in the event of failure during instantiation.

createInstance

public static AdminMgr createInstance(Session adminSess)
                               throws SecurityException

Create and return a reference to AdminMgr object using HOME context.

Parameters:

adminSess - contains a valid Fortress A/RBAC Session object.

Returns:

instance of AdminMgr.

Throws:

SecurityException - in the event of failure during instantiation.

createInstance

public static AdminMgr createInstance(String contextId,
                                      Session adminSess)
                               throws SecurityException

Create and return a reference to AdminMgr object.

Parameters:

contextId - maps to sub-tree in DIT, e.g. ou=contextId, dc=example, dc=com.

adminSess - contains a valid Fortress A/RBAC Session object.

Returns:

instance of AdminMgr.

Throws:

SecurityException - in the event of failure during instantiation.