public interface OwLdapSchemaInterpreter
Schema base LDAP strategy interface.
Defines OwLdapConnector
operations that are LDAP-schema dependent.
Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.
For licensing information read the license.txt file or
go to: http://wiki.alfresco.com
Modifier and Type | Method and Description |
---|---|
String |
findDistinguishedNameAnonymously(String user_p,
OwLdapConnection connection_p)
Returns the full distinguished name for the login user to use for authentication later.
|
OwObjectCollection |
findGroupsMatching(OwLdapConnection connection,
String pattern)
Search for groups that match the pattern.
|
OwUserInfo |
findUserByDNAnonymously(String strID_p,
OwLdapConnection connection)
Finds a user by its Distinguished Name.
|
OwUserInfo |
findUserByIdAnonymously(String strID_p,
OwLdapConnection connection)
Finds a user by its ID.
|
OwUserInfo |
findUserByLoginAnonymously(String strID_p,
OwLdapConnection connection) |
OwObjectCollection |
findUserMatching(OwLdapConnection connection,
String pattern) |
Collection<String> |
getAllShortGroupNames(OwLdapConnection connection_p)
Reads all groups from the LDAP (e.g.
|
String |
getRecordId(String dname,
OwLdapConnection connection) |
Collection<String> |
getShortGroupNames(OwLdapConnection connection_p)
Returns the group names of the user.
|
String |
getUserDisplayName(OwLdapConnection connection_p)
Get the user display name, or a
null value. |
String |
getUserDisplayName(String dname,
OwLdapConnection connection) |
String |
getUserId(OwLdapConnection connection_p)
Returns a unique ID of the user
|
String |
getUserLongin(String dname,
OwLdapConnection connection) |
String |
getUserLongName(OwLdapConnection connection_p)
Gets the user's long name
|
String |
getUserShortName(OwLdapConnection connection_p)
Get the user short name, or a
null value. |
void |
init(Properties ldapProperties_p,
Properties adminLdapProperties_p)
Properties initialization method used to make schema specific initializations of the directory properties
|
String findDistinguishedNameAnonymously(String user_p, OwLdapConnection connection_p) throws OwAuthenticationException, OwConfigurationException
user_p
- representing the login name for the user being searchedOwAuthenticationException
- the user that wants to login is not available in the LDAPOwConfigurationException
- possible cause: the LDAP connector is not set up correctly in the bootstrap.xml (Authentication node)Collection<String> getAllShortGroupNames(OwLdapConnection connection_p) throws OwAuthenticationException, OwConfigurationException, OwInvalidOperationException
OwAuthenticationException
- LDAP authorization ExceptionOwConfigurationException
- possible cause: the LDAP connector is not set up correctly in the bootstrap.xml (Authentication node)OwInvalidOperationException
- if the operation could no be performed due to errors during LDAP accessCollection<String> getShortGroupNames(OwLdapConnection connection_p) throws OwAuthenticationException, OwConfigurationException, OwInvalidOperationException
OwAuthenticationException
- LDAP authorization ExceptionOwInvalidOperationException
- if the operation could no be performed due to errors during LDAP accessOwConfigurationException
- possible cause: the LDAP connector is not set up correctly in the bootstrap.xml (Authentication node)String getUserDisplayName(OwLdapConnection connection_p) throws OwAuthenticationException, OwConfigurationException, OwInvalidOperationException
null
value.null
value.OwAuthenticationException
- thrown when the user is not authenticated.OwInvalidOperationException
- thrown when the "displayName" attribute cannot be resolved.OwConfigurationException
- possible cause: the LDAP connector is not set up correctly in the bootstrap.xml (Authentication node)String getUserShortName(OwLdapConnection connection_p) throws OwAuthenticationException, OwConfigurationException, OwInvalidOperationException
null
value.null
value.OwAuthenticationException
- thrown when the user is not authenticated.OwInvalidOperationException
- thrown when the "name" attribute cannot be resolved.OwConfigurationException
- possible cause: the LDAP connector is not set up correctly in the bootstrap.xml (Authentication node)String getUserLongName(OwLdapConnection connection_p) throws OwAuthenticationException, OwConfigurationException, OwInvalidOperationException
String
OwAuthenticationException
- LDAP authorization ExceptionOwInvalidOperationException
- invalid LDAP operationOwConfigurationException
- possible cause: the LDAP connector is not set up correctly in the bootstrap.xml (Authentication node)String getUserId(OwLdapConnection connection_p) throws OwAuthenticationException, OwInvalidOperationException, OwConfigurationException
String
OwAuthenticationException
- LDAP authorization ExceptionOwInvalidOperationException
- invalid LDAP operationOwConfigurationException
- possible cause: the LDAP connector is not set up correctly in the bootstrap.xml (Authentication node)void init(Properties ldapProperties_p, Properties adminLdapProperties_p) throws OwConfigurationException
ldapProperties_p
- user based propertiesadminLdapProperties_p
- admin user based propertiesOwConfigurationException
OwUserInfo findUserByDNAnonymously(String strID_p, OwLdapConnection connection) throws OwException
strID_p
- connection
- OwException
- Throws OwObjectNotFoundException if no user was found.OwUserInfo findUserByIdAnonymously(String strID_p, OwLdapConnection connection) throws OwException
strID_p
- connection
- OwException
- Throws OwObjectNotFoundException if no user was found.OwObjectCollection findUserMatching(OwLdapConnection connection, String pattern) throws OwException
connection
- pattern
- OwException
OwObjectCollection findGroupsMatching(OwLdapConnection connection, String pattern) throws OwException
connection
- pattern
- OwUserInfo
representing groups that match the pattern.OwException
String getUserDisplayName(String dname, OwLdapConnection connection) throws OwException
dname
- User DN.connection
- OwException
String getUserLongin(String dname, OwLdapConnection connection) throws OwException
dname
- connection
- OwException
String getRecordId(String dname, OwLdapConnection connection) throws OwException
dname
- connection
- OwException
OwUserInfo findUserByLoginAnonymously(String strID_p, OwLdapConnection connection) throws OwException
OwException
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.