# All Classes and Interfaces

Class
Description
AbstractAuthProvider
This abstract provider provides DFC session operation.
AbstractClientTokenAuthProvider
This abstract provider additionally provides client token utility.
AbstractController
The abstract class for resource controllers.
AbstractFieldJsonDeserializer
This abstract class has default implementation for JSON field deserializer.
AbstractFieldJsonSerializer
This abstract class has default implementation for JSON field serializer.
AbstractFieldXmlDeserializer
This abstract class has default implementation for XML field deserializer.
AbstractFieldXmlSerializer
This abstract class has default implementation for XML field serializer.
AbstractLinkable
abstraction for linkable
AbstractLogoutWebSecurity
Provides a convenient base class for creating a customize Documentum REST Services logout authentication scheme.
AbstractUriTemplate
Abstract uri template.
AbstractWebSecurity
Provides a convenient base class for creating a customize Documentum REST Services authentication scheme.
AccessorPermission
AccessorPermission identify users and groups and define their object-level permissions to the object with which the ACL is associated.
AccessType
AclManager
The Access Control List manager.
AclObject
Acl object is applied to a repository object to define object-level security, or to a folder for use in folder security
AclObjectConverter
Convert DFC object IDfACL to Core REST model(PermissionSetObject)
AdminMethods
Static Map for Admin Methods
AnnotatedFieldBindingProcessor
Binding processor for the annotated field.
AnnotatedFieldDeserializer<T>
This is an interface for defining the behavior to deserialize the serializable field.
AnnotatedFieldSerializer<T>
This is an interface for defining the behavior to serialize the serializable field.
AnnotatedJsonMessageConverter<T>
An implementation of Spring message converter which reads and writes JSON messages for the annotated models.
AnnotatedJsonMessageReader
An implementation of `StreamingMessageReader` which reads the JSON message and parse it as the annotated model instance.
AnnotatedJsonMessageWriter
An implementation of `StreamingMessageWriter` which writes the JSON message from the annotated model instance.
AnnotatedXmlMessageConverter<T>
An implementation of Spring message converter which reads and writes XML messages for the annotated models.
AnnotatedXmlMessageReader
An implementation of `StreamingMessageReader` which reads the XML message and parse it as the annotated model instance.
AnnotatedXmlMessageWriter
An implementation of `StreamingMessageWriter` which writes the XML message from the annotated model instance.
AnonymousAccess
An annotation used on a controller class to make this resource anonymously accessible.
AppEnvironment
The environment of current application.
ArrayFieldJsonDeserializer
JSON field reader for array data type.
AsBuilder
AspectManager
The aspect manager.
AspectTypeObject
aspect type resource
AssistanceItem
Attribute dependencies resource
AssistanceValueItem
Attribute dependencies resource
AtomAuthor
Atom author
AtomContent
Atom content
AtomEntry
Atom entry
AtomFeed<T extends AtomEntry>
Atom feed
Attribute<T>
AttributeInfo
Attribute info of `TypeObject`, it is meta data of attribute.
AttributeLifecycleInfo
AttributesCopier
This is a utility, which copies all the attributes from source `PersistentObject` to target one
AttributesFilter
Filter the attributes for a target object
AttributeValue
A utility to handle attribute value
AttributeView
A class representing the 'view expression' client provides.
AttributeView.ViewName
The name for the view.
AuditEvent
AuditEventList
AuditManager
AuditPolicy
AuditTrail
AuditTrail.AuditData
AuditTrail.ValuePair
AuthSchemeProfile
Enabling conditional Java web security configurations for classes extending from `AbstractWebSecurity`.
AuthType
Authentication types supported by the persistence layer.
BaseUriFactory
The URI factory to build resource URIs from templates.
BaseUriInfo
This class provides the basic information for an URI.
BasicAuthBeans
Beans for HTTP basic authentication.
BasicPermission
BasicType
A list of basic types defined for REST API.
BatchManager
The batch manager.
CabinetObject
Cabinet object
CheckinPolicy
Enum for checkin policies
ChecksumManager
ClientInfoUtil
ClientToken
Data model for Documentum Client Token.
ClientToken.TokenField
Token fields for client token
ClientTokenAuthToken
Client token authentication token
ClientTokenFactory
A factory to create, encrypt and decrypt client token.
ClientTokenPostAuthFilter
Filter to set response cookies and headers for authenticated client token authentication token
ClientTokenPreAuthFilter
Filter to logout for client token cookie/header
ClientTokenSignOutFilter
Filter to logout for client token cookie
CloseableDfSession
CollectionParam
A typed parameter group for the common collection parameters used on the controller.
CollectionResult<T>
A collection data result for the query.
Compat71TypeAtomContentJson
Deprecated.
since 7.2
Compat71TypeAtomEntryJson
Deprecated.
since 7.2
Compat71TypeObjectJson
Deprecated.
since 7.2
Compressor
An interface to compress and decompress binaries.
ConditionalFixedListValue
ConditionalQueryValue
ConditionalValueAssist
ConstraintsValidationPolicy
Enum for type of constraint validation.
ContentAttribute
ContentDataSource
The content data source of the content object
ContentfulObject
A contentful sysobject
ContentManager
The content manager to manage the content stream on the sysobject.
ContentMetaData
class for primary content and rendition metadata
ContentMetaDataManager
The content metadata manager to manage the content metadata on the sysobject
ContextHolder
A context holder can contains the information for an authenticated security context.
ContextSessionManager
An interface to provide the functions to get the context DFC session.
ContextSessionManager.SessionCallable<V>
Callable operation with automatically assigning the session
CoreLinkRelation
rel value of LinkRelation is part of the contract between client and server, and should NOT be changed at will
Crypto
An interface to encrypt or decrypt binaries.
Crypto
Deprecated.
use `Crypto` instead.
CSRFClientProvidingException
CSRF exception caused by client side CSRF generation
CSRFHandler
The CSRF token handler as a Spring bean
CSRFRuntime
Default security runtime properties values.
CSRFServerException
CSRF exception caused by server side CSRF generation
CSRFUtil
A utility to handle CSRF token
CSRFValidationException
CSRF exception caused by CSRF token validation
CtAuthBeans
Beans for Client Token authentication.
DarManager
DataSource
The data source model to replace javax.activation, since the javax.activation is deprecated
DataViewBinding
An annotation used on a view class to bind the linkable or entryable view with query types and the model class.
DateFormatter
This class is used for formatting/parsing date time according to ISO 8601.
DefaultFeedView<T extends Linkable>
The default view implementation for a feed resource.
DefaultRepositoryContextCleaner
This class is a default implementation `RepositoryContextCleaner`.
DefaultSecurityRuntime
Default security runtime properties values.
DefaultValue
Provide default values for query strings in the typed parameter `TypedParam` Use either "value" or "provider" to set a default value for the query parameter; if the default value is a constant, set it via "value" field; otherwise, implement your own ValueProvider to provide the default value for the query parameter programmatically.
DefaultValue
Default value for `AttributeInfo`
DelayedFieldJsonDeserializer
This is the default JSON deserializer for serializable field.
DelayedFieldJsonSerializer
This is the delayed JSON serializer for serializable field.
DelayedFieldXmlDeserializer
This is the default XML deserializer for serializable field.
DelayedFieldXmlSerializer
This is the delayed XML serializer for serializable field.
DeleteVersionPolicy
Enum for delete version policies
DfcList<T>
DfcSessions
DFC session utility.
DfcValueConverter
Convert Core REST attribute value to DFC model
DfcValueValidator
Validator for the value used as `IDfValue`
Digest
Annotation indicating a method parameter should be bound to digest message consumed from the conditional headers, like `If-None-Match` or `If-Match`, for a web request.
DisplayConfig
Display config resource
DisplayConfig.AttributeHint
DmlViewParam
Enum for dml view parameter
DocumentObject
Document resource
DQLBuilder
Utility to build DQL
DQLReservedWords
Deprecated.
please use com.emc.documentum.rest.filter.translator.dql.DQLReservedWords
DqlWhereClauseTranslator
Translate a search expression into a boolean expression that can be used within DQL where clause
Enforce
EntryableView<T extends Linkable>
Abstract class for resource representation views that could be represented as atom entry.
EntryFieldJsonDeserializer
JSON field reader for complex object data type.
EntryFieldJsonSerializer
JSON field writer for simple data type.
EntryFieldXmlDeserializer
XML field reader for serializable entry.
EntryFieldXmlSerializer
XML field writer for null data.
EventHubEventData
EventHubManager
ExtendedPermission
FeedableView<T extends Linkable>
Abstract class for resource representation views that could be represented as atom feed
FeedViewBinding
An annotation used on a feed view class to bind entryable view classes and the feed type.
FileDataSource
FolderLink
Folder link resource
FolderLinksManager
The folder links manager to link, unlink and move objects across folders.
FolderObject
Folder resource
Format
Format resource
FormatManager
The format manager.
FormatRestrictionConfig
GenericQueryTemplate
An abstract query template to build DQL for collection without pagination.
GroupManager
The group manager.
GroupMember
GroupObject
Group resource
HomeDocHints
Hints of Home Doc resource
HomeDocJSON
Home Doc resource for JSON
HomeDocJSON.Resource
Resource in `HomeDocJSON.ResourceEntry` of Home Document
HomeDocJSON.ResourceEntry
Resource Entry in Home Document for JSON
HomeDocument
Model of Home Document
HomeDocument.Resource
Resource in Home Document
HomeDocXML
Home Doc resource for XML
HomeDocXML.Resource
Resource in Home Document for XML
IDfCloseableSession
the wrapper which wrap an IDfSession, and able to be closed
IntegerEnum
An utility to generate (value, constant name) map for enum types which implement `IntegerValue`
IntegerValue
A unified interface for enum type with integer type value to implement.
JobManager
The job manager.
JobObject
Job resource
KeyGen
An utility to make keys and digests for input objects.
LegacyLinkableView
Deprecated.
use LinkableView instead
Lifecycle
Lifecycle resource
Lifecycle.EntryCriteria
Lifecycle.IdAble
Lifecycle.ImplementationType
Lifecycle.Module
Lifecycle.Procedure
Lifecycle.Status
Lifecycle.TypeInclusion
LifecycleConverter
LifecycleManager
The lifecycle manager
LifecycleState
Lifecycle State resource
LifecycleState.ReturnCondition
LightweightObject
LightweightObjectManager
The lightweight object manager.
Link
Model of link
Linkable
linkable
LinkableView<T extends Linkable>
Abstract class for resource representation views that contain link relations.
LinkRelation
IANA registered link relations Refer the link for details: http://www.iana.org/assignments/link-relations/link-relations.xhtml
ListFieldJsonSerializer
JSON field writer for list data type.
ListFieldXmlSerializer
XML field writer for list data.
LoginUserInfo
MapFieldJsonDeserializer
JSON field reader for map data type.
MapFieldJsonSerializer
JSON field writer for map data type.
MapFieldXmlDeserializer
XML field reader for java map.
MapFieldXmlSerializer
XML field writer for null data.
MappingTable
MediaTypeHelper
A helper class to check the information within a media type.
MediaUrlPolicy
Enum for media URL policies
MessageBundle
The message bundle which loads all available properties files from 'classpath*:com/emc/documentum/rest/messages/rest-*messages*.properties'
Metadataless
Whether the request may not have the metadata.
MethodManager
The Method manager
MethodObject
Method Object
MimeFormatMappingConfig
MIME type format mapping configuration
ModuleManager
Created by vellur on 1/16/2020.
ModuleObject
Created by vellur on 1/14/2020.
Modules
Created by vellur on 1/22/2020.
NameAsPathCoder
A name path coder to encode and decode a textural name when the name is used in the URI path.
NetworkLocation
Network location resource
NullFieldJsonSerializer
JSON field writer for null data.
NullFieldXmlSerializer
XML field writer for null data.
ObjectAspects
Object aspects resource
ObjectCollectionManager<T>
The object collection manager that gets objects by DQL.
ObjectFieldJsonDeserializer
JSON field reader for complex object data type.
ObjectFieldJsonSerializer
JSON field writer for object data type.
ObjectFieldXmlDeserializer
XML field reader for serializable object.
ObjectFieldXmlSerializer
XML field writer for null data.
ObjectLifecycle
Object lifecycle resource
ObjectLifecycle.Schedule
ObjectManager
A persistent object manager.
ObjectType
A persistent type utility.
Page<T>
A page class provides all the information for the paginated items.
PagedDataRetriever<T>
Fetch a page of data via DQL using the paged query template.
PagedPersistentDataRetriever<T extends PersistentObject>
Fetch a page of persistent data via DQL using the paged query template.
PagedQueryDataRetriever<T>
The paged query data retriever provides users a simple implementation to execute a template query and convert the query result into the user defined data model class.
PagedQueryTemplate
An abstract paged query template to build DQL for a paginated collection.
PageUri<T>
The URI info for pagination.
Paginator<T>
A class to paginate items based on the page size.
PagingConfig
The runtime configuration for pagination settings where the settings are loaded from the classpath resource 'rest-api-paging-config.properties'.
PagingParam
A typed parameter group for the common pagination parameters used on the controller.
Permissions
Permission definition
PermissionSetObject
Permission set object represents a set of user permissions to an specified object.
PersistenceConfig
The runtime configuration for persistence settings where the settings are loaded from the classpath resource 'rest-api-persistence-config.properties'.
PersistenceContextConfig
The runtime configuration for persistence context settings where the settings are loaded from the classpath resource 'rest-api-context-config.properties'.
PersistentLinkableView<T extends PersistentObject>
Default implementation of persistent data view.
PersistentObject
Persistent object resource.
PreferenceManager
The preference manager.
PreferenceObject
Persistent object resource.
ProductInfo
Product info resource
QualificationBuilder
A builder to construct the DQL qualification.
QueryEngine
The query engine to execute a DQL query and return as a list of `PersistentObject`.
QueryExecutor
A DQL query executor to run a DQL with the given DFC session.
QueryParam
Annotation used for the simple query parameter on the controller method or within a parameter group.
QueryParamNames
Query parameter names
QueryResultItem
Model of query result item
QueryResultSetConverter
Convert for query result set
QueryType
Enum for query type
RelationManager
The relation manager.
RelationObject
Relation resource
RelationRole
Enum for relation roles
RelationTypeManager
The relation type manager.
RelationTypeObject
Model for relation type metadata
Repository
Model for repository resource
RepositoryContextCleaner
An interface used in `AnonymousAccess` to assign a certain cleaner for the context cleaning.
RepositoryContextHolder
A repository context holder contains the user credentials and other information for an authenticated security context.
RepositoryContextInitializer
An interface used in `AnonymousAccess` to assign a certain initializer for context initialization.
RepositoryManager
The repository manager.
RepositorySession
An interface to provide the functions to get the DFC session.
RepositorySessionManager
An interface to provide the functions to create, get and remove DFC session managers.
RequestUri
Annotation used for the UriInfo parameter on the controller method.
ResourceUriBuilder
Builder to build the URI based on a given resource or a custom URI template.
ResourceVersion
Deprecated.
Since 7.3, this class is moved to package com.emc.documentum.rest.config.version.
ResourceViewBinding
An annotation used on a controller class or a controller method to bind the view definition to the resource operation output.
RestAbstractHttpMessageConverter<T>
This class is used to override the addDefaultHeaders to support MediaType.APPLICATION_OCTET_STREAM content-type header, as the Spring does not support it since 4.2.3
RestBindingConfigAware
Abstract class to include a `BindingConfig`.
RestClientErrorException
This class represents exception caused by REST client
RestClientErrorProfile
RestContentFormatForbiddenException
RestError
Model for Rest Error info, which is the error info shown to users
RestErrorBuilder
A builder to build the REST error from a generic exception.
RestLackOfDependencyValuesException
RestServiceAvailabilityException
This class is an general exception used to check if a certain rest service is available or not.
RestServiceException
The REST service exception class transforms a `DfException` or a `DfRuntimeException` into a REST error representation.
RestValueAssistanceDefinitionException
SanitizerConfig
The runtime configuration for sanitizer settings where the settings are loaded from the classpath resource 'rest-api-sanitizer-config.properties'.
ScopeConfig
Scope config resource
SerializableField
The annotation defined on a Java class field for marshalling and unmarshalling.
SerializableField.DEFAULT
It is only for default value of `SerializableField.defaultImpl()`
SerializableField4XmlList
The annotation defined on a Java List or Array field for custom marshalling and unmarshalling.
SerializableField4XmlMap
The annotation defined on a Java Map field for custom marshalling and unmarshalling.
SerializableFieldMeta
Metadata for a serializable field in a class.
SerializableType
Annotation that can be used to mark a class as a serializable REST representation.
SerializableType.FieldVisibility
Visibility of the field in marshalling.
Server
Model for server info in repository resource
SessionAwareAbstractManager
An abstract class containing the autowired bean of the `RepositorySession`.
SimpleDataFieldJsonDeserializer
JSON field reader for simple data type.
SimpleDataFieldJsonSerializer
JSON field writer for simple data type.
SimpleDataFieldXmlDeserializer
XML field reader for simple data type.
SimpleDataFieldXmlSerializer
XML field writer for null data.
SimpleUriTemplate
Simple URI template with normalization.
SingleParam
A typed parameter group for the common single resource parameters used on the controller.
SkipFieldJsonDeserializer
JSON field reader for unrecognized token.
SkipFieldXmlDeserializer
XML field reader for unrecognized token.
SortOrder
The definition for an ordered attribute in the order specification
SortSpec
The sort specification for object attributes.
StreamingMessageReader
An interface to read a message input stream and return it as a model instance.
StreamingMessageWriter
An interface to write the model instance as the message output stream.
Subscribers
SubscriptionManager
SupportedMediaTypes
A class that holds all supported media types and their format extensions
SysObject
Model sys object resource in the repository.
SysObjectManager
The sysobject manager.
TemplateParams
This annotation is used on resource controllers that are designed to provide clients with link relations as URI templates e.g.
TypedObjectConverter
Convert DFC objects to Core REST model
TypedParam
Annotation used for the typed parameter on the controller method or within a parameter group.
TypeLifecycleInfo
TypeManager
interface to manage type
TypeObject
Type resource
TypeParameter
The parameter used to get the type definition
UriFactory
Deprecated.
Since 7.3, the URI build in this pattern is not supported.
UriHelper
A helper class to parse the request URI
UriInfo
This class provides some extended information for an URI
UserExtendedPrivileges
UserManager
The user manager.
UserObject
User resource
UserProfileImageManager
The user display picture manager.
UTF8QueryParam
Annotation used for the query parameter, that requires to be parsed with UTF8 charset
UtilityBeans
Bean factory for utility classes.
ValidatableParameter
Interface shows that the parameter is validatable
ValueAssistanceManager
The value assistance and value assistance dependencies for type and aspect type manager.
ValueAssistances
Attribute dependencies resource
ValueAssistancesInputs
Attribute dependencies resource
ValueConstraint
VersioningManager
The versioning manager.
VersionPolicy
Model for version policy
ViewParams
View parameters set to in the 'others' parameter of a view class.
VirtualDocumentManager
The virtual document manager.
VirtualDocumentNode
Model virtual document node in the repository.
VirtualDocumentNode.CopyBehavior
VirtualDocumentSnapshot
Model virtual document snapshot in the repository.
WrappedListFieldXmlDeserializer
XML field reader for wrapped list.
XMLNamespace
Constants of XML namespace definition