org.waarp.openr66.protocol.localhandler

Class ServerActions

java.lang.Object

org.waarp.openr66.protocol.localhandler.ConnectionActions

org.waarp.openr66.protocol.localhandler.ServerActions

Direct Known Subclasses:

TransferActions

public class ServerActions
extends ConnectionActions

Class to implement actions related to extra server actions: shutdown, bandwidth control, configuration import/export, log purge, request restart/stop/cancel, business request, block new request control, information request and transfer request.

Can be used in both standard mode (original packet), or in JSON mode.

Field Summary

Fields inherited from class org.waarp.openr66.protocol.localhandler.ConnectionActions

globalDigest, localChannelReference, localDigest, session

Constructor Summary

Constructors

Constructor and Description
ServerActions()

Method Summary

Modifier and Type	Method and Description
long[]	bandwidth(boolean setter, long writeglobal, long readglobal, long writesession, long readsession) Get or Set the bandwidth configuration
void	blockRequest(BlockRequestPacket packet) Block/Unblock Request
R66Result	blockRequest(byte[] key, boolean isBlocking) Block/Unblock Request
R66Future	businessRequest(boolean isToApplied, String className, String arguments, String extraArguments, int delay) Business Request (channel should stay open) Note: the thread called should manage all writeback informations, as well as status, channel closing if needed or not.
void	businessRequest(BusinessRequestPacket packet) Business Request (channel should stay open) Note: the thread called should manage all writeback informations, as well as status, channel closing if needed or not.
R66Result	cancelTransfer(Transfer transfer)
String[]	configExport(boolean bhost, boolean brule, boolean bbusiness, boolean balias, boolean broles) Export configuration and return filenames in order
ConfigImportResponseJsonPacket	configImport(ConfigImportJsonPacket json) Import configuration from files as parameter
void	information(InformationPacket packet) Receive a request of information
ValidPacket	informationFile(byte request, String rulename, String filename, boolean jsonOutput) Receive a request of information (Transfer information or File listing)
ValidPacket	informationRequest(long id, boolean isTo, String remoteHost, boolean jsonOutput) Receive a request of information (Transfer information or File listing)
boolean	isCodeValid(ErrorCode code)
void	jsonCommand(JsonCommandPacket packet, JsonPacket json) Receive a json request
String[]	logPurge(boolean purge, boolean clean, Timestamp start, Timestamp stop, String startid, String stopid, String rule, String request, boolean pending, boolean transfer, boolean done, boolean error, boolean isPurge) Purge the logs as required
R66Result	requestRestart(String reqd, String reqr, long id, Date date) Request to restart a transfer
void	shutdown(byte[] key, boolean isRestart) Receive a Shutdown request
void	shutdown(ShutdownPacket packet) Receive a Shutdown request
static String[]	staticConfigExport(String dir, boolean bhost, boolean brule, boolean bbusiness, boolean balias, boolean broles) Export configuration and return filenames in order
R66Result	stopOrCancel(byte type, String reqd, String reqr, long id) Stop or Cancel a transfer.
R66Result	stopTransfer(Transfer transfer)
void	test(TestPacket packet) Test reception
R66Result	transferRequest(TransferRequestJsonPacket request) Receive a TransferRequest in JSON mode: just setting it to be scheduled
void	valid(ValidPacket packet) Receive a validation or a special request

Methods inherited from class org.waarp.openr66.protocol.localhandler.ConnectionActions

allowReusableAuthentication, authent, channelClosed, connectionError, errorMesg, getLocalChannelReference, getSession, hasReusableAuthentication, newSession, setLocalChannelReference, startup, tryFinalizeRequest, validateAuthenticationReuse

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerActions

public ServerActions()

Method Detail

test

public final void test(TestPacket packet)
                throws OpenR66ProtocolNotAuthenticatedException,
                       OpenR66ProtocolPacketException

Test reception

Parameters:

packet -

Throws:

OpenR66ProtocolNotAuthenticatedException

OpenR66ProtocolPacketException

information

public final void information(InformationPacket packet)
                       throws OpenR66ProtocolNotAuthenticatedException,
                              OpenR66ProtocolNoDataException,
                              OpenR66ProtocolPacketException

Receive a request of information

Parameters:

packet -

Throws:

CommandAbstractException

OpenR66ProtocolNotAuthenticatedException

OpenR66ProtocolNoDataException

OpenR66ProtocolPacketException

valid

public final void valid(ValidPacket packet)
                 throws OpenR66ProtocolNotAuthenticatedException,
                        OpenR66RunnerErrorException,
                        OpenR66ProtocolSystemException,
                        OpenR66ProtocolBusinessException

Receive a validation or a special request

Parameters:

packet -

Throws:

OpenR66ProtocolNotAuthenticatedException

