com.hds.hcpaw.fss.api.model

Class User

java.lang.Object

com.hds.hcpaw.fss.api.model.BaseFssApiResource

com.hds.hcpaw.fss.api.model.User

public abstract class User
extends BaseFssApiResource

Holds information about a user.

Field Summary

Fields inherited from class com.hds.hcpaw.fss.api.model.BaseFssApiResource

UTF_8

Method Summary

Modifier and Type	Method and Description
static User	create(FssApiVersion apiVersion, java.lang.String username, java.lang.Long quotaBytes, java.lang.Long usageBytes, java.lang.String email, LinkSettings linkSettings, AccountSettings accountSettings, java.lang.Long fileCount, java.lang.Boolean hasAuthProviderEmail, java.lang.Long directoryCount, java.lang.Long conflicts, java.lang.String displayName, java.lang.String userId, java.lang.String uniqueId, java.lang.Boolean sharingEnabled, java.lang.Boolean isRegistered, TeamFolderSettings teamFolderSettings, ConfigSettings configSettings, java.lang.Boolean inUpgrade, java.lang.String providerId, java.lang.String providerType, java.lang.Boolean isGlobalLogout) Returns a versioned User that is compatible with the specified apiVersion.
AccountSettings	getAccountSettings() Return the user's account settings.
ConfigSettings	getConfigSettings() Returns the configuration settings for the user
java.lang.Long	getConflicts() Return number of conflicts of the user.
java.lang.Long	getDirectoryCount() Return the user's directory count.
java.lang.String	getDisplayName() Returns the user's display name.
java.lang.String	getEmail() Returns the user's email address.
java.lang.Long	getFileCount() Return the user's file count.
static java.lang.Class<? extends User>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the User that corresponds to the specified apiVersion.
java.lang.Boolean	getHasAuthProviderEmail() Returns whether or not the user has an email address specified by their auth provider.
java.lang.Boolean	getInUpgrade() Returns whether an upgrade is occurring
LinkSettings	getLinkSettings() Returns the user's default link settings.
java.lang.String	getProviderId() Returns the user's auth provider's ID.
java.lang.String	getProviderType() Returns the user's auth provider type
java.lang.Long	getQuotaBytes() Returns the number of bytes that the user can store as active versions on HCP Anywhere.
java.lang.Boolean	getRegistered() Returns whether or not the user is registered.
java.lang.Boolean	getSharingEnabled() Returns whether or not the user is able to share.
TeamFolderSettings	getTeamFolderSettings() Returns team folder settings for the user.
java.lang.String	getUniqueId() Returns the user's unique ID for their auth provider.
java.lang.Long	getUsageBytes() Returns the number of bytes currently used by the user's active versions of files on HCP Anywhere.
java.lang.String	getUserId() Returns the user's ID.
java.lang.String	getUsername() Returns the user's username.
java.lang.Boolean	isGlobalLogout() Returns if the logout is global
protected void	validate(java.lang.String fieldName, BaseFssApiResource parent) Validates this object.

Methods inherited from class com.hds.hcpaw.fss.api.model.BaseFssApiResource

badValue, badValue, fromJson, toJson, toJson, toString, validate, validateFieldInRange, validateFieldInRange, validateFieldIsNull, validateFieldNotNull, validateLocale, validateOptionalField, validateOptionalFieldList, validateRequiredField, validateRequiredFieldList, writeToOutputStream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getFssApiClass

public static java.lang.Class<? extends User> getFssApiClass(FssApiVersion apiVersion)

Returns the Class of the User that corresponds to the specified apiVersion.

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the User that corresponds to the specified apiVersion

create

public static User create(FssApiVersion apiVersion,
                          java.lang.String username,
                          java.lang.Long quotaBytes,
                          java.lang.Long usageBytes,
                          java.lang.String email,
                          LinkSettings linkSettings,
                          AccountSettings accountSettings,
                          java.lang.Long fileCount,
                          java.lang.Boolean hasAuthProviderEmail,
                          java.lang.Long directoryCount,
                          java.lang.Long conflicts,
                          java.lang.String displayName,
                          java.lang.String userId,
                          java.lang.String uniqueId,
                          java.lang.Boolean sharingEnabled,
                          java.lang.Boolean isRegistered,
                          TeamFolderSettings teamFolderSettings,
                          ConfigSettings configSettings,
                          java.lang.Boolean inUpgrade,
                          java.lang.String providerId,
                          java.lang.String providerType,
                          java.lang.Boolean isGlobalLogout)
                   throws AwUnsupportedApiVersionException

Returns a versioned User that is compatible with the specified apiVersion.

Parameters:

apiVersion - API version to be supported by the User

username - username of the user

