com.hds.hcpaw.fss.api.model

Class BaseFssApiResource

java.lang.Object

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

Direct Known Subclasses:

AccountActivity, AccountActivityEntry, AccountActivityRequest, AccountSettings, AuthConfig, AuthConfigFactor, AuthConfigListing, Authentication, BrandingInfo, ClearClientCredentialsRequest, Client, ClientDeregisterRequest, ClientDownloadRequest, ClientListing, ClientRenameRequest, CollaborationActivity, CollaborationActivityEntry, CollaborationActivityRequest, ConfigSettings, ConflictListing, DeletePathRequest, DownloadZipRequest, EmptyFssApiResult, Entry, EntryBackupInfo, EntryIdentifier, EntrySharingInfo, ErrorMessage, FileAccessEntry, FileCreateRequest, FileHistoryListingRequest, FileReadRequest, FileRestoreRequest, FilesActivity, FilesActivityEntry, FilesActivityRequest, FilesystemInfo, FilesystemListing, FileUpdateRequest, FileVersionEntry, FileVersionListing, FileVersionPromoteRequest, FolderCreateRequest, FolderListing, FolderListingRequest, FolderRestoreRequest, FolderSize, FolderSizeRequest, GroupMember, GroupMembersListing, ImpressumInfo, InvitationListing, InviteRequest, InviteResult, InviteResultEntry, Link, LinkAccessEntry, LinkAccessListing, LinkBrowseListing, LinkBrowseSearchResult, LinkCopyToLocalResult, LinkCopyToLocalResultEntry, LinkCreateRequest, LinkDeleteRequest, LinkListing, LinkListRequest, LinkMetadata, LinkMetadataRequest, LinkRequestBase, LinkSettings, LinkUpdateRequest, ListGroupMembersRequest, ListPathLinksRequest, MovePathRequest, MultiDeletePathRequest, MultiDeletePathResult, MultiDeletePathResultEntry, OfficeOnlineServerInfo, OwnerInfo, PathMetadataGetRequest, PathSearchResult, PreserveMembershipRequest, PrivacyInfo, PrivacyPolicyInfo, Provider, ProviderListing, ReadAccessListing, RestorePoint, RestorePointListing, SamlRedirectRequest, SearchPathRequest, ShareAlert, ShareAlertListing, ShareAlertRequest, ShareConvertRequest, ShareCreateRequest, SharedFolder, SharedFolderListing, ShareGroupInfo, ShareGroupListRequest, ShareInvitation, ShareInvitationAcceptRequest, ShareInvitationCancelRequest, ShareInvitationRejectRequest, ShareInviteSearchEntry, ShareInviteSearchRequest, ShareInviteSearchResult, ShareLeaveRequest, ShareMember, ShareMemberListing, ShareMemberListRequest, ShareRemoveGroupRequest, ShareRemoveMemberRequest, ShareSettingsUpdateRequest, ShareSyncMembershipRequest, ShareUserInfo, ShareUserListRequest, SubdirectoryListingRequest, TeamFolderApproveRequest, TeamFolderCancelRequest, TeamFolderCreateRequest, TeamFolderDeleteRequest, TeamFolderInfo, TeamFolderSettings, TeamFolderUpdateRequest, UnshareFolderRequest, User, UserSettingsUpdateRequest

public abstract class BaseFssApiResource
extends java.lang.Object

Base class of all resources received by or returned from the FSS API.

Field Summary

Fields

Modifier and Type	Field and Description
static java.nio.charset.Charset	UTF_8 The UTF-8 Charset

Constructor Summary

Constructors

Constructor and Description
BaseFssApiResource()

Method Summary

