com.hcl.domino.keep.admin

Class AbstractAsyncDominoDirectory

java.lang.Object

com.hcl.domino.keep.dbrequests.AsyncDominoJNX<io.vertx.core.json.JsonObject>

com.hcl.domino.keep.dbrequests.AsyncDominoJNXJson

com.hcl.domino.keep.admin.AbstractAsyncDominoAdmin

com.hcl.domino.keep.admin.AbstractAsyncDominoDirectory

All Implemented Interfaces:

AsyncDominoBase<io.vertx.core.json.JsonObject>, KeepSubscriberInfo, io.reactivex.ObservableOnSubscribe<io.vertx.core.json.JsonObject>

Direct Known Subclasses:

CreateDirectoryAssistance, DeleteDirectoryAssistance, DeleteGroup, GetDirectoryAssistance, GetGroup, GetGroupByName, UpdateDirectoryAssistance, UpdateGroup, UpdateGroupMembers

public abstract class AbstractAsyncDominoDirectory
extends AbstractAsyncDominoAdmin

Abstract class for checking Domino Directory access

Nested Class Summary

Nested classes/interfaces inherited from interface com.hcl.domino.keep.dbrequests.AsyncDominoBase

AsyncDominoBase.RequestType

Field Summary

Fields inherited from class com.hcl.domino.keep.dbrequests.AsyncDominoJNX

apiName, appTags, logger, requestParams, UNNEEDED_CALL, user, vertx

Constructor Summary

Constructors

Constructor and Description
AbstractAsyncDominoDirectory()

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.lang.String>	getAllGroups(KeepJnxSession s, com.hcl.domino.data.Database db, boolean denyGroup) Builds a Map of all groups, allowing easy access to retrieve members
protected java.lang.String	getDirectoryAssistanceDB(DbRequestParameters<io.vertx.core.json.JsonObject> request) This will read the Server Form to get the MasterAddressBook
protected DirectoryAssistance	getDirectoryAssistanceFromNote(com.hcl.domino.data.Document doc) Converts a DirectoryAssistance document to a DirectoryAssistance object
protected Group	getGroupFromNote(com.hcl.domino.data.Document doc) Converts a Group document to a Group object
protected java.util.List<java.lang.String>	validateAndUpdateGroupMembers(KeepJnxSession s, com.hcl.domino.data.Database db, java.lang.String unid, java.lang.String memberType, java.util.List<java.lang.String> members, java.lang.String addRemoveType)

Methods inherited from class com.hcl.domino.keep.admin.AbstractAsyncDominoAdmin

getKeepDbInfo, setKeepDbInfo, subscribe

Methods inherited from class com.hcl.domino.keep.dbrequests.AsyncDominoJNXJson

getDbRequestParameters

Methods inherited from class com.hcl.domino.keep.dbrequests.AsyncDominoJNX

accessControlCheck, dontCallProcessPayload, emitterToObserver, getActualDatabaseName, getApiName, getAppTags, getBarbican, getEventbusId, getRequestType, getSubscriber, getUser, getUserForMetrics, isProcessPayloadRequired, isWorkInProgress, processDominoRequest, recordAppMetrics, setApiName, setBarbican, setDbFileName, setProcessPayloadRequired, setRequestParams, setRequestType, setSubscriber, setUser, setVertx, validateDqlAccess, validateOpenAccess, validationCheck

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.hcl.domino.keep.dbrequests.AsyncDominoBase

customValidator, preflight, process

Constructor Detail

AbstractAsyncDominoDirectory

public AbstractAsyncDominoDirectory()

Method Detail

getAllGroups

protected java.util.Map<java.lang.String,java.lang.String> getAllGroups(KeepJnxSession s,
                                                                        com.hcl.domino.data.Database db,
                                                                        boolean denyGroup)
                                                                 throws KeepExceptionInsufficientAccess

Builds a Map of all groups, allowing easy access to retrieve members

Parameters:

s -

• KeepJnxSession for current user

db -

• database used as starting point for query

denyGroup -

• whether GroupType is @link{com.hcl.domino.admin.Group.GroupType#DENY_ACCESS}

Returns:

Map of all groups

Throws:

KeepExceptionInsufficientAccess - error if the user doesn’t have access to database

getDirectoryAssistanceDB

protected java.lang.String getDirectoryAssistanceDB(DbRequestParameters<io.vertx.core.json.JsonObject> request)
                                             throws KeepExceptionNotFound

This will read the Server Form to get the MasterAddressBook

Parameters:

request -

Returns:

MasterAddressBook came from document

Throws:

KeepExceptionNotFound

getDirectoryAssistanceFromNote

protected DirectoryAssistance getDirectoryAssistanceFromNote(com.hcl.domino.data.Document doc)

Converts a DirectoryAssistance document to a DirectoryAssistance object

Parameters:

doc - document to convert

Returns:

DirectoryAssistanceLdap or DirectoryAssistanceNotes, depending on whether domain type set

getGroupFromNote

protected Group getGroupFromNote(com.hcl.domino.data.Document doc)

Converts a Group document to a Group object

Parameters:

doc - document to convert

Returns:

GroupAuto or GroupManual, depending on whether AutoPopulate method is set

validateAndUpdateGroupMembers

protected java.util.List<java.lang.String> validateAndUpdateGroupMembers(KeepJnxSession s,
                                                                         com.hcl.domino.data.Database db,
                                                                         java.lang.String unid,
                                                                         java.lang.String memberType,
                                                                         java.util.List<java.lang.String> members,
                                                                         java.lang.String addRemoveType)
                                                                  throws KeepException

Throws:

KeepException