quotaBytes - number of bytes that the user can store as active versions on Anywhere

usageBytes - number of bytes currently used by the user's active versions of files on HCP Anywhere

email - email address of the user

linkSettings - link settings of the user

accountSettings - account settings of the user

fileCount - number of files

hasAuthProviderEmail - Whether or not the user has an email address specified by their auth provider

directoryCount - number of directories

conflicts - number of conflicts

displayName - display name of the user

userId - ID of the user.

uniqueId - The unique auth ID for the user given by their auth provider.

isRegistered - Whether the user is registered/enabled

sharingEnabled - Whether or not the user is allowed to share. False if the user has share whitelisting enabled and an empty whitelist.

configSettings - Configuration specific settings for the user.

inUpgrade - Whether or not an upgrade is occurring

providerId - The user's auth provider's ID.

providerType - The user's auth provider type

isGlobalLogout - The user's auth provider logout type

Returns:

Throws:

AwUnsupportedApiVersionException

getUsername

public java.lang.String getUsername()

Returns the user's username.

Returns:

the user's username

getDisplayName

public java.lang.String getDisplayName()

Returns the user's display name.

Returns:

the user's display name.

getUserId

public java.lang.String getUserId()

Returns the user's ID.

Returns:

The user's ID.

getUniqueId

public java.lang.String getUniqueId()

Returns the user's unique ID for their auth provider.

Returns:

the user's unique ID for their auth provider.

getQuotaBytes

public java.lang.Long getQuotaBytes()

Returns the number of bytes that the user can store as active versions on HCP Anywhere.

Returns:

the number of bytes that the user can store as active versions on HCP Anywhere

getUsageBytes

public java.lang.Long getUsageBytes()

Returns the number of bytes currently used by the user's active versions of files on HCP Anywhere.

Returns:

the number of bytes currently used by the user's active versions of files on HCP Anywhere

getEmail

public java.lang.String getEmail()

Returns the user's email address.

Returns:

the user's email address

getLinkSettings

public LinkSettings getLinkSettings()

Returns the user's default link settings.

Returns:

the user's default link settings

getAccountSettings

public AccountSettings getAccountSettings()

Return the user's account settings. Note that the target object is introduced in V300. Calling this method on older version will return null.

Returns:

the AccountSettings

getFileCount

public java.lang.Long getFileCount()

Return the user's file count. Note that the target object is introduced in V300. Calling this method on older version will return null.

Returns:

the fileCount

getHasAuthProviderEmail

public java.lang.Boolean getHasAuthProviderEmail()

Returns whether or not the user has an email address specified by their auth provider.

Returns:

the hasAuthProviderEmail

getDirectoryCount

public java.lang.Long getDirectoryCount()

Return the user's directory count. Note that the target object is introduced in V300. Calling this method on older version will return null.

Returns:

the directoryCount

getConflicts

public java.lang.Long getConflicts()

Return number of conflicts of the user. Note that the target object is introduced in V300. Calling this method on older version will return null.

Returns:

the conflicts

getSharingEnabled

public java.lang.Boolean getSharingEnabled()

Returns whether or not the user is able to share.

Returns:

whether or not the user is able to share.

getRegistered

public java.lang.Boolean getRegistered()

Returns whether or not the user is registered.

Returns:

whether or not the user is registered.

getTeamFolderSettings

public TeamFolderSettings getTeamFolderSettings()

Returns team folder settings for the user.

Returns:

team folder settings for the user.

getConfigSettings

public ConfigSettings getConfigSettings()

Returns the configuration settings for the user

Returns:

configuration settings for the user

getInUpgrade

public java.lang.Boolean getInUpgrade()

Returns whether an upgrade is occurring

Returns:

whether an upgrade is occurring

getProviderId

public java.lang.String getProviderId()

Returns the user's auth provider's ID.

Returns:

the user's auth provider's ID.

getProviderType

public java.lang.String getProviderType()

Returns the user's auth provider type

Returns:

the users' auth provider type

isGlobalLogout

public java.lang.Boolean isGlobalLogout()

Returns if the logout is global

Returns:

if the logout is global

validate

protected void validate(java.lang.String fieldName,
                        BaseFssApiResource parent)
                 throws AwJsonException

Validates this object.

Specified by:

validate in class BaseFssApiResource

Parameters:

fieldName - name of this object in the parent (containing) object. If this object is a top-level object (not contained within another object), then enter null for this parameter

parent - parent (containing) object that contains the object specified in the fieldName parameter. If this object is a top-level object (not contained within another object), then enter null for this parameter

Throws:

AwJsonException - if any validation errors occur

See Also:

BaseFssApiResource.validate(String, BaseFssApiResource)