com.plumtree.server
Interface IPTProfileSourceProvider

All Superinterfaces:
IPTUnknown

public interface IPTProfileSourceProvider
extends IPTUnknown

Interface to profile source providers, which make user profile information available for import into Plumtree. This interface is no longer outward-facing. It has been replaced by the internal interface IProfileProvider.

See Also:
IPTProfileSource

Method Summary
 java.lang.String AttachToUser(int nUserID, java.lang.String bstrLoginName, java.lang.String bstrUniqueName, java.lang.String bstrLastSignature)
          Deprecated. Attaches to a user to which subsequent calls to GetUserSignature() and GetUserProperties() will apply.
 java.lang.String GetGlobalSignature()
          Deprecated. Returns a signature for the provider; if this is unchanged, no user's information has changed.
 java.lang.Object[][] GetKnownProperties(java.lang.String bstrLocale)
          Deprecated. Currently unused; returns a list of all properties known by the provider.
 java.lang.Object[][] GetUserProperties()
          Deprecated. Returns a list of properties and values for the current user.
 java.lang.String GetUserSignature()
          Deprecated. Returns a signature for the current user.
 void Initialize(IPTSession pSession, java.lang.Object[] vsaPropertyList, com.plumtree.openfoundation.util.IXPPropertyBag pbagProfileSourceInfo, com.plumtree.openfoundation.util.IXPPropertyBag pbagAuthSourceInfo, int nWebServiceID)
          Deprecated. Initializes the provider.
 void Shutdown()
          Deprecated. Called after the sync has completed; releases any resources.
 
Methods inherited from interface com.plumtree.server.IPTUnknown
GetInterfaces
 

Method Detail

Initialize

public void Initialize(IPTSession pSession,
                       java.lang.Object[] vsaPropertyList,
                       com.plumtree.openfoundation.util.IXPPropertyBag pbagProfileSourceInfo,
                       com.plumtree.openfoundation.util.IXPPropertyBag pbagAuthSourceInfo,
                       int nWebServiceID)
Deprecated. 
Initializes the provider.
Parameters:
pSession - an IPTSession
vsaPropertyList - array of properties to return for each user
pbagProfileSourceInfo - provider settings
pbagAuthSourceInfo - auth source partner settings
nWebServiceID - web service associated with the provider

GetKnownProperties

public java.lang.Object[][] GetKnownProperties(java.lang.String bstrLocale)
Deprecated. 
Currently unused; returns a list of all properties known by the provider. May eventually be used to display a friendly UI in the profile source editor.
Parameters:
bstrLocale - current locale
Returns:
an array of [property name, property identifier]

GetGlobalSignature

public java.lang.String GetGlobalSignature()
Deprecated. 
Returns a signature for the provider; if this is unchanged, no user's information has changed. Could be a last modified date.
Returns:
a signature, or an empty string if none.

AttachToUser

public java.lang.String AttachToUser(int nUserID,
                                     java.lang.String bstrLoginName,
                                     java.lang.String bstrUniqueName,
                                     java.lang.String bstrLastSignature)
Deprecated. 
Attaches to a user to which subsequent calls to GetUserSignature() and GetUserProperties() will apply.
Parameters:
nUserID - id of the user
bstrLoginName - the user's login name
bstrUniqueName - the user's unique name
bstrLastSignature - the user's previous signature
Returns:
a message for the job log

GetUserSignature

public java.lang.String GetUserSignature()
Deprecated. 
Returns a signature for the current user. If this is unchanged from the previous sync, the user's information will not be updated. Could be a last modified date.
Returns:
a signature, or an empty string if none

GetUserProperties

public java.lang.Object[][] GetUserProperties()
Deprecated. 
Returns a list of properties and values for the current user.
Returns:
array of [property identifier, property value]

Shutdown

public void Shutdown()
Deprecated. 
Called after the sync has completed; releases any resources.


Copyright © 2003 Plumtree Software Inc. All Rights Reserved.