|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPTUser
IPTUser is the interface representing a portal User object.
Method Summary | |
---|---|
int |
GetAuthenticationSourceID()
Retrieves the authentication source ID for this user. |
java.lang.String |
GetAuthenticationUser()
Retrieves the authentication name for the user. |
int |
GetDefaultProfile()
Retrieves the ID of the Default Profile from which this user was created. |
java.lang.String |
GetEncryptedNumericPassword()
Retrieves the encrypted numeric password. |
java.lang.String |
GetEncryptedPassword()
Retrieves the encrypted password for the user. |
boolean |
GetLockedStatus()
Retrieves the lock status for this user account. |
java.lang.String |
GetLoginName()
Retrieves the login name for the user, which uniquely identifies the user within Plumtree, and is used in calls to IPTSession.Connect(). |
java.lang.String |
GetMappingAuthName()
Retrieves the Mapping Auth Name for the user. |
java.lang.String |
GetNumericUserName()
Retrieves the numeric user name for this user. |
com.plumtree.openfoundation.util.IXPPropertyBag |
GetPersonalInformation()
Deprecated. in 5.0. Use user profiling instead. |
java.lang.String |
GetUniqueAuthName()
Retrieves the Auth Unique Name for the user. |
int |
GetUserType()
Retrieves the user type for the user, which identifies the user as either a regular user or a guest user. |
boolean |
IsGuestUser()
Returns true if the user is of type PT_USER_TYPES.PT_USER_TYPE_GUEST |
IPTQueryResult |
QueryDirectGroups()
Queries for the user's group memberships, without taking into account any nested group hierarchy. |
IPTQueryResult |
QueryDirectGroups(boolean bIncludeDynamicMemberships,
boolean bIncludeStaticMemberships)
Queries for the user's group memberships, without taking into account any nested group hierarchy. |
IPTQueryResult |
QueryFlattenedGroups()
Queries for the user's group memberships, taking into account any nested group hierarchy. |
IPTQueryResult |
QueryUserGroups()
Deprecated. in 5.0. Use QueryFlattenedGroups() or QueryDirectGroups() instead, as appropriate. |
void |
SetAuthenticationSourceID(int iAuthSourceID)
Sets the authentication source ID for this user. |
void |
SetAuthenticationUser(java.lang.String strAuthUserName)
Sets the login name for the user. |
void |
SetDefaultProfile(int iDefaultProfileID)
Sets the objectID which is the Default Profile that should be used for this user. |
void |
SetEncryptedNumericPassword(java.lang.String strEncryptedNumericPassword)
Sets the encrypted numeric password. |
void |
SetEncryptedPassword(java.lang.String strEncryptedPassword)
Sets the (encrypted) password for the user. |
void |
SetLockedStatus(boolean bLocked)
Sets the locked status for this user account. |
void |
SetLoginName(java.lang.String strLoginName)
Sets the login name for the user, which uniquely identifies the user within Plumtree. |
void |
SetMappingAuthName(java.lang.String strMappingAuthName)
Sets the Mapping Auth Name for the user. |
void |
SetNumericPassword(java.lang.String strNumericPassword)
Sets the user's numeric password (PIN), which can be used in calls to IPTSession.NumericConnect(). |
void |
SetNumericUserName(java.lang.String strNumericUserName)
Sets the numeric user name for this user. |
void |
SetPassword(java.lang.String strPassword)
Sets the password for the user. |
void |
SetUniqueAuthName(java.lang.String strAuthUniqueName)
Sets the Auth Unique Name for the user. |
void |
SetUserType(int nUserType)
Sets the user type for the user, which identifies the user as either a regular user or a guest user. |
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 |
---|
com.plumtree.openfoundation.util.IXPPropertyBag GetPersonalInformation()
IPTQueryResult QueryUserGroups()
int GetAuthenticationSourceID()
void SetAuthenticationSourceID(int iAuthSourceID)
iAuthSourceID
- - The authentication source ID. Must be a valid object ID
specifying an auth source in the system.
PTException
- - PT_RESULTCODES.PT_E_ACCESSDENIED indicates this is a built-in
user and cannot be modified.
PTException
- - PT_RESULTCODES.PT_E_INVALIDARG indicates that the auth source
ID passed in was not a valid ID.java.lang.String GetAuthenticationUser()
PTException
- - PT_RESULTCODES.PT_E_ACCESSDENIED indicates that the user is
not an externally authenticated user.void SetAuthenticationUser(java.lang.String strAuthUserName)
strAuthUserName
- - The authentication name for the user.java.lang.String GetEncryptedPassword()
void SetEncryptedPassword(java.lang.String strEncryptedPassword)
Sets the (encrypted) password for the user. Only applies to users from the Plumtree Authentication Source, cannot be called on users that have been synchronized from an external authentication source.
This method is only available to Administrators. Normally the IPTUser.SetPassword() method should be used by clients instead of this method.
strEncryptedPassword
- - The new (encrypted) password for the user.
PTException
- - PT_RESULTCODES.PT_E_ACCESSDENIED indicates that the
calling user is not an Administrator, or that the IPTUser object is not a
user from the Plumtree Authentication Source.void SetPassword(java.lang.String strPassword)
Sets the password for the user. Only applies to users from the Plumtree Authentication Source, cannot be called on users that have been synchronized from an external authentication source.
The new password's length in characters must be less than the value specified by the PT_SERVERCONSTANTS.PT_MAX_PASSWORDSIZE constant, and cannot contain newline, carriage return, or tab characters.
strPassword
- - The (clear-text) new password for the user.
PTException
- - PT_RESULTCODES.PT_E_ACCESSDENIED indicates that the
IPTUser object is not a user from the Plumtree Authentication Source.
PTException
- - PT_RESULTCODES.PT_E_INVALIDPASSWORD indicates the new
password is either too long, or contains invalid characters.boolean GetLockedStatus()
void SetLockedStatus(boolean bLocked)
bLocked
- - Pass true to indicate the user account is locked, and false
to indicate the account is not locked.
PTException
- - PT_RESULTCODES.PT_E_INVALIDARG indicates the caller is
trying to lock their own user account, which is not allowed.
PTException
- - PT_RESULTCODES.PT_E_CANNOTLOCKGUESTACCOUNT indicates the
caller is trying the lock the built-in Guest user account.java.lang.String GetMappingAuthName()
void SetMappingAuthName(java.lang.String strMappingAuthName)
strMappingAuthName
- - The new mapping auth name for the user.java.lang.String GetUniqueAuthName()
For example, an LDAP provider might have a "CN=bob,OU=plumtree" string whereas an NT provider might have "PLUMTREE\Bob".
void SetUniqueAuthName(java.lang.String strAuthUniqueName)
strAuthUniqueName
- - The auth unique name for the user.
PTException
- - PT_RESULTCODES.PT_E_ACCESSDENIED indicates that this
user is from the Plumtree Authentication source.int GetDefaultProfile()
void SetDefaultProfile(int iDefaultProfileID)
iDefaultProfileID
- - The Default Profile's object ID.java.lang.String GetNumericUserName()
void SetNumericUserName(java.lang.String strNumericUserName)
strNumericUserName
- - The new numeric user name for the user. This
string must evaluate to a valid number, e.g. each character must be a
digit from 0 through 9. The length of the username in characters must be
less than the value specified by the PT_SERVERCONSTANTS.MAX_NUMERIC_STORESIZE
constant. The numeric user name must also be unique within the system.
PTException
- - PT_RESULTCODES.PT_E_NUM_AUTH_INVALID_USERNAME indicates
that the username was too long.
PTException
- - PT_RESULTCODES.PT_E_NUM_AUTH_NONNUMERIC_STRING indicates
that the username contained non-numeric characters.
PTException
- - PT_RESULTCODES.PT_E_NUM_AUTH_NONUNIQUE_USERNAME indicates
that the numeric username specified is already in use by another user in the
system.void SetNumericPassword(java.lang.String strNumericPassword)
Sets the user's numeric password (PIN), which can be used in calls to IPTSession.NumericConnect().
The new password's length in characters must be less than that specified in the PT_SERVERCONTSTANTS.MAX_NUMERIC_STORESIZE. The string passed in must convert to a valid numeric string.
strNewNumericPassword
- - The new numeric password.
PTException
- - PT_RESULTCODES.PT_E_NONNUMERIC_STRING indicates
that the new password passed in is not a valid numeric string.
PTException
- - PT_RESULTCODES.PT_E_NUM_AUTH_INVALID_USERNAME indicates that
the new password was too long.java.lang.String GetEncryptedNumericPassword()
void SetEncryptedNumericPassword(java.lang.String strEncryptedNumericPassword)
strEncryptedNumericPassword
- - The new (encrypted) numeric password.IPTQueryResult QueryFlattenedGroups()
IPTQueryResult QueryDirectGroups()
IPTUserGroup
IPTQueryResult QueryDirectGroups(boolean bIncludeDynamicMemberships, boolean bIncludeStaticMemberships)
bIncludeDynamicMemberships
- - true
to include dynamic
memberships for this user. false
to suppress dynamic
memberships.bIncludeStaticMemberships
- - true
to include static
memberships. false
to suppress static memberships
IPTUserGroup
java.lang.String GetLoginName()
void SetLoginName(java.lang.String strLoginName)
strLoginName
- - The new login name for the user.int GetUserType()
PT_USER_TYPES
boolean IsGuestUser()
void SetUserType(int nUserType)
The
- user's type.PT_USER_TYPES
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |