|
BEA Systems, Inc. | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object weblogic.security.acl.AbstractListableRealm
public abstract class AbstractListableRealm
The Abstract Listable realm class is used to write custom security realms.
To implement a custom realm, you should only override the methods your realm knows about. For example, if your realm does not manage ACLs, you should not provide your own implementations of the ACL methods.
This class maintains a contract with the FlatGroup class for performance and correctness. If your realm provides a group abstraction, we recommend (but do not require) that your Group objects inherit from FlatGroup.
FlatGroup
Constructor Summary | |
---|---|
protected |
AbstractListableRealm(String auditName)
Deprecated. Constructor to be called by public constructors in subclasses. |
Method Summary | |
---|---|
protected User |
authCertificates(String userName,
Vector certificates)
Deprecated. Attempt authentication based on any X.509 certificates the user has presented. |
User |
authenticate(UserInfo userInfo)
Deprecated. Check whether some User matches the presented UserInfo and accept its credentials. |
protected User |
authInternal(UserInfo userInfo)
Deprecated. The authentication dispatcher. |
protected User |
authSSLCertificates(String userName,
Vector certificates)
Deprecated. Attempt authentication based on any SSL certificates the remote client has presented. |
protected User |
authUserPassword(String userName,
String password)
Deprecated. Attempt authentication based on a user name and password. |
Acl |
getAcl(String name)
Deprecated. Retrieves an Access Control List (Acl) of that name, or null. |
Acl |
getAcl(String name,
char separator)
Deprecated. Retrieves an Access Control List (Acl) with the best matching name, or null. |
Principal |
getAclOwner(Object credential)
Deprecated. Retrieves the owner of all ACLs in a BasicRealm, or null, depending on the validity of the passed credential. |
Enumeration |
getAcls()
Deprecated. Gets an Enumeration of the Acls in a ListableRealm. |
Object |
getDelegator()
Deprecated. Return the object that is delegating to this object. |
Group |
getGroup(String name)
Deprecated. Retrieves a group of that name or null. |
Hashtable |
getGroupMembers(String name)
Deprecated. This is not a public method. |
protected Hashtable |
getGroupMembersInternal(String name)
Deprecated. Obtain the set of members of this group. |
Enumeration |
getGroups()
Deprecated. Gets an Enumeration of the Groups in a ListableRealm. |
String |
getName()
Deprecated. Gets the name of a BasicRealm. |
Permission |
getPermission(String name)
Deprecated. Retrieves a permission object of that name or, if null is passed in, returns null. |
Enumeration |
getPermissions()
Deprecated. Gets an Enumeration of the Permissions in a ListableRealm. |
User |
getUser(String name)
Deprecated. Retrieves a User by the specified name, or null. |
User |
getUser(UserInfo userInfo)
Deprecated. Deprecated in WebLogic Server 7.0. |
Enumeration |
getUsers()
Deprecated. Gets an Enumeration of the in a ListableRealm. |
void |
init(String name,
Object ownerCredential)
Deprecated. Initializes a realm implementation. |
void |
load(String name,
Object credential)
Deprecated. Loads a BasicRealm from some persistent state identified in the name. |
void |
save(String name)
Deprecated. Saves the realm to some persistent state identified in the name. |
void |
setDelegator(Object obj)
Deprecated. Set the object that is delegating to this object. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected AbstractListableRealm(String auditName)
auditName
- the name of your realm, to be used when
generating audit log eventsMethod Detail |
---|
public void init(String name, Object ownerCredential) throws NotOwnerException
init
in interface BasicRealm
name
- Name of RealmownerCredential
- Credentialed owner of a BasicRealm
NotOwnerException
- if
the owner credential is invalidpublic String getName()
getName
in interface BasicRealm
public User getUser(String name)
getUser
in interface BasicRealm
name
- User name
public User getUser(UserInfo userInfo)
getUser
in interface BasicRealm
userInfo
- Credentials to check against
public User authenticate(UserInfo userInfo)
By default, this implementation calls the authInternal method, and performs an audit log of the result.
userInfo
- Credentials to check against
AbstractListableRealm.authInternal(UserInfo userInfo)
protected User authInternal(UserInfo userInfo)
userInfo
- authentication information
AbstractListableRealm.authCertificates(java.lang.String, java.util.Vector)
,
AbstractListableRealm.authUserPassword(java.lang.String, java.lang.String)
,
AbstractListableRealm.authSSLCertificates(java.lang.String, java.util.Vector)
protected User authCertificates(String userName, Vector certificates)
The default implementation of this method calls CertAuthentication.authenticate.
userName
- the name of the usercertificates
- a vector containing X509 objects
CertAuthentication.authenticate(java.lang.String, java.util.Vector, boolean)
protected User authSSLCertificates(String userName, Vector certificates)
The default implementation of this method calls CertAuthentication.authenticate.
userName
- the name of the usercertificates
- a vector containing X509 objects
AbstractListableRealm.authCertificates(java.lang.String, java.util.Vector)
protected User authUserPassword(String userName, String password)
The default implementation of this method always returns null.
userName
- the name of the userpassword
- the user's plain text password
public Principal getAclOwner(Object credential)
getAclOwner
in interface BasicRealm
credential
- Credentials of an owner
public Hashtable getGroupMembers(String name)
This method tries to look for a cached Group object that has the given name. If it finds it and the object has a set of members, it returns those members. Otherwise, it calls the getGroupMembersInternal method.
getGroupMembers
in interface FlatGroup.Source
name
- the group for which to obtain membership
information
FlatGroup
,
AbstractListableRealm.getGroupMembersInternal(String name)
protected Hashtable getGroupMembersInternal(String name)
Principal
public Group getGroup(String name)
getGroup
in interface BasicRealm
name
- Name of group
public Acl getAcl(String name)
getAcl
in interface BasicRealm
name
- Name of ACL associated with a BasicRealm
public Acl getAcl(String name, char separator)
getAcl
in interface BasicRealm
name
- Name of the Acl to retrieveseparator
- Character separator
public Permission getPermission(String name)
getPermission
in interface BasicRealm
name
- Name of permission to retrieve
public void load(String name, Object credential) throws ClassNotFoundException, IOException, NotOwnerException
load
in interface BasicRealm
name
- Name of BasicRealm to loadcredential
- Credentialed owner of a BasicRealm
ClassNotFoundException
- if the BasicRealm cannot be found
IOException
- if there is an I/O error
NotOwnerException
- if the credential does not match an ownerpublic void save(String name) throws IOException
save
in interface BasicRealm
name
- Name to save under
IOException
- if there is an I/O errorpublic Enumeration getUsers()
getUsers
in interface ListableRealm
public Enumeration getGroups()
getGroups
in interface ListableRealm
public Enumeration getAcls()
getAcls
in interface ListableRealm
public Enumeration getPermissions()
getPermissions
in interface ListableRealm
public void setDelegator(Object obj)
public Object getDelegator()
|
Documentation is available at http://download.oracle.com/docs/cd/E13222_01/wls/docs92 Copyright 2006 BEA Systems Inc. |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |