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	LOCAL Name of service profile property indicating that the service is local.
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	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

ER_XML, OBJ_PROFILE_ATTR_CATEGORY, OBJ_PROFILE_ATTR_CUSTOM_CLASS, OBJ_PROFILE_ATTR_MAP, OBJ_PROFILE_ATTR_NAME, OBJ_PROFILE_ATTR_RDN, OBJ_PROFILE_ATTR_SEARCH, OBJ_PROFILE_RULES_ATTR

Constructor Summary

ServiceProfile(DistinguishedName dn, java.lang.String name, java.lang.String customClass, java.lang.String nameAttr, java.util.Map attrMap, java.lang.String searchAttr, java.lang.String accountClass, java.lang.String accountProfileName)
Constructs a new ServiceProfile object.

ServiceProfile(DistinguishedName dn, java.lang.String name, java.lang.String customClass, java.lang.String nameAttr, java.util.Map 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)
Constructs a new ServiceProfile object.

ServiceProfile(DistinguishedName dn, java.lang.String name, java.lang.String customClass, java.lang.String nameAttr, java.util.Map 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 operations, java.util.Collection rules)
Constructs a new ServiceProfile object.

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

Method Summary

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

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

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

Methods inherited from class java.lang.Object

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

Field Detail

ACCOUNTCLASS

public static java.lang.String ACCOUNTCLASS

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

ACCOUNT_PROFILE

public static java.lang.String ACCOUNT_PROFILE

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

SERVICE_PROVIDER_FACTORY

public static java.lang.String SERVICE_PROVIDER_FACTORY

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

PROPERTIES

public static java.lang.String PROPERTIES

The name attribute with the collection of protocol and behavior properties

LOCAL

public static java.lang.String LOCAL

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

TRUE

public static java.lang.String TRUE

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

PROTOCOL_MAPPINGS

public static 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.

TRANSFORMS

public static java.lang.String TRANSFORMS

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

Constructor Detail

ServiceProfile

public ServiceProfile(DistinguishedName dn,
                      java.lang.String name,
                      java.lang.String customClass,
                      java.lang.String nameAttr,
                      java.util.Map attrMap,
                      java.lang.String searchAttr,
                      java.lang.String accountClass,
                      java.lang.String accountProfileName)

Constructs a new ServiceProfile object.

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

ServiceProfile

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

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

ServiceProfile

public ServiceProfile(DistinguishedName dn,
                      java.lang.String name,
                      java.lang.String customClass,
                      java.lang.String nameAttr,
                      java.util.Map 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)

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

ServiceProfile

public ServiceProfile(DistinguishedName dn,
                      java.lang.String name,
                      java.lang.String customClass,
                      java.lang.String nameAttr,
                      java.util.Map 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 operations,
                      java.util.Collection 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.

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.

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.

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