OpenR66RunnerErrorException

OpenR66ProtocolSystemException

OpenR66ProtocolBusinessException

jsonCommand

public final void jsonCommand(JsonCommandPacket packet,
                              JsonPacket json)
                       throws OpenR66ProtocolNotAuthenticatedException,
                              OpenR66RunnerErrorException,
                              OpenR66ProtocolSystemException,
                              OpenR66ProtocolBusinessException,
                              OpenR66ProtocolShutdownException,
                              OpenR66ProtocolPacketException,
                              OpenR66ProtocolNoDataException

Receive a json request

Parameters:

packet -

json -

Throws:

OpenR66ProtocolNotAuthenticatedException

OpenR66RunnerErrorException

OpenR66ProtocolSystemException

OpenR66ProtocolBusinessException

OpenR66ProtocolShutdownException

OpenR66ProtocolPacketException

OpenR66ProtocolNoDataException

bandwidth

public final long[] bandwidth(boolean setter,
                              long writeglobal,
                              long readglobal,
                              long writesession,
                              long readsession)
                       throws OpenR66ProtocolNotAuthenticatedException,
                              OpenR66ProtocolNoCorrectAuthenticationException

Get or Set the bandwidth configuration

Parameters:

setter -

writeglobal -

readglobal -

writesession -

readsession -

Returns:

the 4 current values for the bandwidth (in the same order)

Throws:

OpenR66ProtocolNotAuthenticatedException

OpenR66ProtocolNoCorrectAuthenticationException

configImport

public final ConfigImportResponseJsonPacket configImport(ConfigImportJsonPacket json)
                                                  throws OpenR66ProtocolNotAuthenticatedException,
                                                         OpenR66ProtocolNoCorrectAuthenticationException,
                                                         OpenR66ProtocolSystemException

Import configuration from files as parameter

Parameters:

json -

Returns:

the packet to answer

Throws:

OpenR66ProtocolNotAuthenticatedException

OpenR66ProtocolSystemException

OpenR66ProtocolNoCorrectAuthenticationException

configExport

public final String[] configExport(boolean bhost,
                                   boolean brule,
                                   boolean bbusiness,
                                   boolean balias,
                                   boolean broles)
                            throws OpenR66ProtocolNotAuthenticatedException,
                                   OpenR66ProtocolNoCorrectAuthenticationException

Export configuration and return filenames in order

Parameters:

bhost -

brule -

bbusiness -

balias -

broles -

Returns:

filenames in order

Throws:

OpenR66ProtocolNotAuthenticatedException

OpenR66ProtocolNoCorrectAuthenticationException

staticConfigExport

public static String[] staticConfigExport(String dir,
                                          boolean bhost,
                                          boolean brule,
                                          boolean bbusiness,
                                          boolean balias,
                                          boolean broles)

Export configuration and return filenames in order

Parameters:

dir -

bhost -

brule -

bbusiness -

balias -

broles -

Returns:

filenames in order

requestRestart

public final R66Result requestRestart(String reqd,
                                      String reqr,
                                      long id,
                                      Date date)
                               throws OpenR66ProtocolNotAuthenticatedException,
                                      OpenR66ProtocolNoCorrectAuthenticationException

Request to restart a transfer

Parameters:

reqd - requested

reqr - requester

id - id of the Transfer

date - time start if any

Returns:

the Result including the error code to use in return

Throws:

OpenR66ProtocolNotAuthenticatedException

OpenR66ProtocolNoCorrectAuthenticationException

isCodeValid

public final boolean isCodeValid(ErrorCode code)

Parameters:

code -

Returns:

True if the code is an OK code and not an error

logPurge

public final String[] logPurge(boolean purge,
                               boolean clean,
                               Timestamp start,
                               Timestamp stop,
                               String startid,
                               String stopid,
                               String rule,
                               String request,
                               boolean pending,
                               boolean transfer,
                               boolean done,
                               boolean error,
                               boolean isPurge)
                        throws OpenR66ProtocolNotAuthenticatedException,
                               OpenR66ProtocolBusinessException

Purge the logs as required

Parameters:

purge -

clean -

start -

stop -

startid -

stopid -

rule -

request -

pending -

transfer -

done -

error -

isPurge -

Returns:

an array of Strings as: filename, nb of exported, nb of purged

Throws:

OpenR66ProtocolNotAuthenticatedException

OpenR66ProtocolBusinessException

stopOrCancel

public final R66Result stopOrCancel(byte type,
                                    String reqd,
                                    String reqr,
                                    long id)
                             throws OpenR66ProtocolNotAuthenticatedException,
                                    OpenR66ProtocolNoCorrectAuthenticationException

Stop or Cancel a transfer. Warning use stopTransfer or cancelTransfer instead.

Parameters:

type -

