com.plumtree.server
Interface IPTAuthSource

All Superinterfaces:
IPTLocalizable, IPTObject, IPTUnknown

public interface IPTAuthSource
extends IPTObject

Authentication Source objects provide authentication for plumtree users, as well as synchronization with external user repositories.

See Also:
IPTAuthSourceProvider

Method Summary
 boolean Authenticate(int vUser, java.lang.String bstrPassword, java.lang.Object vSecurityToken)
          Deprecated.  
 boolean Authenticate(java.lang.String vUser, java.lang.String bstrPassword, java.lang.Object vSecurityToken)
          Deprecated.  
 IPTAuthSourceProvider GetAuthOnlyProvider()
          Deprecated.  
 int GetAuthPartnerID()
          Returns the ID of the authentication partner, or 0 for no partner.
 IPTAuthSourceProvider GetAuthSourceProvider()
          Deprecated.  
 int GetAuthType()
          Deprecated.  
 int GetBulkCopyNum()
          Returns the maximum number of database rows which can be inserted at a time during user sync.
 int GetDefaultProfileForNewUsers()
          Returns the id of the default profile which will be applied to users imported by this auth source.
 java.lang.Object[] GetDefaultProfilesMap_FolderIDs()
          Returns the array of folder ids from the default profiles map.
 java.lang.Object[] GetDefaultProfilesMap_GroupIDs()
          Returns the array of group ids from the default profiles map.
 java.lang.Object[] GetDefaultProfilesMap_UserIDs()
          Returns the array of default profile ids from the default profiles map.
 int GetDeletedGroupFolderID()
          Returns the id of the admin folder where deleted groups will be moved.
 int GetDeletedUserFolderID()
          Returns the id of the admin folder where deleted users will be moved.
 int GetEveryoneGroupID()
          Returns the id of the everyone group for this auth source.
 java.lang.Object[] GetFullSyncGroups()
          Returns the list of groups which have been selected for partial users sync.
 int GetNewGroupFolderID()
          Returns the id of the admin folder where new groups will be created.
 int GetNewUserFolderID()
          Returns the id of the admin folder where new users will be created.
 java.lang.String GetPrefixString()
          Returns the prefix used for users imported by this auth source.
 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 GetSettings()
          Deprecated.  
 int GetSupportsSync()
          Returns whether this auth source supports user sync.
 int GetSyncType()
          Returns the sync gype fo this auth source.
 boolean GetUseDefaultProfilesMap()
          Returns whether the default profiles map is used for this auth source.
 int GetWebServiceID()
          Returns the id of the web service associated with this auth source.
 void SetAuthPartnerID(int Value)
          Sets the ID of the authentication partner, or 0 for no partner.
 void SetAuthType(int Value)
          Deprecated.  
 void SetBulkCopyNum(int Value)
          Sets the maximum number of database rows which can be inserted at a time during user sync.
 void SetDefaultProfileForNewUsers(int Value)
          Sets the id of the default profile which will be applied to users imported by this auth source.
 void SetDefaultProfilesMap(int[] vsaUserGroupIDs, int[] vsaUserIDs, int[] vsaFolderIDs)
          Sets the default profiles map, which determines which default profile new users will receive, and into which admin folder they will be placed.
 void SetDefaultProfilesMap(java.lang.Object[] vsaUserGroupIDs, java.lang.Object[] vsaUserIDs, java.lang.Object[] vsaFolderIDs)
          Sets the default profiles map, which determines which default profile new users will receive, and into which admin folder they will be placed.
 void SetDeletedGroupFolderID(int Value)
          Sets the id of the admin folder where deleted groups will be created.
 void SetDeletedUserFolderID(int Value)
          Sets the id of the admin folder where deleted users will be moved.
 void SetFullSyncGroups(int[] Value)
          Sets the list of groups which have been selected for partial users sync.
 void SetFullSyncGroups(java.lang.Object[] Value)
          /** Sets the list of groups which have been selected for partial users sync.
 void SetNewGroupFolderID(int Value)
          Sets the id of the admin folder where new groups will be created.
 void SetNewUserFolderID(int Value)
          Sets the id of the admin folder where new users will be created.
 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 SetSettings(int Value)
          Deprecated.  
 void SetSupportsSync(int Value)
          Sets whether this auth source supports user sync.
 void SetSyncType(int Value)
          Sets the sync type of this auth source.
 void SetUseDefaultProfilesMap(boolean Value)
          Sets whether the default profiles map is used for this auth source.
 void SetWebServiceID(int Value)
          Returns the id of the web service associated with this auth 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
 

Method Detail

GetProviderCLSID

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

SetProviderCLSID

public void SetProviderCLSID(java.lang.String Value)
Sets the provider CLSID.
Parameters:
Value - a CLSID

GetPrefixString

public java.lang.String GetPrefixString()
Returns the prefix used for users imported by this auth source.
Returns:
the prefix.

GetAuthType

public int GetAuthType()
Deprecated.  

Returns the auth type of this auth source. Deprecated, because all auth sources except the Plumtree auth source are now of type PT_AUTHTYPE_EXTENSIBLE.
Returns:
a PT_AUTHTYPE
See Also:
PT_AUTHTYPES

SetAuthType

public void SetAuthType(int Value)
Deprecated.  

Sets the auth type of this auth source. Deprecated, because all auth sources except the Plumtree auth source are now of type PT_AUTHTYPE_EXTENSIBLE.
Parameters:
Value - a PT_AUTHTYPE
See Also:
PT_AUTHTYPES

GetSyncType

public int GetSyncType()
Returns the sync gype fo this auth source.
Returns:
a PT_SYNCTYPE
See Also:
PT_SYNCTYPES

SetSyncType

public void SetSyncType(int Value)
Sets the sync type of this auth source.
Parameters:
Value - a PT_SYNCTYPE
See Also:
PT_SYNCTYPES

GetAuthSourceProvider

public IPTAuthSourceProvider GetAuthSourceProvider()
Deprecated.  

Returns the provider for this auth source.
Returns:
an IPTAuthSourceProvider
See Also:
IPTAuthSourceProvider

GetSettings

public int GetSettings()
Deprecated.  

Unused method for getting a bitmask of settings.
Returns:
a bitmask of PT_AUTHSOURCE_SETTINGS
See Also:
PT_AUTHSOURCE_SETTINGS

SetSettings

public void SetSettings(int Value)
Deprecated.  

Unused method for setting a bitmask of settings.
Parameters:
Value - a bitmask of PT_AUTHSOURCE_SETTINGS
See Also:
PT_AUTHSOURCE_SETTINGS

GetEveryoneGroupID

public int GetEveryoneGroupID()
Returns the id of the everyone group for this auth source.
Returns:
the id of the everyone group

Authenticate

public boolean Authenticate(int vUser,
                            java.lang.String bstrPassword,
                            java.lang.Object vSecurityToken)
Deprecated.  

Unused method which authenticates a user. This code now resides in PTInternalSession.
Parameters:
vUser - a user id
bstrPassword - the password
vSecurityToken - security token used for sso
Returns:
true if the authentication succeeds

Authenticate

public boolean Authenticate(java.lang.String vUser,
                            java.lang.String bstrPassword,
                            java.lang.Object vSecurityToken)
Deprecated.  

Unused method which authenticates a user.
Parameters:
vUser - a user's login name
bstrPassword - the password
vSecurityToken - security token used for sso
Returns:
true if the authentication succeeds

GetFullSyncGroups

public java.lang.Object[] GetFullSyncGroups()
Returns the list of groups which have been selected for partial users sync. Only members of these groups will be imported.
Returns:
an array of integers

SetFullSyncGroups

public void SetFullSyncGroups(int[] Value)
Sets the list of groups which have been selected for partial users sync. Only members of these groups will be imported.
Parameters:
Value - an array of group ids

SetFullSyncGroups

public void SetFullSyncGroups(java.lang.Object[] Value)
/** Sets the list of groups which have been selected for partial users sync. Only members of these groups will be imported.
Parameters:
Value - an array of group ids

GetDefaultProfileForNewUsers

public int GetDefaultProfileForNewUsers()
Returns the id of the default profile which will be applied to users imported by this auth source.
Returns:
the id of the default profile user

SetDefaultProfileForNewUsers

public void SetDefaultProfileForNewUsers(int Value)
Sets the id of the default profile which will be applied to users imported by this auth source.
Parameters:
Value - the id of the default profile user

GetBulkCopyNum

public int GetBulkCopyNum()
Returns the maximum number of database rows which can be inserted at a time during user sync.
Returns:
number of rows which can be inserted

SetBulkCopyNum

public void SetBulkCopyNum(int Value)
Sets the maximum number of database rows which can be inserted at a time during user sync.
Parameters:
Value - number of rows which can be inserted

GetProviderInfo

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

SetProviderInfo

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

SetProviderInfo

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

GetAuthPartnerID

public int GetAuthPartnerID()
Returns the ID of the authentication partner, or 0 for no partner. The auth partner, if any, is used to authenticate users from this auth source.
Returns:
the id of the auth partner

SetAuthPartnerID

public void SetAuthPartnerID(int Value)
Sets the ID of the authentication partner, or 0 for no partner. The auth partner, if any, is used to authenticate users from this auth source.
Parameters:
Value - the id of the auth partner

GetAuthOnlyProvider

public IPTAuthSourceProvider GetAuthOnlyProvider()
Deprecated.  

Returns the provider used for authentication, i.e. the provider of the auth partner.
Returns:
the auth provider

GetUseDefaultProfilesMap

public boolean GetUseDefaultProfilesMap()
Returns whether the default profiles map is used for this auth source. If not, all new users will receive the profile id returned by GetDefaultProfileForNewUsers.
Returns:
true if the default profile map is used

SetUseDefaultProfilesMap

public void SetUseDefaultProfilesMap(boolean Value)
Sets whether the default profiles map is used for this auth source. If not, all new users will receive the profile id returned by GetDefaultProfileForNewUsers.
Parameters:
Value - whether the default profile map should be used

SetDefaultProfilesMap

public void SetDefaultProfilesMap(int[] vsaUserGroupIDs,
                                  int[] vsaUserIDs,
                                  int[] vsaFolderIDs)
Sets the default profiles map, which determines which default profile new users will receive, and into which admin folder they will be placed.
Parameters:
vsaUserGroupIDs - array of group ids
vsaUserIDs - array of default profile ids
vsaFolderIDs - array of folder ids

SetDefaultProfilesMap

public void SetDefaultProfilesMap(java.lang.Object[] vsaUserGroupIDs,
                                  java.lang.Object[] vsaUserIDs,
                                  java.lang.Object[] vsaFolderIDs)
Sets the default profiles map, which determines which default profile new users will receive, and into which admin folder they will be placed.
Parameters:
vsaUserGroupIDs - array of group ids
vsaUserIDs - array of default profile ids
vsaFolderIDs - array of folder ids

GetDefaultProfilesMap_GroupIDs

public java.lang.Object[] GetDefaultProfilesMap_GroupIDs()
Returns the array of group ids from the default profiles map.
Returns:
the array of group ids

GetDefaultProfilesMap_UserIDs

public java.lang.Object[] GetDefaultProfilesMap_UserIDs()
Returns the array of default profile ids from the default profiles map.
Returns:
the array of default profile ids

GetDefaultProfilesMap_FolderIDs

public java.lang.Object[] GetDefaultProfilesMap_FolderIDs()
Returns the array of folder ids from the default profiles map.
Returns:
the array of folder ids

GetSupportsSync

public int GetSupportsSync()
Returns whether this auth source supports user sync.
Returns:
a PT_AUTHSOURCE_SUPPORTSSYNCMODE
See Also:
PT_AUTHSOURCE_SUPPORTSSYNCMODES

SetSupportsSync

public void SetSupportsSync(int Value)
Sets whether this auth source supports user sync.
Parameters:
Value - a PT_AUTHSOURCE_SUPPORTSSYNCMODE
See Also:
PT_AUTHSOURCE_SUPPORTSSYNCMODES

GetNewUserFolderID

public int GetNewUserFolderID()
Returns the id of the admin folder where new users will be created.
Returns:
a folder id

SetNewUserFolderID

public void SetNewUserFolderID(int Value)
Sets the id of the admin folder where new users will be created.
Parameters:
Value - a folder id

GetNewGroupFolderID

public int GetNewGroupFolderID()
Returns the id of the admin folder where new groups will be created.
Returns:
a folder id

SetNewGroupFolderID

public void SetNewGroupFolderID(int Value)
Sets the id of the admin folder where new groups will be created.
Parameters:
Value - a folder id

GetDeletedUserFolderID

public int GetDeletedUserFolderID()
Returns the id of the admin folder where deleted users will be moved. If 0, users will be deleted instead of disabled and moved.
Returns:
a folder id

SetDeletedUserFolderID

public void SetDeletedUserFolderID(int Value)
Sets the id of the admin folder where deleted users will be moved. If 0, users will be deleted instead of disabled and moved.
Parameters:
Value - a folder id

GetDeletedGroupFolderID

public int GetDeletedGroupFolderID()
Returns the id of the admin folder where deleted groups will be moved. If 0, groups will be deleted instead of moved.
Returns:
a folder id

SetDeletedGroupFolderID

public void SetDeletedGroupFolderID(int Value)
Sets the id of the admin folder where deleted groups will be created. If 0, groups will be deleted instead of moved.
Parameters:
Value - a folder id

GetWebServiceID

public int GetWebServiceID()
Returns the id of the web service associated with this auth source. Only applicable to remote auth sources.
Returns:
a web service id

SetWebServiceID

public void SetWebServiceID(int Value)
Returns the id of the web service associated with this auth source. Only applicable to remote auth sources.
Parameters:
Value - a web service id


Copyright © 2003 Plumtree Software Inc. All Rights Reserved.