com.hcl.domino.admin.idvault

Interface IdVault

public interface IdVault

Access to all id and cert operations

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IdVault.IDAccessCallback<T> Callback interface to work with an opened ID
static class	IdVault.IdFlag Flags of a User ID
static interface	IdVault.SyncResult

Method Summary

Modifier and Type	Method and Description
void	changeIdPassword(Path idPath, String oldPassword, String newPassword) This function changes the password in the specified ID file. You can use this function to change the password in a user's id, a server's id, or a certifier's id. Multiple passwords are not supported.
void	checkIdPassword(Path idPath, String password) The method tries to open the ID with the specified password.
String	extractUserIdFromVault(String userName, String password, Path idPath, String serverName) Will contact the server and locate a vault for userName. Then extract the ID file from the vault and write it to idPath. If successful returns with the vault server name.
Set<IdVault.IdFlag>	getIdFlags() Returns flags for the ID that is active for the current process
Set<IdVault.IdFlag>	getIDFlags(UserId userId) Returns flags for the specified ID file
UserId	getUserIdFromVault(String userName, String password, String serverName) Will contact the server and locate a vault for userName. Then downloads the ID file from the vault and store it in memory.
UserId	getUserIdWithToken(Object token, String serverName) Will contact the server and retrieves the UserId associated with the provided implementation-specific token.
String	getUsernameFromId(Path idPath) This function will extract the username from an ID file.
boolean	isIdInVault(String userName, String server) Checks if the ID vault on the specified server contains an ID for a user
<T> T	openUserIdFile(Path idPath, String password, IdVault.IDAccessCallback<T> callback) Opens an ID file and returns an in-memory handle for signing (Document.sign(UserId, boolean)) and using note encrypting (Document.copyAndEncrypt(UserId, java.util.Collection) / Document.decrypt(UserId)).
String	putUserIdIntoVault(String userName, String password, Path idPath, String serverName) Will open the ID file name provided, locate a vault server for user userName, upload the ID file contents to the vault, then return with the vault server name.
String	putUserIdIntoVault(String userName, String password, UserId userId, String serverName) Will locate a vault server for user userName and upload the specified ID contents to the vault, then return with the vault server name.
void	resetUserPasswordInVault(String server, String userName, String password, int downloadCount) Resets an ID password.
IdVault.SyncResult	syncUserIdWithVault(String userName, String password, Path idPath, String serverName) Will open the ID file name provided, locate a vault server, synch the ID file contents to the vault, then return the synched content.

Method Detail

extractUserIdFromVault

String extractUserIdFromVault(String userName,
                              String password,
                              Path idPath,
                              String serverName)

Will contact the server and locate a vault for userName.
Then extract the ID file from the vault and write it to idPath.

If successful returns with the vault server name.

Parameters:

userName - Name of user whose ID is being put into vault - either abbreviated or canonical format

password - Password to id file being uploaded to the vault

idPath - Path to where the download ID file should be created or overwritten

serverName - Name of server to contact

Returns:

the vault server name

Throws:

DominoException - in case of problems, e.g. ERR 22792 Wrong Password

getUserIdFromVault

UserId getUserIdFromVault(String userName,
                          String password,
                          String serverName)

Will contact the server and locate a vault for userName.
Then downloads the ID file from the vault and store it in memory.

Parameters:

userName - Name of user whose ID is being put into vault - either abbreviated or canonical format

password - Password to id file being uploaded to the vault

serverName - Name of server to contact

Returns:

the in-memory user id

Throws:

DominoException - in case of problems, e.g. ERR 22792 Wrong Password

getUserIdWithToken

UserId getUserIdWithToken(Object token,
                          String serverName)

Will contact the server and retrieves the UserId associated with the provided implementation-specific token.

Parameters:

token - the token to use to retrieve the ID. The class of the token depends on the available vault provider implementations

serverName - the name of the server to contact

Returns:

the in-memory user ID

Throws:

UnsupportedOperationException - when no provider can be found to handle token

Since:

1.0.19

putUserIdIntoVault

String putUserIdIntoVault(String userName,
                          String password,
                          Path idPath,
                          String serverName)

Will open the ID file name provided, locate a vault server for user userName, upload the ID file contents to the vault, then return with the vault server name.

Parameters:

userName - Name of user whose ID is being put into vault - either abbreviated or canonical format

