| Package | Description |
|---|---|
| oracle.ifs.fdk | |
| oracle.ifs.fdk.core | |
| oracle.ifs.fdk.core.ah | |
| oracle.ifs.fdk.impl | |
| oracle.ifs.fdk.impl.ah | |
| oracle.ifs.protocols.ftp.commands | |
| oracle.ifs.protocols.ftp.server |
| Modifier and Type | Method and Description |
|---|---|
static FdkException |
FdkException.getInstance(String detailedErrorCode,
NamedValue[] info)
Constructs a new instance.
|
static FdkException |
FdkException.getInstance(String detailedErrorCode,
Throwable cause,
NamedValue[] info)
Maps any Throwable to and FdkException, setting the error code
explicitly.
|
static FdkException |
FdkException.getInstance(Throwable cause)
Maps any Throwable to an FdkException.
|
static FdkException |
FdkException.getInstance(Throwable cause,
NamedValue[] info)
Maps any Throwable to an FdkException.
|
static FdkException |
FdkException.getInstance(Throwable cause,
NamedValue[] info,
boolean log)
Gives control over what needs to be logged.
|
| Modifier and Type | Method and Description |
|---|---|
static String |
ClientUtils.fdkExceptionToString(FdkException fdke,
boolean includeStackTrace)
Returns a String representation of a FdkException, suitable for
detail logging.
|
| Modifier and Type | Method and Description |
|---|---|
void |
RequestManager.acknowledgeRequestForUser(long requestId,
NamedValue[] def,
AttributeRequest[] attributes)
Acknowledges the request for the given user.
|
Item |
ExtendedLockManager.acquireDavLock(long id,
NamedValue[] attributes)
Acquires a DAV lock on the given Item.
|
Item[] |
LockManager.acquireManualLocks(long[] ids,
NamedValueSet[] attributes)
Acquires manual locks on the given Items.
|
Item |
ExtendedLockManager.acquireNullOrDavLock(long id,
String name,
NamedValue[] attributes)
Acquires either a Null Resource Lock or a DAV lock on the given Item
name.
|
Item |
SecurityManager.addGrants(long id,
NamedValue[] def,
AttributeRequest[] attributes)
Adds the specified grants to the SecurityConfiguration of the target item.
|
Item |
CategoryManager.addMetaDataAttribute(long mdscatId,
NamedValue attributedef,
AttributeRequest[] attrrequest)
Adds an attribute to a category subclass.
|
Item |
GroupManager.addUsers(long groupId,
NamedValue[] def,
AttributeRequest[] attributes)
Adds members and managers to an existing group.
|
void |
RequestManager.approveRequestForUser(long requestId,
NamedValue[] def,
AttributeRequest[] attributes)
Approves the request for the given user.
|
abstract void |
FdkSession.beginRequest(boolean wait,
long timeout,
String tag)
Notifies the session that a new request has begun.
|
abstract void |
ManagersFactory.beginRequest(String tag)
Marks the begining of a request that will result in successive calls to
various managers and their methods.
|
long |
SessionManager.beginTransaction()
Begins a transaction on this session.
|
void |
ContentManager.calculateConsumedQuota(long id)
Initiate the calculation of consumed quota
|
void |
VersionManager.cancelCheckout(long[] items)
Cancels check-out for a set of items.
|
void |
RequestManager.cancelRequestForUser(long requestId,
NamedValue[] def,
AttributeRequest[] attributes)
Cancels the request for the given user.
|
Item[] |
VersionManager.checkin(long[] items,
NamedValue[] workflowParams,
NamedValueSet[] attrs,
AttributeRequest[] attributes)
Checks in a set of documents, or creates a request for checkin if
operation is workflow-enabled.
|
boolean |
FileManager.checkNameValidity(long parentId,
String name)
Checks to see if the proposed name is a valid object name
in the target folder.
|
Item[] |
VersionManager.checkout(long[] items,
String[] comments)
Deprecated.
This API works with non-workflow enabled checkout
only. The results cannot be guaranteed if this API
is used in conjunction with WF.
Use checkoutDocuments() for workflow enabled checkout. |
Item[] |
VersionManager.checkoutDocuments(long[] items,
String[] comments,
NamedValue[] workflowParams,
NamedValueSet[] attrs,
AttributeRequest[] attributes)
Checks out a set of documents.
|
boolean |
SecurityManager.checkPermission(long target,
long userOrGroup,
long permission)
Determines whether the given DirectoryObject has the given permission
on the given target object.
|
void |
SessionManager.commitTransaction(long id)
Commits a transaction started by calling
beginTransaction(). |
abstract ManagersFactory |
FdkConfiguration.constructManagersFactory(FdkSession session)
Construct a ManagersFactory for a quest or system session.
|
static Item[] |
Item.convertToItems(FdkSession session,
LibraryObject[] reposObjects,
AttributeRequest[] attributes)
Converts a list of repository objects to the corresponding Items.
|
Item[] |
FileManager.copy(long[] items,
NamedValue[] workflowParams,
NamedValueSet[] attrs)
Copies items.
|
Item |
VersionManager.copyToLatestVersion(long versionId,
NamedValue[] attrs)
Copies a version to the latest version in the version history.
|
Item |
VersionManager.copyToWorkingCopy(long versionId)
Copies a version to the working copy.
|
Item |
VersionManager.copyVersion(long versionId,
NamedValue[] attrs)
Copies a version.
|
Item |
AuditManager.createAuditReport(NamedValue[] searchOptions,
NamedValue[] sortOptions,
NamedValue[] reportOptions,
AttributeRequest[] attrs)
Creates an audit report given a search specification
as a DocumentDefinition that can be used to create a Document later.
|
Item |
AuditManager.createAuditTypeList(NamedValue[] def,
AttributeRequest[] attrs)
Creates an AuditTypeList.
|
Item |
CategoryManager.createCategorySubClass(NamedValue[] attributes,
AttributeRequest[] attrrequest)
Creates a Category subclass.
|
Item |
ContainerManager.createContainer(long target,
NamedValue[] def,
AttributeRequest[] attributes)
Creates a new container.
|
Item |
FileManager.createDocument(NamedValue[] docDef,
NamedValue[] workflowParams,
AttributeRequest[] attributes)
Creates a new Document.
|
Item |
FileManager.createDocumentDefinition(NamedValue[] def,
AttributeRequest[] attributes)
Creates a new DocumentDefinition Item, which can be used later to create a
Document Item.
|
Item[] |
FileManager.createDocumentDefinitions(NamedValueSet[] defs,
AttributeRequest[] attributes)
Creates set of new DocumentDefinition Items, which can be used later to
create Document Items.
|
Item[] |
FileManager.createDocuments(NamedValueSet[] docDefs,
NamedValue[] workflowParams,
AttributeRequest[] attributes)
Creates a set of new Documents.
|
Item |
FileManager.createFolder(long destFolderId,
NamedValue[] attributes,
AttributeRequest[] attrrequest)
Creates a new FOLDER Item.
|
Item[] |
FileManager.createFolders(long[] destFolders,
NamedValueSet[] attributes,
AttributeRequest[] attrrequest)
Creates a set of folders.
|
Item |
GroupManager.createGroup(NamedValue[] def,
AttributeRequest[] attributes)
Creates a new group, returning an Item that represents it.
|
Item |
LifecycleManager.createLifecyclePolicy(NamedValue[] def,
AttributeRequest[] attrs)
Creates a new LIFECYCLE_POLICY Item.
|
Item[] |
FileManager.createLinks(long folderId,
NamedValueSet[] linkDefs,
AttributeRequest[] attributes)
Creates a set of new Links.
|
Item |
WorkspaceManager.createPersonalWorkspace(NamedValue[] def,
AttributeRequest[] attributes)
Creates a new personal workspace for the current user.
|
Item |
WorkspaceManager.createPersonalWorkspaceForUser(long userId,
NamedValue[] def,
AttributeRequest[] attributes)
Creates a new personal workspace for the given user.
|
Item |
RelationManager.createRelation(long from,
long to,
NamedValue[] options,
AttributeRequest[] attributes)
Create a new relation between two documents.
|
Item |
SecurityManager.createRole(long target,
NamedValue[] def,
AttributeRequest[] attributes)
Creates a new Role for use in the target domain.
|
void |
RequestManager.createUserRequest(long[] targets,
NamedValue[] params)
Creates a UserRequest for each set of targets that are controlled by a
specific UserRequestWorkflowConfiguration.
|
Item |
WorkspaceManager.createWorkspace(long target,
NamedValue[] wfParams,
NamedValue[] def,
AttributeRequest[] attributes)
Creates a new workspace or a request.
|
void |
FileManager.delete(long[] items,
NamedValue[] workflowParams,
NamedValueSet[] attrs)
Deletes items.
|
void |
CategoryManager.deleteCategory(long categoryId)
Deprecated.
|
void |
ContainerManager.deleteContainer(long id,
NamedValue[] def)
Deletes a container.
|
void |
GroupManager.deleteGroup(long groupId)
Deletes a group.
|
void |
LifecycleManager.deleteLifecyclePolicy(long id,
NamedValue[] options)
Deletes a LIFECYCLE_POLICY Item.
|
void |
RelationManager.deleteRelation(long id)
Delete a relation.
|
void |
RequestManager.deleteRequests(long[] ids)
Deletes the Reqeusts having the given IDs.
|
void |
SecurityManager.deleteRole(long target,
NamedValue[] def)
Deletes a Role.
|
void |
VersionManager.deleteVersion(long versionId)
Deletes a version, so that it is no longer part of the version history.
|
void |
WorkspaceManager.deleteWorkspace(long id,
NamedValue[] def)
Deletes a workspace.
|
void |
RequestManager.denyRequestForUser(long requestId,
NamedValue[] def,
AttributeRequest[] attributes)
Denies the request for the given user.
|
void |
FdkSessionListener.disconnectCallback(FdkSession session)
Called right before a session is about to be disconnected.
|
void |
ArchiveManager.emptyArchive(long archiveId)
Empties a given Archive.
|
void |
TrashManager.emptyTrash(long trashId)
Empties the given TrashFolder.
|
abstract boolean |
FdkSession.endRequest()
Notifies the session that the request has ended.
|
abstract void |
ManagersFactory.endRequest()
Marks the end of a request.
|
NamedValue[] |
SearchManager.executeSelect(NamedValue priTarget,
NamedValue[] auxTargets,
String searchCondition,
String sortCondition,
NamedValue[] bindVals,
NamedValue[] options,
AttributeRequest[] attrReqs)
Executes a search using a prepared selector.
|
int |
SearchManager.executeSelectCount(NamedValue priTarget,
NamedValue[] auxTargets,
String searchCondition,
NamedValue[] bindVals,
NamedValue[] options)
Executes a search to obtain the result count using a prepared selector.
|
boolean |
FileManager.exists(String absolutePath)
Checks to see if an object exists at the given absolute path.
|
boolean |
FileManager.existsRelative(long folderId,
String relativePath)
Checks to see if an object exists at the given relative path, relative
to the given Folder.
|
long |
AuditManager.findAuditHistory(String name)
Returns the Audit History id associated with the specified name, or
FDK_ITEM_NOT_FOUND exception, if no match can be found.
|
NamedValueSet[] |
UserManager.findCredentialManagerUsers(NamedValue[] searchOptions)
Find a list of users from the current credential manager that match
the specified search options.
|
Item[] |
UserManager.findDomainUsers(NamedValue[] options,
AttributeRequest[] attrs)
Find a list of provisioned users in the current domain that match the
specified search options.
|
Item[] |
GroupManager.findGroups(NamedValue[] def,
AttributeRequest[] attributes)
Returns a set of GROUPs.
|
Item[] |
LifecycleManager.findLifecyclePolicies(NamedValue[] options,
AttributeRequest[] attrs)
Returns an array of LIFECYCLE_POLICY Items that match the specified search
options.
|
Item |
LifecycleManager.findLifecyclePolicyByName(String name,
AttributeRequest[] attrs)
Returns the LIFECYCLE_POLICY Item with the specified name, or null if no
matching LIFECYCLE_POLICY Item exists.
|
Item |
SecurityManager.findRoleByKey(String key,
AttributeRequest[] attributes)
Fetches a single OOTB role by its registered role key.
|
boolean |
FileManager.folderLinksExist(String path)
Returns true if the given absolute path contains any LINK items.
|
void |
CategoryManager.freeCategoryClass(long ahcclassId)
Frees the given class object.
|
abstract ArchiveManager |
ManagersFactory.getArchiveManager()
Returns the ArchiveManager instance.
|
static ArchiveManager |
Managers.getArchiveManager(FdkSession session)
Deprecated.
Returns the Archive manager.
|
NamedValue |
EventHandlerContext.getAuditHistoryProperty(String key)
Gets a property of the custom Audit History by its property name.
|
abstract AuditManager |
ManagersFactory.getAuditManager()
Returns The AuditManager instance.
|
static AuditManager |
Managers.getAuditManager(FdkSession session)
Deprecated.
Returns the AuditManager.
|
NamedValue[] |
AuditManager.getAuditTypeEntries(NamedValue[] options)
Returns the AuditTypeEntries for an Item type
or that are contained within an existing AuditTypeList.
|
NamedValue[] |
AuditManager.getAuditTypeEntriesFromAuditTypesList(long id)
Returns the AuditTypes of an AuditTypeList.
|
Item |
AuditManager.getAuditTypeList(String name,
AttributeRequest[] attrs)
Returns the AuditTypeList corresponding to the specified name.
|
abstract CategoryManager |
ManagersFactory.getCategoryManager()
Returns The CategoryManager instance.
|
static CategoryManager |
Managers.getCategoryManager(FdkSession session)
Deprecated.
Returns the Category manager used to support custom metadata.
|
abstract CommonManager |
ManagersFactory.getCommonManager()
Returns the CommonManager instance.
|
static CommonManager |
Managers.getCommonManager(FdkSession session)
Deprecated.
Returns the common manager used to perform common operations.
|
Item[] |
SecurityManager.getComputedGranteeList(long target,
long role,
AttributeRequest[] attributes)
Deprecated.
10.1.3.0.0 use
getComputedUserGranteeList |
Item[] |
SecurityManager.getComputedGroupGranteeList(long target,
long role,
AttributeRequest[] attributes)
Returns the set of groups that are granted the specified role on the
specified SecurityConfiguration.
|
Item[] |
SecurityManager.getComputedUserGranteeList(long target,
long role,
AttributeRequest[] attributes)
Returns the set of users that are granted the specified role on the
specified SecurityConfiguration.
|
abstract ContainerManager |
ManagersFactory.getContainerManager()
Returns the ContainerManager instance.
|
static ContainerManager |
Managers.getContainerManager(FdkSession session)
Deprecated.
Returns the container manager.
|
InputStream |
FileContentManager.getContent(long id)
Returns the contents of an item identified by the given ID.
|
abstract ContentManager |
ManagersFactory.getContentManager()
Returns The ContentManager instance.
|
Item |
SessionManager.getCurrentUser(AttributeRequest[] attributes)
Returns the user as an Item for the current session.
|
Item |
DomainManager.getDefaultDomain(AttributeRequest[] attributes)
Returns the default
DOMAIN Item. |
Item |
ContentManager.getDefaultMedia(AttributeRequest[] attributes)
Return the default media defined in the system.
|
String |
ContentManager.getDefaultStorageGroup()
Return the default storage group name.
|
Preference |
UserManager.getDomainDefaultUserPreference(String key,
AttributeRequest[] attributes)
Get domain level default value for a single user preference.
|
Preference[] |
UserManager.getDomainDefaultUserPreferences(String[] keys,
AttributeRequest[] attributes)
Get domain level default values for the requested user preferences.
|
abstract DomainManager |
ManagersFactory.getDomainManager()
Returns the DomainManager instance.
|
static DomainManager |
Managers.getDomainManager(FdkSession session)
Deprecated.
Returns the domain manager.
|
abstract ExtendedFileContentManager |
InProcessManagersFactory.getExtendedFileContentManager()
Returns The ExtendedFileContentManager instance.
|
abstract ExtendedLockManager |
InProcessManagersFactory.getExtendedLockManager()
Returns the ExtendedLockManager instance.
|
abstract FileContentManager |
ManagersFactory.getFileContentManager()
Returns the FileContentManager instance.
|
static ExtendedFileContentManager |
Managers.getFileContentManager(FdkSession session)
Deprecated.
Returns the file content manager used to perform content operations.
|
abstract FileManager |
ManagersFactory.getFileManager()
Returns the FileManager instance.
|
static FileManager |
Managers.getFileManager(FdkSession session)
Deprecated.
Returns the file manager used to perform basic file management operations.
|
abstract GroupManager |
ManagersFactory.getGroupManager()
Returns the GroupManager instance.
|
static GroupManager |
Managers.getGroupManager(FdkSession session)
Deprecated.
Returns the group manager used to perform operations on groups.
|
String[] |
MailManager.getGroupManagersEmail(long id)
Gets addresses of the managers of the given group.
|
String[] |
MailManager.getGroupMembersEmail(long id)
Gets addresses of the members of the given group.
|
abstract FdkSession |
GuestSessionPool.getGuestSession()
Gets a guest session.
|
static GuestSessionPool |
GuestSessionPool.getInstance()
Singleton method.
|
abstract Object |
FdkSession.getInternalSession()
Returns the internal session associated with this user session.
|
Item |
CommonManager.getItem(long id,
AttributeRequest[] attributes)
Returns an Item given an Item ID and an array of AttributeRequests.
|
ItemCertificate[] |
AuditManager.getItemCertificates(long[] ids)
Returns the ItemCertificates for the given Event IDs.
|
NamedValue[] |
CommonManager.getItemInvalidations(long[] addedIds,
long[] removedIds,
long[] setIds)
Gets the set of Item invalidations for items the session has
registered interest for.
|
Item[] |
CommonManager.getItems(long[] ids,
AttributeRequest[] attributes)
Returns an array of Items given an array of Item IDs and an array
of AttributeRequests.
|
abstract LifecycleManager |
ManagersFactory.getLifecycleManager()
Returns The LifecycleManager instance.
|
abstract LockManager |
ManagersFactory.getLockManager()
Returns the LockManager instance.
|
static ExtendedLockManager |
Managers.getLockManager(FdkSession session)
Deprecated.
Returns the lock manager.
|
abstract MailManager |
InProcessManagersFactory.getMailManager()
Returns the MailManager instance.
|
static MailManager |
Managers.getMailManager(FdkSession session)
Deprecated.
Returns the Mail manager.
|
abstract ManagersFactory |
FdkSession.getManagersFactory()
Returns the managers factory corresponding to this session.
|
Item |
ContentManager.getMediaByName(String name,
AttributeRequest[] attributes)
Get media by name.
|
Item[] |
FileManager.getMostRecentDocuments(NamedValue[] options,
AttributeRequest[] attributes)
Returns the most recent documents for the current user
If the primary or secondary sort attributes are specified
but the corresponding sort directions are not specified,
the sorting defaults to ascending order.
|
NamedValueSet[] |
FileManager.getNameConflictResolutionOptions(long[] sourceItems,
long[] conflictItems,
NamedValueSet[] defs)
Deprecated.
the conflict resolution options are now returned along
with the exception thrown in case of operation like
move or copy. The info is present on the information
of exception FDK_ITEM_ALREADY_EXISTS mapped to key
EXCEPTION_INFO_CONFLICT_RESOLUTION_OPTIONS.
|
long |
EventHandlerContext.getNextItemId()
Returns the next sequence ID value that would have been leveraged for a
new Item/Object created in the repository.
|
String |
SortManager.getPrimarySortAttribute(String tableName)
Gets the primary sort attribute for the given table.
|
boolean |
SortManager.getPrimarySortDirection(String tableName)
Gets the primary sort direction (true == ascending) for the given table.
|
NamedValueSet[] |
SearchManager.getProperties()
Returns the property information for the seach properties.
|
abstract RelationManager |
ManagersFactory.getRelationManager()
Returns The RelationManager instance.
|
Item |
WorkflowManager.getRequestForWorkflowProcess(long workflowPid,
AttributeRequest[] attrs)
Returns a Request corresponding to a given WorkflowProcess id.
|
abstract RequestManager |
ManagersFactory.getRequestManager()
Returns the RequestManager instance.
|
static RequestManager |
Managers.getRequestManager(FdkSession session)
Deprecated.
Returns the request manager.
|
Item[] |
CategoryManager.getRequiredCategories(long folderId,
AttributeRequest[] requestedAttributes)
Deprecated.
Request REQUIRED_CATEGORIES on CategoryConfiguration
|
Item |
SecurityManager.getRole(long id,
AttributeRequest[] attributes)
Fetches a single role
|
Item |
SecurityManager.getRoleByName(String name,
AttributeRequest[] attributes)
Fetches a single role by its common name.
|
abstract SearchManager |
ManagersFactory.getSearchManager()
Returns the SearchManager instance.
|
static SearchManager |
Managers.getSearchManager(FdkSession session)
Deprecated.
Returns the search manager.
|
String |
SortManager.getSecondarySortAttribute(String tableName)
Gets the secondary sort attribute for the given table.
|
boolean |
SortManager.getSecondarySortDirection(String tableName)
Gets the secondary sort direction (true == ascending) for the given table.
|
abstract SecurityManager |
ManagersFactory.getSecurityManager()
Returns the SecurityManager instance.
|
static SecurityManager |
Managers.getSecurityManager(FdkSession session)
Deprecated.
Returns the security manager.
|
String[] |
MailManager.getSecurityMembersEmail(long id)
Gets addresses of the users who have at least discover access to the given
item.
|
FdkSession |
AutoTimeoutSessionManager.getSession(String username)
Retrieves a session for the specified user.
|
abstract SessionManager |
ManagersFactory.getSessionManager()
Returns the SessionManager instance.
|
static SessionManager |
Managers.getSessionManager(FdkSession session)
Deprecated.
Returns the session manager used to perform session and transaction
operations.
|
NamedValue[] |
SessionManager.getSessionProperties(String[] properties)
Returns the requested session properties.
|
abstract SortManager |
ManagersFactory.getSortManager()
Returns the SortManager instance.
|
static SortManager |
Managers.getSortManager(FdkSession session)
Deprecated.
Returns the sort manager.
|
abstract Object |
FdkSession.getState(Object key)
Returns the value stored at the given key using
setState(). |
NamedValue[] |
FileManager.getSupportedCharsetNames()
Returns a list of supported character sets.
|
String[] |
FileManager.getSupportedCharsets()
Returns the list of supported character sets
|
NamedValue[] |
FileManager.getSupportedLanguageNames()
Returns a list of supported languages.
|
String[] |
FileManager.getSupportedLanguages()
Returns the list of supported languages
|
abstract SystemConfigurationManager |
ManagersFactory.getSystemConfigurationManager()
Returns the SystemConfigurationManager instance.
|
static SystemConfigurationManager |
Managers.getSystemConfigurationManager(FdkSession session)
Deprecated.
Returns the system configuration manager used to query the configuration
of the server.
|
NamedValue[] |
SystemConfigurationManager.getSystemConfigurationProperties(String[] properties)
Returns the values for the requested system configuration properties.
|
abstract TrashManager |
ManagersFactory.getTrashManager()
Returns the TrashManager instance.
|
static TrashManager |
Managers.getTrashManager(FdkSession session)
Deprecated.
Returns the trash manager used to perform operations on trash folders.
|
long |
CommonManager.getUniqueId()
Returns a unique ID backed by a repository sequence.
|
abstract Item |
ManagersFactory.getUser(AttributeRequest[] attributes)
Returns the user as an Item that was authenticated for this instance.
|
Item |
UserManager.getUser(String name,
AttributeRequest[] attributes)
Gets the specified user by name.
|
abstract UserManager |
ManagersFactory.getUserManager()
Returns the UserManager instance.
|
static UserManager |
Managers.getUserManager(FdkSession session)
Deprecated.
Returns the User manager used to support user operations.
|
Preference |
UserManager.getUserPreference(String key,
AttributeRequest[] attributes)
Get a user preference for the current user,
by its preference key.
|
Preference[] |
UserManager.getUserPreferences(String[] keys,
AttributeRequest[] attributes)
Get a set of user preferences for the current user,
by preference key.
|
Preference[] |
UserManager.getUserPreferencesForUser(long userId,
String[] keys,
AttributeRequest[] attributes)
Get a set of user preferences for the specified user,
by preference key.
|
String[] |
MailManager.getUsersWithRoleEmail(long id)
Gets addresses of all users in the domain who currently have the given
role.
|
abstract VersionManager |
ManagersFactory.getVersionManager()
Returns the VersionManager instance.
|
static VersionManager |
Managers.getVersionManager(FdkSession session)
Deprecated.
Returns the version manager used to perform versioning operations.
|
Item |
WorkflowManager.getWorkflowConfiguration(long id,
String operation,
boolean direct,
AttributeRequest[] attrs)
Returns the WorkflowConfiguration of the specified type
that is associated with the given item ID, or null if no
WorkflowConfiguration of the specified type exists for the given item ID.
|
Item[] |
WorkflowManager.getWorkflowConfigurations(long id,
AttributeRequest[] attrs)
Returns every WorkflowConfiguration that is associated directly
with the given Item ID, or null if no WorkflowConfigurations exist directly
on the given Item ID.
|
abstract WorkflowManager |
ManagersFactory.getWorkflowManager()
Returns the WorkflowManager instance.
|
static WorkflowManager |
Managers.getWorkflowManager(FdkSession session)
Deprecated.
Returns the workflow manager.
|
abstract WorkspaceManager |
ManagersFactory.getWorkspaceManager()
Returns the WorkspaceManager instance.
|
static WorkspaceManager |
Managers.getWorkspaceManager(FdkSession session)
Deprecated.
Returns the workspace manager.
|
boolean |
SecurityManager.hasOnlyExplicitGrantedAccess(long target,
long user)
Returns true if the specified user has a grant on the specified public
object that names the user as the grantee, and the permissions granted
by this grant represent all the permissions of that user on the public
object.
|
boolean |
SecurityManager.hasPropagatingGrants(long target,
long user)
Returns true if the specified user has any grants on the specified
SecurityConfiguration that propagated from a parent.
|
boolean |
UserManager.hasUserPreference(String key)
Check if a user preference is set for the current user.
|
boolean |
RequestManager.isOperationRequestEnabled(long id,
String ecmAction)
Returns whether the specified operation(ecm action) is
workflow enabled i.e request based.
|
Item |
WorkspaceManager.joinWorkspace(long id,
long[] reqRoles,
NamedValue[] wfParams,
AttributeRequest[] attributes)
Requests to join a JoinableWorkspace.
|
void |
SessionManager.keepAlive()
Keeps a long running transaction that spans multiple requests alive.
|
NamedValue[] |
AuditManager.listAggregateEventColumnValues(String aggFunction,
String[] columnNames,
NamedValue[] searchOptions,
NamedValue[] sortOptions)
Returns an array of column values (each element of the array corresponds to
a specific column).
|
String[] |
FileManager.listAutoFolderingActionSpecifications()
Returns the list of registered auto folder creation specification names.
|
Item[] |
WorkflowManager.listCustomWorkflows(NamedValue[] options,
AttributeRequest[] attributes)
Returns all Custom Workflow instances that have been registered.
|
String[] |
UserManager.listExternallySupportedUserPreferences()
Returns the list of externally supported user preferences
|
Item[] |
FileManager.listFolder(long folderId,
NamedValue[] options,
AttributeRequest[] attributes)
Returns the items of a folder and returns the requested attributes that
apply to each item.
|
Item[] |
WorkspaceManager.listJoinableWorkspaces(NamedValue[] options,
AttributeRequest[] attrs)
Lists workspaces that can be joined via request.
|
String[] |
LifecycleManager.listLifecycleActionSpecifications()
Returns the list of registered lifecycle action specifications.
|
String[] |
LifecycleManager.listLifecycleDateRuleSpecifications()
Returns the list of registered Lifecycle date rule specifications.
|
Item[] |
LockManager.listLockedDocuments(int[] locks,
NamedValue[] options,
AttributeRequest[] attributes)
Returns a list of Documents locked by a user.
|
Item[] |
ContentManager.listMedias(AttributeRequest[] attributes)
List all media items defined in the system.
|
String[] |
AuditManager.listOperationActionSpecifications()
Returns the list of registered operation action specification names.
|
String[] |
RelationManager.listRelationActionSpecifications()
Returns the list of registered relation action specifications.
|
Item[] |
RequestManager.listRequests(long id,
NamedValue[] def,
AttributeRequest[] attributes)
Returns the list of all reqeusts sent out by given user(id).
|
Item[] |
RequestManager.listRequestsForUser(long id,
NamedValue[] def,
AttributeRequest[] attributes)
Returns the list of all reqeusts that the given user is responder to.
|
Item[] |
SecurityManager.listRoles(long id,
NamedValue[] options,
AttributeRequest[] attributes)
Returns the available security roles in the domain that apply to the given
target object.
|
Item[] |
SecurityManager.listRolesByItemType(String itemType,
NamedValue[] options,
AttributeRequest[] attributes)
Returns the available security roles in the domain that apply to the
given target object class.
|
String[] |
ContentManager.listStorageGroups()
List all storage group names defined in the system.
|
Item[] |
VersionManager.listVersions(long id,
NamedValue[] options,
AttributeRequest[] attributes)
Returns the versions of an item and the requested attributes that
apply to each item.
|
Item[] |
WorkflowManager.listWorkflows(AttributeRequest[] attributes)
Returns all Workflow instances that have been registered.
|
abstract FdkSession |
FdkConfiguration.login(FdkCredential cred)
Login and create an FdkSession context.
|
static ManagersFactory |
ManagersFactory.login(FdkCredential credential)
Returns an authenticated instance for use by in-process clients only.
|
static ManagersFactory |
ManagersFactory.login(FdkCredential credential,
String wsUrl)
Returns an authenticated instance for use by either remoted clients
over Web Services if an URL is provided or in-process clients if the
URL is
null. |
static ManagersFactory |
ManagersFactory.login(FdkCredential credential,
String className,
boolean ws,
Map config)
Returns an authenticated instance with a custom configuration.
|
static ManagersFactory |
ManagersFactory.login(FdkCredential credential,
String wsUrl,
Map config)
Returns an authenticated instance for use by either remoted clients
over Web Services if an URL is provided or in-process clients if the
URL is
null. |
NamedValue[] |
AuthenticatedUserLoginManager.login(NamedValue[] options,
AttributeRequest[] userAttributes)
Start a session for the currently authenticated user.
|
NamedValue[] |
UsernameTokenLoginManager.login(NamedValue[] options,
AttributeRequest[] userAttributes)
Start a session authenticated by the Web Services Username Token.
|
NamedValue[] |
RemoteLoginManager.login(String username,
String password,
NamedValue[] options,
AttributeRequest[] userAttributes)
Start a session authenticated as the given user.
|
abstract void |
ManagersFactory.logout()
The counterpart of the
login() methods. |
void |
RemoteLoginManager.logout()
Disconnects the current session, if any.
|
void |
VersionManager.makeVersioned(long[] docIds)
Changes non-version-controlled documents into a version-controlled
documents with a single version.
|
Item |
CategoryManager.modifyCategorySubClass(long mdscatId,
NamedValue[] attributes,
AttributeRequest[] attrrequest)
Modifies the given Category subclass.
|
Item |
CategoryManager.modifyMetaDataAttribute(long attributeId,
NamedValue attributedef,
AttributeRequest[] attrrequest)
Given an Attribute description, modify the attribute to the given class
and return the modified classobject id.
|
Item[] |
FileManager.move(long[] items,
NamedValue[] workflowParams,
NamedValueSet[] attrs)
Moves items.
|
Item |
VersionManager.moveVersion(long versionId,
NamedValue[] attrs)
Moves a version.
|
void |
SessionManager.popSessionMode(int mode)
Pops the session one level, out of a privileged mode.
|
void |
AuditManager.postEvent(String opTypeKey,
long targetItem,
NamedValue[] optPayload)
Posts a custom audit event.
|
void |
UserManager.provisionCurrentUserPreferences()
Synchronize the preferences of the current user with user preferences
from the Identity Repositiory.
|
void |
UserManager.provisionUserPreferences(long userId)
Synchronize the preferences of the specified user with user preferences
from the Identity Repository.
|
void |
EventHandlerContext.purgeEvent(Event event)
Purges an Event from its audit history.
|
void |
EventHandlerContext.purgeEvents(Event[] events)
Purges a set of Events from their audit histories.
|
void |
SessionManager.pushSessionMode(int mode)
Pushes the session into a privileged mode where certain permission checks
are ignored, depending on the mode.
|
int |
ExtendedFileContentManager.read(long docId,
long offset,
byte[] buffer,
int length)
Reads a byte range from the content of a document and places it in the
provided buffer.
|
Item |
ExtendedLockManager.refreshDavLock(long id,
NamedValue[] attributes)
Refreshes a DAV lock.
|
void |
ExtendedLockManager.releaseDavLock(long id)
Releases a DAV on the given Item.
|
void |
LockManager.releaseManualLocks(long[] ids)
Releases manual locks on the given Items.
|
void |
ExtendedLockManager.releaseNullResourceLock(long id,
String name)
Releases a Null Resource Lock on the given Item
name.
|
void |
EventHandlerContext.removeAuditHistoryProperty(String key)
Removes a property of the custom Audit History by its property name.
|
void |
AuditManager.removeAuditingConfiguration(long folderId)
Removes the AuditingConfiguration from a Folder.
|
void |
CategoryManager.removeCategoryAttribute(long mdscatId,
String attrName)
Deprecated.
use removeMetaDataAttibute
|
void |
CategoryManager.removeCategoryConfiguration(long folderId)
remove the existing CategoryConfiguration for a Folder.
|
void |
CategoryManager.removeMetaDataAttribute(long attributeId)
Remove an attribute from a MetaDataCategory class.
|
void |
AuditManager.removeOperationConfiguration(long folderId)
Removes the OperationConfiguration for a Folder.
|
void |
SecurityManager.removeSecurityConfiguration(long id)
Removes the SecurityConfiguration from the target item.
|
void |
UserManager.removeUserPreference(String key)
Remove a user preference for the current user.
|
Item |
GroupManager.removeUsers(long groupId,
NamedValue[] def,
AttributeRequest[] attributes)
Removes members and managers from an existing group.
|
void |
VersionManager.removeVersioningConfiguration(long folderId)
Removes the VersioningConfiguration for a Folder.
|
void |
WorkflowManager.removeWorkflowConfiguration(long id,
String operation)
Removes a
WORKFLOW_CONFIGURATION Item of the specified type
from the specified FOLDER Item. |
Item |
ContentManager.requestQuotaUpdate(long id,
NamedValue[] wfParams,
NamedValue[] attrs,
AttributeRequest[] attributes)
Request an update to the existing quota on a workspace for non-admin user.
|
Item |
FileManager.resolvePath(String path,
AttributeRequest[] attributes)
Resolves a path, returning an Item that represents a PublicObject.
|
Item |
FileManager.resolveRelativePath(long folderId,
String path,
AttributeRequest[] attributes)
Resolves a relative path from a Folder, returning an Item that represents
a PublicObject.
|
void |
EventHandlerContext.restartEventHandler()
Causes a reset of the handler settings.
|
Item |
ArchiveManager.restoreFromArchive(long archiveId,
long sourceId,
NamedValue[] options)
Restores a document/folder specified by sourceId into the location
specified by DESTFOLDER option from the Archive.
|
void |
AutoTimeoutSessionManager.returnSession(FdkSession session)
Returns a session back to the manager.
|
void |
SessionManager.rollbackTransaction(long id)
Rolls back a transaction started by calling
beginTransaction()
. |
NamedValue[] |
SearchManager.search(SearchExpression expr,
NamedValue[] options,
AttributeRequest[] attrReqs)
Performs a search.
|
Event[] |
AuditManager.searchAuditHistory(NamedValue[] searchOptions,
NamedValue[] sortOptions)
Searches an Audit History, returning an array of matching Event instances.
|
Item[] |
RequestManager.searchResponders(String name,
AttributeRequest[] attrreqs)
Simple search for Users with given (exact)name.
|
void |
ArchiveManager.setArchiveConfiguration(long archiveId,
NamedValue[] attributes)
Sets the Archive configuration.
|
void |
EventHandlerContext.setAuditHistoryProperty(String key,
NamedValue value)
Sets a property of the custom Audit history.
|
void |
AuditManager.setAuditingConfiguration(long folderId,
NamedValue[] config)
Sets the AuditingConfiguration for a Folder, replacing any existing
AuditingConfiguration.
|
void |
CategoryManager.setCategoryConfiguration(long folderId,
NamedValue[] config)
Sets or updates the CategoryConfiguration for a Folder.
|
void |
EventHandlerContext.setDomain(long domainId)
Sets the Domain that should be used while processing an Event.
|
void |
UserManager.setDomainDefaultUserPreference(Preference value)
Set domain level default value for a single user preference.
|
void |
UserManager.setDomainDefaultUserPreferences(Preference[] values)
Set domain level default values for user preferences.
|
void |
AuditManager.setOperationConfiguration(long folderId,
NamedValue[] config)
Sets the OperationConfiguration for a Folder, replacing any existing
OperationConfiguration.
|
Item |
SecurityManager.setSecurityConfiguration(long id,
NamedValue[] def,
AttributeRequest[] attributes)
Updates the SecurityConfiguration of the target item.
|
Item |
SessionManager.setSessionMode(int mode,
AttributeRequest[] attributes)
Switches the current session into one of the administration modes
(currently only DOMAIN) or out of administration mode (NORMAL).
|
void |
SessionManager.setSessionProperties(NamedValue[] properties)
Set properties on the current session.
|
void |
SortManager.setSortPreference(NamedValue[] options)
Creates a setting in the current user's user preferences to always sort
the given table using the given options.
|
abstract void |
FdkSession.setState(Object key,
Object value)
Sets a value representing a piece of state that makes sense to the
application.
|
void |
TrashManager.setTrashConfiguration(long trashId,
NamedValue[] config)
Sets the TrashFolder configuration.
|
void |
UserManager.setUserPreference(Preference value)
Set a user preference for the current user.
|
void |
UserManager.setUserPreferences(Preference[] values)
Set an array of user preferences for the current user.
|
void |
UserManager.setUserPreferencesForUser(long userId,
Preference[] values)
Set an array of user preferences for the specified user.
|
void |
VersionManager.setVersioningConfiguration(long folderId,
NamedValue[] config)
Sets the VersioningConfiguration for a Folder, replacing any existing
VersioningConfiguration.
|
void |
WorkflowManager.setWorkflowConfiguration(long id,
String operation,
NamedValue[] def)
Sets a
WORKFLOW_CONFIGURATION for a FOLDER Item,
replacing any existing WORKFLOW_CONFIGURATION of the same
operation type (Attributes.WORKFLOW_CONFIGURATION_OPERATION). |
Item[] |
SortManager.sortAttributeList(long id,
NamedValue[] options,
AttributeRequest[] attrs)
Given an id of a repos object, constructs an item with an attribute of
the given name and sorts the resulting value.
|
Item[] |
FileManager.uncompress(long[] items,
AttributeRequest[] attributes)
Uncompresses the items refered to by
items. |
Item |
AuditManager.updateAuditTypeList(long id,
NamedValue[] def,
AttributeRequest[] attrs)
Updates the name or description of an existing AuditTypeList.
|
Item |
CategoryManager.updateCategory(long catId,
NamedValue[] ahcDef,
AttributeRequest[] attributes)
Deprecated.
|
Item |
ContainerManager.updateContainer(long id,
NamedValue[] def,
AttributeRequest[] attributes)
Updates an existing container.
|
void |
ExtendedFileContentManager.updateContent(long id,
InputStream content,
NamedValue[] attributes)
Updates the content of an existing DOCUMENT or DOCUMENT_DEFINITION item.
|
Item |
FileManager.updateDocument(long docId,
NamedValue[] docDef,
AttributeRequest[] attributes)
Updates a Document.
|
Item[] |
FileManager.updateDocuments(long[] docIds,
NamedValueSet[] docDefs,
AttributeRequest[] attributes)
Updates multiple Documents.
|
Item |
DomainManager.updateDomain(long id,
NamedValue[] def,
AttributeRequest[] attributes)
Updates a
DOMAIN Item. |
Item |
FileManager.updateFolder(long folderId,
NamedValue[] attrs,
AttributeRequest[] attributes)
Updates a Folder.
|
Item |
GroupManager.updateGroup(long groupId,
NamedValue[] def,
AttributeRequest[] attributes)
Updates a group.
|
Item |
LifecycleManager.updateLifecyclePolicy(long id,
NamedValue[] def,
AttributeRequest[] attrs)
Updates an existing LIFECYCLE_POLICY Item.
|
Item |
LifecycleManager.updateLifecyclePolicyEntry(long id,
NamedValue[] def,
AttributeRequest[] attrs)
Updates an existing LIFECYCLE_POLICY_ENTRY item.
|
Item |
FileManager.updateLink(long linkId,
NamedValue[] attrs,
AttributeRequest[] attributes)
Updates a Link.
|
void |
ContentManager.updateQuota(long id,
NamedValue[] attrs)
Updates an existing quota.
|
Item |
RelationManager.updateRelation(long id,
NamedValue[] options,
AttributeRequest[] attributes)
Update an existing relation.
|
Item |
SecurityManager.updateRole(long target,
NamedValue[] def,
AttributeRequest[] attributes)
Updates a Role.
|
Item |
VersionManager.updateVersion(long id,
NamedValue[] attrs,
AttributeRequest[] attributes)
Updates a version-controlled document.
|
Item |
WorkspaceManager.updateWorkspace(long id,
NamedValue[] def,
AttributeRequest[] attributes)
Updates an existing Workspace.
|
String |
WorkflowManager.validateWorkflowParameterValue(long workflowId,
String paramName,
String value)
Validates that the
value for the parameter name
is correct according to the validator defined for that parameter. |
abstract boolean |
FdkSession.verifyCredential(Credential credential)
Verifies that the given credential is valid for the user represented
by this session.
|
| Constructor and Description |
|---|
InProcessManagersFactory(Map config)
Protected constructor.
|
Item(FdkSession session,
LibraryObject reposObject,
AttributeRequest[] attributes)
Constructor that converts a repository object into an Item.
|
ManagersFactory(Map config)
Protected constructor.
|
| Modifier and Type | Method and Description |
|---|---|
void |
CoreRequestManager.acknowledgeRequestForUser(long requestId,
NamedValue[] def,
AttributeRequest[] attributes) |
Item |
CoreExtendedLockManager.acquireDavLock(long id,
NamedValue[] attributes) |
Item[] |
CoreLockManager.acquireManualLocks(long[] ids,
NamedValueSet[] attributes) |
Item |
CoreExtendedLockManager.acquireNullOrDavLock(long id,
String name,
NamedValue[] attributes) |
Item |
CoreSecurityManager.addGrants(long id,
NamedValue[] def,
AttributeRequest[] attributes) |
Item |
CoreCategoryManager.addMetaDataAttribute(long categoryId,
NamedValue attributedef,
AttributeRequest[] attrrequest)
adds a metadata attribute.
|
protected Item |
CoreCategoryManager.addMetaDataCategoryAttribute(long categoryId,
NamedValue attributedef,
AttributeRequest[] attrrequest)
Deprecated.
use addMetaDataAttribute
|
Item |
CoreGroupManager.addUsers(long groupId,
NamedValue[] def,
AttributeRequest[] attributes) |
void |
CoreRequestManager.approveRequestForUser(long requestId,
NamedValue[] def,
AttributeRequest[] attributes) |
long |
CoreSessionManager.beginTransaction()
Begins a transaction on this session.
|
void |
CoreContentManager.calculateConsumedQuota(long id)
Initiate the calculation of consumed quota
|
void |
CoreVersionManager.cancelCheckout(long[] items) |
void |
CoreRequestManager.cancelRequestForUser(long requestId,
NamedValue[] def,
AttributeRequest[] attributes) |
Item[] |
CoreVersionManager.checkin(long[] items,
NamedValue[] workflowParams,
NamedValueSet[] attrs,
AttributeRequest[] attributes) |
protected void |
CoreCategoryManager.checkInvalidAttributes(Map attrMap)
if any attributes remain, then they are invalid
|
boolean |
CoreFileManager.checkNameValidity(long parentId,
String name)
Checks to see if the proposed name is a valid object name
in the target folder.
|
Item[] |
CoreVersionManager.checkout(long[] items,
String[] comments) |
Item[] |
CoreVersionManager.checkoutDocuments(long[] items,
String[] comments,
NamedValue[] workflowParams,
NamedValueSet[] attrs,
AttributeRequest[] attributes) |
boolean |
CoreSecurityManager.checkPermission(long target,
long userOrGroup,
long permission) |
void |
CoreSessionManager.commitTransaction(long id)
Commits a transaction started by calling
beginTransaction(). |
ManagersFactory |
CoreFdkConfiguration.constructManagersFactory(FdkSession session)
Construct a ManagersFactory for a quest or system session.
|
Item[] |
CoreFileManager.copy(long[] items,
NamedValue[] workflowParams,
NamedValueSet[] attrs)
Copies items.
|
Item |
CoreVersionManager.copyToLatestVersion(long versionId,
NamedValue[] attrs) |
Item |
CoreVersionManager.copyToWorkingCopy(long versionId) |
Item |
CoreVersionManager.copyVersion(long versionId,
NamedValue[] attrs) |
Item |
CoreAuditManager.createAuditReport(NamedValue[] searchOptions,
NamedValue[] sortOptions,
NamedValue[] reportOptions,
AttributeRequest[] attrs) |
Item |
CoreAuditManager.createAuditTypeList(NamedValue[] def,
AttributeRequest[] attrs) |
Item |
CoreCategoryManager.createCategorySubClass(NamedValue[] attributes,
AttributeRequest[] attrrequest) |
Item |
CoreContainerManager.createContainer(long target,
NamedValue[] def,
AttributeRequest[] attributes) |
Item |
CoreFileManager.createDocument(NamedValue[] docDef,
NamedValue[] workflowParams,
AttributeRequest[] attributes)
Creates a new Document.
|
Item |
CoreFileManager.createDocumentDefinition(NamedValue[] def,
AttributeRequest[] attributes)
Creates a new DocumentDefinition Item, which can be used later to create a
Document Item.
|
Item[] |
CoreFileManager.createDocumentDefinitions(NamedValueSet[] defs,
AttributeRequest[] attributes)
Creates set of new DocumentDefinition Items, which can be used later to
create Document Items.
|
Item[] |
CoreFileManager.createDocuments(NamedValueSet[] docDefs,
NamedValue[] workflowParams,
AttributeRequest[] attributes)
Creates a set of new Documents.
|
Item |
CoreFileManager.createFolder(long destFolderId,
NamedValue[] attributes,
AttributeRequest[] attrequest)
Creates a new FOLDER Item.
|
Item[] |
CoreFileManager.createFolders(long[] destFolders,
NamedValueSet[] attributes,
AttributeRequest[] attrequest)
Creates a set of folders.
|
Item |
CoreGroupManager.createGroup(NamedValue[] def,
AttributeRequest[] attributes) |
Item |
CoreLifecycleManager.createLifecyclePolicy(NamedValue[] def,
AttributeRequest[] attrs)
Creates a new LIFECYCLE_POLICY Item.
|
Item[] |
CoreFileManager.createLinks(long folderId,
NamedValueSet[] linkDefs,
AttributeRequest[] attributes)
Creates a set of new Links.
|
Item |
CoreWorkspaceManager.createPersonalWorkspace(NamedValue[] def,
AttributeRequest[] attributes) |
Item |
CoreWorkspaceManager.createPersonalWorkspaceForUser(long userId,
NamedValue[] def,
AttributeRequest[] attributes) |
Item |
CoreRelationManager.createRelation(long from,
long to,
NamedValue[] options,
AttributeRequest[] attributes)
Create a new relation between two documents.
|
Item |
CoreSecurityManager.createRole(long target,
NamedValue[] def,
AttributeRequest[] attributes) |
void |
CoreRequestManager.createUserRequest(long[] targets,
NamedValue[] workflowParams) |
Item |
CoreWorkspaceManager.createWorkspace(long target,
NamedValue[] workflowParams,
NamedValue[] def,
AttributeRequest[] attributes) |
void |
CoreFileManager.delete(long[] items,
NamedValue[] workflowParams,
NamedValueSet[] attrs)
Deletes items.
|
void |
CoreCategoryManager.deleteCategory(long catId) |
void |
CoreContainerManager.deleteContainer(long id,
NamedValue[] def) |
void |
CoreGroupManager.deleteGroup(long groupId) |
void |
CoreLifecycleManager.deleteLifecyclePolicy(long idval,
NamedValue[] options)
Deletes a LIFECYCLE_POLICY Item.
|
void |
CoreRelationManager.deleteRelation(long id)
Delete a relation.
|
void |
CoreRequestManager.deleteRequests(long[] ids) |
void |
CoreSecurityManager.deleteRole(long id,
NamedValue[] def) |
void |
CoreVersionManager.deleteVersion(long versionId) |
void |
CoreWorkspaceManager.deleteWorkspace(long id,
NamedValue[] def) |
void |
CoreRequestManager.denyRequestForUser(long requestId,
NamedValue[] def,
AttributeRequest[] attributes) |
void |
CoreArchiveManager.emptyArchive(long archiveId)
Empties a given Archive.
|
void |
CoreTrashManager.emptyTrash(long trashId) |
NamedValue[] |
CoreSearchManager.executeSelect(NamedValue priTarget,
NamedValue[] auxTargets,
String searchCondition,
String sortCondition,
NamedValue[] bindVals,
NamedValue[] options,
AttributeRequest[] attrReqs) |
int |
CoreSearchManager.executeSelectCount(NamedValue priTarget,
NamedValue[] auxTargets,
String searchCondition,
NamedValue[] bindVals,
NamedValue[] options) |
boolean |
CoreFileManager.exists(String absolutePath)
Checks to see if an object exists at the given absolute path.
|
boolean |
CoreFileManager.existsRelative(long folderId,
String relativePath)
Checks to see if an object exists at the given relative path, relative
to the given Folder.
|
long |
CoreAuditManager.findAuditHistory(String name) |
NamedValueSet[] |
CoreUserManager.findCredentialManagerUsers(NamedValue[] searchOptions) |
Item[] |
CoreUserManager.findDomainUsers(NamedValue[] options,
AttributeRequest[] attrs) |
Item[] |
CoreGroupManager.findGroups(NamedValue[] def,
AttributeRequest[] attributes) |
Item[] |
CoreLifecycleManager.findLifecyclePolicies(NamedValue[] options,
AttributeRequest[] attrs)
Returns an array of LIFECYCLE_POLICY Items that match the specified search
options.
|
Item |
CoreLifecycleManager.findLifecyclePolicyByName(String name,
AttributeRequest[] attrs)
Returns the LIFECYCLE_POLICY Item with the specified name, or null if no
matching LIFECYCLE_POLICY Item exists.
|
Item |
CoreSecurityManager.findRoleByKey(String key,
AttributeRequest[] attributes) |
boolean |
CoreFileManager.folderLinksExist(String path)
Returns true if the given absolute path contains any LINK items.
|
void |
CoreCategoryManager.freeCategoryClass(long mdscatId)
Frees a category class.
|
NamedValue[] |
CoreAuditManager.getAuditTypeEntries(NamedValue[] options) |
NamedValue[] |
CoreAuditManager.getAuditTypeEntriesFromAuditTypesList(long id) |
Item |
CoreAuditManager.getAuditTypeList(String name,
AttributeRequest[] attrs) |
Item[] |
CoreSecurityManager.getComputedGranteeList(long target,
long role,
AttributeRequest[] attributes) |
Item[] |
CoreSecurityManager.getComputedGroupGranteeList(long target,
long role,
AttributeRequest[] attributes) |
Item[] |
CoreSecurityManager.getComputedUserGranteeList(long target,
long role,
AttributeRequest[] attributes) |
protected Item[] |
CoreCategoryManager.getConfigurationMetaDataCategories(long folderId,
int categorytype,
AttributeRequest[] requestedAttributes,
String configClassName)
Deprecated.
remove when getRequiredCategories is removed.
|
InputStream |
CoreFileContentManager.getContent(long docId)
Returns the contents of an item identified by the given ID.
|
Item |
CoreSessionManager.getCurrentUser(AttributeRequest[] attributes)
Returns the user as an Item for the current session.
|
Item |
CoreDomainManager.getDefaultDomain(AttributeRequest[] attributes) |
Item |
CoreContentManager.getDefaultMedia(AttributeRequest[] attributes)
Return the default media defined in the system.
|
String |
CoreContentManager.getDefaultStorageGroup()
Return the default storage group name.
|
Preference |
CoreUserManager.getDomainDefaultUserPreference(String key,
AttributeRequest[] attributes) |
Preference[] |
CoreUserManager.getDomainDefaultUserPreferences(String[] keys,
AttributeRequest[] attributes) |
String[] |
CoreMailManager.getGroupManagersEmail(long id) |
String[] |
CoreMailManager.getGroupMembersEmail(long id) |
Item |
CoreCommonManager.getItem(long id,
AttributeRequest[] attributes)
Returns an Item given an Item ID and an array of AttributeRequests.
|
ItemCertificate[] |
CoreAuditManager.getItemCertificates(long[] ids) |
NamedValue[] |
CoreCommonManager.getItemInvalidations(long[] addedIds,
long[] removedIds,
long[] setIds)
Gets the set of Item invalidations for items the session has
registered interest for.
|
Item[] |
CoreCommonManager.getItems(long[] ids,
AttributeRequest[] attributes)
Returns an array of Items given an array of Item IDs and an array
of AttributeRequests.
|
protected static String |
CoreAuditManager.getItemTypeFromClassName(LibrarySession session,
String className)
Get the Item type for a specified class name, for auditing purposes.
|
Item |
CoreContentManager.getMediaByName(String name,
AttributeRequest[] attributes)
Get media by name.
|
Item[] |
CoreFileManager.getMostRecentDocuments(NamedValue[] options,
AttributeRequest[] attributes)
Returns the most recent documents for the current user
If the primary or secondary sort attributes are specified
but the corresponding sort directions are not specified,
the sorting defaults to ascending order.
|
NamedValueSet[] |
CoreFileManager.getNameConflictResolutionOptions(long[] sourceItems,
long[] conflictItems,
NamedValueSet[] defs)
Returns an array of valid and applicable name conflict resolution options
for each {sourceItem, conflictItem, def} tuple passed to this method.
|
String |
CoreSortManager.getPrimarySortAttribute(String tableName) |
boolean |
CoreSortManager.getPrimarySortDirection(String tableName) |
NamedValueSet[] |
CoreSearchManager.getProperties() |
Item |
CoreWorkflowManager.getRequestForWorkflowProcess(long workflowPid,
AttributeRequest[] attrs)
Returns a Request corresponding to a given WorkflowProcess id.
|
Item[] |
CoreCategoryManager.getRequiredCategories(long folderId,
AttributeRequest[] requestedAttributes) |
protected Item[] |
CoreCategoryManager.getRequiredMetaDataCategories(long folderId,
AttributeRequest[] attrReqs,
String cfgClassName)
Returns the RequiredCategories of the given folder, or null if none.
|
Item |
CoreSecurityManager.getRole(long id,
AttributeRequest[] attributes) |
Item |
CoreSecurityManager.getRoleByName(String name,
AttributeRequest[] attributes) |
String |
CoreSortManager.getSecondarySortAttribute(String tableName) |
boolean |
CoreSortManager.getSecondarySortDirection(String tableName) |
String[] |
CoreMailManager.getSecurityMembersEmail(long id) |
NamedValue[] |
CoreSessionManager.getSessionProperties(String[] properties)
Returns the requested session properties.
|
NamedValue[] |
CoreFileManager.getSupportedCharsetNames()
Returns a list of supported character sets.
|
String[] |
CoreFileManager.getSupportedCharsets()
Returns the list of supported character sets
|
NamedValue[] |
CoreFileManager.getSupportedLanguageNames()
Returns a list of supported languages.
|
String[] |
CoreFileManager.getSupportedLanguages()
Returns the list of supported languages
|
long |
CoreCommonManager.getUniqueId()
Returns a unique ID backed by a repository sequence.
|
Item |
CoreUserManager.getUser(String name,
AttributeRequest[] attributes) |
Preference |
CoreUserManager.getUserPreference(String key,
AttributeRequest[] attributes)
Get a user preference for the current user,
by its preference key.
|
Preference[] |
CoreUserManager.getUserPreferences(String[] keys,
AttributeRequest[] attributes)
Get a set of user preferences for the current user,
by preference key.
|
Preference[] |
CoreUserManager.getUserPreferencesForUser(long userId,
String[] keys,
AttributeRequest[] attributes)
Get a set of user preferences for the specified user,
by preference key.
|
String[] |
CoreMailManager.getUsersWithRoleEmail(long id) |
Item |
CoreWorkflowManager.getWorkflowConfiguration(long id,
String operation,
boolean direct,
AttributeRequest[] attrs) |
Item[] |
CoreWorkflowManager.getWorkflowConfigurations(long id,
AttributeRequest[] attrs) |
boolean |
CoreSecurityManager.hasOnlyExplicitGrantedAccess(long target,
long user) |
boolean |
CoreSecurityManager.hasPropagatingGrants(long target,
long user) |
boolean |
CoreUserManager.hasUserPreference(String prefKey)
Check if a user preference is set for the current user.
|
boolean |
CoreRequestManager.isOperationRequestEnabled(long id,
String ecmAction) |
Item |
CoreWorkspaceManager.joinWorkspace(long id,
long[] requestedRoles,
NamedValue[] wfParams,
AttributeRequest[] attributes) |
void |
CoreSessionManager.keepAlive()
Keeps a long running transaction that spans multiple requests alive.
|
NamedValue[] |
CoreAuditManager.listAggregateEventColumnValues(String aggFunction,
String[] columnNames,
NamedValue[] searchOptions,
NamedValue[] sortOptions) |
String[] |
CoreFileManager.listAutoFolderingActionSpecifications()
Returns the list of registered auto folder creation specification names.
|
Item[] |
CoreWorkflowManager.listCustomWorkflows(NamedValue[] options,
AttributeRequest[] attributes) |
String[] |
CoreUserManager.listExternallySupportedUserPreferences()
Returns the list of externally supported user preferences
|
Item[] |
CoreFileManager.listFolder(long id,
NamedValue[] options,
AttributeRequest[] attributes)
Returns the items of a folder and returns the requested attributes that
apply to each item.
|
Item[] |
CoreWorkspaceManager.listJoinableWorkspaces(NamedValue[] options,
AttributeRequest[] attrs) |
String[] |
CoreLifecycleManager.listLifecycleActionSpecifications()
Returns the list of registered lifecycle action specifications.
|
String[] |
CoreLifecycleManager.listLifecycleDateRuleSpecifications()
Returns the list of registered Lifecycle date rule specifications.
|
Item[] |
CoreLockManager.listLockedDocuments(int[] locks,
NamedValue[] options,
AttributeRequest[] attributes) |
Item[] |
CoreContentManager.listMedias(AttributeRequest[] attributes)
List all media items defined in the system.
|
String[] |
CoreAuditManager.listOperationActionSpecifications()
Returns the list of registered operation action specification names.
|
String[] |
CoreRelationManager.listRelationActionSpecifications()
Returns the list of registered relation action specifications.
|
Item[] |
CoreRequestManager.listRequests(long id,
NamedValue[] options,
AttributeRequest[] attributes) |
Item[] |
CoreRequestManager.listRequestsForUser(long id,
NamedValue[] options,
AttributeRequest[] attributes) |
Item[] |
CoreSecurityManager.listRoles(long id,
NamedValue[] options,
AttributeRequest[] attributes) |
Item[] |
CoreSecurityManager.listRolesByItemType(String itemName,
NamedValue[] options,
AttributeRequest[] attributes) |
String[] |
CoreContentManager.listStorageGroups()
List all storage group names defined in the system.
|
Item[] |
CoreVersionManager.listVersions(long id,
NamedValue[] options,
AttributeRequest[] attributes) |
Item[] |
CoreWorkflowManager.listWorkflows(AttributeRequest[] attributes) |
FdkSession |
CoreFdkConfiguration.login(FdkCredential cred)
Login and create an FdkSession context.
|
void |
CoreVersionManager.makeVersioned(long[] docIds) |
long |
CoreAuditManager.markCurrentAuditingId()
Mark the starting point for subsequent audit event searches.
|
Item |
CoreCategoryManager.modifyCategorySubClass(long mdscatId,
NamedValue[] attributes,
AttributeRequest[] attrrequest) |
Item |
CoreCategoryManager.modifyMetaDataAttribute(long attributeId,
NamedValue attributedef,
AttributeRequest[] attrrequest)
modify a category attribute.
|
Item[] |
CoreFileManager.move(long[] items,
NamedValue[] workflowParams,
NamedValueSet[] attrs)
Moves items.
|
Item |
CoreVersionManager.moveVersion(long versionId,
NamedValue[] attrs) |
void |
CoreSessionManager.popSessionMode(int mode)
Pops the session one level, out of a privileged mode.
|
void |
CoreAuditManager.postEvent(String opTypeKey,
long targetItem,
NamedValue[] optPayload)
Posts a custom audit event.
|
void |
CoreAuditManager.processRawAuditEvents()
Force processing of raw audit events.
|
void |
CoreUserManager.provisionCurrentUserPreferences()
Synchronize the preferences of the current user with user preferences
from OID.
|
void |
CoreUserManager.provisionUserPreferences(long userId)
Synchronize the preferences of the specified user with user preferences
from OID.
|
void |
CoreSessionManager.pushSessionMode(int mode)
Pushes the session into a privileged mode where certain permission checks
are ignored, depending on the mode.
|
int |
CoreFileContentManager.read(long docId,
long offset,
byte[] buffer,
int length)
Reads a byte range from the content of a document and places it in the
provided buffer.
|
Item |
CoreExtendedLockManager.refreshDavLock(long id,
NamedValue[] attributes) |
void |
CoreExtendedLockManager.releaseDavLock(long id) |
void |
CoreLockManager.releaseManualLocks(long[] ids) |
void |
CoreExtendedLockManager.releaseNullResourceLock(long id,
String name) |
void |
CoreAuditManager.removeAuditingConfiguration(long folderId) |
void |
CoreCategoryManager.removeCategoryAttribute(long categoryId,
String attributename)
Deprecated.
use removeMetaDataAttribute
|
void |
CoreCategoryManager.removeCategoryConfiguration(long folderId) |
void |
CoreCategoryManager.removeMetaDataAttribute(long attributeId)
removes a category attribute.
|
protected void |
CoreCategoryManager.removeMetaDataCategoryAttribute(long categoryId,
String attributeName)
Deprecated.
use removeMetaDataAttribute
|
protected void |
CoreCategoryManager.removeMetaDataConfiguration(long folderId,
String configClassName) |
void |
CoreAuditManager.removeOperationConfiguration(long folderId)
Removes the OperationConfiguration for a Folder.
|
void |
CoreSecurityManager.removeSecurityConfiguration(long id) |
void |
CoreUserManager.removeUserPreference(String prefKey)
Remove a user preference for the curent user.
|
Item |
CoreGroupManager.removeUsers(long groupId,
NamedValue[] def,
AttributeRequest[] attributes) |
void |
CoreVersionManager.removeVersioningConfiguration(long folderId) |
void |
CoreWorkflowManager.removeWorkflowConfiguration(long id,
String operation) |
Item |
CoreContentManager.requestQuotaUpdate(long id,
NamedValue[] wfParams,
NamedValue[] attrs,
AttributeRequest[] attributes)
Request an update to the existing quota on a workspace for non-admin user.
|
Item |
CoreFileManager.resolvePath(String path,
AttributeRequest[] attributes)
Resolves a path, returning an Item that represents a PublicObject.
|
Item |
CoreFileManager.resolveRelativePath(long folderId,
String path,
AttributeRequest[] attributes)
Resolves a relative path from a Folder, returning an Item that represents
a PublicObject.
|
Item |
CoreArchiveManager.restoreFromArchive(long archiveId,
long sourceId,
NamedValue[] options)
Restores a document/folder specified by sourceId into the location
specified by DESTFOLDER option value from the Archive.
|
void |
CoreSessionManager.rollbackTransaction(long id)
Rolls back a transaction started by calling
beginTransaction()
. |
NamedValue[] |
CoreSearchManager.search(SearchExpression expr,
NamedValue[] options,
AttributeRequest[] attrReqs) |
Event[] |
CoreAuditManager.searchAuditHistory(NamedValue[] searchOptions,
NamedValue[] sortOptions) |
Item[] |
CoreRequestManager.searchResponders(String name,
AttributeRequest[] attrs) |
void |
CoreArchiveManager.setArchiveConfiguration(long archiveId,
NamedValue[] attributes)
Updates the specified Archive.
|
void |
CoreAuditManager.setAuditingConfiguration(long folderId,
NamedValue[] config) |
void |
CoreCategoryManager.setCategoryConfiguration(long folderId,
NamedValue[] config) |
void |
CoreUserManager.setDomainDefaultUserPreference(Preference value) |
void |
CoreUserManager.setDomainDefaultUserPreferences(Preference[] values) |
protected void |
CoreCategoryManager.setMetaDataConfiguration(long folderId,
NamedValue[] config,
String configClassName) |
void |
CoreAuditManager.setOperationConfiguration(long folderId,
NamedValue[] config)
Sets the OperationConfiguration for a Folder, replacing any existing
OperationConfiguration.
|
Item |
CoreSecurityManager.setSecurityConfiguration(long id,
NamedValue[] def,
AttributeRequest[] attributes) |
Item |
CoreSessionManager.setSessionMode(int mode,
AttributeRequest[] attributes)
Switches the current session into one of the administration modes
(currently only DOMAIN) or out of administration mode (NORMAL).
|
void |
CoreSessionManager.setSessionProperties(NamedValue[] properties)
Set properties on the current session.
|
void |
CoreSortManager.setSortPreference(NamedValue[] options) |
void |
CoreTrashManager.setTrashConfiguration(long trashId,
NamedValue[] config) |
void |
CoreUserManager.setUserPreference(Preference pref)
Set a user preference for the current user.
|
void |
CoreUserManager.setUserPreferences(Preference[] prefs)
Set an array of user preferences for the current user.
|
void |
CoreUserManager.setUserPreferencesForUser(long userId,
Preference[] prefs)
Set an array of user preferences for the specified user.
|
void |
CoreVersionManager.setVersioningConfiguration(long folderId,
NamedValue[] config) |
void |
CoreWorkflowManager.setWorkflowConfiguration(long id,
String operation,
NamedValue[] config) |
Item[] |
CoreSortManager.sortAttributeList(long id,
NamedValue[] options,
AttributeRequest[] attrs) |
Item[] |
CoreFileManager.uncompress(long[] items,
AttributeRequest[] attributes)
Uncompresses the items refered to by
items. |
Item |
CoreAuditManager.updateAuditTypeList(long id,
NamedValue[] def,
AttributeRequest[] attrs) |
Item |
CoreCategoryManager.updateCategory(long catId,
NamedValue[] attrs,
AttributeRequest[] attributes) |
Item |
CoreContainerManager.updateContainer(long id,
NamedValue[] def,
AttributeRequest[] attributes) |
void |
CoreFileContentManager.updateContent(long id,
InputStream content,
NamedValue[] attributes)
Updates the content of an existing DOCUMENT or DOCUMENT_DEFINITION item.
|
Item |
CoreFileManager.updateDocument(long docId,
NamedValue[] attrs,
AttributeRequest[] attributes)
Updates a Document.
|
Item[] |
CoreFileManager.updateDocuments(long[] items,
NamedValueSet[] attrs,
AttributeRequest[] attributes)
Updates multiple Documents.
|
Item |
CoreDomainManager.updateDomain(long id,
NamedValue[] def,
AttributeRequest[] attributes) |
Item |
CoreFileManager.updateFolder(long folderId,
NamedValue[] attrs,
AttributeRequest[] attributes)
Updates a Folder.
|
Item |
CoreGroupManager.updateGroup(long groupId,
NamedValue[] def,
AttributeRequest[] attributes) |
Item |
CoreLifecycleManager.updateLifecyclePolicy(long id,
NamedValue[] def,
AttributeRequest[] attrs)
Updates an existing LIFECYCLE_POLICY Item.
|
Item |
CoreLifecycleManager.updateLifecyclePolicyEntry(long id,
NamedValue[] def,
AttributeRequest[] attrs)
Updates an existing LIFECYCLE_POLICY_ENTRY item.
|
Item |
CoreFileManager.updateLink(long linkId,
NamedValue[] attrs,
AttributeRequest[] attributes)
Updates a Link.
|
void |
CoreContentManager.updateQuota(long id,
NamedValue[] attrs)
Updates an existing quota.
|
Item |
CoreRelationManager.updateRelation(long id,
NamedValue[] options,
AttributeRequest[] attributes)
Update an existing relation.
|
Item |
CoreSecurityManager.updateRole(long id,
NamedValue[] def,
AttributeRequest[] attributes) |
Item |
CoreVersionManager.updateVersion(long id,
NamedValue[] attrs,
AttributeRequest[] attributes) |
Item |
CoreWorkspaceManager.updateWorkspace(long id,
NamedValue[] def,
AttributeRequest[] attributes) |
String |
CoreWorkflowManager.validateWorkflowParameterValue(long workflowId,
String paramName,
String value) |
| Constructor and Description |
|---|
CoreInProcessManagersFactory(FdkCredential credential,
Map config)
Constructs an CoreInProcessManagersFactory.
|
CoreInProcessManagersFactory(FdkSessionImpl session)
Package protected constructor used by FdkSessionImpl in some special
cases.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
CorePathAttributeHandler.canHandle(AttributeHandlerContext context) |
Object |
CorePathAttributeHandler.getValue(AttributeHandlerContext context) |
| Modifier and Type | Method and Description |
|---|---|
static void |
Utils.addAuditTypestoDefinition(LibrarySession ls,
AuditTypeListDefinition atlDef,
NamedValue[] auditTypesNamedValues)
Populates the AuditTypeListDefinition with the given Audit Types.
|
void |
FdkGuestSessionImpl.beginRequest(boolean wait,
long timeout,
String tag) |
void |
FdkSystemSessionImpl.beginRequest(boolean wait,
long timeout,
String tag) |
void |
FdkUserSessionImpl.beginRequest(boolean wait,
long timeout,
String tag) |
void |
InProcessManagersFactoryImpl.beginRequest(String tag)
Marks the begining of a request that will result in successive calls to
various managers and their methods.
|
long |
FdkSessionImpl.beginTransaction()
Begins a transaction on this session.
|
long |
FdkUserSessionImpl.beginTransaction() |
boolean |
AttributeHandler.canHandle(AttributeHandlerContext context)
Returns
true if this handler can handle the attribute
request on the given object instance. |
boolean |
AttributeHandler.canUpdate(AttributeHandlerContext context)
Returns
true if this handler can update the attribute,
false if the attribute is not updateable. |
static void |
Utils.checkInvalidAttributes(Map attrMap)
If any attributes remain, then they are invalid.
|
void |
FdkSessionImpl.commitTransaction(long id)
Commits a transaction started by calling
beginTransaction(). |
void |
FdkUserSessionImpl.commitTransaction(long id) |
void |
FdkSessionImpl.disconnect()
Disconnects this user session.
|
void |
FdkGuestSessionImpl.disconnectNotify() |
void |
FdkSystemSessionImpl.disconnectNotify() |
void |
FdkUserSessionImpl.disconnectNotify()
Disconnects this user session.
|
boolean |
FdkUserSessionImpl.endRequest() |
void |
InProcessManagersFactoryImpl.endRequest()
Marks the end of a request.
|
static LinkedHashMap |
AttributeHelper.getAttributes(FdkSession fsession,
LibraryObject reposObject,
AttributeRequest[] attributes)
Returns the map of specified attributes.
|
static int |
Utils.getAuditOperationType(LibrarySession session,
String opTypeKey)
Returns the audit op type (int) corresponding to a audit op type key
(String).
|
static AuditTypeList |
Utils.getAuditTypeList(LibrarySession ls,
Long id)
Returns an AuditTypeList from a given ID or throws an exception if
the item cannot be found or it is not an AuditTypeList.
|
static String |
Utils.getAuditTypeOperationKey(LibrarySession session,
int opType)
Returns the audit operation key (String) for the given audit operation
type.
|
static boolean |
OptionUtils.getBoolean(Map map,
String name,
boolean defaultValue)
Get a boolean value from a options map.
|
static DefinitionObject |
Utils.getDefinitionObject(LibrarySession ls,
long id)
Returns a DefinitionObject from a given ID or throws an exception if
the item cannot be found or it is not a DefinitionObject.
|
static DefinitionObject |
Utils.getDefinitionObject(LibrarySession ls,
Long id)
Returns a DefinitionObject from a given ID or throws an exception if
the item cannot be found or it is not a DefinitionObject.
|
static DirectoryGroup |
Utils.getDirectoryGroup(LibrarySession ls,
Long id)
Returns a DirectoryGroup from a given ID or throws an exception if
the item cannot be found or it is not a DirectoryGroup.
|
static DirectoryObject |
Utils.getDirectoryObject(LibrarySession ls,
Long id)
Returns a DirectoryObject from a given ID or throws an exception if
the item cannot be found or it is not a DirectoryObject.
|
static Document |
Utils.getDocument(LibrarySession ls,
long id)
Returns the Document from a given ID or throws an exception if
the item cannot be found or it is not a Document.
|
static Document |
Utils.getDocument(LibrarySession ls,
Long id)
Returns the Document from a given ID or throws an exception if
the item cannot be found or it is not a Document.
|
static Folder |
Utils.getFolder(LibrarySession ls,
AttributeValue av)
Returns the Folder from a given AttributeValue or throws an exception if
the item cannot be found or it is not a Folder.
|
static Folder |
Utils.getFolder(LibrarySession ls,
long id)
Returns the Folder from a given ID or throws an exception if
the item cannot be found or it is not a Folder.
|
static Folder |
Utils.getFolder(LibrarySession ls,
Long id)
Returns the Folder from a given ID or throws an exception if
the item cannot be found or it is not a Folder.
|
FdkSession |
GuestSessionPoolImpl.getGuestSession() |
static FdkServiceEventHandler |
FdkServiceEventHandler.getInstance(LibrarySession session)
Returns the singleton instance of this Executor.
|
static int |
OptionUtils.getInteger(Map map,
String name,
int defaultValue)
Get an integer value from a options map.
|
Object |
FdkSessionImpl.getInternalSession()
Returns the internal session associated with this user session.
|
abstract LibrarySession |
FdkSessionImpl.getLibrarySession()
Returns the
LibrarySession associated with this user session. |
LibrarySession |
FdkUserSessionImpl.getLibrarySession() |
static LifecyclePolicy |
Utils.getLifecyclePolicy(LibrarySession ls,
Long id)
Returns the LifecyclePolicy for the given ID.
|
static Link |
Utils.getLink(LibrarySession ls,
long id)
Returns the Link from a given ID or throws an exception if
the item cannot be found or it is not a Link.
|
static Link |
Utils.getLink(LibrarySession ls,
Long id)
Returns the Link from a given ID or throws an exception if
the item cannot be found or it is not a Link.
|
static long |
OptionUtils.getLong(Map map,
String name,
long defaultValue)
Get a long value from a options map.
|
ManagersFactory |
FdkSessionImpl.getManagersFactory()
Returns the managers factory corresponding to this session.
|
static Media |
Utils.getMedia(LibrarySession ls,
Long id)
Returns the Media from a given ID or throws an exception if
the item cannot be found or it is not a Media object.
|
static Media |
Utils.getMedia(LibrarySession ls,
String mediaName)
Returns the Media given its name or throws an exception if
the item cannot be found.
|
static String |
AttributeHelper.getNameAttribute(FdkSession session,
LibraryObject reposObject)
Returns the NAME attribute for an object based on the handler for
the attribute.
|
static PublicObject |
Utils.getPublicObject(LibrarySession ls,
long id)
Returns the PublicObject from a given ID or throws an exception if
the item cannot be found or it is not a PublicObject.
|
static PublicObject |
Utils.getPublicObject(LibrarySession ls,
Long id)
Returns the PublicObject from a given ID or throws an exception if
the item cannot be found or it is not a PublicObject.
|
FdkSession |
AutoTimeoutSessionManagerImpl.getSession(String username) |
Object |
FdkUserSessionImpl.getState(Object key) |
static String |
OptionUtils.getString(Map map,
String name,
String defaultValue)
Get a String value from a options map.
|
NamedValue[] |
SystemConfigurationManagerImpl.getSystemConfigurationProperties(String[] properties) |
Item |
FdkGuestSessionImpl.getUser(AttributeRequest[] attributes) |
abstract Item |
FdkSessionImpl.getUser(AttributeRequest[] attributes)
Returns the user for this session.
|
Item |
FdkSystemSessionImpl.getUser(AttributeRequest[] attributes) |
Item |
FdkUserSessionImpl.getUser(AttributeRequest[] attributes) |
Item |
InProcessManagersFactoryImpl.getUser(AttributeRequest[] attributes)
Returns the user as an Item that was authenticated for this instance.
|
static DirectoryUser |
Utils.getUser(LibrarySession ls,
Long id)
Returns a DirectoryUser from a given ID or throws an exception if
the item cannot be found or it is not a DirectoryUser.
|
Object |
AttributeHandler.getValue(AttributeHandlerContext context)
Returns the value of an attribute.
|
static VersionDescription |
Utils.getVersionDescription(LibrarySession ls,
long id)
Returns the VersionDescription from a given ID or throws an exception if
the item cannot be found or it is not a VersionDescription.
|
static VersionDescription |
Utils.getVersionDescription(LibrarySession ls,
Long id)
Returns the VersionDescription from a given ID or throws an exception if
the item cannot be found or it is not a VersionDescription.
|
static Object |
AttributeHelper.implicitConversion(FdkSessionImpl session,
Object value,
AttributeRequest[] requestedAttrs)
Converts the return value of an attribute to the proper type based on some
implicit rules:
PropertyBundle -> NamedValue[]
LibraryObject -> Item
LibraryObject[] -> Item[]
AttributeValue -> implicitConversion(session, av.getObject(), ar)
|
NamedValue[] |
RemoteLoginManagerImpl.interopTest(long[] longarray,
String[] strings,
NamedValue[] nv) |
NamedValue[] |
AuthenticatedUserLoginManagerImpl.login(NamedValue[] options,
AttributeRequest[] userAttributes)
Start a session for the currently authenticated user.
|
NamedValue[] |
UsernameTokenLoginManagerImpl.login(NamedValue[] options,
AttributeRequest[] userAttributes)
Start a session authenticated by the Web Services Username Token.
|
NamedValue[] |
RemoteLoginManagerImpl.login(String username,
String password,
NamedValue[] options,
AttributeRequest[] userAttributes)
Start a session authenticated as the given user.
|
void |
InProcessManagersFactoryImpl.logout()
The counterpart of the
login() methods. |
void |
RemoteLoginManagerImpl.logout()
Disconnects the current session, if any.
|
void |
FdkUserSessionImpl.popSessionMode(int mode) |
void |
FdkUserSessionImpl.pushSessionMode(int mode) |
void |
AutoTimeoutSessionManagerImpl.returnSession(FdkSession session) |
void |
FdkSessionImpl.rollbackTransaction(long id)
Rolls back a transaction started by calling
beginTransaction()
. |
void |
FdkUserSessionImpl.rollbackTransaction(long id) |
static void |
AttributeHelper.setAttributes(FdkSessionImpl session,
LibraryObject reposObject,
NamedValue[] attributes)
Sets the attributes on a given repository object.
|
Item |
FdkUserSessionImpl.setSessionMode(int mode,
AttributeRequest[] attributes) |
void |
FdkUserSessionImpl.setState(Object key,
Object value) |
AttributeUpdater |
AttributeHandler.setValue(AttributeHandlerContext context,
Object value)
Updates the attribute with the given value.
|
static AttributeValue |
Utils.toAttributeValue(NamedValue nv)
Convert a NamedValue to an AttributeValue.
|
static AttributeValue[] |
Utils.toAttributeValues(NamedValue[] nvs)
Convert a NamedValue array to an AttributeValue array.
|
static Event |
EventHelper.toEvent(AuditEvent auditEvent)
Converts an AuditEvent to an Event.
|
static Event[] |
EventHelper.toEvents(AuditEvent[] auditEvents)
Converts a set of AuditEvents to a set of Events.
|
static NamedValue |
Utils.toNamedValue(AttributeValue av)
Converts an AttributeValue to a NamedValue.
|
static NamedValue[] |
Utils.toNamedValues(AttributeValue[] avs)
Converts an AttributeValue array to a NamedValue array.
|
boolean |
FdkUserSessionImpl.verifyCredential(Credential credential) |
| Constructor and Description |
|---|
AutoTimeoutSessionManagerImpl(Server server,
long timeout,
Map options)
Constructor.
|
FdkSystemSessionImpl()
Creates a new FdkSystemSessionImpl using a LibrarySession retrieved
from the SystemSessionPool.
|
InProcessManagersFactoryImpl(FdkCredential credential,
Map config)
Constructs an InProcessManagersFactoryImpl.
|
InProcessManagersFactoryImpl(FdkSessionImpl session)
Package protected constructor used by FdkSessionImpl in some special
cases.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
ChainedAttributeHandler.canHandle(AttributeHandlerContext context) |
boolean |
ChainedMethodAttributeHandler.canHandle(AttributeHandlerContext context)
Returns true if the repos object returned by the underlying attribute
handler is an instance of the
given objectClass constructor parameter.
|
boolean |
DocumentDefinitionSizeAttributeHandler.canHandle(AttributeHandlerContext context) |
boolean |
MappedValueAttributeHandler.canHandle(AttributeHandlerContext context) |
boolean |
MixedAttributeHandler.canHandle(AttributeHandlerContext context) |
boolean |
PermissionBitMappingAttributeHandler.canHandle(AttributeHandlerContext context) |
boolean |
ChainedAttributeHandler.canUpdate(AttributeHandlerContext context) |
Object |
ChainedAttributeHandler.getValue(AttributeHandlerContext context) |
Object |
ChainedMethodAttributeHandler.getValue(AttributeHandlerContext context)
Returns the value returned by the method registered
for use by this instance.
|
Object |
LocalizerAttributeHandler.getValue(AttributeHandlerContext context)
Returns the value returned by the Localizer's accessor method registered
for use by this instance.
|
Object |
MappedValueAttributeHandler.getValue(AttributeHandlerContext context) |
Object |
MethodAttributeHandler.getValue(AttributeHandlerContext context)
Returns the value returned by the method registered
for use by this instance.
|
Object |
MixedAttributeHandler.getValue(AttributeHandlerContext context) |
Object |
PermissionBitMappingAttributeHandler.getValue(AttributeHandlerContext context) |
AttributeUpdater |
ChainedAttributeHandler.setValue(AttributeHandlerContext context,
Object value) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
FtpAuthCommand.execute(FtpServerChannel channel,
String cmdKey,
Argument[] flags,
Argument[] args) |
protected void |
FtpCccCommand.execute(FtpServerChannel channel,
String cmdKey,
Argument[] flags,
Argument[] args) |
protected void |
FtpCdCommand.execute(FtpServerChannel channel,
String cmdKey,
Argument[] flags,
Argument[] args)
Execute a command.
|
protected void |
FtpCdupCommand.execute(FtpServerChannel channel,
String cmdKey,
Argument[] flags,
Argument[] args)
Execute a command.
|
protected void |
FtpGetCommand.execute(FtpServerChannel channel,
String cmdKey,
Argument[] flags,
Argument[] args)
Execute a command.
|
protected void |
FtpLnCommand.execute(FtpServerChannel channel,
String cmdKey,
Argument[] flags,
Argument[] args)
Execute a command.
|
protected void |
FtpLoginCommand.execute(FtpServerChannel channel,
String cmdKey,
Argument[] flags,
Argument[] args)
Execute a FtpLoginCommand.
|
protected void |
FtpLogoutCommand.execute(FtpServerChannel channel,
String cmdKey,
Argument[] flags,
Argument[] args)
Execute a command.
|
protected void |
FtpLsCommand.execute(FtpServerChannel channel,
String cmdKey,
Argument[] flags,
Argument[] args)
Execute a command.
|
protected void |
FtpMkdirCommand.execute(FtpServerChannel channel,
String cmdKey,
Argument[] flags,
Argument[] args)
Execute a command.
|
protected void |
FtpModeCommand.execute(FtpServerChannel channel,
String cmdKey,
Argument[] flags,
Argument[] positionals)
Execute a command.
|
protected void |
FtpNoOpCommand.execute(FtpServerChannel channel,
String cmdKey,
Argument[] flags,
Argument[] args)
Execute a command.
|
protected void |
FtpPasvCommand.execute(FtpServerChannel channel,
String cmdKey,
Argument[] flags,
Argument[] args)
Execute a command.
|
protected void |
FtpPbszCommand.execute(FtpServerChannel channel,
String cmdKey,
Argument[] flags,
Argument[] args) |
protected void |
FtpPortCommand.execute(FtpServerChannel channel,
String cmdKey,
Argument[] flags,
Argument[] args)
Execute a command.
|
protected void |
FtpProtCommand.execute(FtpServerChannel channel,
String cmdKey,
Argument[] flags,
Argument[] args) |
protected void |
FtpPutCommand.execute(FtpServerChannel channel,
String cmdKey,
Argument[] flags,
Argument[] args)
Execute a command.
|
protected void |
FtpPwdCommand.execute(FtpServerChannel channel,
String cmdKey,
Argument[] flags,
Argument[] args)
Execute a command.
|
protected void |
FtpRenameFromCommand.execute(FtpServerChannel channel,
String cmdKey,
Argument[] flags,
Argument[] args)
Execute a command.
|
protected void |
FtpRenameToCommand.execute(FtpServerChannel channel,
String cmdKey,
Argument[] flags,
Argument[] args)
Execute a command.
|
protected void |
FtpRmCommand.execute(FtpServerChannel channel,
String cmdKey,
Argument[] flags,
Argument[] args)
Execute a command.
|
protected void |
FtpStatsCommand.execute(FtpServerChannel channel,
String cmdKey,
Argument[] flags,
Argument[] args)
Execute a command.
|
protected void |
FtpSystCommand.execute(FtpServerChannel channel,
String cmdKey,
Argument[] flags,
Argument[] args)
Execute a command.
|
protected void |
FtpTypeCommand.execute(FtpServerChannel channel,
String cmdKey,
Argument[] flags,
Argument[] args)
Execute a command.
|
protected void |
FtpUserCommand.execute(FtpServerChannel channel,
String cmdKey,
Argument[] flags,
Argument[] args)
Executes a FtpUserCommand.
|
String |
FtpCommand.getHomeFolderPath(FdkSession fdksession)
Get the home folder path.
|
| Modifier and Type | Method and Description |
|---|---|
void |
FtpSession.determineDocumentCharacterSetAndLanguage()
Determines the command character set used for this FtpSession.
|
String |
FtpSession.getCharacterSet()
Gets the default document character set for this session.
|
FdkSession |
FtpServer.getGuestSession()
Get a guest session.
|
String |
FtpSession.getLanguage()
Gets the default document language for this session.
|
void |
FtpServer.releaseGuestSession(FdkSession fdksession)
Release a guest session
|
Copyright © 2023. All rights reserved.