Package com.ibm.di.connector.tam

Class Policy

java.lang.Object

com.ibm.di.connector.tam.CommonBase

com.ibm.di.connector.tam.Policy

public class Policy
extends CommonBase

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	POLICY_ATTR_USER_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
Policy(Entry entry, com.tivoli.pd.jutil.PDContext context, Log log)	Policy Constructor
Policy(SearchCriteria searchcriteria, com.tivoli.pd.jutil.PDContext context, Log log)	Policy Constructor
Policy(com.tivoli.pd.jutil.PDContext context, SearchCriteria searchcriteria, Log log)	Policy Constructor.
Policy(java.lang.String s, com.tivoli.pd.jutil.PDContext context, Log log)	Policy Contructor

Method Summary

Modifier and Type	Method	Description
void	delete()	Deletes a Policy from TAM
Entry	getAttributes()	Returns the Policy details in the form of an Entry object
static java.util.List	list(SearchCriteria searchCriteria, com.tivoli.pd.jutil.PDContext mPDContext)	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 mPDContext)	Return a List (ArrayList) of TAM Policies
void	modify()	Modifies a Policy in TAM
void	modify_postset()	Modifies a Policy in TAM
void	put()	Creates a Policy in TAM
static java.util.Vector	schema()	Get the schema for TAM policy.
void	set(Entry entry)	Set the object with the Entry data

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

POLICY_ATTR_USER_ID

public static final java.lang.String POLICY_ATTR_USER_ID

See Also:

Constant Field Values

Constructor Detail

Policy

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

Policy Contructor

Parameters:

s - The Policy name

context - The TAM Context

log - The IBM Tivoli Directory Integrator Connector log

Throws:

com.tivoli.pd.jutil.PDException

Policy

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

Policy Constructor

Parameters:

entry - The Entry data from IBM Tivoli Directory Integrator

context - The TAM Context

log - The IBM Tivoli Directory Integrator Connector log

Policy

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

Policy Constructor

Parameters:

searchcriteria - The Search criteria

context - The TAM Context

log - The IBM Tivoli Directory Integrator Connector Log

Throws:

TAMConnectorException

com.tivoli.pd.jutil.PDException

Policy

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

Policy Constructor. Constructs a Policy initialised only with the SearchCriteria attributes.

Parameters:

context - The TAM Context.

searchcriteria - The Search criteria

log - The IBM Tivoli Directory Integrator Connector Log

Throws:

TAMConnectorException

com.tivoli.pd.jutil.PDException

Method Detail

set

public void set(Entry entry)

Set the object with the Entry data

Parameters:

entry - The IBM Tivoli Directory Integrator Entry data

put

public void put()
         throws TAMConnectorException,
                com.tivoli.pd.jutil.PDException

Creates a Policy in TAM

Throws:

TAMConnectorException

com.tivoli.pd.jutil.PDException

modify

public void modify()
            throws TAMConnectorException

Modifies a Policy in TAM

Throws:

TAMConnectorException

modify_postset

public void modify_postset()
                    throws TAMConnectorException

Modifies a Policy in TAM

Throws:

TAMConnectorException

delete

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

Deletes a Policy from TAM

Unsets each value for the user

Throws:

TAMConnectorException

com.tivoli.pd.jutil.PDException

getAttributes

public Entry getAttributes()

Returns the Policy details in the form of an Entry object

Returns:

Entry

schema

public static java.util.Vector schema()

Get the schema for TAM policy.

Returns:

vector with the schema description

list

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

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

Parameters:

mPDContext - The TAM Context

searchCriteria - The IDI search criteria

Returns:

List (ArrayList)

Throws:

com.tivoli.pd.jutil.PDException

list

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

Return a List (ArrayList) of TAM Policies

Parameters:

mPDContext - The TAM Context

Returns:

List (ArrayList)

Throws:

com.tivoli.pd.jutil.PDException