com.ibm.di.connector.tam
Class Group

java.lang.Object
  com.ibm.di.connector.tam.CommonBase
      com.ibm.di.connector.tam.Group

public class Group
extends CommonBase

Group class contains the functionality to find, add, modify and delete Groups from TAM using the TAM Connector for IBM Tivoli Directory Integrator.

Field Summary

static java.lang.String

GROUP_ATTR_GROUP_ID

Fields inherited from class com.ibm.di.connector.tam.CommonBase

DATE_FORMAT, MAX_SIGNED_DWORD, MAX_UNSIGNED_DWORD, mLogProxy, mPDContext, mPDMessages, QSS_BOOLEAN, QSS_BYTE_ARRAY, QSS_DATE, QSS_INTEGER, QSS_LONG, QSS_STRING, QSS_VECTOR

Constructor Summary

Group(Entry entry, com.tivoli.pd.jutil.PDContext context, Log log)
Constructor for Group.

Group(com.tivoli.pd.jutil.PDContext context, SearchCriteria searchcriteria, Log log)
Constructor for Group.

Group(SearchCriteria searchcriteria, com.tivoli.pd.jutil.PDContext context, Log log)
Constructor for Group.

Group(java.lang.String s, com.tivoli.pd.jutil.PDContext context, Log log)
Constructor for Group.

Method Summary

void	delete(boolean deleteReg) Delete a Group
Entry	getAttributes() Returns the Group details in an Entry object
java.lang.String	getDesc() Return the Group Description
java.lang.String	getGroupID() Returns the Group Name
java.util.List	getUsers() Retuns the Users associated with the group.
static java.util.List	list(com.tivoli.pd.jutil.PDContext pdContext) Return a List (ArrayList) of Groups
static java.util.List	list(SearchCriteria searchCriteria, com.tivoli.pd.jutil.PDContext pdContext) Returns a list (ArrayList) of all the Groups for the TAM Context matching search criteria value
static java.util.List	list(java.lang.String filter, com.tivoli.pd.jutil.PDContext pdContext) Return a filtered List (ArrayList) of Groups
void	modify(Entry changes) Modify a Group
void	put(boolean importReg) Add a Group
java.lang.Boolean	replaceUsers()
static java.util.Vector	schema() Get the schema for TAM groups.
Attribute	usersAtt()

Methods inherited from class com.ibm.di.connector.tam.CommonBase

addSchemaEntry, createAndAddEntryAttribute, debug, debug, error, getBooleanEntryAttributeValue, getByteArrayEntryAttributeValue, getDateEntryAttributeValue, getIntegerEntryAttributeValue, getLongEntryAttributeValue, getPDMessage, getStringEntryAttributeValue, logmsg, printEntry, processMsgs

Methods inherited from class java.lang.Object

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

Field Detail

GROUP_ATTR_GROUP_ID

public static final java.lang.String GROUP_ATTR_GROUP_ID

See Also:

Constant Field Values

Constructor Detail

Group

public Group(java.lang.String s,
             com.tivoli.pd.jutil.PDContext context,
             Log log)
      throws TAMConnectorException,
             com.tivoli.pd.jutil.PDException

Constructor for Group.

Parameters:

s - Contains the Group name

context - The TAM Context

log - The Connector log

Throws:

com.tivoli.pd.jutil.PDException

TAMConnectorException

Group

public Group(Entry entry,
             com.tivoli.pd.jutil.PDContext context,
             Log log)

Constructor for Group.

Parameters:

entry - The IBM Tivoli Directory Integrator Data

context - The TAM Context

log - The Connector log

Group

public Group(SearchCriteria searchcriteria,
             com.tivoli.pd.jutil.PDContext context,
             Log log)
      throws TAMConnectorException,
             com.tivoli.pd.jutil.PDException

Constructor for Group.

Parameters:

searchcriteria - The Group name

context - The TAM Context

log - The Connector log

Throws:

TAMConnectorException

com.tivoli.pd.jutil.PDException

Group

public Group(com.tivoli.pd.jutil.PDContext context,
             SearchCriteria searchcriteria,
             Log log)
      throws TAMConnectorException

Constructor for Group. Designed to be used w/o a previous call to Locate() to initialise from the existing underlying PDObject

Parameters:

context - The TAM Context

searchcriteria - The Group name

log - The Connector log

Throws:

TAMConnectorException

Method Detail

getUsers

public java.util.List getUsers()

Retuns the Users associated with the group.

Returns:

mUsers

See Also:

Vector

getGroupID

public java.lang.String getGroupID()

Returns the Group Name

Returns:

mGroupID

getDesc

public java.lang.String getDesc()

Return the Group Description

Returns:

mDescription;

replaceUsers

public java.lang.Boolean replaceUsers()

usersAtt

public Attribute usersAtt()

put

public void put(boolean importReg)
         throws TAMConnectorException

Add a Group

Parameters:

importReg - true to import the user details from the registry false to create the user details and add to the registry

Throws:

TAMConnectorException

modify

public void modify(Entry changes)
            throws TAMConnectorException

Modify a Group

Parameters:

changes - The group entry to modify.

Throws:

TAMConnectorException

getAttributes

public Entry getAttributes()

Returns the Group details in an Entry object

Returns:

Entry

delete

public void delete(boolean deleteReg)
            throws TAMConnectorException,
                   com.tivoli.pd.jutil.PDException

Delete a Group

Parameters:

deleteReg - true to delete the user from TAM and the registry false to delete the user from TAM but not the registry

Throws:

TAMConnectorException

com.tivoli.pd.jutil.PDException

schema

public static java.util.Vector schema()

Get the schema for TAM groups.

Returns:

vector with the schema description

list

public static java.util.List list(com.tivoli.pd.jutil.PDContext pdContext)
                           throws com.tivoli.pd.jutil.PDException

Return a List (ArrayList) of Groups

Parameters:

pdContext - The TAM Context

Returns:

List (ArrayList)

Throws:

com.tivoli.pd.jutil.PDException

list

public static java.util.List list(SearchCriteria searchCriteria,
                                  com.tivoli.pd.jutil.PDContext pdContext)
                           throws com.tivoli.pd.jutil.PDException

Returns a list (ArrayList) of all the Groups for the TAM Context matching search criteria value

Parameters:

pdContext - The TAM Context

searchCriteria - The IDI search criteria

Returns:

List (ArrayList)

Throws:

com.tivoli.pd.jutil.PDException

list

public static java.util.List list(java.lang.String filter,
                                  com.tivoli.pd.jutil.PDContext pdContext)
                           throws com.tivoli.pd.jutil.PDException

Return a filtered List (ArrayList) of Groups

Parameters:

filter - A TAM Group filter string. The filter is a case-insensitive mixture of string constants and wildcards. Filtering is on the group name

pdContext - The TAM Context

Returns:

List (ArrayList)

Throws:

com.tivoli.pd.jutil.PDException