com.ibm.itim.dataservices.model
Class ServiceProfile

java.lang.Object
  com.ibm.itim.dataservices.model.ObjectProfile
      com.ibm.itim.dataservices.model.ServiceProfile

All Implemented Interfaces:

ManagableProfile, java.io.Serializable

public class ServiceProfile
extends ObjectProfile

Value Object class that holds the attribute data of an object profile.

See Also:

ObjectProfileEntity, Serialized Form

Field Summary

static java.lang.String	ACCOUNT_PROFILE The name attribute with the name of the account profile corresponding to this service type.
static java.lang.String	ACCOUNTCLASS The name attribute with the name of the account class corresponding to this service type.
static java.lang.String	COMPLEX_ATTRIBUTE_HANDLER The name of the attribute handler class attribute
static java.lang.String	COMPLEX_ATTRIBUTES The name of the complex attribute list attribute
static java.lang.String	DORMANT_ACCOUNT_SUPPORT Flag indicating whether service includes dormant account support.
static java.lang.String	GROUP_MAPPINGS The name of the LDAP attribute for map of account attribute name by group
static java.lang.String	HR_FEED Name for a property indicating whether or not the service profile is an HR feed service profile.
static java.lang.String	ITIM_DSML2_PROVIDER_FACTORY The constant specifies the service provider factory class for a DSML2 Service.
static java.lang.String	LOCAL Name of service profile property indicating that the service is local.
static java.lang.String	MANUAL_SERVICE_PROVIDER_FACTORY The constant specifies the service provider factory class for a Manual Service.
static java.lang.String	OPERATION_ADD_DELETE_SINGLE_VALUED_ATTRIBUTES The name of the LDAP attribute for the list of add-delete-single-value attributes per operation type.
static java.lang.String	OPERATION_REPLACE_MULTI_VALUED_ATTRIBUTES The name of the LDAP attribute for the list of replace-multi-value attributes per operation type.
static java.lang.String	OPERATION_REQUIRED_ATTRIBUTES The name of the LDAP attribute for the list of required attributes per operation type.
static java.lang.String	OPERATION_SEND_ONLY_ATTRIBUTES The name of the LDAP attribute for the list of send-only attributes per operation type.
static java.lang.String	PROPERTIES The name attribute with the collection of protocol and behavior properties
static java.lang.String	PROTOCOL_MAPPINGS The name attribute with the collection of protocol mappings.
static java.lang.String	SERVICE_PROVIDER_FACTORY The name attribute with the name of the Java class used to instantiate the ServiceProvider.
static java.lang.String	SERVICE_SUPPORT_CLASS The name of the LDAP attribute for the service support class.
static java.lang.String	TRANSFORMS The name attribute with the xml document containing the transforms used to communicate with legacy TIM agents.
static java.lang.String	TRUE Value of service profile property indicating that the service is local.

Fields inherited from class com.ibm.itim.dataservices.model.ObjectProfile

ACCOUNT_ATTR_PASSWORD, DAO_CLASS, DESCRIPTION_ATTR, ER_XML, MANAGE_GROUP, OBJ_PROFILE_ATTR_CATEGORY, OBJ_PROFILE_ATTR_CUSTOM_CLASS, OBJ_PROFILE_ATTR_MAP, OBJ_PROFILE_ATTR_NAME, OBJ_PROFILE_ATTR_PROPS, OBJ_PROFILE_ATTR_RDN, OBJ_PROFILE_ATTR_SEARCH, OBJ_PROFILE_RULES_ATTR, OWNERSHIP_TYPE_ATTR

Constructor Summary

ServiceProfile(DistinguishedName dn, java.util.Map<java.lang.String,java.lang.String> attrMap, java.util.Collection<ObjectProfileOperation> operations, java.util.Collection<LifecycleRule> complianceRules, AttributeValues attributes)
XXX This description is not correct and needs to be updated.

