com.plumtree.server
Interface IPTProfileSource

All Superinterfaces:
IPTLocalizable, IPTObject, IPTServerContext, IPTStorable, IPTUnknown

public interface IPTProfileSource
extends IPTObject

Profile source objects import user profile information from external repositories.

Version:
$Revision$
Author:
Mike Jahr
See Also:
com.plumtree.server.IPTProfileSourceProvider

Method Summary
 void ClearHistory()
          Clears the history of imports, so all information will be re-imported during the next sync.
 int GetAuthSourcePartner()
          Returns the auth source parter whose settings will be used for the provider.
 java.lang.Object[] GetGroupList()
          Returns the list of groups whose profile information will be updated.
 int GetPortalUniqueKey()
          Returns the id of an IPTProperty or a value from the PT_PROFILE_UNIQUE_KEYS enumeration.
 java.lang.Object[][] GetPropertyMap()
          Returns the map from property id to provider attribute.
 java.lang.String GetProviderCLSID()
          Returns the CLSID of the provider for this auth source.
 com.plumtree.openfoundation.util.IXPPropertyBag GetProviderInfo()
          Returns the provider property bag.
 int GetWebServiceID()
          Returns the id of the web service associated with the provider.
 void SetAuthSourcePartner(int Value)
          Sets the auth source parter whose settings will be used for the provider.
 void SetGroupList(int[] Value)
          Sets the list of groups whose profile information will be updated.
 void SetGroupList(java.lang.Object[] Value)
          Sets the list of groups whose profile information will be updated.
 void SetPortalUniqueKey(int nUniqueKeyID)
          Allows a particular property value to be sent to remote profile providers (PWS) in place of the portal's unique name for each user.
 void SetPropertyMap(java.lang.Object[][] Value)
          Sets the map from property id to provider attribute.
 void SetProviderCLSID(java.lang.String Value)
          Sets the provider CLSID.
 void SetProviderInfo(com.plumtree.openfoundation.util.IXPPropertyBag Value)
          Sets the provider property bag.
 void SetProviderInfo(java.lang.String Value)
          Sets the provider property bag as XML.
 void SetWebServiceID(int Value)
          Returns the id of the web service associated with the provider.
 void UpdateUserProfile(int nUserID)
          Updates the given user's profile against this profile source.
 
Methods inherited from interface com.plumtree.server.IPTObject
GetAdminFolderID, GetClassID, GetCreated, GetImageUUID, GetLastModified, GetObjectProperties, SetAdminFolderID, SetImageUUID, SetLastModified
 
Methods inherited from interface com.plumtree.server.IPTLocalizable
GetDescription, GetIsLocalized, GetLocalizedDescription, GetLocalizedDescriptions, GetLocalizedName, GetLocalizedNames, GetName, GetPrimaryLang, GetSupportsLocalization, SetDescription, SetIsLocalized, SetLocalizedDescriptions, SetLocalizedNames, SetName, SetPrimaryLang
 
Methods inherited from interface com.plumtree.server.IPTUnknown
GetInterfaces
 
Methods inherited from interface com.plumtree.server.IPTServerContext
GetAccessLevel, GetACL, GetLastModifiedBy, GetLockState, GetObjectID, GetOwnerID, GetServerContextSettings, GetSession, GetSettings, LockObject, SetLastModifiedBy, SetObjectID, SetOwnerID, SetServerContextSettings, SetSettings, UnlockObject
 
Methods inherited from interface com.plumtree.server.IPTStorable
Store
 

Method Detail

GetProviderCLSID

java.lang.String GetProviderCLSID()
Returns the CLSID of the provider for this auth source.

Returns:
a CLSID

SetProviderCLSID

void SetProviderCLSID(java.lang.String Value)
Sets the provider CLSID.

Parameters:
Value - a CLSID

GetProviderInfo

com.plumtree.openfoundation.util.IXPPropertyBag GetProviderInfo()
Returns the provider property bag.

Returns:
the provider property bag

SetProviderInfo

void SetProviderInfo(com.plumtree.openfoundation.util.IXPPropertyBag Value)
Sets the provider property bag.

Parameters:
Value - the provider property bag

SetProviderInfo

void SetProviderInfo(java.lang.String Value)
Sets the provider property bag as XML.

Parameters:
Value - the provider property bag as XML

GetGroupList

java.lang.Object[] GetGroupList()
Returns the list of groups whose profile information will be updated. Users can be included in the list with negative id numbers.

Returns:
array of group and user ids

SetGroupList

void SetGroupList(int[] Value)
Sets the list of groups whose profile information will be updated. Users can be included in the list with negative id numbers.

Parameters:
Value - array of group and user ids

SetGroupList

void SetGroupList(java.lang.Object[] Value)
Sets the list of groups whose profile information will be updated. Users can be included in the list with negative id numbers.

Parameters:
Value - array of group and user ids

GetAuthSourcePartner

int GetAuthSourcePartner()
Returns the auth source parter whose settings will be used for the provider.

Returns:
an auth source id

SetAuthSourcePartner

void SetAuthSourcePartner(int Value)
Sets the auth source parter whose settings will be used for the provider.

Parameters:
Value - an auth source id

GetPropertyMap

java.lang.Object[][] GetPropertyMap()
Returns the map from property id to provider attribute.

Returns:
array of [property id, attribute]

SetPropertyMap

void SetPropertyMap(java.lang.Object[][] Value)
Sets the map from property id to provider attribute.

Parameters:
Value - array of [property id, attribute]

GetWebServiceID

int GetWebServiceID()
Returns the id of the web service associated with the provider.

Returns:
a web service id

SetWebServiceID

void SetWebServiceID(int Value)
Returns the id of the web service associated with the provider.

Parameters:
Value - a web service id

ClearHistory

void ClearHistory()
Clears the history of imports, so all information will be re-imported during the next sync.


SetPortalUniqueKey

void SetPortalUniqueKey(int nUniqueKeyID)

Allows a particular property value to be sent to remote profile providers (PWS) in place of the portal's unique name for each user.

Parameters:
nUniqueKeyID - - the object id of an IPTProperty you wish to send to remote profile providers (PWS) in place of the portal's unique key. Alternatively, one can pass something from the PT_PROFILE_UNIQUE_KEYS enumeration.
See Also:
IPTProperty, PT_PROFILE_UNIQUE_KEYS

GetPortalUniqueKey

int GetPortalUniqueKey()

Returns the id of an IPTProperty or a value from the PT_PROFILE_UNIQUE_KEYS enumeration.

Returns:
a valid IPTProperty object id, or a PT_PROFILE_UNIQUE_KEYS value.
See Also:
IPTProperty, PT_PROFILE_UNIQUE_KEYS

UpdateUserProfile

void UpdateUserProfile(int nUserID)

Updates the given user's profile against this profile source. If the user has no valid attributes in the remote profile repository, no changes will be made. This function does not replace a profile synchronization, but instead allows for singleton updates of specific users between profile syncs.

Parameters:
nUserID - - the portal user id of the user to update


Copyright 2008 Plumtree Software Inc. All Rights Reserved.