password - Password to id file being uploaded to the vault

idPath - Path to where the download ID file should be created or overwritten

serverName - Name of server to contact

Returns:

the vault server name

Throws:

DominoException - in case of problems, e.g. ERR 22792 Wrong Password

putUserIdIntoVault

String putUserIdIntoVault(String userName,
                          String password,
                          UserId userId,
                          String serverName)

Will locate a vault server for user userName and upload the specified ID contents to the vault, then return with the vault server name.

Parameters:

userName - Name of user whose ID is being put into vault - either abbreviated or canonical format

password - Password to id file being uploaded to the vault

userId - user id

serverName - Name of server to contact

Returns:

the vault server name

Throws:

DominoException - in case of problems, e.g. ERR 22792 Wrong Password

syncUserIdWithVault

IdVault.SyncResult syncUserIdWithVault(String userName,
                                       String password,
                                       Path idPath,
                                       String serverName)

Will open the ID file name provided, locate a vault server, synch the ID file contents to the vault, then return the synched content. If successful the vault server name is returned.

Parameters:

userName - Name of user whose ID is being put into vault - either abbreviated or canonical format

password - Password to id file being uploaded to the vault

idPath - Path to where the download ID file should be created or overwritten

serverName - Name of server to contact

Returns:

sync result

resetUserPasswordInVault

void resetUserPasswordInVault(String server,
                              String userName,
                              String password,
                              int downloadCount)

Resets an ID password. This password is required by the user when they recover their ID file from the ID vault.

Parameters:

server - Name of server to contact to request the password reset. Can be NULL if executed from a program or agent on a server. Does NOT have to be a vault server. But must be running Domino 8.5 or later.

userName - Name of user to reset their vault id file password.

password - New password to set in the vault record for pUserName.

downloadCount - (max. 65535) If this user's effective policy setting document has "allow automatic ID downloads" set to no, then this parameter specifies how many downloads the user can now perform. If downloads are automatic this setting should be zero.

changeIdPassword

void changeIdPassword(Path idPath,
                      String oldPassword,
                      String newPassword)

This function changes the password in the specified ID file.
You can use this function to change the password in a user's id, a server's id, or a certifier's id.

Multiple passwords are not supported.

Parameters:

idPath - path to the ID file whose password should be changed

oldPassword - old password in the ID file. This parameter can only be NULL if there is no old password. If this parameter is set to "", then ERR_BSAFE_NULLPARAM is returned

newPassword - new password on the ID file. If this parameter is NULL, the password is cleared. If the specified ID file requires a password and this parameter is NULL, then ERR_BSAFE_PASSWORD_REQUIRED is returned. If this parameter is set to "", then ERR_BSAFE_NULLPARAM is returned. If the specified ID file is set for a minimum password length and this string contains less than that minimum, then ERR_REG_MINPSWDCHARS is returned.

checkIdPassword

void checkIdPassword(Path idPath,
                     String password)

The method tries to open the ID with the specified password. If the password is not correct, the method tries a DominoException

Parameters:

idPath - id path

password - password

Throws:

DominoException - e.g. ERR 6408 if password is incorrect

getUsernameFromId

String getUsernameFromId(Path idPath)

This function will extract the username from an ID file.

Parameters:

idPath - id path

Returns:

canonical username

openUserIdFile

<T> T openUserIdFile(Path idPath,
                     String password,
                     IdVault.IDAccessCallback<T> callback)

Opens an ID file and returns an in-memory handle for signing (Document.sign(UserId, boolean)) and using note encrypting (Document.copyAndEncrypt(UserId, java.util.Collection) / Document.decrypt(UserId)).

Type Parameters:

T - optional result type

Parameters:

idPath - id path on disk

password - id password

callback - callback code to access the opened ID; we automatically close the ID file when the callback invocation is done

Returns:

optional computation result

isIdInVault

boolean isIdInVault(String userName,
                    String server)

Checks if the ID vault on the specified server contains an ID for a user

Parameters:

userName - user to check

server - server

Returns:

true if ID is in vault

getIdFlags

Set<IdVault.IdFlag> getIdFlags()

Returns flags for the ID that is active for the current process

Returns:

flags

getIDFlags

Set<IdVault.IdFlag> getIDFlags(UserId userId)

Returns flags for the specified ID file

Parameters:

userId - user id, use null for the ID that is active for the current process

Returns:

flags