ServiceProfile(DistinguishedName dn, java.lang.String name, java.lang.String customClass, java.lang.String nameAttr, java.util.Map<java.lang.String,java.lang.String> attrMap, java.util.Collection<java.lang.String> searchAttr, java.lang.String accountClass, java.lang.String accountProfileName, java.lang.String serviceProviderFactory, java.util.Properties properties, java.util.Properties protocolMappings, java.lang.String transforms, java.util.Collection<ObjectProfileOperation> operations, java.util.Collection<LifecycleRule> rules)
Constructs a new ServiceProfile object.

ServiceProfile(DistinguishedName dn, java.lang.String name, java.lang.String customClass, java.lang.String nameAttr, java.util.Map<java.lang.String,java.lang.String> attrMap, java.lang.String searchAttr, java.lang.String accountClass, java.lang.String accountProfileName, java.lang.String serviceProviderFactory, java.util.Properties properties, java.util.Properties protocolMappings, java.lang.String transforms)
Deprecated. Use ServiceProfile(String,String,String,String,Map,Collection, String,String) instead.

ServiceProfile(DistinguishedName dn, java.lang.String name, java.lang.String customClass, java.lang.String nameAttr, java.util.Map<java.lang.String,java.lang.String> attrMap, java.lang.String searchAttr, java.lang.String accountClass, java.lang.String accountProfileName, java.lang.String serviceProviderFactory, java.util.Properties properties, java.util.Properties protocolMappings, java.lang.String transforms, java.util.Collection<ObjectProfileOperation> operations, java.util.Collection<LifecycleRule> rules)
Deprecated. Use ServiceProfile(DistinguishedName,String,String,String,Map,Collection, String,String,String,Properties,Properties,String,Collection,Colletion) instead.

ServiceProfile(java.lang.String name, java.lang.String customClass, java.lang.String nameAttr, java.util.Map<java.lang.String,java.lang.String> attrMap, java.util.Collection<java.lang.String> searchAttr, java.lang.String accountClass, java.lang.String accountProfileName, java.lang.String serviceProviderFactory)
Constructs a new ServiceProfile object.

ServiceProfile(java.lang.String name, java.lang.String customClass, java.lang.String nameAttr, java.util.Map<java.lang.String,java.lang.String> attrMap, java.lang.String searchAttr, java.lang.String accountClass, java.lang.String accountProfileName, java.lang.String serviceProviderFactory)
Deprecated. Use ServiceProfile(String,String,String,String,Map,Collection, String,String) instead.

ServiceProfile(java.lang.String name, java.lang.String customClass, java.lang.String nameAttr, java.util.Map<java.lang.String,java.lang.String> attrMap, java.lang.String searchAttr, java.lang.String accountClass, java.lang.String accountProfileName, java.lang.String serviceProviderFactory, java.util.Properties props)
Constructs a new ServiceProfile object.

Method Summary