Modifier and Type	Method and Description
protected void	badValue(java.lang.String fieldName, java.lang.String parentFieldName) Calls badValue with a null reason.
protected void	badValue(java.lang.String fieldName, java.lang.String parentFieldName, java.lang.String reason) Throws an AwJsonException with a message that the fieldName is not valid.
static <T extends BaseFssApiResource> T	fromJson(FssApiVersion version, java.io.Reader reader, java.lang.Class<T> type) Reads the JSON representation of an object from the specified reader and converts it to an object of the specified type.
java.lang.String	toJson() Returns the JSON representation of this object.
static java.lang.String	toJson(java.lang.Object o) Returns the JSON representation of the specified object.
java.lang.String	toString() The JSON representation of the specified object.
void	validate() Validates this object.
protected abstract void	validate(java.lang.String fieldName, BaseFssApiResource parent) Validates this object.
protected void	validateFieldInRange(java.lang.String fieldName, java.lang.Integer fieldValue, int min, int max, java.lang.String parentFieldName) Validates that fieldValue is in the range min to max.
protected void	validateFieldInRange(java.lang.String fieldName, java.lang.Long fieldValue, long min, long max, java.lang.String parentFieldName) Validates that fieldValue is in the range min to max.
protected void	validateFieldIsNull(java.lang.String fieldName, java.lang.Object fieldValue, java.lang.String parentFieldName) Validates that fieldValue is null.
protected void	validateFieldNotNull(java.lang.String fieldName, java.lang.Object fieldValue, java.lang.String parentFieldName) Validates that fieldValue is not null.
protected void	validateLocale(java.lang.String fieldName, java.lang.String fieldValue, java.lang.String parentFieldName) Validates that the provided locale is supported
protected void	validateOptionalField(java.lang.String fieldName, BaseFssApiResource fieldValue) Validates an optional field of your choice.
protected <T> void	validateOptionalFieldList(java.lang.String fieldName, java.util.List<T> fieldValues, java.lang.String parentFieldName) Validates an optional list.
protected void	validateRequiredField(java.lang.String fieldName, BaseFssApiResource fieldValue, java.lang.String parentFieldName) Validates that fieldValue is not null and is valid.
protected <T> void	validateRequiredFieldList(java.lang.String fieldName, java.util.List<T> fieldValues, java.lang.String parentFieldName) Validates that the fieldValues are not null and that all objects contained within it are not null and are valid.
static void	writeToOutputStream(java.lang.Object o, java.io.OutputStream outputStream) Writes the JSON representation of the specified Object to the outputStream.

Methods inherited from class java.lang.Object

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

Field Detail

UTF_8

public static final java.nio.charset.Charset UTF_8

The UTF-8 Charset

Constructor Detail

BaseFssApiResource

public BaseFssApiResource()

Method Detail

writeToOutputStream

public static void writeToOutputStream(java.lang.Object o,
                                       java.io.OutputStream outputStream)
                                throws java.io.IOException

Writes the JSON representation of the specified Object to the outputStream.

Parameters:

o - the object whose JSON representation is to be written to the OutputStream

outputStream - the OutputStream where the JSON representation of the specified Object is written

Throws:

java.io.IOException

toJson

public static java.lang.String toJson(java.lang.Object o)

Returns the JSON representation of the specified object.

toJson

public java.lang.String toJson()

Returns the JSON representation of this object.

fromJson

public static <T extends BaseFssApiResource> T fromJson(FssApiVersion version,
                                                        java.io.Reader reader,
                                                        java.lang.Class<T> type)
                                                 throws AwJsonException

Reads the JSON representation of an object from the specified reader and converts it to an object of the specified type.

Type Parameters:

T - the object to be returned

Parameters:

version - FSS API version of the object to be read

reader - contains the JSON string that will be read

type - the Class or base class of the object that will be returned

Returns:

an instance of T, created by reading the specified JSON string

Throws:

AwJsonException

validate

public void validate()
              throws AwJsonException

Validates this object.

Throws:

AwJsonException - if any validation errors occur

validate

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

Validates this object. Implementers of this method should call the various validate methods in this class for the fields in the class. For example, if an implementing class has a required field called foo and an optional field called bar, then this method should call validateRequiredField(String, BaseFssApiResource, String) for foo, and validateOptionalField(String, BaseFssApiResource) for bar.

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

validateRequiredField

protected void validateRequiredField(java.lang.String fieldName,
                                     BaseFssApiResource fieldValue,
                                     java.lang.String parentFieldName)
                              throws AwJsonException

Validates that fieldValue is not null and is valid. Calls validate(String, BaseFssApiResource) on fieldValue.

Parameters:

fieldName - name of fieldValue in the parent (containing) object

fieldValue - object to be validated

parentFieldName - name of the parent field that contains fieldValue

Throws:

AwJsonException - if any validation errors occur

validateOptionalField

protected void validateOptionalField(java.lang.String fieldName,
                                     BaseFssApiResource fieldValue)
                              throws AwJsonException