reqd -

reqr -

id -

Returns:

the Result to answer

Throws:

OpenR66ProtocolNotAuthenticatedException

OpenR66ProtocolNoCorrectAuthenticationException

stopTransfer

public final R66Result stopTransfer(Transfer transfer)

Parameters:

transfer - the transfer to stop

Returns:

cancelTransfer

public final R66Result cancelTransfer(Transfer transfer)

Parameters:

transfer - the transfer to stop

Returns:

shutdown

public final void shutdown(ShutdownPacket packet)
                    throws OpenR66ProtocolShutdownException,
                           OpenR66ProtocolNotAuthenticatedException,
                           OpenR66ProtocolBusinessException

Receive a Shutdown request

Parameters:

packet -

Throws:

OpenR66ProtocolShutdownException

OpenR66ProtocolNotAuthenticatedException

OpenR66ProtocolBusinessException

shutdown

public final void shutdown(byte[] key,
                           boolean isRestart)
                    throws OpenR66ProtocolShutdownException,
                           OpenR66ProtocolNotAuthenticatedException,
                           OpenR66ProtocolBusinessException

Receive a Shutdown request

Parameters:

key -

isRestart -

Throws:

OpenR66ProtocolShutdownException

OpenR66ProtocolNotAuthenticatedException

OpenR66ProtocolBusinessException

businessRequest

public final void businessRequest(BusinessRequestPacket packet)
                           throws OpenR66ProtocolNotAuthenticatedException,
                                  OpenR66ProtocolPacketException,
                                  OpenR66ProtocolNoCorrectAuthenticationException

Business Request (channel should stay open)

Note: the thread called should manage all writeback informations, as well as status, channel closing if needed or not.

Parameters:

packet -

Throws:

OpenR66ProtocolNotAuthenticatedException

OpenR66ProtocolPacketException

OpenR66ProtocolNoCorrectAuthenticationException

businessRequest

public final R66Future businessRequest(boolean isToApplied,
                                       String className,
                                       String arguments,
                                       String extraArguments,
                                       int delay)
                                throws OpenR66ProtocolNotAuthenticatedException,
                                       OpenR66ProtocolNoCorrectAuthenticationException

Business Request (channel should stay open)

Note: the thread called should manage all writeback informations, as well as status, channel closing if needed or not.

Parameters:

isToApplied - True means this is an action request, False it is the feedback

className -

arguments -

extraArguments -

delay -

Returns:

future of the execution

Throws:

OpenR66ProtocolNotAuthenticatedException

OpenR66ProtocolNoCorrectAuthenticationException

blockRequest

public final void blockRequest(BlockRequestPacket packet)
                        throws OpenR66ProtocolBusinessException

Block/Unblock Request

Parameters:

packet -

Throws:

OpenR66ProtocolBusinessException

blockRequest

public final R66Result blockRequest(byte[] key,
                                    boolean isBlocking)
                             throws OpenR66ProtocolBusinessException

Block/Unblock Request

Parameters:

key -

isBlocking -

Returns:

The result

Throws:

OpenR66ProtocolPacketException

OpenR66ProtocolBusinessException

informationFile

public final ValidPacket informationFile(byte request,
                                         String rulename,
                                         String filename,
                                         boolean jsonOutput)
                                  throws OpenR66ProtocolNotAuthenticatedException,
                                         OpenR66ProtocolNoDataException

Receive a request of information (Transfer information or File listing)

Parameters:

request - InformationPacket.ASKENUM ordinal

rulename - rulename for file path

filename - partial name (including wildcard)

jsonOutput - ValidPacket will contain Json format ?

Returns:

the ValidPacket to answer containing: File Listing as Header and Number of entries as Middle

Throws:

OpenR66ProtocolNotAuthenticatedException

OpenR66ProtocolNoDataException

informationRequest

public final ValidPacket informationRequest(long id,
                                            boolean isTo,
                                            String remoteHost,
                                            boolean jsonOutput)
                                     throws OpenR66ProtocolNotAuthenticatedException,
                                            OpenR66ProtocolNoDataException

Receive a request of information (Transfer information or File listing)

Parameters:

id - Id of request

isTo - True for remote host is requester, False for requested (default)

remoteHost - requester/requested for transfer if jsonOutput is True, else (jsonOutput False) remoteHost is from current Authenticated user

jsonOutput - ValidPacket will contain Json format ?

Returns:

the ValidPacket to answer containing: Transfer Information as Header

Throws:

OpenR66ProtocolNotAuthenticatedException

OpenR66ProtocolNoDataException

transferRequest

public final R66Result transferRequest(TransferRequestJsonPacket request)

Receive a TransferRequest in JSON mode: just setting it to be scheduled

Parameters:

request -

Returns:

the result associated with the new transfer request