com.hcl.domino.admin

Interface AdministrationProcess

All Superinterfaces:

DominoClientDescendant

public interface AdministrationProcess
extends DominoClientDescendant

Represents the administration process

Field Summary

Fields

Modifier and Type	Field and Description
static int	IDVAULT_DELETE
static int	IDVAULT_MARK_AS_INACTIVE
static int	IDVAULT_RETAIN
static int	MAILFILE_DELETE_ALL
static int	MAILFILE_DELETE_HOME
static int	MAILFILE_DELETE_NONE
static int	PWD_CHK_CHECKPASSWORD
static int	PWD_CHK_DONTCHECKPASSWORD
static int	PWD_CHK_LOCKOUT

Method Summary

Modifier and Type	Method and Description
Optional<Integer>	addGroupMembers(String group, Collection<String> members) Enters a request in the Administration Requests database to add members to a new or existing a group.
int	addServerToCluster(String server, String cluster) Enters a request in the Administration Requests database to add a server to a cluster.
Optional<Integer>	changeHTTPPassword(String username, String oldpassword, String newpassword) Enters a request in the Administration Requests database to change a user's Internet password.
String	getCertificateAuthorityOrg()
DominoDateTime	getCertificateExpiration()
String	getCertifierFile()
String	getCertifierPassword()
String	getServer()
boolean	isCertificateAuthorityAvailable()
boolean	isUseCertificateAuthority()
int	removeServerFromCluster(String server) Enters a request in the Administration Requests database to remove a server from a cluster.
int	renameGroup(String group, String newgroup) Enters a request in the Administration Requests database to rename a group.
void	setCertificateAuthorityOrg(String caa)
void	setCertificateExpiration(Temporal ce)
void	setCertifierFile(String cf)
void	setCertifierPassword(String cf)
void	setUseCertificateAuthority(boolean uca)

Methods inherited from interface com.hcl.domino.misc.DominoClientDescendant

getParentDominoClient

Field Detail

MAILFILE_DELETE_NONE

static final int MAILFILE_DELETE_NONE

See Also:

Constant Field Values

MAILFILE_DELETE_HOME

static final int MAILFILE_DELETE_HOME

See Also:

Constant Field Values

MAILFILE_DELETE_ALL

static final int MAILFILE_DELETE_ALL

See Also:

Constant Field Values

PWD_CHK_DONTCHECKPASSWORD

static final int PWD_CHK_DONTCHECKPASSWORD

See Also:

Constant Field Values

PWD_CHK_CHECKPASSWORD

static final int PWD_CHK_CHECKPASSWORD

See Also:

Constant Field Values

PWD_CHK_LOCKOUT

static final int PWD_CHK_LOCKOUT

See Also:

Constant Field Values

IDVAULT_MARK_AS_INACTIVE

static final int IDVAULT_MARK_AS_INACTIVE

See Also:

Constant Field Values

IDVAULT_DELETE

static final int IDVAULT_DELETE

See Also:

Constant Field Values

IDVAULT_RETAIN

static final int IDVAULT_RETAIN

See Also:

Constant Field Values

Method Detail

getServer

String getServer()

getCertificateAuthorityOrg

String getCertificateAuthorityOrg()

setCertificateAuthorityOrg

void setCertificateAuthorityOrg(String caa)

getCertificateExpiration

DominoDateTime getCertificateExpiration()

setCertificateExpiration

void setCertificateExpiration(Temporal ce)

getCertifierFile

String getCertifierFile()

setCertifierFile

void setCertifierFile(String cf)

getCertifierPassword

String getCertifierPassword()

setCertifierPassword

void setCertifierPassword(String cf)

isCertificateAuthorityAvailable

boolean isCertificateAuthorityAvailable()

isUseCertificateAuthority

boolean isUseCertificateAuthority()

setUseCertificateAuthority

void setUseCertificateAuthority(boolean uca)

addGroupMembers

Optional<Integer> addGroupMembers(String group,
                                  Collection<String> members)

Enters a request in the Administration Requests database to add members to a new or existing a group.

Parameters:

group - The name of the group

members - The name of the group

Returns:

The note ID of an entry created in the Administration Requests database

changeHTTPPassword

Optional<Integer> changeHTTPPassword(String username,
                                     String oldpassword,
                                     String newpassword)

Enters a request in the Administration Requests database to change a user's Internet password.

Parameters:

username - The full hierarchical name (can be abbreviated) of the user.

oldpassword - The existing password

newpassword - The new password

Returns:

note id The note ID of an entry created in the Administration Requests database

renameGroup

int renameGroup(String group,
                String newgroup)

Enters a request in the Administration Requests database to rename a group.

Parameters:

group - The name of the group.

newgroup - The new name of the group.

Returns:

The note ID of an entry created in the Administration Requests database.

addServerToCluster

int addServerToCluster(String server,
                       String cluster)

Enters a request in the Administration Requests database to add a server to a cluster.

Parameters:

server - The full hierarchical name (can be abbreviated) of the server.

cluster - The name of the cluster.

Returns:

The note ID of an entry created in the Administration Requests database.

removeServerFromCluster

int removeServerFromCluster(String server)

Enters a request in the Administration Requests database to remove a server from a cluster.

Parameters:

server - The name of the server.

Returns:

The note ID of an entry created in the Administration Requests database.