com.plumtree.server
Interface IPTACLSyncMap

All Superinterfaces:

IPTUnknown

public interface IPTACLSyncMap
extends IPTUnknown

Version:

$Revision$

Author:

MikeSample An ItemType is either ExternalDomain, AuthSourceCategory, ExternalGroup, or UserGroup. A MappingType is either Domain or Group

Method Summary

void	AddMapping(int lACLMappingType, java.lang.String bstrFromString, java.lang.String bstrToString) Add a mapping
void	ClearMappings(int lACLMappingType) Remove all existing mappings in memory for the given type
IPTAccessList	GetACL(java.lang.Object[][] vsaACL) Generates an ACL for the list of users and groups passed in The array coming in should be a 2D array with three columns.
int	GetDataSourceID() Gets the ID of the data source associated with the crawler who opened the acl sync map.
void	Initialize(IPTSession pSession) Initializes the map
IPTQueryResult	QueryMappedItems(int lACLItemType) Get the all of the strings that are in the map for this item.
IPTQueryResult	QueryMappingsForItem(int lACLItemType, java.lang.String bstrString) Get the items that this item is mapped to or from.
IPTQueryResult	QueryUnmappedExternalDomains(java.lang.Object[][] vQueryFilter) Returns external domains for which no mapping currently exists
void	RemoveMapping(int lACLMappingType, java.lang.String bstrFromString, java.lang.String bstrToString) Delete a mapping entry
void	SetDataSourceID(int Value) Sets the ID of the data source associated with the crawler who opened the acl sync map.

Methods inherited from interface com.plumtree.server.IPTUnknown

GetInterfaces

Method Detail

QueryMappedItems

IPTQueryResult QueryMappedItems(int lACLItemType)

Get the all of the strings that are in the map for this item.

Parameters:

lACLItemType - a PT_ACLSYNC_ITEMTYPES for which mappings desired

Returns:

an IPTQueryResult containing all the string mappings for this type

QueryMappingsForItem

IPTQueryResult QueryMappingsForItem(int lACLItemType,
                                    java.lang.String bstrString)

Get the items that this item is mapped to or from.

Parameters:

lACLItemType - a PT_ACLSYNC_ITEMTYPES for which mappings desired

bstrString - The mapping string

Returns:

an IPTQueryResult containing mapped items

AddMapping

void AddMapping(int lACLMappingType,
                java.lang.String bstrFromString,
                java.lang.String bstrToString)

Add a mapping

Parameters:

lACLMappingType - The type to which the mapping is added

bstrFromString - The source string for the mapping

bstrToString - The target or corresponding "To" string

RemoveMapping

void RemoveMapping(int lACLMappingType,
                   java.lang.String bstrFromString,
                   java.lang.String bstrToString)

Delete a mapping entry

Parameters:

lACLMappingType - The type for which the mapping will be removed

bstrFromString - The source string for the mapping

bstrToString - The target or corresponding "To" string

GetACL

IPTAccessList GetACL(java.lang.Object[][] vsaACL)

Generates an ACL for the list of users and groups passed in The array coming in should be a 2D array with three columns. The first column is external domain strings, the second column is external user group or user names, and the third column is PT_USER_ID or PT_USERGROUP_ID. The Data Source ID must be set before this call can succeed.

Parameters:

vsaACL - An array specifying groups and users for which an ACL should be generated

Returns:

An IPTAccessList produced for the requested users and groups

Initialize

void Initialize(IPTSession pSession)

Initializes the map

Parameters:

pSession - A user session from which a secured map is built

SetDataSourceID

void SetDataSourceID(int Value)

Sets the ID of the data source associated with the crawler who opened the acl sync map. Must be set before GetACL is called.

Parameters:

Value - an int indicating the appropriate Data Source ID

GetDataSourceID

int GetDataSourceID()

Gets the ID of the data source associated with the crawler who opened the acl sync map.

Parameters:

Value - an int indicating the appropriate Data Source ID

QueryUnmappedExternalDomains

IPTQueryResult QueryUnmappedExternalDomains(java.lang.Object[][] vQueryFilter)

Returns external domains for which no mapping currently exists

Parameters:

vQueryFilter - A QueryFilter

Returns:

an IPTQueryResult containing external domain descriptors

ClearMappings

void ClearMappings(int lACLMappingType)

Remove all existing mappings in memory for the given type

Parameters:

lACLMappingType - The type for which all mappings will be removed