com.wewebu.ow.server.ecm
Interface OwAuthenticationProvider

All Known Subinterfaces:
OwNetwork

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


Method Summary
 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
 

Method Detail

getLoginSubModul

OwUILoginModul getLoginSubModul()
                                throws Exception
get an instance of the login UI submodule for user authentication Login is very specific to the provider and can not be handled generically

Returns:
OwUILoginModul OwView derived module
Throws:
Exception

getUserSelectSubModul

OwUIUserSelectModul getUserSelectSubModul(String strID_p,
                                          int[] types_p)
                                          throws Exception
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

Parameters:
strID_p - the ID of the currently set user or null if no user is selected
types_p - array of type identifiers as defined in OwUIUserSelectModul
Returns:
OwUIUserSelectModul OwView derived module
Throws:
Exception

canUserSelect

boolean canUserSelect()
                      throws Exception
check if the user select module is supported i.e. getUserSelectSubModul is implemented

Returns:
true if access rights can be edited
Throws:
Exception

getCredentials

OwCredentials getCredentials()
                             throws Exception
get the credentials of the logged in user

Returns:
the valid credentials of the logged in user, or null if not logged on
Throws:
Exception

getUserFromID

OwUserInfo getUserFromID(String strID_p)
                         throws Exception
get the user information form a User ID

Parameters:
strID_p - the ID of the searched user
Returns:
the user information object of a user
Throws:
Exception

getRoleDisplayName

String getRoleDisplayName(String strRoleName_p)
                          throws Exception
get the display name for a role name

Parameters:
strRoleName_p - to retrieve the display name for
Returns:
the display name for the role
Throws:
Exception

logout

void logout()
            throws Exception
log off and reset credentials

Throws:
Exception

loginDefault

void loginDefault(String strUser_p,
                  String strPassword_p)
                  throws Exception
log on to the provider with default configuration NOTE: The behavior of the function depends on the configuration of the ECM adapter. For a determined login use the OwUILoginModul Screen (getLoginSubModul())

Parameters:
strUser_p - String user name or name of function user or null to use a default login if available
strPassword_p - String the password for the user or null if not required
Throws:
Exception


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.