AdminTool (FIX Antenna Java 2.24.0 API Documentation)

java.lang.Object
- com.epam.admintool.AdminTool

All Implemented Interfaces:

com.epam.fixengine.acceptor.FIXAdminSessionListener, FIXServerListener
```
public class AdminTool
extends Object
implements com.epam.fixengine.acceptor.FIXAdminSessionListener
```
Main class for AdminTool Application.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ADMIN_PROTOCOL_VERSION_TAG` Tag that contains version of admin protocol.
`protected FIXSession`	`adminSession`
`protected ICommandHandler`	`commandHandler`
`protected String`	`commandPackageName`
`protected com.epam.fixengine.manager.ConfiguredSessionRegister`	`configuredSessionRegister`
`protected Lock`	`lock`
`protected static Log`	`LOG`
`static int`	`TIMEZONE_TAG` Tag that contains component time zone.

Constructor Summary

Constructors
Constructor and Description

AdminTool()
Creates the AdminTool .

Constructors
Constructor and Description
`AdminTool()` Creates the `AdminTool` .

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`getFormattedTimeZone()`
`void`	`newFIXSession(FIXSession session)` This method is invoked every time when new FIXSession is created.
`protected void`	`process(FIXFieldList message)` Process the request.
`protected void`	`sendResponse(String problem, String code, Long requestID)` Sends the response.
`void`	`setAdminSession(FIXSession adminSession)` Setter for admin session.
`void`	`setCommandHandler(ICommandHandler commandHandler)` Setter for command handler.
`protected void`	`setSessionExternalPackageName()` Sets the package of commands.
`void`	`setSessionRegister(com.epam.fixengine.manager.ConfiguredSessionRegister configuredSessionRegister)`
`protected boolean`	`validateMessage(FIXFieldList message)` Validates the message.
`protected boolean`	`validateRequestID(Long commandRequestID)` Validates the requestID.

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

- Field Detail
  - LOG
```
protected static Log LOG
```
  - TIMEZONE_TAG
```
public static final int TIMEZONE_TAG
```
    Tag that contains component time zone. TimeZone format "+|- HH:MM, e.g. +03:00 or -03:00".
    
    See Also:
    
    Constant Field Values
  - ADMIN_PROTOCOL_VERSION_TAG
```
public static final int ADMIN_PROTOCOL_VERSION_TAG
```
    Tag that contains version of admin protocol. Example: 2.0.12
    
    See Also:
    
    Constant Field Values
  - adminSession
```
protected FIXSession adminSession
```
  - commandPackageName
```
protected String commandPackageName
```
  - commandHandler
```
protected ICommandHandler commandHandler
```
  - configuredSessionRegister
```
protected com.epam.fixengine.manager.ConfiguredSessionRegister configuredSessionRegister
```
  - lock
```
protected Lock lock
```
- Constructor Detail
  - AdminTool
```
public AdminTool()
```
    Creates the AdminTool .
- Method Detail
  - setCommandHandler
```
public void setCommandHandler(ICommandHandler commandHandler)
```
    Setter for command handler.
  - setAdminSession
```
public void setAdminSession(FIXSession adminSession)
```
    Setter for admin session.
  - setSessionRegister
```
public void setSessionRegister(com.epam.fixengine.manager.ConfiguredSessionRegister configuredSessionRegister)
```
    Specified by:
    
    setSessionRegister in interface com.epam.fixengine.acceptor.FIXAdminSessionListener
  - process
```
protected void process(FIXFieldList message)
```
    Process the request.
    
    Parameters:
    
    message - the fix message
  - setSessionExternalPackageName
```
protected void setSessionExternalPackageName()
```
    Sets the package of commands.
  - validateMessage
```
protected boolean validateMessage(FIXFieldList message)
```
    Validates the message.
    
    Parameters:
    
    message - the fix message
  - validateRequestID
```
protected boolean validateRequestID(Long commandRequestID)
```
    Validates the requestID.
    
    Parameters:
    
    commandRequestID -
  - sendResponse
```
protected void sendResponse(String problem,
                            String code,
                            Long requestID)
```
    Sends the response.
    
    Parameters:
    
    problem - the discription
    
    code - the result code
    
    requestID - the last request id
  - newFIXSession
```
public void newFIXSession(FIXSession session)
```
    Description copied from interface: FIXServerListener
    
    This method is invoked every time when new FIXSession is created.
    
    Specified by:
    
    newFIXSession in interface FIXServerListener
    
    Parameters:
    
    session - the new session
    
    See Also:
    
    FIXServerListener.newFIXSession(com.epam.fixengine.FIXSession)
  - getFormattedTimeZone
```
public static String getFormattedTimeZone()
```

Class AdminTool

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

TIMEZONE_TAG

ADMIN_PROTOCOL_VERSION_TAG

adminSession

commandPackageName

commandHandler

configuredSessionRegister

lock

Constructor Detail

AdminTool

Method Detail

setCommandHandler

setAdminSession

setSessionRegister

process

setSessionExternalPackageName

validateMessage

validateRequestID

sendResponse

newFIXSession

getFormattedTimeZone