MOVEitUserInfo

java.lang.Object
- com.stdnet.moveit.api.MOVEitObjectInfo
- - com.stdnet.moveit.api.MOVEitUserInfo

```
public class MOVEitUserInfo
extends MOVEitObjectInfo
```
Container object used to provide information about a specific user on a MOVEit Transfer server. Instances of the object are returned by various methods of the Client object. An instance of the object is populated using information returned from the MOVEit Transfer host, and then passed on to the calling program, which can then access the information through the available methods.

Constructor Summary

Constructors
Constructor and Description

MOVEitUserInfo()

Constructors
Constructor and Description
`MOVEitUserInfo()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`adHocQuotaSize()` The user's adhoc quota size, if any, in bytes.
`long`	`adHocQuotaTime()` The user's adhoc quota timespan value, in days.
`int`	`allowAttachments()` Indicates whether the user is allowed to add attachments to packages.
`int`	`allowFTPS()` Whether the user is allowed to access the MOVEit Transfer FTPS (FTP-over-SSL) interface.
`int`	`allowHTTPSClient()` Whether the user is allowed to access the MOVEit Transfer HTTPS interface using clients other than a web browser.
`int`	`allowHTTPSWeb()` Whether the user is allowed to access the MOVEit Transfer HTTPS interface using a web browser.
`int`	`allowInsecureFTP()` Whether the user is allowed to access the MOVEit Transfer insecure FTP interface.
`int`	`allowSSH()` Whether the user is allowed to access the MOVEit Transfer SFTP (FTP-over-SSH) interface.
`int`	`authMethod()` When the user's organization is using a "mixed" authentication mode (RADIUS then MOVEit or LDAP then MOVEit), this setting determines how the user will be authenticated.
`int`	`chrootDefaultFolder()` When set to 1, the user's default folder will appear to be the root of the folder tree when a user signs on to MOVEit Transfer via the FTP or SSH interfaces.
`long`	`defaultCustomAttachDownloadLimit()` The default value for setting custom attachment download limits on packages.
`long`	`defaultCustomPackageExpiration()` The default value for setting custom expiration times on packages.
`java.lang.String`	`defaultFolderPath()` The full path of this user's default folder.
`int`	`defaultRequestDeliveryReceipt()` The default value for whether or not to request delivery receipts when sending a package.
`int`	`defaultSecureNote()` The default value for whether or not to secure the package note.
`java.lang.String`	`email()` This user's email address.
`int`	`emailFormat()` The user's preferred email format.
`java.lang.String`	`expirationPolicyName()` The name of the expiration policy assigned to this user.
`long`	`folderQuota()` The user's folder quota, if any, in bytes.
`int`	`forcePasswordChange()` If set to 1, this user will be forced to change his or her password the next time they sign onto the system.
`java.lang.String`	`homeFolderPath()` The full path of this user's home folder.
`java.lang.String`	`ID()` The ID of this user.
`int`	`instID()` ID of the organization this file exists in.
`java.lang.String`	`language()` User's language
`java.lang.String`	`lastLoginStamp()` Last time this user signed on.
`long`	`maxCustomAttachDownloadLimit()` The maximum allowed value for setting custom attachment download limits on packages.
`long`	`maxCustomPackageExpiration()` The maximum allowed value for setting custom expiration times on packages.
`java.lang.String`	`notes()` Optional user description.
`int`	`notification()` Indicates if this user receives email notifications.
`int`	`orgID()` ID of the organization this file exists in.
`java.lang.String`	`passChangeStamp()` Last time this user's password was changed.
`int`	`permission()` Indicates what class of user this is.
`long`	`perPackageQuota()` The user's per package quota, if any, in bytes.
`int`	`promptForWizard()` Indicates whether the user will be prompted to install the File Transfer Wizard if they do not already have it installed.
`long`	`quota()` The user's folder quota, if any, in bytes.
`java.lang.String`	`realname()` The "real" name of this user.
`int`	`requireFTPSCert()` Whether the user is required to submit an SSL client certificate when accessing the MOVEit Transfer FTPS interface.
`int`	`requireFTPSCertPassword()` Whether the user is required to submit a password as well when submitting an SSL client certificate to the MOVEit Transfer FTPS interface.
`int`	`requireHTTPSCert()` Whether the user is required to submit an SSL client certificate when accessing the MOVEit Transfer HTTPS interface.
`int`	`requireHTTPSCertPassword()` Whether the user is required to submit a password as well when submitting an SSL client certificate to the MOVEit Transfer HTTPS interface.
`int`	`requireSSHKey()` Whether the user is required to submit an SSH client key when accessing the MOVEit Transfer SFTP interface.
`int`	`requireSSHKeyPassword()` Whether the user is required to submit a password as well when submitting an SSH client key to the MOVEit Transfer SFTP interface.
`int`	`sendToUnregisteredRecip()` Whether the user is allowed to send packages to recipients who are not currently registered users.
`int`	`sharedAccount()` Indicates whether the user is a shared account.
`java.lang.String`	`status()` Either "suspended" or "active".
`java.lang.String`	`statusNote()` Often indicates why this user was suspended or reactivated.
`java.lang.String`	`username()` The username of this user.

Methods inherited from class com.stdnet.moveit.api.MOVEitObjectInfo
dataInitialized

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MOVEitUserInfo
```
public MOVEitUserInfo()
```
- Method Detail
  - username
```
public java.lang.String username()
```
    The username of this user. Used in conjunction with a password and/or other authentication mechanisms to authenticate this user. Example: "gjones". Depending on this organization's folder naming conventions, this name may or may not be the name of this user's home folder as well.
    
    Returns:
    
    Username of user
  - instID
```
public int instID()
```
    ID of the organization this file exists in.
    
    Returns:
    
    Organization ID
  - orgID
```
public int orgID()
```
    ID of the organization this file exists in.
    
    Returns:
    
    Organization ID
  - ID
```
public java.lang.String ID()
```
    The ID of this user. Used to identify the user internally and link the account to other elements on the system, such as folders and files. Example: "gjonesr8my61b5oj".
    
    Returns:
    
    ID of user
  - realname
```
public java.lang.String realname()
```
    The "real" name of this user. Example: "George Jones" Depending on this organization's folder naming conventions, this name may or may not the name of this user's home folder as well.
    
    Returns:
    
    Display name of user
  - status
```
public java.lang.String status()
```
    Either "suspended" or "active".
    
    Returns:
    
    Status of user
  - statusNote
```
public java.lang.String statusNote()
```
    Often indicates why this user was suspended or reactivated.
    
    Returns:
    
    Any notes about the user's status
  - defaultFolderPath
```
public java.lang.String defaultFolderPath()
```
    The full path of this user's default folder. (Unless explicitly specified, a user's default folder will normally be their Home folder.) This value will be blank for users who do not have a home or default folder, such as temporary users.
    
    Returns:
    
    Path of user's default folder
  - email
```
public java.lang.String email()
```
    This user's email address. May be blank.
    
    Returns:
    
    Email address of user
  - emailFormat
```
public int emailFormat()
```
    The user's preferred email format.
    Possible format codes:
    - 1 = HTML
    - 2 = Text
    Returns:
    
    Email format code for the user
  - expirationPolicyName
```
public java.lang.String expirationPolicyName()
```
    The name of the expiration policy assigned to this user. Blank string if no policy is assigned.
    
    Returns:
    
    Name of expiration policy assigned to the user
  - homeFolderPath
```
public java.lang.String homeFolderPath()
```
    The full path of this user's home folder. This value will be blank for users who do not have a home folder, such as temporary users.
    
    Returns:
    
    Path of user's home folder
  - notes
```
public java.lang.String notes()
```
    Optional user description.
    
    Returns:
    
    Any notes about the user
  - language
```
public java.lang.String language()
```
    User's language
    
    Returns:
    
    Language code of user's current language
  - lastLoginStamp
```
public java.lang.String lastLoginStamp()
```
    Last time this user signed on.
    
    Returns:
    
    Date and time of the user's last signon
  - passChangeStamp
```
public java.lang.String passChangeStamp()
```
    Last time this user's password was changed.
    
    Returns:
    
    Date and time of the user's last password change
  - permission
```
public int permission()
```
    Indicates what class of user this is.
    Possible permission codes:
    - 6 = TempUser
    - 10 = User
    - 20 = FileAdmin
    - 30 = Admin
    - 40 = SysAdmin
    Returns:
    
    Permission code of the user
  - notification
```
public int notification()
```
    Indicates if this user receives email notifications.
    0 = user receives no notifications
    1 = user receives notifications
    2 = admin user receives normal notifications plus admin alerts
    
    Returns:
    
    User notification setting
  - forcePasswordChange
```
public int forcePasswordChange()
```
    If set to 1, this user will be forced to change his or her password the next time they sign onto the system.
    
    Returns:
    
    User force password change setting
  - quota
```
public long quota()
```
    The user's folder quota, if any, in bytes. (Unlimited quotas are represented with a value of 0.)
    
    Returns:
    
    User quota setting
  - folderQuota
```
public long folderQuota()
```
    The user's folder quota, if any, in bytes. (Unlimited quotas are represented with a value of 0.)
    
    Returns:
    
    User quota setting
  - chrootDefaultFolder
```
public int chrootDefaultFolder()
```
    When set to 1, the user's default folder will appear to be the root of the folder tree when a user signs on to MOVEit Transfer via the FTP or SSH interfaces. This prevents the user from seeing any other folders but those that are underneath their default folder.
    
    Returns:
    
    1 if enabled; otherwise, 0.
  - authMethod
```
public int authMethod()
```
    When the user's organization is using a "mixed" authentication mode (RADIUS then MOVEit or LDAP then MOVEit), this setting determines how the user will be authenticated.
    Possible method codes:
    - 20 = MOVEit Only
    - 10 = External Only
    - 0 = Both
    Returns:
    
    User authentication method
  - sharedAccount
```
public int sharedAccount()
```
    Indicates whether the user is a shared account.
    
    Returns:
    
    1 if the account is shared; otherwise, 0.
  - promptForWizard
```
public int promptForWizard()
```
    Indicates whether the user will be prompted to install the File Transfer Wizard if they do not already have it installed.
    
    Returns:
    
    1 if enabled; otherwise, 0.
  - allowAttachments
```
public int allowAttachments()
```
    Indicates whether the user is allowed to add attachments to packages.
    
    Returns:
    
    0 if prohibited; 2 if use Organization setting.
  - defaultCustomAttachDownloadLimit
```
public long defaultCustomAttachDownloadLimit()
```
    The default value for setting custom attachment download limits on packages. This setting determines the default value for how many times each attachment file on a package can be downloaded for packages sent by the user. This setting will only take effect if custom download limits are enabled by the user's organization. A value of 0 indicates to use the organization's default custom attachment download limit.
    
    Returns:
    
    User default custom attachment download limit
  - maxCustomAttachDownloadLimit
```
public long maxCustomAttachDownloadLimit()
```
    The maximum allowed value for setting custom attachment download limits on packages. This setting determines the max value for how many times each attachment file on a package can be downloaded for packages sent by the user. This setting will only take effect if custom download limits are enabled by the user's organization. A value of 0 indicates to use the organization's max value for setting custom attachment download limits on packages.
    
    Returns:
    
    User max custom attachment download limit
  - defaultCustomPackageExpiration
```
public long defaultCustomPackageExpiration()
```
    The default value for setting custom expiration times on packages. This setting determines the default value for configuring the number of hours a package will be valid for. This setting will only take effect if custom expirations are enabled by the user's organization.
    
    Returns:
    
    User default custom package expiration, in hours
  - maxCustomPackageExpiration
```
public long maxCustomPackageExpiration()
```
    The maximum allowed value for setting custom expiration times on packages. This setting determines the max value for configuring the number of hours a package will be valid for. This setting will only take effect if custom expirations are enabled by the user's organization. A value of 0 indicates to use the organization's max value for setting custom expirations on packages.
    
    Returns:
    
    User max custom package expiration, in hours
  - adHocQuotaSize
```
public long adHocQuotaSize()
```
    The user's adhoc quota size, if any, in bytes. (Unlimited quotas are represented with a value of 0.)
    
    Returns:
    
    User ad hoc quota size
  - adHocQuotaTime
```
public long adHocQuotaTime()
```
    The user's adhoc quota timespan value, in days.
    
    Returns:
    
    User ad hoc quota time
  - perPackageQuota
```
public long perPackageQuota()
```
    The user's per package quota, if any, in bytes. (Unlimited quotas are represented with a value of 0.)
    
    Returns:
    
    User per package quota
  - sendToUnregisteredRecip
```
public int sendToUnregisteredRecip()
```
    Whether the user is allowed to send packages to recipients who are not currently registered users. If allowed, the user will be able to send packages to email addresses that don't match any currently registered users, whereby MOVEit Transfer, depending on its configuration, will either create Temporary Users for those email addresses, or allow guest access to the package using Package Password. 0 if prohibited; 2 if use organization setting.
    
    Returns:
    
    0 if prohibited; 2 if use org setting.
  - defaultRequestDeliveryReceipt
```
public int defaultRequestDeliveryReceipt()
```
    The default value for whether or not to request delivery receipts when sending a package.
    
    Returns:
    
    1 if delivery receipts are to be requested by default; 0 otherwise.
  - defaultSecureNote
```
public int defaultSecureNote()
```
    The default value for whether or not to secure the package note.
    
    Returns:
    
    1 if the note is to be secured by default; 0 otherwise.
  - allowHTTPSWeb
```
public int allowHTTPSWeb()
```
    Whether the user is allowed to access the MOVEit Transfer HTTPS interface using a web browser.
    
    Returns:
    
    1 if allowed; otherwise, 0.
  - allowHTTPSClient
```
public int allowHTTPSClient()
```
    Whether the user is allowed to access the MOVEit Transfer HTTPS interface using clients other than a web browser.
    
    Returns:
    
    1 if allowed; otherwise, 0.
  - requireHTTPSCert
```
public int requireHTTPSCert()
```
    Whether the user is required to submit an SSL client certificate when accessing the MOVEit Transfer HTTPS interface.
    
    Returns:
    
    1 if required; otherwise, 0.
  - requireHTTPSCertPassword
```
public int requireHTTPSCertPassword()
```
    Whether the user is required to submit a password as well when submitting an SSL client certificate to the MOVEit Transfer HTTPS interface.
    
    Returns:
    
    1 if required; otherwise, 0.
  - allowInsecureFTP
```
public int allowInsecureFTP()
```
    Whether the user is allowed to access the MOVEit Transfer insecure FTP interface. NOTE: Insecure FTP access also requires that insecure FTP be enabled and the user's IP address be allowed to access it. This is done through the MOVEit Transfer Config utility on the server itself.
    
    Returns:
    
    1 if allowed; otherwise, 0.
  - allowFTPS
```
public int allowFTPS()
```
    Whether the user is allowed to access the MOVEit Transfer FTPS (FTP-over-SSL) interface.
    
    Returns:
    
    1 if allowed; otherwise, 0.
  - requireFTPSCert
```
public int requireFTPSCert()
```
    Whether the user is required to submit an SSL client certificate when accessing the MOVEit Transfer FTPS interface.
    
    Returns:
    
    1 if required; otherwise, 0.
  - requireFTPSCertPassword
```
public int requireFTPSCertPassword()
```
    Whether the user is required to submit a password as well when submitting an SSL client certificate to the MOVEit Transfer FTPS interface.
    
    Returns:
    
    1 if required; otherwise, 0.
  - allowSSH
```
public int allowSSH()
```
    Whether the user is allowed to access the MOVEit Transfer SFTP (FTP-over-SSH) interface.
    
    Returns:
    
    1 if allowed; otherwise, 0.
  - requireSSHKey
```
public int requireSSHKey()
```
    Whether the user is required to submit an SSH client key when accessing the MOVEit Transfer SFTP interface.
    
    Returns:
    
    1 if required; otherwise, 0.
  - requireSSHKeyPassword
```
public int requireSSHKeyPassword()
```
    Whether the user is required to submit a password as well when submitting an SSH client key to the MOVEit Transfer SFTP interface.
    
    Returns:
    
    1 if required; otherwise, 0.

Class MOVEitUserInfo

Constructor Summary

Method Summary

Methods inherited from class com.stdnet.moveit.api.MOVEitObjectInfo

Methods inherited from class java.lang.Object

Constructor Detail

MOVEitUserInfo

Method Detail

username

instID

orgID

ID

realname

status

statusNote

defaultFolderPath

email

emailFormat

expirationPolicyName

homeFolderPath

notes

language

lastLoginStamp

passChangeStamp

permission

notification

forcePasswordChange

quota

folderQuota

chrootDefaultFolder

authMethod

sharedAccount

promptForWizard

allowAttachments

defaultCustomAttachDownloadLimit

maxCustomAttachDownloadLimit

defaultCustomPackageExpiration

maxCustomPackageExpiration

adHocQuotaSize

adHocQuotaTime

perPackageQuota

sendToUnregisteredRecip

defaultRequestDeliveryReceipt

defaultSecureNote

allowHTTPSWeb

allowHTTPSClient

requireHTTPSCert

requireHTTPSCertPassword

allowInsecureFTP

allowFTPS

requireFTPSCert

requireFTPSCertPassword

allowSSH

requireSSHKey

requireSSHKeyPassword