void	addComplexAttribute(java.lang.String attrName) Adds a complex attribute
void	disableDormantAccountSupport() Disables dormant accounts.
void	enableDormantAccountSupport() Enables dormant accounts if they are supported.
java.lang.String	getAccountClass() Returns the Account's class name of the service profile.
java.lang.String	getAccountProfileName() Returns the Account's profile name of the service profile.
java.lang.String	getAttributeHandlerClass() Returns the attribute handler class
java.util.Collection<java.lang.String>	getComplexAttributes() Returns the list of complex attributes
java.lang.String	getGroupAccountAttribute(java.lang.String groupObjectClass) Returns the account attribute name for the give group type
java.lang.String[]	getGroupAccountAttributes() Returns a list of account attribute names that are related to group
java.util.Map<java.lang.String,java.lang.String>	getGroupMappings() Returns mapping of group membership attribute on the account
java.lang.String[]	getGroupObjectClass() Returns a list of object class name for GROUP supporting data
java.util.Collection<java.lang.String>	getOperationAddDeleteSingleAttributes() List of strings that tell which single-valued attributes are considered as ADD/DELETE instead of REPLACE for each operation.
java.util.Collection<java.lang.String>	getOperationReplaceMultiAttributes() List of strings that tell which multi-valued attributes are considered as REPLACE instead of ADD and REMOVE for each operation.
java.util.Collection<java.lang.String>	getOperationRequiredAttributes() List of strings that tell which attribtues are required for each operation.
java.util.Collection<java.lang.String>	getOperationSendAttributes() List of strings that tell which attributes are send-only for each operation.
java.util.Properties	getProperties() Returns the service provider protocol and behavior properties for the service profile.
java.util.Properties	getProtocolMappings() Returns the service provider protocol mappings that determine the service instance attributes to be sent with messages to the managed resource.
java.lang.String	getServiceProviderFactory() Returns the service provider factory for the service profile.
java.lang.String	getTransforms() Returns the service provider transforms for the service profile.
boolean	isComplexAttribute(java.lang.String attrName) Indicates whether an attribute is a complex attribute
boolean	isDormantAccountSupported() Indicates if a service profile supports dormant accounts.
boolean	isPasswordAllowedOnRestore() Property indicates that the account password MAY be send when restoring an account.
boolean	isPasswordRequiredOnRestore() Property indicates that the account password is REQUIRED for restoring accounts.
void	removeComplexAttribute(java.lang.String attrName) Removes a complex attribute
void	removeGroupMapping(java.lang.String groupObjectClass) Removes a group mapping to specifiy account attribute for group membership
void	setAccountClass(java.lang.String accountClassName) Sets the Account's class name of the service profile.
void	setAccountProfileName(java.lang.String profileName) Sets the Account's profile name of the profile.
void	setAttributeHandlerClass(java.lang.String className) Sets the attribute handler class
void	setComplexAttributes(java.util.Collection<java.lang.String> attrNames) Sets the list of complex attributes supported
void	setGroupMapping(java.lang.String groupObjectClass, java.lang.String groupAccountAttributeName) Sets a group mapping to specifiy account attribute for group membership
java.util.Map<java.lang.String,java.lang.String>	setGroupMappings(java.util.Map<java.lang.String,java.lang.String> groupMappings) Sets mapping of group membership attribute on account.
void	setServiceProviderFactory(java.lang.String serviceProviderFactory) Sets the service provider factory for the service profile.

Methods inherited from class com.ibm.itim.dataservices.model.ObjectProfile

addOperation, addRule, getAttributeMap, getCategory, getCustomClass, getCustomProperties, getDaoClassName, getDistinguishedName, getMappedAttribute, getName, getNameAttribute, getOperation, getOperationNames, getOperations, getRule, getRules, getSearchAttribute, getSearchAttributes, getTenantDN, isPasswordAttributeExist, removeOperation, removeRule, setAttributeMap, setCategory, setCustomClass, setName, setNameAttribute, setOperation, setOperations, setRule, setRules, setSearchAttribute, setSearchAttribute, setTenantDN, toString, toXML

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ACCOUNTCLASS

public static final java.lang.String ACCOUNTCLASS

The name attribute with the name of the account class corresponding to this service type.

See Also:

Constant Field Values

ACCOUNT_PROFILE

public static final java.lang.String ACCOUNT_PROFILE

The name attribute with the name of the account profile corresponding to this service type.

See Also:

Constant Field Values

SERVICE_PROVIDER_FACTORY

public static final java.lang.String SERVICE_PROVIDER_FACTORY

The name attribute with the name of the Java class used to instantiate the ServiceProvider.

See Also:

Constant Field Values

MANUAL_SERVICE_PROVIDER_FACTORY

public static final java.lang.String MANUAL_SERVICE_PROVIDER_FACTORY

The constant specifies the service provider factory class for a Manual Service.

See Also:

Constant Field Values

PROPERTIES

public static final java.lang.String PROPERTIES

The name attribute with the collection of protocol and behavior properties

See Also:

Constant Field Values

LOCAL

public static final java.lang.String LOCAL

Name of service profile property indicating that the service is local.

See Also:

Constant Field Values

TRUE

public static final java.lang.String TRUE

Value of service profile property indicating that the service is local.

See Also:

Constant Field Values

PROTOCOL_MAPPINGS

public static final java.lang.String PROTOCOL_MAPPINGS

The name attribute with the collection of protocol mappings. These are used to put service instance attribute values in messages to managed resources.

See Also:

Constant Field Values

TRANSFORMS

public static final java.lang.String TRANSFORMS

The name attribute with the xml document containing the transforms used to communicate with legacy TIM agents.

See Also:

Constant Field Values

SERVICE_SUPPORT_CLASS

public static final java.lang.String SERVICE_SUPPORT_CLASS

The name of the LDAP attribute for the service support class.

Since:

TIM 5.0

See Also:

Constant Field Values

GROUP_MAPPINGS

public static final java.lang.String GROUP_MAPPINGS

The name of the LDAP attribute for map of account attribute name by group

Since:

TIM 5.0

See Also:

Constant Field Values

COMPLEX_ATTRIBUTE_HANDLER

public static final java.lang.String COMPLEX_ATTRIBUTE_HANDLER

The name of the attribute handler class attribute

Since:

TIM 5.0

See Also:

Constant Field Values

COMPLEX_ATTRIBUTES

public static final java.lang.String COMPLEX_ATTRIBUTES

The name of the complex attribute list attribute

Since:

TIM 5.0

See Also:

Constant Field Values

OPERATION_REQUIRED_ATTRIBUTES

public static final java.lang.String OPERATION_REQUIRED_ATTRIBUTES

The name of the LDAP attribute for the list of required attributes per operation type. This is a multi-valued LDAP attribute, type DirectoryString{1000}. Syntax of a value:
op_name=source:attr_name[,source:attr_name2]...

where
op_name is one of: add|modify|suspend|restore|passwordChange|delete|search
source is either the letter "s" (for service) or "a" (for account)
attr_name is an attribute name from the service or account objectclass, depending on source value.

See Also:

Constant Field Values

OPERATION_SEND_ONLY_ATTRIBUTES

public static final java.lang.String OPERATION_SEND_ONLY_ATTRIBUTES

The name of the LDAP attribute for the list of send-only attributes per operation type. This is a multi-valued LDAP attribute, type DirectoryString{1000}. Syntax of a value:
op_name=attr_name[,attr_name2]...

where
op_name is one of: add|modify|suspend|restore|passwordChange|delete|search
attr_name is an account attribute name.

See Also:

Constant Field Values

OPERATION_REPLACE_MULTI_VALUED_ATTRIBUTES

public static final java.lang.String OPERATION_REPLACE_MULTI_VALUED_ATTRIBUTES

The name of the LDAP attribute for the list of replace-multi-value attributes per operation type. This is a multi-valued LDAP attribute, type DirectoryString{1000}. Syntax of a value:
op_name=attr_name[,attr_name2]...

where
op_name is one of: add|modify|suspend|restore|passwordChange|delete|search
attr_name is an account attribute name.

See Also:

Constant Field Values

OPERATION_ADD_DELETE_SINGLE_VALUED_ATTRIBUTES

public static final java.lang.String OPERATION_ADD_DELETE_SINGLE_VALUED_ATTRIBUTES

The name of the LDAP attribute for the list of add-delete-single-value attributes per operation type. This is a multi-valued LDAP attribute, type DirectoryString{1000}. Syntax of a value:
op_name=attr_name[,attr_name2]...

where
op_name is one of: add|modify|suspend|restore|passwordChange|delete|search
attr_name is an account attribute name.

See Also:

Constant Field Values

ITIM_DSML2_PROVIDER_FACTORY

public static final java.lang.String ITIM_DSML2_PROVIDER_FACTORY

The constant specifies the service provider factory class for a DSML2 Service.

See Also:

Constant Field Values

HR_FEED

public static final java.lang.String HR_FEED

Name for a property indicating whether or not the service profile is an HR feed service profile.

See Also:

Constant Field Values

DORMANT_ACCOUNT_SUPPORT

public static final java.lang.String DORMANT_ACCOUNT_SUPPORT

Flag indicating whether service includes dormant account support. Check if the key "com.ibm.itim.remoteservices.ResourceProperties.DORMANT_ACCOUNT_SUPPORT" defined as property of the service profile. If the value defined for the key is "true", returns true, else false. Possible value for com.ibm.itim.remoteservices.ResourceProperties.DORMANT_ACCOUNT_SUPPORT are

• true
• false

See Also:

Constant Field Values

