public interface OwAuthenticationProvider
Base interface for the authentication of users.
To be implemented with the specific ECM system.
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 |
---|---|
boolean |
canUserSelect()
check if the user select module is supported i.e.
|
OwCredentials |
getCredentials()
get the credentials of the logged in user
|
OwUILoginModul |
getLoginSubModul()
get an instance of the login UI submodule for user authentication
Login is very specific to the provider and can not be handled generically
|
String |
getRoleDisplayName(String strRoleName_p)
get the display name for a role name
|
OwUserInfo |
getUserFromID(String strID_p)
get the user information form a User ID
|
OwUIUserSelectModul |
getUserSelectSubModul(String strID_p,
int[] types_p)
get an instance of the user select UI submodule for selecting a user or group
User selection is very specific to the ECM System and can not be handled generically
|
void |
loginDefault(String strUser_p,
String strPassword_p)
log on to the provider with default configuration
NOTE: The behavior of the function depends on the configuration of the ECM adapter.
|
void |
logout()
log off and reset credentials
|
OwUILoginModul getLoginSubModul() throws Exception
Exception
OwUIUserSelectModul getUserSelectSubModul(String strID_p, int[] types_p) throws Exception
strID_p
- the ID of the currently set user or null if no user is selectedtypes_p
- array of type identifiers as defined in OwUIUserSelectModulException
boolean canUserSelect() throws Exception
Exception
OwCredentials getCredentials() throws Exception
Exception
OwUserInfo getUserFromID(String strID_p) throws Exception
strID_p
- the ID of the searched userException
String getRoleDisplayName(String strRoleName_p) throws Exception
strRoleName_p
- to retrieve the display name forException
void loginDefault(String strUser_p, String strPassword_p) throws Exception
strUser_p
- String user name or name of function user or null to use a default login if availablestrPassword_p
- String the password for the user or null if not requiredException
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.