Package com.ibm.di.connector.tam

Class User

java.lang.Object

com.ibm.di.connector.tam.CommonBase

com.ibm.di.connector.tam.User

public class User
extends CommonBase

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

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	USER_ATTR_LOGIN_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

Constructors

Constructor	Description
User(Entry entry, com.tivoli.pd.jutil.PDContext context, Log log)	Constructor used to instantiate a User from the Entry object.
User(SearchCriteria searchcriteria, com.tivoli.pd.jutil.PDContext context, Log log)	Constructor used to instantiate a User from the search criteria.
User(com.tivoli.pd.jutil.PDContext context, SearchCriteria searchcriteria, Log log)	Constructor used to instantiate a User from the search criteria.
User(java.lang.String s, com.tivoli.pd.jutil.PDContext context, Log log)	Constructor used to instantiate a User from the PDUser object.

Method Summary

Modifier and Type	Method	Description
void	delete(boolean deleteReg)	Delete user entry.
java.lang.String	desc()
Entry	getAttributes()	Constructs an Entry object from the user details.
java.util.List	getGroups()	Returns the Groups associated with the user
java.lang.String	getLoginID()	Return the Login ID for the User
Attribute	groupsAttribute()
java.lang.Boolean	isAccountValid()
java.lang.Boolean	isPasswordValid()
java.lang.Boolean	isSSOUser()
static java.util.List	list(SearchCriteria searchCriteria, com.tivoli.pd.jutil.PDContext pdContext)	Returns a list (ArrayList) of all the Users for the TAM Context matching search criteria value
static java.util.List	list(com.tivoli.pd.jutil.PDContext pdContext)	Returns a list (ArrayList) of all the Users for the TAM Context
static java.util.List	list(java.lang.String filter, com.tivoli.pd.jutil.PDContext pdContext)	Returns a filtered list (ArrayList) of all the Users for the TAM Context
java.lang.Integer	maxConcurrentWebSessions()
java.lang.Integer	maxFailedLogins()
void	modify(Entry changes)	Modify a user entry.
java.lang.String	password()
void	put(boolean importReg)	Creates a user in TAM from the IBM Tivoli Directory Integrator input details
java.lang.Boolean	replaceGroups()
static java.util.Vector	schema()	returns the schema for IBM Tivoli Directory Integrator.

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

USER_ATTR_LOGIN_ID

public static final java.lang.String USER_ATTR_LOGIN_ID

See Also:

Constant Field Values

Constructor Detail

User

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

Constructor used to instantiate a User from the PDUser object.

Uses the common log object from the TAMConnector class.

Parameters:

s - Contains the User name

context - The TAM Context

log - The Connector log

Throws:

com.tivoli.pd.jutil.PDException

See Also:

PDUser, TAMConnector

User

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

Constructor used to instantiate a User from the Entry object.

Uses the common log object from the TAMConnector class.

Parameters:

entry - the Entry object

context - the TAM context

log - the LogProxyImpl object

See Also:

Entry, TAMConnector

User

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

Constructor used to instantiate a User from the search criteria.

Uses the common log object from the TAMConnector class.

Parameters:

searchcriteria - the user login search criteria

context - the TAM context

log - the LogProxyImpl object

Throws:

TAMConnectorException

com.tivoli.pd.jutil.PDException

See Also:

SearchCriteria, PDContext, TAMConnector

User

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

Constructor used to instantiate a User from the search criteria. It populates the User only with the attributes it can get from the search criteria.

Uses the common log object from the TAMConnector class.

Parameters:

context - the TAM context

searchcriteria - the user login search criteria

log - the LogProxyImpl object

Throws:

TAMConnectorException

See Also:

SearchCriteria, PDContext, TAMConnector

Method Detail

getGroups

public java.util.List getGroups()

Returns the Groups associated with the user

Returns:

mUserGroups

See Also:

Vector

getLoginID

public java.lang.String getLoginID()

Return the Login ID for the User

Returns:

mLoginID

getAttributes

public Entry getAttributes()

Constructs an Entry object from the user details.

The Entry object is used by IBM Tivoli Directory Integrator

Returns:

Entry

See Also:

Entry

put

public void put(boolean importReg)
         throws TAMConnectorException

Creates a user in TAM from the IBM Tivoli Directory Integrator input details

Parameters:

importReg - true if the user should be import created, false if the use should be created without importing.

Throws:

TAMConnectorException

desc

public java.lang.String desc()

password

public java.lang.String password()

isAccountValid

public java.lang.Boolean isAccountValid()

isPasswordValid

public java.lang.Boolean isPasswordValid()

isSSOUser

public java.lang.Boolean isSSOUser()

maxFailedLogins

public java.lang.Integer maxFailedLogins()

maxConcurrentWebSessions

public java.lang.Integer maxConcurrentWebSessions()

replaceGroups

public java.lang.Boolean replaceGroups()

groupsAttribute

public Attribute groupsAttribute()

modify

public void modify(Entry changes)
            throws TAMConnectorException

Modify a user entry.

Parameters:

changes - The user entry to modify.

Throws:

TAMConnectorException

delete

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

Delete user entry.

Parameters:

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

Throws:

TAMConnectorException

com.tivoli.pd.jutil.PDException

schema

public static java.util.Vector schema()

returns the schema for IBM Tivoli Directory Integrator.

Returns:

Vector

list

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

Returns a list (ArrayList) of all the Users for the TAM Context

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 Users 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

Returns a filtered list (ArrayList) of all the Users for the TAM Context

Parameters:

filter - A TAM User filter string. The filter is a case-sensitive mixture of string constants and wildcards. Filtering is on the principal name

pdContext - The TAM Contex

Returns:

List (ArrayList)

Throws:

com.tivoli.pd.jutil.PDException