Constructor Detail

ServiceProfile

public ServiceProfile(java.lang.String name,
                      java.lang.String customClass,
                      java.lang.String nameAttr,
                      java.util.Map<java.lang.String,java.lang.String> attrMap,
                      java.lang.String searchAttr,
                      java.lang.String accountClass,
                      java.lang.String accountProfileName,
                      java.lang.String serviceProviderFactory)

Deprecated. Use ServiceProfile(String,String,String,String,Map,Collection, String,String) instead.

Constructs a new ServiceProfile object.

Parameters:

name - Name of the object profile.

customClass - Name of the data store class.

nameAttr - Attribute to use as the name of an entry defined by this profile.

attrMap - A mapping of semantic attributes to class attributes.

searchAttr - Attribute to use when searching entries defined by this profile.

accountClass - The name of the corresponding account class

accountProfileName - The name of the corresponding account profile

serviceProviderFactory - The name of the Java class used to instantiate the ServiceProviderfor communication to the managed resource

Since:

deprecated in 5.0 to support multiple search attributes.

ServiceProfile

public ServiceProfile(java.lang.String name,
                      java.lang.String customClass,
                      java.lang.String nameAttr,
                      java.util.Map<java.lang.String,java.lang.String> attrMap,
                      java.lang.String searchAttr,
                      java.lang.String accountClass,
                      java.lang.String accountProfileName,
                      java.lang.String serviceProviderFactory,
                      java.util.Properties props)

Constructs a new ServiceProfile object.

Parameters:

name - Name of the object profile.

customClass - Name of the data store class.

nameAttr - Attribute to use as the name of an entry defined by this profile.

attrMap - A mapping of semantic attributes to class attributes.

searchAttr - Attribute to use when searching entries defined by this profile.

accountClass - The name of the corresponding account class

accountProfileName - The name of the corresponding account profile

serviceProviderFactory - The name of the Java class used to instantiate the ServiceProviderfor communication to the managed resource

ServiceProfile

public ServiceProfile(java.lang.String name,
                      java.lang.String customClass,
                      java.lang.String nameAttr,
                      java.util.Map<java.lang.String,java.lang.String> attrMap,
                      java.util.Collection<java.lang.String> searchAttr,
                      java.lang.String accountClass,
                      java.lang.String accountProfileName,
                      java.lang.String serviceProviderFactory)

Constructs a new ServiceProfile object.

Parameters:

name - Name of the object profile.

customClass - Name of the data store class.

nameAttr - Attribute to use as the name of an entry defined by this profile.

attrMap - A mapping of semantic attributes to class attributes.

searchAttr - Attribute to use when searching entries defined by this profile.

accountClass - The name of the corresponding account class

accountProfileName - The name of the corresponding account profile

serviceProviderFactory - The name of the Java class used to instantiate the ServiceProviderfor communication to the managed resource

ServiceProfile

public ServiceProfile(DistinguishedName dn,
                      java.lang.String name,
                      java.lang.String customClass,
                      java.lang.String nameAttr,
                      java.util.Map<java.lang.String,java.lang.String> attrMap,
                      java.lang.String searchAttr,
                      java.lang.String accountClass,
                      java.lang.String accountProfileName,
                      java.lang.String serviceProviderFactory,
                      java.util.Properties properties,
                      java.util.Properties protocolMappings,
                      java.lang.String transforms)

Deprecated. Use ServiceProfile(String,String,String,String,Map,Collection, String,String) instead.

Constructs a new ServiceProfile object. This constructor adds parameters needed for communication to remote resources: serviceProviderFactory, properties, and transforms. They are not needed for the TIM Service or for hosted services.

Parameters:

dn - DistinguishedName of the profile.

name - Name of the object profile.

customClass - Name of the data store class.

nameAttr - Attribute to use as the name of an entry defined by this profile.

attrMap - A mapping of semantic attributes to class attributes.

searchAttr - Attribute to use when searching entries defined by this profile.

accountClass - The name of the corresponding account class

accountProfileName - The name of the corresponding account profile

serviceProviderFactory - The name of the Java class used to instantiate the ServiceProviderfor communication to the managed resource

