| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Abstact class to get list of users/groups and authenticate them. Implementations of this could be text file, LDAP, NIS, NT Domains..............
| Field Summary | |
| static int | MAIL_ATTRIBUTE | 
| static int | NAME_ATTRIBUTE | 
| static int | UID_ATTRIBUTE | 
| Method Summary | |
|  CollaborationPrincipal | authenticate(java.lang.String uid,
             java.lang.String pass)autheticate a user | 
|  boolean | changeUserPassword(java.lang.String uid,
                   java.lang.String password)changes a user's password | 
|  CollaborationPrincipal | createUser(java.lang.String uid,
           java.lang.String password,
           java.util.Map attributes)adds a new user to the realm | 
|  CollaborationPrincipal[] | expandGroup(CollaborationPrincipal principal,
            CollaborationGroup g)expand the contents of a group | 
|  ConferenceStore | getConferenceStore()returns a handle to a conference storage provider | 
|  java.lang.String | getDomainName(java.lang.String searchBase)returns a domain name associated with a scope For instance in the case of an LDAP realm, it would be the domain name associated with an organization. | 
|  CollaborationGroup | getGroup(CollaborationPrincipal principal,
         java.lang.String gid)retrieve a group based on its unique identifier | 
|  NewsStorageProvider | getNewsStorageProvider()returns a handle to a conference storage provider | 
|  PolicyProvider | getPolicyProvider()returns a handle to a policy provider associated with this Realm. | 
|  CollaborationPrincipal | getPrincipal(CollaborationPrincipal principal,
             java.lang.String uid)get a CollaborationPrincipal from the uid | 
|  CollaborationPrincipal | getPrincipal(java.lang.String searchBase,
             java.lang.String uid) | 
|  java.lang.String | getSearchBase(java.lang.String domainName)returns a search base or scope associated with a DNS domain identifier. | 
|  java.lang.String | getUserPassword(CollaborationPrincipal principal)Retrieve a user password. | 
|  UserSettingsStorageProvider | getUserSettingsStorageProvider()returns a handle to a user settings storage provider | 
|  boolean | ignoreDomains()get the ignoredomains value | 
|  boolean | isMemberOfGroup(CollaborationPrincipal p,
                CollaborationGroup g)returns true if a principal is member of a group | 
|  void | removeUser(java.lang.String uid)removes a user from the realm | 
|  RealmSearchResults | search(CollaborationPrincipal principal,
       java.lang.String pattern,
       int attributeType,
       java.lang.String filter)search for users | 
|  RealmSearchResults | search(java.lang.String searchFilter,
       java.lang.String scope)search for users | 
|  RealmSearchResults | search(java.lang.String base,
       java.lang.String pattern,
       int attributeType,
       java.lang.String filter)search for users | 
|  void | stop()stop the realm | 
| Field Detail | 
public static final int NAME_ATTRIBUTE
public static final int UID_ATTRIBUTE
public static final int MAIL_ATTRIBUTE
| Method Detail | 
public void stop()
public CollaborationPrincipal getPrincipal(CollaborationPrincipal principal,
                                           java.lang.String uid)
                                    throws RealmException
uid - principal - principal making the request
com.iplanet.im.server.RealmException
RealmException
public CollaborationPrincipal getPrincipal(java.lang.String searchBase,
                                           java.lang.String uid)
                                    throws RealmException
RealmException
public CollaborationPrincipal createUser(java.lang.String uid,
                                         java.lang.String password,
                                         java.util.Map attributes)
                                  throws RealmException
uid - user ID (fully-quaslified)password - user passwordattributes - user attributes.
RealmException
public void removeUser(java.lang.String uid)
                throws RealmException
uid - user ID (fully-quaslified)
RealmException
public boolean changeUserPassword(java.lang.String uid,
                                  java.lang.String password)
                           throws RealmException
uid - user ID (fully-qualified)password - new user password
RealmExceptionpublic java.lang.String getUserPassword(CollaborationPrincipal principal)
principal - The principal whose password is required
public CollaborationGroup getGroup(CollaborationPrincipal principal,
                                   java.lang.String gid)
                            throws RealmException
gid - group identifierprincipal - principal making the request
com.iplanet.im.server.RealmException
RealmException
public CollaborationPrincipal[] expandGroup(CollaborationPrincipal principal,
                                            CollaborationGroup g)
                                     throws RealmException
g - principal - principal making the request
com.iplanet.im.server.RealmException
RealmException
public RealmSearchResults search(CollaborationPrincipal principal,
                                 java.lang.String pattern,
                                 int attributeType,
                                 java.lang.String filter)
                          throws RealmException
principal - principal making the requestpattern - search patternfilter - search filterattributeType - one of NAME_ATTRIBUTE, UID_ATTRIBUTE, 
 or MAIL_ATTRIBUTE
RealmException
public RealmSearchResults search(java.lang.String base,
                                 java.lang.String pattern,
                                 int attributeType,
                                 java.lang.String filter)
                          throws RealmException
base - search basepattern - search patternfilter - search filterattributeType - one of NAME_ATTRIBUTE, UID_ATTRIBUTE, 
 or MAIL_ATTRIBUTE
RealmException
public RealmSearchResults search(java.lang.String searchFilter,
                                 java.lang.String scope)
                          throws RealmException
searchFilter - search filterscope - search base
RealmException
public CollaborationPrincipal authenticate(java.lang.String uid,
                                           java.lang.String pass)
                                    throws RealmException
uid - login idpass - password
RealmException
public boolean isMemberOfGroup(CollaborationPrincipal p,
                               CollaborationGroup g)
                        throws RealmException
p - principal to locate in the groupg - group object
RealmException
public java.lang.String getSearchBase(java.lang.String domainName)
                               throws RealmException
domainName - DNS domain name
RealmException
public java.lang.String getDomainName(java.lang.String searchBase)
                               throws RealmException
searchBase - -search scope
RealmExceptionpublic UserSettingsStorageProvider getUserSettingsStorageProvider()
UserSettingsStorageProviderpublic ConferenceStore getConferenceStore()
ConferenceStorageProviderpublic NewsStorageProvider getNewsStorageProvider()
NewsStorageProviderpublic PolicyProvider getPolicyProvider()
NewsStorageProviderpublic boolean ignoreDomains()
| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||