com.hcl.domino.admin

Class AbstractGroup

java.lang.Object

com.hcl.domino.admin.AbstractGroup

All Implemented Interfaces:

Group

Direct Known Subclasses:

GroupAuto, GroupManual

public abstract class AbstractGroup
extends java.lang.Object
implements Group

Nested Class Summary

Nested classes/interfaces inherited from interface com.hcl.domino.admin.Group

Group.GroupType

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	logger
protected java.util.TreeSet<java.lang.String>	members

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractGroup() Constructor
protected	AbstractGroup(com.hcl.domino.data.Document doc) Loads a Group from a Document

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getAdministrators()
java.lang.String	getCategory()
java.lang.String	getDescription()
java.lang.String	getInternetAddress()
java.lang.String	getMailDomain()
java.util.TreeSet<java.lang.String>	getMembers()
java.lang.String	getMetaversalId()
java.lang.String	getName()
java.lang.String	getNoteId()
java.util.List<java.lang.String>	getOwners()
Group.GroupType	getType()
java.lang.String	getUnid()
void	loadMetadata(com.hcl.domino.data.Database db, com.hcl.domino.data.Document doc) Sets metaversalID and UNID from database and note
void	resolve(KeepJnxSession s, java.util.Map<java.lang.String,java.lang.String> groups) Iterates through groups to expand out all members to individuals’ names
protected java.util.TreeSet<java.lang.String>	resolveRecursive(KeepJnxSession s, java.lang.String groupName, java.util.TreeSet<java.lang.String> incomingMembers, java.util.ArrayList<java.lang.String> traversedGroups, java.util.TreeSet<java.lang.String> previousMembers, java.util.Map<java.lang.String,java.lang.String> allGroups)
void	setAdministrators(java.util.List<java.lang.String> administrators)
void	setCategory(java.lang.String category)
void	setDescription(java.lang.String description)
void	setInternetAddress(java.lang.String internetAddress)
void	setMailDomain(java.lang.String mailDomain)
void	setName(java.lang.String name)
void	setOwners(java.util.List<java.lang.String> owners)
void	setType(Group.GroupType type)
void	writeToNote(com.hcl.domino.data.Document doc) Serializes values from Group to a specific Document

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.slf4j.Logger logger

members

protected java.util.TreeSet<java.lang.String> members

Constructor Detail

AbstractGroup

protected AbstractGroup()

Constructor

AbstractGroup

protected AbstractGroup(com.hcl.domino.data.Document doc)

Loads a Group from a Document

Parameters:

doc - Document from which to load values

Method Detail

getAdministrators

public java.util.List<java.lang.String> getAdministrators()

Specified by:

getAdministrators in interface Group

Returns:

list of administrators for the group. This can include named users or groups. This is only used for access if the users are restricted to Author access in the directory’s ACL.

getCategory

public java.lang.String getCategory()

Specified by:

getCategory in interface Group

Returns:

category used for grouping groups in the Notes Client

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface Group

Returns:

textual description for the group

getInternetAddress

public java.lang.String getInternetAddress()

Specified by:

getInternetAddress in interface Group

Returns:

internet address, only relevant to mail groups or multi-purpose groups used for mailing

getMailDomain

public java.lang.String getMailDomain()

Specified by:

getMailDomain in interface Group

Returns:

mail domain, only relevant to mail groups or multi-purpose groups used for mailing

getMembers

public java.util.TreeSet<java.lang.String> getMembers()

Specified by:

getMembers in interface Group

Returns:

list of members - named individuals and/or groups

getMetaversalId

public java.lang.String getMetaversalId()

Specified by:

getMetaversalId in interface Group

Returns:

document NoteID + “~” + database relative path, to retrieve the document on the current server

getName

public java.lang.String getName()

Specified by:

getName in interface Group

Returns:

group name

getNoteId

public java.lang.String getNoteId()

Specified by:

getNoteId in interface Group

Returns:

gets document NoteID, first part of the metaversal ID

getOwners

public java.util.List<java.lang.String> getOwners()

Specified by:

getOwners in interface Group

Returns:

owners for the group. This should only include named individuals. This is only used for access if the users are restricted to Author access in the directory’s ACL.

getType

public Group.GroupType getType()

Specified by:

getType in interface Group

Returns:

type denoting how the group can be used within Domino

getUnid

public java.lang.String getUnid()

Specified by:

getUnid in interface Group

Returns:

gets document UNID

loadMetadata

public void loadMetadata(com.hcl.domino.data.Database db,
                         com.hcl.domino.data.Document doc)

Description copied from interface: Group

Sets metaversalID and UNID from database and note

Specified by:

loadMetadata in interface Group

Parameters:

db -

• from which to get database path for metaversal ID

doc -

• from which to get NoteID (for metaversalID) and UNID

resolve

public void resolve(KeepJnxSession s,
                    java.util.Map<java.lang.String,java.lang.String> groups)

Description copied from interface: Group

Iterates through groups to expand out all members to individuals’ names

Specified by:

resolve in interface Group

Parameters:

s - KeepJnxSession for the current user

groups - All groups in relevant directories

setAdministrators

public void setAdministrators(java.util.List<java.lang.String> administrators)

Specified by:

setAdministrators in interface Group

Parameters:

administrators - for the group, either named individuals or other groups

setCategory

public void setCategory(java.lang.String category)

Specified by:

setCategory in interface Group

Parameters:

category - used for grouping groups in the Notes Client

setDescription

public void setDescription(java.lang.String description)

Specified by:

setDescription in interface Group

Parameters:

description - for the group

setInternetAddress

public void setInternetAddress(java.lang.String internetAddress)

Specified by:

setInternetAddress in interface Group

Parameters:

internetAddress - only relevant to mail groups or multi-purpose groups used for mailing

setMailDomain

public void setMailDomain(java.lang.String mailDomain)

Specified by:

setMailDomain in interface Group

Parameters:

mailDomain - only relevant to mail groups or multi-purpose groups used for mailing

setName

public void setName(java.lang.String name)

Specified by:

setName in interface Group

Parameters:

name - of the group

setOwners

public void setOwners(java.util.List<java.lang.String> owners)

Specified by:

setOwners in interface Group

Parameters:

owners - for the group. This should only include named individuals

setType

public void setType(Group.GroupType type)

Specified by:

setType in interface Group

Parameters:

type - denoting how the group can be used within Domino

writeToNote

public void writeToNote(com.hcl.domino.data.Document doc)

Description copied from interface: Group

Serializes values from Group to a specific Document

Specified by:

writeToNote in interface Group

Parameters:

doc - NoteNote to which to write values

resolveRecursive

protected java.util.TreeSet<java.lang.String> resolveRecursive(KeepJnxSession s,
                                                               java.lang.String groupName,
                                                               java.util.TreeSet<java.lang.String> incomingMembers,
                                                               java.util.ArrayList<java.lang.String> traversedGroups,
                                                               java.util.TreeSet<java.lang.String> previousMembers,
                                                               java.util.Map<java.lang.String,java.lang.String> allGroups)

Parameters:

s -

• KeepJnxSession for the current user

incomingMembers -

• members for the current group

traversedGroups -

• groups already processed

previousMembers -

• list of members to add to

allGroups -

• Map of group names and noteId~filepath pointer to group

Returns:

previousGroup + resolved members of sub-groups