properties - A table of String objects representing protocol and behavior properties.

protocolMappings - the service provider protocol mappings that determine the service instance attributes to be sent with messages to the managed resource

transforms - An xml document containing transforms (legacy TIM agents) - may be null

Since:

deprecated in 5.0 to support multiple search attributes.

ServiceProfile

public ServiceProfile(DistinguishedName dn,
                      java.lang.String name,
                      java.lang.String customClass,
                      java.lang.String nameAttr,
                      java.util.Map<java.lang.String,java.lang.String> attrMap,
                      java.lang.String searchAttr,
                      java.lang.String accountClass,
                      java.lang.String accountProfileName,
                      java.lang.String serviceProviderFactory,
                      java.util.Properties properties,
                      java.util.Properties protocolMappings,
                      java.lang.String transforms,
                      java.util.Collection<ObjectProfileOperation> operations,
                      java.util.Collection<LifecycleRule> rules)

Deprecated. Use ServiceProfile(DistinguishedName,String,String,String,Map,Collection, String,String,String,Properties,Properties,String,Collection,Colletion) instead.

Constructs a new ServiceProfile object. This constructor adds parameters needed for communication to remote resources: serviceProviderFactory, properties, and transforms. They are not needed for the TIM Service or for hosted services.

Parameters:

dn - DistinguishedName of the profile.

name - Name of the object profile.

customClass - Name of the data store class.

nameAttr - Attribute to use as the name of an entry defined by this profile.

attrMap - A mapping of semantic attributes to class attributes.

searchAttr - Attribute to use when searching entries defined by this profile.

accountClass - The name of the corresponding account class

accountProfileName - The name of the corresponding account profile

serviceProviderFactory - The name of the Java class used to instantiate the ServiceProviderfor communication to the managed resource

properties - A table of String objects representing protocol and behavior properties.

protocolMappings - the service provider protocol mappings that determine the service instance attributes to be sent with messages to the managed resource

transforms - An xml document containing transforms (legacy TIM agents) - may be null

operations - The workflow operation mappings that determine the operations of this service

rules - Collection of compliance rules for this service profile.

Since:

deprecated in 5.0 to support multiple search attributes.

ServiceProfile

public ServiceProfile(DistinguishedName dn,
                      java.lang.String name,
                      java.lang.String customClass,
                      java.lang.String nameAttr,
                      java.util.Map<java.lang.String,java.lang.String> attrMap,
                      java.util.Collection<java.lang.String> searchAttr,
                      java.lang.String accountClass,
                      java.lang.String accountProfileName,
                      java.lang.String serviceProviderFactory,
                      java.util.Properties properties,
                      java.util.Properties protocolMappings,
                      java.lang.String transforms,
                      java.util.Collection<ObjectProfileOperation> operations,
                      java.util.Collection<LifecycleRule> rules)

Constructs a new ServiceProfile object. This constructor adds parameters needed for communication to remote resources: serviceProviderFactory, properties, and transforms. They are not needed for the TIM Service or for hosted services.

Parameters:

dn - DistinguishedName of the profile.

name - Name of the object profile.

customClass - Name of the data store class.

nameAttr - Attribute to use as the name of an entry defined by this profile.

attrMap - A mapping of semantic attributes to class attributes.

searchAttr - Attribute to use when searching entries defined by this profile.

accountClass - The name of the corresponding account class

accountProfileName - The name of the corresponding account profile

serviceProviderFactory - The name of the Java class used to instantiate the ServiceProviderfor communication to the managed resource

properties - A table of String objects representing protocol and behavior properties.

protocolMappings - the service provider protocol mappings that determine the service instance attributes to be sent with messages to the managed resource

transforms - An xml document containing transforms (legacy TIM agents) - may be null

operations - The workflow operation mappings that determine the operations of this service

rules - Collection of compliance rules for this service profile.

ServiceProfile

public ServiceProfile(DistinguishedName dn,
                      java.util.Map<java.lang.String,java.lang.String> attrMap,
                      java.util.Collection<ObjectProfileOperation> operations,
                      java.util.Collection<LifecycleRule> complianceRules,
                      AttributeValues attributes)

