com.ibm.di.connector.NT4UserMetaDataConnector
Class GroupInfo

java.lang.Object
  com.ibm.di.connector.NT4UserMetaDataConnector.GroupInfo

public class GroupInfo
extends Object

The GroupInfo class represents Windows Group's data structure and encapsulates methods that import and export that data to an Entry object.

Field Summary

static String	GROUP_ATTR_COMMENT Group entry attribute name: Comment
static String	GROUP_ATTR_GROUP_NAME Group entry attribute name: GroupName
static String	GROUP_ATTR_GROUPS Group entry attribute name: Groups
static String	GROUP_ATTR_IS_GLOBAL Group entry attribute name: IsGlobal
static String	GROUP_ATTR_USERS Group entry attribute name: Users

Constructor Summary

	GroupInfo() Default constructor.
protected	GroupInfo(Entry aGroupEntry) Constructs the GroupInfo object and populates its members with Group data from the given Entry parameter.

Method Summary

protected void	completeGroupData(GroupInfo aGroupInfo) All "null" data members are assigned the values of the corresponding aGroupInfo's data members.
protected void	copyDataFromGroupEntry(Entry aGroupEntry) Copies data from a group entry.
String	getComment() Retrieves comment.
String	getGroupName() Retrieves the group name.
Boolean	getIsGlobal() Checks if the group is global.
protected static void	populateGroupEntryAttributes(Entry aGroupEntry, GroupInfo aGroupInfo, Vector aUserNames, Vector aGroupNames) Given a group attributes' values creates and adds those attributes to the given entry.
protected static Vector	queryGroupSchema() Retrieves connector group entry's structure.
void	setComment(String aComment) Sets group comment.
void	setGroupName(String aGroupName) Sets the group name.
void	setIsGlobal(Boolean aIsGlobal) Sets parameter that indicates whether the group is global or not.

Methods inherited from class java.lang.Object

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

Field Detail

GROUP_ATTR_GROUP_NAME

public static final String GROUP_ATTR_GROUP_NAME

Group entry attribute name: GroupName

See Also:

Constant Field Values

GROUP_ATTR_COMMENT

public static final String GROUP_ATTR_COMMENT

Group entry attribute name: Comment

See Also:

Constant Field Values

GROUP_ATTR_IS_GLOBAL

public static final String GROUP_ATTR_IS_GLOBAL

Group entry attribute name: IsGlobal

See Also:

Constant Field Values

GROUP_ATTR_USERS

public static final String GROUP_ATTR_USERS

Group entry attribute name: Users

See Also:

Constant Field Values

GROUP_ATTR_GROUPS

public static final String GROUP_ATTR_GROUPS

Group entry attribute name: Groups

See Also:

Constant Field Values

Constructor Detail

GroupInfo

public GroupInfo()

Default constructor.

GroupInfo

protected GroupInfo(Entry aGroupEntry)

Constructs the GroupInfo object and populates its members with Group data from the given Entry parameter.

Parameters:

aGroupEntry - The Group Entry object containing data to initialize the new GroupInfo object with.

Method Detail

getGroupName

public String getGroupName()

Retrieves the group name.

Returns:

String , group name

getComment

public String getComment()

Retrieves comment.

Returns:

String , comment

getIsGlobal

public Boolean getIsGlobal()

Checks if the group is global.

Returns:

Boolean , global information

setGroupName

public void setGroupName(String aGroupName)

Sets the group name.

Parameters:

aGroupName - - String , sets group name

setComment

public void setComment(String aComment)

Sets group comment.

Parameters:

aComment - - String , comment to set

setIsGlobal

public void setIsGlobal(Boolean aIsGlobal)

Sets parameter that indicates whether the group is global or not.

Parameters:

aIsGlobal - - Boolean , sets if the group is global

copyDataFromGroupEntry

protected void copyDataFromGroupEntry(Entry aGroupEntry)

Copies data from a group entry.

Parameters:

aGroupEntry - The group entry to copy from.

completeGroupData

protected void completeGroupData(GroupInfo aGroupInfo)

All "null" data members are assigned the values of the corresponding aGroupInfo's data members.

Parameters:

aGroupInfo - The GroupInfo instance which data members' data will be copied.

populateGroupEntryAttributes

protected static void populateGroupEntryAttributes(Entry aGroupEntry,
                                                   GroupInfo aGroupInfo,
                                                   Vector aUserNames,
                                                   Vector aGroupNames)

Given a group attributes' values creates and adds those attributes to the given entry.

Parameters:

aGroupEntry - The group entry object where attributes will be added.

aGroupInfo - The GroupInfo structure containing the base group attributes.

aUserNames - Vector of Strings containing the names of the group's users.

aGroupNames - Vector of Strings containing the names of the group's groups. When populating a global group entry this parameter is null.

queryGroupSchema

protected static Vector queryGroupSchema()

Retrieves connector group entry's structure.

Returns:

Vector of elements of type Entry describing each groups's attribute structure.