RealmManager (Oracle Containers for J2EE Security Java API Reference)

Method Summary
`abstract Realm`	`createRealm(java.lang.String name, InitRealmInfo realmInfo)` Creates a Realm, it's UserManager and RoleManager using the information specified in the InitRealmInfo object.
`abstract void`	`dropRealm(Realm realm)` Drops a Realm given the realm instance.
`abstract void`	`dropRealm(java.lang.String name)` Drops a Realm of the specified name This operation will drop the entrie subtree belong the the specific realm.
`abstract Realm`	`getRealm(java.lang.String name)` Gets the Realm instance of the specified name
`static RealmManager`	`getRealmManager()` Returns an instance of RealmManager
`abstract java.util.Set`	`getRealms()` Gets all the realms registered with JAZN.

Methods inherited from class java.lang.Object

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

Constructor Detail

RealmManager

public RealmManager()

Method Detail

getRealmManager

public static RealmManager getRealmManager()

Returns an instance of RealmManager

getRealms

public abstract java.util.Set getRealms()
                                 throws JAZNException

Gets all the realms registered with JAZN.

Returns:: a set of Realm instances
Throws:: JAZNNamingException - if NamingException is encountered.; JAZNException

getRealm

public abstract Realm getRealm(java.lang.String name)
                        throws JAZNException

Gets the Realm instance of the specified name

Returns:: the Realm instance of the specified name
Throws:: JAZNNamingException - if NamingException is encountered.; JAZNException

createRealm

public abstract Realm createRealm(java.lang.String name,
                                  InitRealmInfo realmInfo)
                           throws JAZNException

Creates a Realm, it's UserManager and RoleManager using the information specified in the InitRealmInfo object. <p/> <p/> By default, the specified realm administrator will be granted the privileges to administor the realm instance. If an adminRole is specified, the administrative privileges will be granted to the adminRole instead. <p/> For a external realm: the specified users searchbase property will be used to locate the administrator with the name specified in adminUser. And the roles searchbase property will be used to locate the admin role with the the name specified in adminRole.

Parameters:: name - name of the Realm; realmInfo - an instance of InitRealmInfoy
Throws:: java.lang.SecurityException - if the caller does not have permission to invoke this method; JAZNObjectExistsException - if object of the specified name already exists.; JAZNNamingException - if a naming Exception is encountered.; JAZNException - is an exception is encountered.
See Also:: InitRealmInfo

dropRealm

public abstract void dropRealm(java.lang.String name)
                        throws JAZNException

Drops a Realm of the specified name This operation will drop the entrie subtree belong the the specific realm. If it is a subscriber realm, it will also drop the subscriber JAZNContext subtree.

Parameters:: name - realm name
Throws:: java.lang.SecurityException - if the caller does not have permission to invoke this method; JAZNObjectNotFoundException - if object of the specified name doesn't exist.; JAZNNamingException - if NamingException is encountered.; JAZNException - if an exception is encountered

dropRealm

public abstract void dropRealm(Realm realm)
                        throws JAZNException

Drops a Realm given the realm instance. This operation will drop the entrie subtree belong the the specific realm. If it is a subscriber realm, it will also drop the subscriber JAZNContext subtree.

Throws:: java.lang.SecurityException - if the caller does not have permission to invoke this method; JAZNObjectNotFoundException - if object of the specified name doesn't exist.; JAZNNamingException - if NamingException is encountered.; JAZNException - if an exception is encountered