XXX This description is not correct and needs to be updated. Constructs a new ServiceProfile object. This constructor adds parameters needed for communication to remote resources: serviceProviderFactory, properties, and transforms. They are not needed for the TIM Service or for hosted services.

Parameters:

dn - DistinguishedName of the profile.

attrMap - A mapping of semantic attributes to class attributes.

operations - The workflow operation mappings that determine the operations of this service

complianceRules - Collection of compliance rules for this service profile.

attributes - TODO Need a good explaination of this parameter

Method Detail

getAccountClass

public java.lang.String getAccountClass()

Returns the Account's class name of the service profile.

Returns:

class name for the account.

setAccountClass

public void setAccountClass(java.lang.String accountClassName)

Sets the Account's class name of the service profile.

Parameters:

accountClassName - name for the account.

getAccountProfileName

public java.lang.String getAccountProfileName()

Returns the Account's profile name of the service profile.

Returns:

Profile name for the account.

setAccountProfileName

public void setAccountProfileName(java.lang.String profileName)

Sets the Account's profile name of the profile.

Parameters:

profileName - Profile name for the account.

getServiceProviderFactory

public java.lang.String getServiceProviderFactory()

Returns the service provider factory for the service profile.

Returns:

service provider factory service.

setServiceProviderFactory

public void setServiceProviderFactory(java.lang.String serviceProviderFactory)

Sets the service provider factory for the service profile.

Parameters:

serviceProviderFactory - servicer provider factory name.

getProperties

public java.util.Properties getProperties()

Returns the service provider protocol and behavior properties for the service profile. The value returned will not be null. If there are no properties an empty table will be returned.

Returns:

A table of protocol and behavior properties

getProtocolMappings

public java.util.Properties getProtocolMappings()

Returns the service provider protocol mappings that determine the service instance attributes to be sent with messages to the managed resource. The value returned will not be null. If there are no properties an empty table will be returned.

Returns:

A table of protocol and behavior properties

getTransforms

public java.lang.String getTransforms()

Returns the service provider transforms for the service profile. Used primarily for legacy TIM agents.

Returns:

An xml string describing the transforms.

getGroupMappings

public java.util.Map<java.lang.String,java.lang.String> getGroupMappings()

Returns mapping of group membership attribute on the account

Returns:

Map of account attribute for group

Since:

TIM 5.0

setGroupMappings

public java.util.Map<java.lang.String,java.lang.String> setGroupMappings(java.util.Map<java.lang.String,java.lang.String> groupMappings)

Sets mapping of group membership attribute on account. Values are stored as strings with a = format.

Parameters:

groupMappings - Map of account attribute for group

Returns:

group mappings object

Since:

TIM 5.0

getGroupObjectClass

public java.lang.String[] getGroupObjectClass()

Returns a list of object class name for GROUP supporting data

Returns:

array of String for object class that represents a group

Since:

TIM 5.0

getGroupAccountAttributes

public java.lang.String[] getGroupAccountAttributes()

Returns a list of account attribute names that are related to group

Returns:

array of String

Since:

TIM 5.0

getOperationRequiredAttributes

public java.util.Collection<java.lang.String> getOperationRequiredAttributes()

List of strings that tell which attribtues are required for each operation.
op_name=source:attr_name[,source:attr_name2]...

where
op_name is one of: add|modify|suspend|restore|passwordChange|delete|search
source is either the letter "s" (for service) or "a" (for account)
attr_name is an attribute name from the service or account objectclass, depending on source value.

Returns:

list of String objects

Since:

TIM 5.0

getOperationSendAttributes

public java.util.Collection<java.lang.String> getOperationSendAttributes()

List of strings that tell which attributes are send-only for each operation.
op_name=attr_name[,attr_name2]...

where
op_name is one of: add|modify|suspend|restore|passwordChange|delete|search
attr_name is an account attribute name.

Returns:

list of String attribute names

Since:

TIM 5.0

getOperationReplaceMultiAttributes

public java.util.Collection<java.lang.String> getOperationReplaceMultiAttributes()

