oracle.ifs.protocols.commands

Class IfsParseStreamCommand

java.lang.Object

oracle.ifs.protocols.commands.utils.IfsCommand

oracle.ifs.protocols.commands.IfsParseStreamCommand

All Implemented Interfaces:

Command

public class IfsParseStreamCommand
extends IfsCommand

A IfsParseStreamCommand is the command to parse a stream with the specified parser and all its options.

Command specification for IfsParseStreamCommand

Inputs:

• session : LibrarySession (required)
• parser : Parser (required)
• stream : InputStream (required)
• name : String (required)
• folderPath : String (required)
• callback : ParserCallback (optional)
• acl : AccessControlList (optional)
• language : String (optional)
• charSet : String (optional)

Outputs :

• libraryobject : LibraryObject

Description:

• Parse the stream with the specified parser with CURRENT_PATH, NAME, LANGUAGE and CHARSET options, and create the appropriate object as specified in the stream content.
• If acl is specified, the newly created object will have the acl assigned to it (IfsDetermineAclCommand is called).

Version:

0.9

Author:

Patricia Li

(Unpublished)

Constructor Summary

Constructors

Constructor and Description
IfsParseStreamCommand() Defualt Constructor

Method Summary

Modifier and Type	Method and Description
CommandContext	createCommandContext() Returns a CommandContext to be used throughout the invocation.
protected void	execute(CommandContext context) Execute a CommandContext.
protected void	execute(ParseStreamContext context) Execute a ParseStreamContext.
protected IfsDetermineAclCommand	getDetermineAclCommand() Return an instance of the IfsDetermineAclCommand.
void	populateNestedCommands(CommandInvoker invoker) Populate the required nested commands.
protected AccessControlList	runDetermineAclCommand(LibrarySession session, AccessControlList acl, Folder folder, String name, LibraryObjectDefinition lodef) Execute an IfsDetermineAclCommand.

Methods inherited from class oracle.ifs.protocols.commands.utils.IfsCommand

postExecute, preExecute, run

Methods inherited from class java.lang.Object

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

Constructor Detail

IfsParseStreamCommand

public IfsParseStreamCommand()

Defualt Constructor

(Published)

Method Detail

populateNestedCommands

public void populateNestedCommands(CommandInvoker invoker)
                            throws IfsException

Populate the required nested commands. In this command, we need IfsDetermineAclCommand.

Specified by:

populateNestedCommands in interface Command

Overrides:

populateNestedCommands in class IfsCommand

Parameters:

invoker - Command invoker object.

Throws:

IfsException - If there is any exception thrown.

See Also:

CommandInvoker

(Published)

execute

protected void execute(CommandContext context)
                throws IfsException

Execute a CommandContext.

Overrides:

execute in class IfsCommand

Parameters:

context - The command context.

Throws:

IfsException - if execution fails

(Published)

execute

protected void execute(ParseStreamContext context)
                throws IfsException

Execute a ParseStreamContext.

Parameters:

context - The command context.

Throws:

IfsException

(Published)

createCommandContext

public CommandContext createCommandContext()
                                    throws IfsException

Returns a CommandContext to be used throughout the invocation.

Specified by:

createCommandContext in interface Command

Overrides:

createCommandContext in class IfsCommand

Returns:

CommandContext

Throws:

IfsException

See Also:

CommandContext

(Published)

runDetermineAclCommand

protected AccessControlList runDetermineAclCommand(LibrarySession session,
                                                   AccessControlList acl,
                                                   Folder folder,
                                                   String name,
                                                   LibraryObjectDefinition lodef)
                                            throws IfsException

Execute an IfsDetermineAclCommand. It takes in all inputs that are required to run IfsDetermineAclCommand.

Returns:

AccessControlList.

Throws:

IfsException

See Also:

IfsDetermineAclCommand

(Unpublished)

getDetermineAclCommand

protected IfsDetermineAclCommand getDetermineAclCommand()
                                                 throws IfsException

Return an instance of the IfsDetermineAclCommand.

Returns:

IfsDetermineAclCommand.

Throws:

IfsException

(Unpublished)