FdkConfiguration (ecmsdk-api 3.4.0 API)

java.lang.Object
- oracle.ifs.fdk.FdkConfiguration

Direct Known Subclasses:

FdkConfigurationImpl
```
public abstract class FdkConfiguration
extends Object
```
Holder class for configuration properties.

(Unpublished)

Constructor Summary

Constructors
Modifier Constructor and Description

protected FdkConfiguration()
Constructor.

Constructors
Modifier	Constructor and Description
`protected`	`FdkConfiguration()` Constructor.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract ManagersFactory`	`constructManagersFactory(FdkSession session)` Construct a ManagersFactory for a quest or system session.
`protected void`	`dispose()` Method that needs to be called by the subclass dispose() method.
`String`	`getBpelWorklistUrl()` Gets the Bpel Worklist App Url.
`long`	`getDavNullResourceLockExpirationPeriod()` Gets the DAV Null resource Lock timeout period in seconds.
`String[]`	`getDavUserAgents()` Returns the User-Agent headers (or parts of) for HTTP clients known to be pure DAV clients.
`String[]`	`getFileExtensionsOmittedFromVirusScan()` Returns the list of omitted extensions from virsu scanning.
`static FdkConfiguration`	`getInstance()` Returns the singleton instance of this class.
`Date`	`getLastAntiVirusDefinitionUpdate()` Returns the Date when the last Virus Scanner definition file update occured.
`String`	`getProductVersion()` Gets the product version string.
`protected void`	`initialize(LibrarySession session)` Method that needs to be called by the subclass initizlize() methods.
`protected void`	`initializeStandalone(String serviceName, SystemUserCredential sysCred)` Initialize after constructing standalone instance.
`static void`	`initializeStandaloneMode(String configClass, String serviceName, SystemUserCredential sysCred)` Initializes the instance for standalone mode.
`boolean`	`isDavCopyMoveThroughFolderLinkAllowed()` Returns whether the DavServlet allows Copy and Move on source paths that contain Folder Links.
`boolean`	`isIdmEnabled()` Returns whether IDM is enabled.
`boolean`	`isInitialized()` Returns true if the instance is in an initialized state.
`boolean`	`isVirusScannerEnabled()` Returns whether the Virus Scanner feature is enabled.
`boolean`	`isWorkflowEnabled()` Returns whether the Workflow feature is enabled.
`abstract FdkSession`	`login(FdkCredential cred)` Login and create an FdkSession context.
`abstract String`	`lookupItemType(LibraryObject reposObject)` Lookup the FDK type for the specified LibraryObject.

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

- Constructor Detail
  - FdkConfiguration
```
protected FdkConfiguration()
```
    Constructor.
- Method Detail
  - initializeStandaloneMode
```
public static final void initializeStandaloneMode(String configClass,
                                                  String serviceName,
                                                  SystemUserCredential sysCred)
```
    Initializes the instance for standalone mode.
    
    Parameters:
    
    serviceName - The service name.
    
    sysCred - The System user credential
  - getInstance
```
public static final FdkConfiguration getInstance()
```
    Returns the singleton instance of this class. If the instance doesn't exist, it will return it in an uninitialized state. It needs to be initialized by calling one of the initialize() methods.
  - initializeStandalone
```
protected void initializeStandalone(String serviceName,
                                    SystemUserCredential sysCred)
```
    Initialize after constructing standalone instance.
    
    Parameters:
    
    serviceName - the service name
    
    sysCred - the system user credential
    
    Throws:
    
    IfsException - if operation fails
    
    (Published)
  - isInitialized
```
public final boolean isInitialized()
```
    Returns true if the instance is in an initialized state.
  - login
```
public abstract FdkSession login(FdkCredential cred)
                          throws FdkException
```
    Login and create an FdkSession context.
    
    Parameters:
    
    cred - the FdkCredential
    
    Returns:
    
    the new FdkSession context
    
    Throws:
    
    FdkException - if operation fails
  - constructManagersFactory
```
public abstract ManagersFactory constructManagersFactory(FdkSession session)
                                                  throws FdkException
```
    Construct a ManagersFactory for a quest or system session.
    
    Parameters:
    
    session - the session
    
    Returns:
    
    the ManagersFactory that uses this session
    
    Throws:
    
    FdkException - if operation fails
  - lookupItemType
```
public abstract String lookupItemType(LibraryObject reposObject)
                               throws IfsException
```
    Lookup the FDK type for the specified LibraryObject.
    
    Parameters:
    
    reposObject - the LibraryObject
    
    Returns:
    
    the ItemTypeRegistry
    
    Throws:
    
    IfsException
  - getDavNullResourceLockExpirationPeriod
```
public final long getDavNullResourceLockExpirationPeriod()
```
    Gets the DAV Null resource Lock timeout period in seconds.
  - getDavUserAgents
```
public final String[] getDavUserAgents()
```
    Returns the User-Agent headers (or parts of) for HTTP clients known to be pure DAV clients.
  - getBpelWorklistUrl
```
public final String getBpelWorklistUrl()
```
    Gets the Bpel Worklist App Url.
  - isIdmEnabled
```
public final boolean isIdmEnabled()
```
    Returns whether IDM is enabled.
  - isVirusScannerEnabled
```
public final boolean isVirusScannerEnabled()
```
    Returns whether the Virus Scanner feature is enabled.
  - getLastAntiVirusDefinitionUpdate
```
public final Date getLastAntiVirusDefinitionUpdate()
```
    Returns the Date when the last Virus Scanner definition file update occured.
    
    (Unpublished)
  - getFileExtensionsOmittedFromVirusScan
```
public final String[] getFileExtensionsOmittedFromVirusScan()
```
    Returns the list of omitted extensions from virsu scanning.
  - isWorkflowEnabled
```
public final boolean isWorkflowEnabled()
```
    Returns whether the Workflow feature is enabled.
  - getProductVersion
```
public final String getProductVersion()
```
    Gets the product version string.
  - isDavCopyMoveThroughFolderLinkAllowed
```
public final boolean isDavCopyMoveThroughFolderLinkAllowed()
```
    Returns whether the DavServlet allows Copy and Move on source paths that contain Folder Links.
  - initialize
```
protected void initialize(LibrarySession session)
                   throws IfsException
```
    Method that needs to be called by the subclass initizlize() methods.
    
    Throws:
    
    IfsException
  - dispose
```
protected void dispose()
```
    Method that needs to be called by the subclass dispose() method.

Class FdkConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FdkConfiguration

Method Detail

initializeStandaloneMode

getInstance

initializeStandalone

isInitialized

login

constructManagersFactory

lookupItemType

getDavNullResourceLockExpirationPeriod

getDavUserAgents

getBpelWorklistUrl

isIdmEnabled

isVirusScannerEnabled

getLastAntiVirusDefinitionUpdate

getFileExtensionsOmittedFromVirusScan

isWorkflowEnabled

getProductVersion

isDavCopyMoveThroughFolderLinkAllowed

initialize

dispose