All Frameworks Class Hierarchy This Framework Previous Indexes
CORBAServerInfra Interface CATIUExitServerSecurity
System.IUnknown
|
+---CATIUExitServerSecurity
Usage: you can freely reimplement this interface.
interface CATIUExitServerSecurity
Interface to manage the user security.
Role: This interface is a user exit. The server manager needs to
authenticate the client and to control its access.
You should implement it on the CATUExitServerSecurity component by creating
a data extension.
- See also:
- CATIUExitServerAdmin
Method Index
- o
authenticate(char*,char**,char*,CATErr*)
- Authenticates a user.
- o
check(char*,char*,char*,CATErr*)
- Check the user credential
Role: Check the credential validity of the user.
- o
isAuthorised(char*,char*,CATErr*)
- Indicates whether a user is authorized to access the application specified.
Enumerated Type Index
- o
CATErr
- Additionnal information when the methods fail.
Methods
o authenticate
public virtual HRESULT authenticate( | const char* | iUser, |
| char** | oUserCredential, |
| const char* | iUserPassword, |
| CATErr* | oReason)=0 |
-
Authenticates a user.
Role: Retrieve the user credential.
- Parameters:
-
- iUser
- The user name
- oUserCredential
- Credential that identifies the user
- iUserPassword
- The user password
- oReason
- Additional information when the return code is not S_OK
- Returns:
- E_FAIL if the user is not valid. In this case,
oUserCredential is NULL
o check
public virtual HRESULT check( | const char* | iUser, |
| const char* | iUserCredential, |
| const char* | iInfo, |
| CATErr* | oReason)=0 |
-
Check the user credential
Role: Check the credential validity of the user.
- Parameters:
-
- iUser
- The user name
- iUserCredential
- The user credential
- iInfo
- For future use. Currently set to null.
- oReason
- Additional information when the return code is not S_OK
- Returns:
- E_FAIL if iUserCredential is not valid
o isAuthorised
public virtual HRESULT isAuthorised( | const char* | iUserCredential, |
| const char* | iApplication, |
| CATErr* | oReason)=0 |
-
Indicates whether a user is authorized to access the application specified.
- Parameters:
-
- iUserCredential
- The user credential
- iApplication
- The application name
- oReason
- Additional information when the return code is not S_OK
- Returns:
- S_OK if the user is authorized and E_FAIL/S_FALSE otherwise
Enumerated Types
o CATErr
-
enum CATErr {
CATErrInvalidUser,
CATErrInvalidCredential,
CATErrInvalidApplication,
CATErrInvalidEnvironment,
CATWngCheckSystemUser,
CATErrOthers
}
Additionnal information when the methods fail.
Role: It is returned by the
authenticate,
check or
isAuthorised methods.
- Parameters:
-
- CATErrInvalidUser
- The input parameter iUser is invalid
- CATErrInvalidCredential
- The input parameter iCredentialClient is invalid
- CATErrInvalidApplication
- The input parameter iApplication is invalid
- CATErrInvalidEnvironment
- Environment variables incorrectly set.
- CATWngCheckSystemUser
- The caller wants to do a system control
- CATErrOthers
- Otherwise
This object is included in the file: CATIUExitServerSecurity.h
If needed, your Imakefile.mk should include the module: GW0EXIT