oracle.ifs.protocols.commands

Class IfsUploadFileContext

java.lang.Object

oracle.ifs.protocols.commands.utils.IfsCommandContext

oracle.ifs.protocols.commands.IfsUploadFileContext

All Implemented Interfaces:

UploadFileContext, CommandContext

public class IfsUploadFileContext
extends IfsCommandContext
implements UploadFileContext

IfsUploadFileContext is the default implmentation of UploadFileContext.

Version:

0.9

Author:

Patricia Li

(Unpublished)

Constructor Summary

Constructors

Constructor and Description
IfsUploadFileContext() Deafult Constructor.
IfsUploadFileContext(LibrarySession session, boolean parseFlag, String name, InputStream stream, String folderPath, AccessControlList acl, boolean aclFromParent, ParserCallback callback, String language, String charSet) Constructor which sets up all the required parameters.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the Context.
AccessControlList	getAcl() Gets the ACL.
boolean	getAclFromParent() Gets the ACL from parent folder.
String	getCharacterSet() Gets the character set.
InputStream	getContentStream() Gets the content stream.
String	getFolderPath() Gets the parent folder path.
String	getLanguage() Gets the language.
LibraryObject	getLibraryObject() Gets the returning LibraryObject.
LibrarySession	getLibrarySession() Gets the session.
String	getName() Gets the document name.
boolean	getParseFlag() Gets the if we are parsing or not.
ParserCallback	getParserCallback() Gets the parser callback.
void	setAcl(AccessControlList acl) Sets the ACL.
void	setAclFromParent(boolean aclFromParent) Sets the ACL from parent folder.
void	setCharacterSet(String charSet) Sets the character set.
void	setContentStream(InputStream stream) Sets the content stream.
void	setFolderPath(String folderPath) Sets the parent folder path.
void	setLanguage(String language) Sets the language.
void	setLibraryObject(LibraryObject lo) Sets the returning LibraryObject.
void	setLibrarySession(LibrarySession session) Sets the session.
void	setName(String name) Sets the document name.
void	setParseFlag(boolean parse) Sets if we are parsing or not.
void	setParserCallback(ParserCallback callback) Sets the parser callback.

Methods inherited from class java.lang.Object

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

Constructor Detail

IfsUploadFileContext

public IfsUploadFileContext()
                     throws IfsException

Deafult Constructor.

Throws:

IfsException

(Published)

IfsUploadFileContext

public IfsUploadFileContext(LibrarySession session,
                            boolean parseFlag,
                            String name,
                            InputStream stream,
                            String folderPath,
                            AccessControlList acl,
                            boolean aclFromParent,
                            ParserCallback callback,
                            String language,
                            String charSet)
                     throws IfsException

Constructor which sets up all the required parameters.

Parameters:

session - LibrarySession.

parseFlag - Parse flag indicating whether we parse or not.

name - Document name.

stream - Content stream.

folderPath - Parent folder path.

acl - ACL to be applied to the new document.

callback - Parser callback.

language - Language.

charSet - Character set.

Throws:

IfsException - - If operation fails.

(Published)

Method Detail

clear

public void clear()

Clears the Context.

Specified by:

clear in interface CommandContext

Overrides:

clear in class IfsCommandContext

(Published)

getLibrarySession

public LibrarySession getLibrarySession()
                                 throws IfsException

Gets the session.

Specified by:

getLibrarySession in interface UploadFileContext

Throws:

IfsException

(Published)

setLibrarySession

public void setLibrarySession(LibrarySession session)
                       throws IfsException

Sets the session.

Specified by:

setLibrarySession in interface UploadFileContext

Throws:

IfsException

(Published)

getParseFlag

public boolean getParseFlag()
                     throws IfsException

Gets the if we are parsing or not.

Specified by:

getParseFlag in interface UploadFileContext

Throws:

IfsException

(Published)

setParseFlag

public void setParseFlag(boolean parse)
                  throws IfsException

Sets if we are parsing or not.

Specified by:

setParseFlag in interface UploadFileContext

Throws:

IfsException

(Published)

getName

public String getName()
               throws IfsException

Gets the document name.

Specified by:

getName in interface UploadFileContext

Throws:

IfsException

(Published)

setName

public void setName(String name)
             throws IfsException

Sets the document name.

Specified by:

setName in interface UploadFileContext

Throws:

IfsException

(Published)

getContentStream

public InputStream getContentStream()
                             throws IfsException

Gets the content stream.

Specified by:

getContentStream in interface UploadFileContext

Throws:

IfsException

(Published)

setContentStream

public void setContentStream(InputStream stream)
                      throws IfsException

Sets the content stream.

Specified by:

setContentStream in interface UploadFileContext

Throws:

IfsException

(Published)

getFolderPath

public String getFolderPath()
                     throws IfsException

Gets the parent folder path.

Specified by:

getFolderPath in interface UploadFileContext

Throws:

IfsException

(Published)

setFolderPath

public void setFolderPath(String folderPath)
                   throws IfsException

Sets the parent folder path.

Specified by:

setFolderPath in interface UploadFileContext

Throws:

IfsException

(Published)

getAcl

public AccessControlList getAcl()
                         throws IfsException

Gets the ACL.

Specified by:

getAcl in interface UploadFileContext

Throws:

IfsException

(Published)

setAcl

public void setAcl(AccessControlList acl)
            throws IfsException

Sets the ACL.

Specified by:

setAcl in interface UploadFileContext

Throws:

IfsException

(Published)

getAclFromParent

public boolean getAclFromParent()
                         throws IfsException

Gets the ACL from parent folder.

Specified by:

getAclFromParent in interface UploadFileContext

Throws:

IfsException

(Published)

setAclFromParent

public void setAclFromParent(boolean aclFromParent)
                      throws IfsException

Sets the ACL from parent folder.

Specified by:

setAclFromParent in interface UploadFileContext

Throws:

IfsException

(Published)

getParserCallback

public ParserCallback getParserCallback()
                                 throws IfsException

Gets the parser callback.

Specified by:

getParserCallback in interface UploadFileContext

Throws:

IfsException

(Published)

setParserCallback

public void setParserCallback(ParserCallback callback)
                       throws IfsException

Sets the parser callback.

Specified by:

setParserCallback in interface UploadFileContext

Throws:

IfsException

(Published)

getLanguage

public String getLanguage()
                   throws IfsException

Gets the language.

Specified by:

getLanguage in interface UploadFileContext

Throws:

IfsException

(Published)

setLanguage

public void setLanguage(String language)
                 throws IfsException

Sets the language.

Specified by:

setLanguage in interface UploadFileContext

Throws:

IfsException

(Published)

getCharacterSet

public String getCharacterSet()
                       throws IfsException

Gets the character set.

Specified by:

getCharacterSet in interface UploadFileContext

Throws:

IfsException

(Published)

setCharacterSet

public void setCharacterSet(String charSet)
                     throws IfsException

Sets the character set.

Specified by:

setCharacterSet in interface UploadFileContext

Throws:

IfsException

(Published)

getLibraryObject

public LibraryObject getLibraryObject()
                               throws IfsException

Gets the returning LibraryObject.

Specified by:

getLibraryObject in interface UploadFileContext

Throws:

IfsException

(Published)

setLibraryObject

public void setLibraryObject(LibraryObject lo)
                      throws IfsException

Sets the returning LibraryObject.

Specified by:

setLibraryObject in interface UploadFileContext

Throws:

IfsException

(Published)