oracle.ifs.protocols.commands

Class IfsCloseChannelCommand

java.lang.Object

oracle.ifs.protocols.commands.utils.IfsCommand

oracle.ifs.protocols.commands.IfsCloseChannelCommand

All Implemented Interfaces:

Command

public class IfsCloseChannelCommand
extends IfsCommand

A IfsCloseChannelCommand supports a basic protocol channel closing operation. This operation detaches an existing ProtocolSession from a Channel and then disconnects the Channel removing it from the ProtocolServer.

Command specification for IfsCloseChannelCommand

Inputs:

• channel : IfsServerChannel (required)

Outputs :

• NONE

Description:

• Takes an IfsServerChannel. Calls IfsServerChannel.disconnect and then removes references to the channel in the IfsProtocolSession.

Version:

0.9

Author:

Kevin Gillett

(Unpublished)

Constructor Summary

Constructors

Constructor and Description
IfsCloseChannelCommand() Defualt Constructor

Method Summary

Modifier and Type	Method and Description
CommandContext	createCommandContext() Returns a CommandContext to be used throughout the invokation.
protected void	execute(CloseChannelContext state) Execute a CommandState.
protected void	execute(CommandContext state) Execute a CommandState.

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

populateNestedCommands, postExecute, preExecute, run

Methods inherited from class java.lang.Object

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

Constructor Detail

IfsCloseChannelCommand

public IfsCloseChannelCommand()

Defualt Constructor

(Published)

Method Detail

execute

protected void execute(CommandContext state)
                throws IfsException

Execute a CommandState. Interperts the invoker object as a Channel.

Overrides:

execute in class IfsCommand

Parameters:

state - the command context.

Throws:

IfsException - if execution fails

(Published)

execute

protected void execute(CloseChannelContext state)
                throws IfsException

Execute a CommandState. Interperts the invoker object as a Channel.

Throws:

IfsException

(Published)

createCommandContext

public CommandContext createCommandContext()
                                    throws IfsException

Returns a CommandContext to be used throughout the invokation.

Specified by:

createCommandContext in interface Command

Overrides:

createCommandContext in class IfsCommand

Returns:

a instance of the CommandContext.

Throws:

IfsException

See Also:

CommandContext

(Published)