com.plumtree.server
Interface IPTAuthSourceProvider

All Superinterfaces:
IPTUnknown

public interface IPTAuthSourceProvider
extends IPTUnknown

Interface to auth source providers, which both authenticate users, and make external users and groups available for import into Plumtree. This interface is no longer outward-facing. It has been replaced by the internal interfaces IAuthProvider and ISyncProvider.

See Also:
IPTAuthSource

Method Summary
 boolean Authenticate(java.lang.String bstrAuthUserName, java.lang.String bstrPassword, java.lang.Object vSecurityToken, IPTUserInfo pUserInfo)
          Deprecated. Authenticates a single user.
 java.lang.String GetAuthSourceProviderCLSID()
          Deprecated. Returns the CLSID for the provider.
 java.lang.Object GetCapabilities(int lAuthSourceCapability)
          Deprecated. Returns whether the provider supports a particular capability.
 java.lang.String GetCategory()
          Deprecated. Returns the provider's auth source prefix, aka category.
 java.lang.String GetDescription()
          Deprecated. Returns a human-readable description for the provider.
 java.lang.Object[][] GetGroups()
          Deprecated. Returns a list of all groups known to the provider.
 java.lang.String GetImageUUID()
          Deprecated. Returns the image UUID for the provider.
 java.lang.Object[][] GetMembers(java.lang.String bstrUniqueGroupName)
          Deprecated. Returns a list of all members of a particular group.
 java.lang.String GetName()
          Deprecated. Returns a human-readable name for the provider.
 java.lang.Object[][] GetUsers()
          Deprecated. Returns a list of all users known to the provider.
 void Initialize(IPTSession pSession, com.plumtree.openfoundation.util.IXPPropertyBag pbagConfigurationInfo, IPTWebService pService)
          Deprecated. Initializes the provider.
 java.lang.String PlumtreeNameToUsername(java.lang.String bstrPlumtreeName)
          Deprecated. Removes the provider's prefix from a username.
 java.lang.String UsernameToPlumtreeName(java.lang.String bstrUsername)
          Deprecated. Prepends the provider's auth source prefix to a username.
 boolean Validate()
          Deprecated. Validate the settings on the provider.
 
Methods inherited from interface com.plumtree.server.IPTUnknown
GetInterfaces
 

Method Detail

GetGroups

public java.lang.Object[][] GetGroups()
Deprecated. 
Returns a list of all groups known to the provider. Column order is determined by the PT_AUTHSOURCEPROV_USERGROUP_COLS enumeration.
Returns:
an array of groups
See Also:
PT_AUTHSOURCEPROV_USERGROUP_COLS

GetUsers

public java.lang.Object[][] GetUsers()
Deprecated. 
Returns a list of all users known to the provider. Column order is determined by the PT_AUTHSOURCEPROV_USERGROUP_COLS enumeration.
Returns:
an array of users
See Also:
PT_AUTHSOURCEPROV_USERGROUP_COLS

GetMembers

public java.lang.Object[][] GetMembers(java.lang.String bstrUniqueGroupName)
Deprecated. 
Returns a list of all members of a particular group. Column order is determined by the PT_AUTHSOURCEPROV_GROUPMEMBERSHIP_COLS enumeration.
Parameters:
bstrUniqueGroupName - the unique name of the group
Returns:
an array of users
See Also:
PT_AUTHSOURCEPROV_GROUPMEMBERSHIP_COLS

Authenticate

public boolean Authenticate(java.lang.String bstrAuthUserName,
                            java.lang.String bstrPassword,
                            java.lang.Object vSecurityToken,
                            IPTUserInfo pUserInfo)
Deprecated. 
Authenticates a single user.
Parameters:
bstrAuthUserName - the user's authentication name
bstrPassword - the password provided by the user
vSecurityToken - a security token used for SSO login
pUserInfo - an IPTUserInfo object
Returns:
whether the authentication succeeded

Validate

public boolean Validate()
Deprecated. 
Validate the settings on the provider.
Returns:
whether the current settings are valid

UsernameToPlumtreeName

public java.lang.String UsernameToPlumtreeName(java.lang.String bstrUsername)
Deprecated. 
Prepends the provider's auth source prefix to a username.
Parameters:
bstrUsername - the username
Returns:
username with the prefix prepended

PlumtreeNameToUsername

public java.lang.String PlumtreeNameToUsername(java.lang.String bstrPlumtreeName)
Deprecated. 
Removes the provider's prefix from a username.
Parameters:
bstrPlumtreeName - the username
Returns:
username sans prefix

GetCategory

public java.lang.String GetCategory()
Deprecated. 
Returns the provider's auth source prefix, aka category.
Returns:
the prefix

GetCapabilities

public java.lang.Object GetCapabilities(int lAuthSourceCapability)
Deprecated. 
Returns whether the provider supports a particular capability.
Parameters:
lAuthSourceCapability - a value from PT_AUTHSOURCEPROVIDER_CAPABILITIES
Returns:
true if the capability is supported
See Also:
PT_AUTHSOURCEPROVIDER_CAPABILITIES

GetName

public java.lang.String GetName()
Deprecated. 
Returns a human-readable name for the provider.
Returns:
a name

GetDescription

public java.lang.String GetDescription()
Deprecated. 
Returns a human-readable description for the provider.
Returns:
a description

GetAuthSourceProviderCLSID

public java.lang.String GetAuthSourceProviderCLSID()
Deprecated. 
Returns the CLSID for the provider.
Returns:
the CLSID.

GetImageUUID

public java.lang.String GetImageUUID()
Deprecated. 
Returns the image UUID for the provider.
Returns:
the image UUID

Initialize

public void Initialize(IPTSession pSession,
                       com.plumtree.openfoundation.util.IXPPropertyBag pbagConfigurationInfo,
                       IPTWebService pService)
Deprecated. 
Initializes the provider.
Parameters:
pSession - an IPTSession
pbagConfigurationInfo - the provider's property bag
pService - the provider's associated web service


Copyright © 2003 Plumtree Software Inc. All Rights Reserved.