Skip navigation links


com.essbase.eas.essbase.server
Class DownloadFileCommandListener

java.lang.Object
  extended by com.essbase.eas.framework.server.application.DefaultApplicationPart
      extended by com.essbase.eas.framework.server.application.AbstractCommandListener
          extended by com.essbase.eas.server.AppManCommandListener
              extended by com.essbase.eas.essbase.server.EssbaseCommandListener
                  extended by com.essbase.eas.essbase.server.DownloadFileCommandListener

All Implemented Interfaces:
ApplicationPart, CommandListener

public class DownloadFileCommandListener
extends EssbaseCommandListener

extension of the EssbaseCommandListener to handle downloading a file (transfering the file from mid tier to console)

Version:
7.0.0
Author:
Madhavi Bolisetty

Nested Class Summary
static class DownloadFileCommandListener.DownloadByteArrayOutputStream
           
static class DownloadFileCommandListener.DownloadFileInputStream
           

 

Field Summary

 

Fields inherited from class com.essbase.eas.essbase.server.EssbaseCommandListener
DEADEND, DEADEND_KEY, FAILED, FAILED_KEY, NOT_CONNECTED, NOT_CONNECTED_KEY, NOT_CONNECTING, NOT_CONNECTING_KEY, RELOGIN, RELOGIN_KEY, requestMap, TOKEN_TIMEOUT1_KEY, TOKEN_TIMEOUT2_KEY

 

Fields inherited from class com.essbase.eas.framework.server.application.AbstractCommandListener
aliasMap, methodMap, RESULT, THERESULT, UPLOAD

 

Fields inherited from class com.essbase.eas.framework.server.application.DefaultApplicationPart
CHAIN_SEPARATOR, manager, parts, serviceContext, serviceManager, state, STATE_BEFORE_WORKERS_ASSIGNED, STATE_CONSTRUCTED, STATE_DESTROYED, STATE_INITIALIZED, STATE_MANAGED, STATE_NULL, STATE_WORKERS_ASSIGNED, STATE_WORKERS_INITIALIZED, storeService

 

Constructor Summary
DownloadFileCommandListener()
          default constructor.

 

Method Summary
 boolean downloadBegin(CommandEvent theEvent, ServiceContext theContext, java.lang.String serverFileName, java.lang.String clientFileName)
          command handler method used to initiate downloading a file from mid tier.
 boolean downloadCancel(CommandEvent theEvent, ServiceContext theContext, java.lang.String serverFileName)
          command handler method to perform steps necessary when an download command is canceled.
 boolean downloadContinue(CommandEvent theEvent, ServiceContext theContext, java.lang.String serverFileName)
          command handler method for continuing the transfer of an outline file from the client to the mid-tier.
 boolean downloadEnd(CommandEvent theEvent, ServiceContext theContext, java.lang.String filename)
           
 CommandDescriptor[] getCommands()
          implementation of the CommandListener.getCommands() method.
 boolean getDirectoryFiles(CommandEvent theEvent, ServiceContext theContext, java.lang.String dir)
           
static java.io.File getDownloadFile(CommandEvent theEvent, StoreService storeService, java.lang.String filename, boolean remove)
           
 boolean handleEventPrep(CommandEvent commandEvent)
          implementation of the CommandListener.handleEventPrep() method.

 

Methods inherited from class com.essbase.eas.essbase.server.EssbaseCommandListener
getEssbaseSession, handleEventException, handleEventPost, set, setResult, validateSession

 

Methods inherited from class com.essbase.eas.server.AppManCommandListener
getSession, getSession, getSession, releaseSession

 

Methods inherited from class com.essbase.eas.framework.server.application.AbstractCommandListener
addMethodAlias, addMethodAlias, assignWorkers, buildMethodMap, convertStringValueToArgument, getArgumentsForCommand, getMethod, getMethodForAlias, getRoles, getSessionObject, handleEvent, init, isRequestFromSameServer, removeSessionObject, setServiceResult, setSessionObject

 

Methods inherited from class com.essbase.eas.framework.server.application.DefaultApplicationPart
destroy, getManager, getManagerChain, getServiceContext, getServiceManager, getStoreService, initWorkers, requestPart, requestPartPool, setManager

 

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

 

Methods inherited from interface com.essbase.eas.framework.server.defs.ApplicationPart
destroy, getManager, getServiceContext, getServiceManager, getStoreService, initWorkers, setManager

 

Constructor Detail

DownloadFileCommandListener

public DownloadFileCommandListener()
default constructor.

Method Detail

handleEventPrep

public boolean handleEventPrep(CommandEvent commandEvent)
                        throws ApplicationException
Description copied from class: AbstractCommandListener
implementation of the CommandListener.handleEventPrep() method. Inheriting classes should override this method if they need to perform any special processing before the method invocation occurs.
Specified by:
handleEventPrep in interface CommandListener
Overrides:
handleEventPrep in class EssbaseCommandListener
Parameters:
commandEvent - the command event that we are processing.
Returns:
true if Ok to continue, false otherwise
Throws:
ApplicationException

getDirectoryFiles

public boolean getDirectoryFiles(CommandEvent theEvent,
                                 ServiceContext theContext,
                                 java.lang.String dir)

downloadBegin

public boolean downloadBegin(CommandEvent theEvent,
                             ServiceContext theContext,
                             java.lang.String serverFileName,
                             java.lang.String clientFileName)
command handler method used to initiate downloading a file from mid tier.

downloadCancel

public boolean downloadCancel(CommandEvent theEvent,
                              ServiceContext theContext,
                              java.lang.String serverFileName)
command handler method to perform steps necessary when an download command is canceled.

downloadContinue

public boolean downloadContinue(CommandEvent theEvent,
                                ServiceContext theContext,
                                java.lang.String serverFileName)
command handler method for continuing the transfer of an outline file from the client to the mid-tier.

downloadEnd

public boolean downloadEnd(CommandEvent theEvent,
                           ServiceContext theContext,
                           java.lang.String filename)

getCommands

public CommandDescriptor[] getCommands()
implementation of the CommandListener.getCommands() method.
Specified by:
getCommands in interface CommandListener
Overrides:
getCommands in class AbstractCommandListener
Returns:
a zero-length array of CommandDescriptor objects.

getDownloadFile

public static java.io.File getDownloadFile(CommandEvent theEvent,
                                           StoreService storeService,
                                           java.lang.String filename,
                                           boolean remove)

Skip navigation links


Copyright © 2001, 2012, Oracle. All rights reserved.