|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
An interface that allows the DocFetch servlet to verify access to the requested document prior to retrieval.
Method Summary | |
IDocFetch |
attachToDocument(java.lang.String sDocumentLocation,
java.lang.String Locale,
java.lang.String Signature,
DocumentFormat fFormat,
UserPrefs userPrefs,
UserInfo userInfo)
Performs access-control checking on the document to be retrieved using either the user's current preferences or the information set in the portal Data Source editor. |
void |
initialize(DataSourceInfo dsInfo)
Performs set up using the information configured in the portal Data Source editor. |
void |
shutdown()
Cleans up any resources created during the retrieval of the requested document. |
Method Detail |
public void initialize(DataSourceInfo dsInfo) throws ServiceException
dsInfo
- the configuration information set in the Data Source editor
ServiceException
- if an error occurred
Note: Values retrieved from the portal using IDocFetchProvider.initialize(DataSourceInfo dsInfo)
will be decoded in the process.
To prevent + from being decoded into a space and % from having indeterminate behavior, make sure that all values entered in the datasource using SCI pages
are encoded using com.plumtree.remote.util.CSPCodec
. Likewise, all values that have been encoded in the SCI datasource pages
should be decoded when displayed with SCI using com.plumtree.remote.util.CSPCodec
.CSPCodec
public IDocFetch attachToDocument(java.lang.String sDocumentLocation, java.lang.String Locale, java.lang.String Signature, DocumentFormat fFormat, UserPrefs userPrefs, UserInfo userInfo) throws ServiceException
IDocFetch
object used to retrieve the document.
sDocumentLocation
- the backend-specific location of this documentLocale
- the string code for the locale to be usedSignature
- the signature of the documentfFormat
- the DocumentFormat
flag to indicate whether the document is being accessed for indexing or retrieval (click-through)userPrefs
- the requesting user's User Preference settingsuserInfo
- the requesting user's User Information settings
IDocFetch
NoLongerExistsException
- if the document has been removed
NotAvailableException
- if the document is temporarily unavailable
NotInitializedException
- if the IDocFetchProvider
is in an uninitialized state
AccessDeniedException
- if access to this document is denied
ServiceException
- if an error occurredpublic void shutdown() throws ServiceException
ServiceException
- if an error occurred
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright ©2010 Oracle® Corporation. All Rights Reserved.