List of strings that tell which multi-valued attributes are considered as REPLACE instead of ADD and REMOVE for each operation.
op_name=attr_name[,attr_name2]...

where
op_name is one of: add|modify|suspend|restore|passwordChange|delete|search
attr_name is an account attribute name.

Returns:

list of String attribute names

Since:

TIM 5.0

getOperationAddDeleteSingleAttributes

public java.util.Collection<java.lang.String> getOperationAddDeleteSingleAttributes()

List of strings that tell which single-valued attributes are considered as ADD/DELETE instead of REPLACE for each operation.
op_name=attr_name[,attr_name2]...

where
op_name is one of: add|modify|suspend|restore|passwordChange|delete|search
attr_name is an account attribute name.

Returns:

list of String attribute names

Since:

TIM 5.0

getGroupAccountAttribute

public java.lang.String getGroupAccountAttribute(java.lang.String groupObjectClass)

Returns the account attribute name for the give group type

Parameters:

groupObjectClass - Name of the group ldap class

Returns:

String that represents the name of the account attribute for group members

setGroupMapping

public void setGroupMapping(java.lang.String groupObjectClass,
                            java.lang.String groupAccountAttributeName)

Sets a group mapping to specifiy account attribute for group membership

Parameters:

groupObjectClass - Name of the object class that represents the group

groupAccountAttributeName - Name of the account attribute that represents the group membership

Since:

TIM 5.0

removeGroupMapping

public void removeGroupMapping(java.lang.String groupObjectClass)

Removes a group mapping to specifiy account attribute for group membership

Parameters:

groupObjectClass - Name of the object class that represents the group

Since:

TIM 5.0

getAttributeHandlerClass

public java.lang.String getAttributeHandlerClass()

Returns the attribute handler class

Returns:

String which is the Name of the attribute handler class

Since:

TIM 5.0

setAttributeHandlerClass

public void setAttributeHandlerClass(java.lang.String className)

Sets the attribute handler class

Parameters:

className - Name of the attribute handler class

Since:

TIM 5.0

isComplexAttribute

public boolean isComplexAttribute(java.lang.String attrName)

Indicates whether an attribute is a complex attribute

Parameters:

attrName - The name of an attribute

Returns:

true if the given attribute is a complex attribute and false otherwise

getComplexAttributes

public java.util.Collection<java.lang.String> getComplexAttributes()

Returns the list of complex attributes

Returns:

Collection of String that represents a complex attribute

Since:

TIM 5.0

setComplexAttributes

public void setComplexAttributes(java.util.Collection<java.lang.String> attrNames)

Sets the list of complex attributes supported

Parameters:

attrNames - List of complex attributes

Since:

TIM 5.0

addComplexAttribute

public void addComplexAttribute(java.lang.String attrName)

Adds a complex attribute

Parameters:

attrName - Name of the attribute

Since:

TIM 5.0

removeComplexAttribute

public void removeComplexAttribute(java.lang.String attrName)

Removes a complex attribute

Parameters:

attrName - Name of the attribute

Since:

TIM 5.0

isPasswordAllowedOnRestore

public boolean isPasswordAllowedOnRestore()

Property indicates that the account password MAY be send when restoring an account. Note: null property value or "TRUE" means NOT allowed.

Note: this method is duplicated from class com.ibm.itim.remoteservices.ResourceProperties.ServiceProviderInformation

Returns:

True if password can be sent for restoring accounts

isPasswordRequiredOnRestore

public boolean isPasswordRequiredOnRestore()

Property indicates that the account password is REQUIRED for restoring accounts. Note: null property value or "TRUE" means NOT required.

Note: this method is duplicated from class com.ibm.itim.remoteservices.ResourceProperties.ServiceProviderInformation

Returns:

True if password is required for restoring accounts

isDormantAccountSupported

public boolean isDormantAccountSupported()

Indicates if a service profile supports dormant accounts.

Returns:

true if the service profile supports dormant accounts; else returns false.

enableDormantAccountSupport

public void enableDormantAccountSupport()

Enables dormant accounts if they are supported.

disableDormantAccountSupport

public void disableDormantAccountSupport()

Disables dormant accounts.