Common Methods

This section introduces and briefly describes the following methods that are implemented in all CCM Card and Credential Management components:

  • CredentialManager

  • UserManager

  • WalletManager

  • SecurityModuleManager

  • SynchronizationManager

Note: For related error codes, see Maximum Session Error Codes. For specific error codes, see Communication and Connectivity Error Codes.
Note: This section is not intended to be a replacement for the Javadoc. For a comprehensive list of all classes, methods, interfaces, and constants, refer to the Javadoc.

Closes the current session with this component.

For Java:

Copy 
void closeSession(void) throws SessionException, LocalizedRemoteException;

For C++:

Copy 
void closeSession(void);

Exceptions:

  • SessionException—if the session was invalid for whatever reason (such as expired or never opened).

  • LocalizedRemoteException— (thrown by the Web service layer) only when the most severe, unexpected, SOAP-level failures occur.

This method exposes the following information:

  • A list of login information where each entry represents a login attempt and includes the following:

  • Whether it was successful or not.

  • The date/time at which it occurred.

  • The authenticated subject, which contains a list of principals representing the identities of the authenticated subject. These identities are:

  • The subject’s DN (if available—otherwise user DN).

  • The subject’s user ID (if available—otherwise user ID).

  • The roles configured for the subject.

For Java:

Copy 
SessionInfo getSessionInfo() 
Throws LocalizedRemoteException, SessionException

For C++:

Copy 
SessionInfo *getSessionInfo();

Returns:

Session information that is contained in the SessionInfo.

Exceptions:

  • SessionException—if there is no valid session (such as session not opened or timed out).

  • LocalizedRemoteException— (thrown by the Web service layer) only when the most severe, unexpected, SOAP-level failures occur.

Returns version information for the client and server.

For Java:

Copy 
String getVersion(void)
throws LocalizedRemoteException;

For C++:

Copy 
TString getVersion(void);

Returns:

The version of this component.

Exceptions:

LocalizedRemoteException— (thrown by the Web service layer) only when the most severe, unexpected, SOAP-level failures occur.

Returns true after successful login and if the ActivID CMS session has not expired or been logged out (CMS session validity); otherwise returns false.

For Java:

Copy 
boolean isSessionOpen(void) 
throws SessionException, LocalizedRemoteException;

For C++:

Copy 
bool isSessionOpen(void);

Returns:

true if a session is currently open; otherwise, it returns false.

Exceptions:

  • SessionException—if there is no valid session (such as session not opened or timed out).

  • LocalizedRemoteException — (thrown by the Web service layer) only when the most severe, unexpected, SOAP-level failures occur.

Opens a new session with this component.

For Java:

Copy 
String openSession (Parameter[] parameters)
throws SessionException, LocalizedRemoteException;

For C++:

Copy 
TString openSession(ParameterVector *parameters);

Parameters:

parameters—reserved for future use.

Returns:

The ID of the session opened by the server.

Exceptions:

  • SessionException—if there is no valid session (such as session not opened or timed out).

  • LocalizedRemoteException— (thrown by the Web service layer) only when the most severe, unexpected, SOAP-level failures occur.