Validates an optional field of your choice. If the fieldValue is not null, then validate is called on fieldValue.

Parameters:

fieldName - name of fieldValue in the parent (containing) object

fieldValue - object to be validated if it is not null

Throws:

AwJsonException

validateRequiredFieldList

protected <T> void validateRequiredFieldList(java.lang.String fieldName,
                                             java.util.List<T> fieldValues,
                                             java.lang.String parentFieldName)
                                      throws AwJsonException

Validates that the fieldValues are not null and that all objects contained within it are not null and are valid. Validate is called on all objects within fieldValues.

Parameters:

fieldName - name of fieldValue in the parent (containing) object

fieldValues - list of objects to be validated

parentFieldName - name of the parent field that contains fieldValues

Throws:

AwJsonException

validateOptionalFieldList

protected <T> void validateOptionalFieldList(java.lang.String fieldName,
                                             java.util.List<T> fieldValues,
                                             java.lang.String parentFieldName)
                                      throws AwJsonException

Validates an optional list. If fieldValues are not null, then validate(String, BaseFssApiResource) is called on all objects specified in fieldValues.

Parameters:

fieldName - name of fieldValues in the parent (containing) object

fieldValues - list of objects to be validated

parentFieldName - name of the parent field that contains fieldValues

Throws:

AwJsonException

validateFieldNotNull

protected void validateFieldNotNull(java.lang.String fieldName,
                                    java.lang.Object fieldValue,
                                    java.lang.String parentFieldName)
                             throws AwJsonException

Validates that fieldValue is not null.

Parameters:

fieldName - name of fieldValue in the parent (containing) object

fieldValue - object to be validated. This cannot be null

parentFieldName - name of the parent field that contains fieldValue

Throws:

AwJsonException - if fieldValue is null

validateFieldInRange

protected void validateFieldInRange(java.lang.String fieldName,
                                    java.lang.Long fieldValue,
                                    long min,
                                    long max,
                                    java.lang.String parentFieldName)
                             throws AwJsonException

Validates that fieldValue is in the range min to max.

Parameters:

fieldName - the name of fieldValue in the parent (containing) object

fieldValue - the field that must fall in the range

min - the minimum value of the field

max - the maximum value of the field

Throws:

AwJsonException

validateFieldInRange

protected void validateFieldInRange(java.lang.String fieldName,
                                    java.lang.Integer fieldValue,
                                    int min,
                                    int max,
                                    java.lang.String parentFieldName)
                             throws AwJsonException

Validates that fieldValue is in the range min to max.

Parameters:

fieldName - the name of fieldValue in the parent (containing) object

fieldValue - the field that must fall in the range

min - the minimum value of the field

max - the maximum value of the field

Throws:

AwJsonException

validateFieldIsNull

protected void validateFieldIsNull(java.lang.String fieldName,
                                   java.lang.Object fieldValue,
                                   java.lang.String parentFieldName)
                            throws AwJsonException

Validates that fieldValue is null.

Parameters:

fieldName - name of fieldValue in the parent (containing) object

fieldValue - an object. This parameter cannot be null

parentFieldName - name of the parent field that contains fieldValue

Throws:

AwJsonException - if fieldValue is null

validateLocale

protected void validateLocale(java.lang.String fieldName,
                              java.lang.String fieldValue,
                              java.lang.String parentFieldName)
                       throws AwJsonException

Validates that the provided locale is supported

Parameters:

fieldName - name of fieldValue in the parent (containing) object

fieldValue - string representing locale to be validated

parentFieldName - name of the parent field that contains fieldValue

Throws:

AwJsonException

badValue

protected void badValue(java.lang.String fieldName,
                        java.lang.String parentFieldName)
                 throws AwJsonException

Calls badValue with a null reason.

Throws:

AwJsonException - always thrown

badValue

protected void badValue(java.lang.String fieldName,
                        java.lang.String parentFieldName,
                        java.lang.String reason)
                 throws AwJsonException

Throws an AwJsonException with a message that the fieldName is not valid.

Parameters:

fieldName - name of the field that is not valid

parentFieldName - name of the parent field that contains fieldName

reason - reason (if known) that fieldName is invalid

Throws:

AwJsonException - always thrown

toString

public java.lang.String toString()

The JSON representation of the specified object.

Overrides:

toString in class java.lang.Object

Returns:

the JSON representation of this object