|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPTAuthSource
Authentication Source objects provide authentication for plumtree users, as well as synchronization with external user repositories.
com.plumtree.server.IPTAuthSourceProvider
Method Summary | |
---|---|
int |
CreateRemoteUser(int nAdminFolderID,
java.lang.String sUniqueName,
java.lang.String sAuthenticationName,
java.lang.String sLoginName,
java.lang.String sDisplayName,
java.lang.Object[] arrGroupUniqueNames)
Creates a remote user against the specified authentication source. |
int |
EnableAgentDisabledUsers()
Enable "agent-disabled" users, and return the number of users that were re-enabled. |
int |
GetAgentDisabledUsersCount()
Get the number of "agent-disabled" users currently disabled by an agent on this auth source. |
int |
GetAuthPartnerID()
Returns the ID of the authentication partner, or 0 for no
partner. |
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. |
boolean |
GetImportCrossASMembers()
Returns the value of the import memberships from other authentication sources flag. |
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 |
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 |
PutEveryoneGroupID(int Value)
Allows the everyone group ID to be set. |
void |
SetAuthPartnerID(int Value)
Sets the ID of the authentication partner, or 0 for no
partner. |
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 |
SetImportCrossASMembers(boolean bImportMembers)
Sets a flag that tells the sync agent to import memberships for users imported to other authentication sources. |
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 |
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 |
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 |
---|
java.lang.String GetProviderCLSID()
void SetProviderCLSID(java.lang.String Value)
Value
- a CLSIDjava.lang.String GetPrefixString()
int GetSyncType()
PT_SYNCTYPES
void SetSyncType(int Value)
Value
- a PT_SYNCTYPEPT_SYNCTYPES
int GetEveryoneGroupID()
void PutEveryoneGroupID(int Value)
Value
- the group ID that the auth source should use for it's everyone groupjava.lang.Object[] GetFullSyncGroups()
void SetFullSyncGroups(int[] Value)
Value
- an array of group idsvoid SetFullSyncGroups(java.lang.Object[] Value)
Value
- an array of group idsint GetDefaultProfileForNewUsers()
void SetDefaultProfileForNewUsers(int Value)
Value
- the id of the default profile userint GetBulkCopyNum()
void SetBulkCopyNum(int Value)
Value
- number of rows which can be insertedcom.plumtree.openfoundation.util.IXPPropertyBag GetProviderInfo()
void SetProviderInfo(com.plumtree.openfoundation.util.IXPPropertyBag Value)
Value
- the provider property bagvoid SetProviderInfo(java.lang.String Value)
Value
- the provider property bag as XMLint GetAuthPartnerID()
0
for no
partner. The auth partner, if any, is used to authenticate users from
this auth source.
void SetAuthPartnerID(int Value)
0
for no
partner. The auth partner, if any, is used to authenticate users from
this auth source.
Value
- the id of the auth partnerboolean GetUseDefaultProfilesMap()
GetDefaultProfileForNewUsers
.
void SetUseDefaultProfilesMap(boolean Value)
GetDefaultProfileForNewUsers
.
Value
- whether the default profile map should be usedvoid SetDefaultProfilesMap(int[] vsaUserGroupIDs, int[] vsaUserIDs, int[] vsaFolderIDs)
vsaUserGroupIDs
- array of group idsvsaUserIDs
- array of default profile idsvsaFolderIDs
- array of folder idsvoid SetDefaultProfilesMap(java.lang.Object[] vsaUserGroupIDs, java.lang.Object[] vsaUserIDs, java.lang.Object[] vsaFolderIDs)
vsaUserGroupIDs
- array of group idsvsaUserIDs
- array of default profile idsvsaFolderIDs
- array of folder idsjava.lang.Object[] GetDefaultProfilesMap_GroupIDs()
java.lang.Object[] GetDefaultProfilesMap_UserIDs()
java.lang.Object[] GetDefaultProfilesMap_FolderIDs()
int GetSupportsSync()
PT_AUTHSOURCE_SUPPORTSSYNCMODES
void SetSupportsSync(int Value)
Value
- a PT_AUTHSOURCE_SUPPORTSSYNCMODEPT_AUTHSOURCE_SUPPORTSSYNCMODES
int GetNewUserFolderID()
void SetNewUserFolderID(int Value)
Value
- a folder idint GetNewGroupFolderID()
void SetNewGroupFolderID(int Value)
Value
- a folder idint GetDeletedUserFolderID()
void SetDeletedUserFolderID(int Value)
Value
- a folder idint GetDeletedGroupFolderID()
void SetDeletedGroupFolderID(int Value)
Value
- a folder idint GetWebServiceID()
void SetWebServiceID(int Value)
Value
- a web service idint EnableAgentDisabledUsers()
int GetAgentDisabledUsersCount()
void SetImportCrossASMembers(boolean bImportMembers)
Sets a flag that tells the sync agent to import memberships for users imported to other authentication sources. The default behavior is for this feature to be disabled.
bImportMembers
- - true
to tell the agent to import
memberships from other authentication sources. false
to tell the agent not to import such memberships.boolean GetImportCrossASMembers()
Returns the value of the import memberships from other authentication sources flag.
true
if the authentication source is importing memberships
from other authentication sources. false
if it is not.int CreateRemoteUser(int nAdminFolderID, java.lang.String sUniqueName, java.lang.String sAuthenticationName, java.lang.String sLoginName, java.lang.String sDisplayName, java.lang.Object[] arrGroupUniqueNames)
Creates a remote user against the specified authentication source. This function does not replace a user synchronization, but instead allows a user to be created against an authentication source in a one-off manner between user synchronizations. All attributes of the user, as imported via this function, will be preserved and properly updated by regular user syncs.
nAdminFolderID
- - the admin folder to create the user in, if -1 is specified the
default folder as specified in the authentication source will be usedsUniqueName
- - the unique name of the user. This string should never change
during the life of this user, e.g. a GUID from Active Directory.sAuthenticationName
- - the authentication name to send to the remote AWS when
the user attempts to authenticate, e.g. JDoe@plumtree.comsLoginName
- - the login name of the user. This is the string the user will
type in as their portal username, e.g. JDoesDisplayName
- - the display name of the user, e.g. John DoearrGroupUniqueNames
- - a set of group unique names for groups from the same
authentication source.
int
representing this user's object id
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |